docker-phpvirtualbox

This is a fork of clue/phpvirtualbox, because it is not very up to date and there are no further configuration options.

phpVirtualBox

phpVirtualBox is a modern web interface that allows you to control remote VirtualBox instances - mirroring the VirtualBox GUI.

Caution due to changes on 03.01.2019

Changed image behavior and environment variables:

The environment variable *_PORT_18083_TCP changed to *_HOSTPORT

Now, the default behavior is to use authentication. If no authentication is used please specify -e CONF_noAuth='true'.

If using multiple servers, there is a need to specify one server as authentication server with *_CONF_authMaster='true'.

Usage

This image provides the phpVirtualBox web interface that communicates with any number of VirtualBox installations on your computers.

Internally, the phpVirtualBox web interface communicates with each VirtualBox installation through the vboxwebsrv program that is installed as part of VirtualBox.

The container is started with following command:

docker run --name vbox_http --restart=always \
    -p 80:80 \
    -e ID_HOSTPORT=ServerIP:PORT \
    -e ID_NAME=serverName \
    -e ID_USER=vboxUser \
    -e ID_PW='vboxUserPassword' \
    -e CONF_browserRestrictFolders="/data,/home" \
    -d jazzdd/phpvirtualbox

-p {OutsidePort}:80 - will bind the webserver to the given host port
-d jazzdd/phpvirtualbox - the name of this docker image
-e ID_NAME - name of the vbox server - display name of the Server in the UI - could be any name
-e ID_HOSTPORT - ip/hostname and port of the vbox server
-e ID_USER - user name of the user in the vbox group
-e ID_PW - password of this user
-e CONF_varName - override default config value of varName, browserRestrictFolders is a useful example. Coma-separated strings will be converted into an array.

ID is an identifier to get all matching environment variables for one vbox server. So, it is possible to define more then one VirtualBox server and manage it with one phpVirtualbox instance.

An example would look as follows:

docker run --name vbox_http --restart=always -p 80:80 \
    -e SRV1_HOSTPORT=192.168.1.1:18083 -e SRV1_NAME=Server1 -e SRV1_USER=user1 -e SRV1_PW='test' \
    -e SRV2_HOSTPORT=192.168.1.2:18083 -e SRV2_NAME=Server2 -e SRV2_USER=user2 -e SRV2_PW='test' \
    -d jazzdd/phpvirtualbox

Running vboxwebsrv as a container

Instead of exposing the vboxwebsrv service to the outside, the jazzdd86/vboxwebsrv image could be used to establish a secure ssh connection to the server and start the vboxwebsrv service on demand and tunneling the vboxwebsrv port to the phpVirtualbox container.

See jazzdd86/vboxwebsrv for more information on how to start the vboxwebsrv service via docker image.

Example:

$ docker run -it --name=vbox_websrv_1 --restart=always jazzdd/vboxwebsrv user1@192.168.1.1

To run phpVirtualbox with the vboxwebsrv container use following command:

$ docker run --name vbox_http --restart=always -p 80:80 -e SRV1_HOSTPORT=vbox_websrv_1:18083 -e SRV1_NAME=Server1 -e SRV1_USER=user1 -e SRV1_PW='test' -d jazzdd/phpvirtualbox

Configurations

As mentioned before -e CONF_varName can override default config values of varName. This configuration options can be used in two ways:

$ docker run --name vbox_http --restart=always \
    -e SRV1_HOSTPORT=192.168.1.1:18083 -e SRV1_NAME=Server1 -e SRV1_USER=user1 -e SRV1_PW='test' \
    -e SRV2_HOSTPORT=192.168.1.2:18083 -e SRV2_NAME=Server2 -e SRV2_USER=user2 -e SRV2_PW='test' \
    -e SRV1_CONF_browserRestrictFolders="/data,/home" \
    -e CONF_browserRestrictFolders="/vm," \
    -d jazzdd/phpvirtualbox

1. -e SRV1_CONF_browserRestrictFolders="/data,/home" - config parameter only valid for one specific virtualbox server
1. -e CONF_browserRestrictFolders="/data," - global configuration - valid for all virtualbox servers, if more than one server was specified

If an option requires an array but only one parameter is given enter a comma after the option (see option 2).

Authentication

The image enables authentication by default. Default login would be admin/admin.

If using multiple servers, there is a need to specify one server as authentication server with e.g. SRV1_CONF_authMaster='true'. If no authMaster is specified, phpVirtualBox uses the first configured server.

If no authentication is used please specify -e CONF_noAuth='true'.

Docker Compose

A docker compose file could look as follows (including one vboxwebsrv service):

version: '3'
services:
    vbox_http:
        container_name: vbox_http
        restart: always
        ports:
            - "8080:80"
        environment:
            SRV1_HOSTPORT: "vbox_websrv_1:18083"
            SRV1_NAME: "Server1"
            SRV1_USER: "user1"
            SRV1_PW: "test"
            SRV2_HOSTPORT: "192.168.1.2:18083"
            SRV2_NAME: "Server2"
            SRV2_USER: "user2"
            SRV2_PW: "test"
            SRV2_CONF_browserRestrictFolders: "/data,"
            SRV2_CONF_authMaster: "true"
            CONF_browserRestrictFolders: "/home,/usr/lib/virtualbox,"
            CONF_noAuth: "true"
        depends_on:
            - vbox_websrv
        image: jazzdd/phpvirtualbox

    vbox_websrv:
        container_name: vbox_websrv_1
        restart: always
        volumes:
            - "./ssh:/root/.ssh"
        environment:
            USE_KEY: 1
        image: jazzdd/vboxwebsrv
        command: user1@192.168.1.1

ipy/phpVirtualbox