Skip to content

2.0 Environment Variables

Rob Ballantyne edited this page Jun 7, 2024 · 4 revisions

Environment variables can be specified by using any of the standard methods (docker-compose.yaml, docker run -e...). Additionally, environment variables can also be passed as arguments to init.sh.

Passing environment variables to init.sh is usually unnecessary, but is useful for some cloud environments where the full docker run command cannot be specified.

Example usage: docker run -e STANDARD_VAR1="this value" -e STANDARD_VAR2="that value" init.sh EXTRA_VAR="other value"


All Containers

Variable Description
CF_QUICK_TUNNELS Create ephemeral Cloudflare tunnels for web services (default true)
CF_TUNNEL_TOKEN Cloudflare zero trust tunnel token - See documentation.
DIRECT_ADDRESS IP/hostname for service portal direct links (default localhost)
DIRECT_ADDRESS_GET_WAN Use the internet facing interface for direct links (default false)
PROVISIONING_SCRIPT URL of a remote script to execute on init.
RCLONE_* Rclone configuration - See rclone documentation
SERVICEPORTAL_PORT_HOST Exposed port for SSH service (default 1111)
SERVICEPORTAL_URL* Override DIRECT_ADDRESS:port with URL for Service Portal
SSH_PORT_HOST Exposed port for SSH service (default 22)
SSH_PUBKEY Your public key for SSH
SYNCTHING_UI_PORT_HOST Exposed port for SSH service (default 8384)
SYNCTHING_TRANSPORT_PORT_HOST Exposed port for SSH service (default 22999)
SYNCTHING_URL* Override DIRECT_ADDRESS:port with URL for Syncthing service
USER_NAME System account username
USER_PASSWORD System account password
WEB_ENABLE_AUTH Enable password protection for web services (default true)
WEB_USER Username for web services (default user)
WEB_PASSWORD Password for web services (default password)
WORKSPACE A volume path. Defaults to /workspace/

Desktop Containers

Variable Description
COTURN_USER Username for Coturn auth. Default user
COTURN_PASSWORD Password for Coturn auth. Auto-generated by default.
COTURN_LISTEN_ADDRESS Override the default listening address. Uses external IP by default.
COTURN_PORT_HOST Default is 3478
ENABLE_COTURN Enable the turn server, Default false
TURN_HOST Turn server address if not using builtin Coturn server
TURN_PORT Turn server address if not using builtin Coturn server
TURN_USERNAME Turn server username
TURN_PASSWORD Turn server password
WEBRTC_ENABLE_RESIZE Enable resize. Default false
WEBRTC_ENCODER Default nvh264enc. Available options: vah264enc, x264enc, vp8enc, vp9enc
WEBRTC_PORT_HOST Exposed port for Selkies WebRTC service (default 6100)
WEBRTC_URL* Override DIRECT_ADDRESS:port with URL for Selkies WebRTC service
VNC_PORT_HOST Exposed port for Kasm VNC service (default 6200)
VNC_URL* Override DIRECT_ADDRESS:port with URL for Kasm VNC service

* SERVICENAME_URL is useful if you want to run this container behind a reverse proxy as it will direct the service portal to use your URL for direct links rather than the default IP:port.