Configure features supported in the container

Runtime is designed as a multi-container application, which means you can use Docker Compose to run it.

Set the environment variables in the .env file according to the environment variables that best suit your needs before executing the Docker Compose command. The .env file should look like this:

SETUPHOSTIMAGE=ubiquity-runtime/setuphost
RUNTIMEIMAGE=ubiquity-runtime/runtime
TAG=<version>
SETUPHOSTCONTAINER=ubiquity-runtime-setuphost
RUNTIMECONTAINER=ubiquity-runtime
VERBOSE=false
VOLUME=
TZ=UTC
APPARMOR_PROFILE=ubiquity-runtime
WEB_LOGIN_PASSWORD=
RDP_DISPLAY=
RDP_XAUTHORITY=
VPN_ADAPTERS=
VPN_P2P=false
Table 1. Environment variables

Variable

Definition

Note

SETUPHOST_IMAGE

Specifies the image name of the Setuphost service.

ALREADY SET

RUNTIME_IMAGE

Specifies the image name of the Runtime service.

ALREADY SET

TAG

Defines the tag for both images.

ALREADY SET

SETUPHOST_CONTAINER

Indicates the container name associated with the Setuphost service.

ALREADY SET

RUNTIME_CONTAINER

Indicates the container name associated with the Runtime service.

ALREADY SET

VERBOSE

Enables detailed output from the Setuphost in operation if set to true. The default value is false.

EDITABLE

VOLUME

Specifies the path to the volume mounted by the Runtime to store persistent data. For example, /path/to/persistent/folder.

SET MANDATORILY

TZ

Sets the time zone where the Runtime operates. By default, the time zone is set to UTC. You can change this preset time zone by modifying the UTC value.

EDITABLE

APPARMOR_PROFILE

Defines the AppArmor profile applied to the Runtime service. To run the container without complying with any security policies, remove this variable or set it to unconfined.

EDITABLE

WEB_LOGIN_PASSWORD

Protects the Web UI of the Runtime through a password. This variable is not set by default, but it is recommended to set it for security purposes. This value is entered into the Setuphost service as a secret.

EDITABLE

RDP_DISPLAY

Specifies the host display used by the Runtime to run the Remote Desktop feature. See Enable the Remote Desktop Protocol (RDP).

SET ONLY FOR RDP

RDP_XAUTHORITY

Specifies the path to the .Xauthority file used by the standard user that interacts with the X11 server. See Enable the Remote Desktop Protocol (RDP).

SET ONLY FOR RDP

VPN_ADAPTERS

Specifies the interfaces with which the Runtime can establish VPN connections. See Enable a VPN connection.

SET ONLY FOR RDP

VPN_P2P

Enables the Point-to-Point VPN feature in Runtime if set to true. The default value is false.

SET ONLY FOR RDP