Guacamole#

Guacamole is a clientless remote desktop gateway. It supports standard protocols like VNC, RDP, and SSH.

amd64
arm64
armv7

Information#

Docker Image: !!! LINK TO DOCKER IMAGE/ DOCKER HUB !!!
Current Image Version: latest

SETUP#

Enabling guacamole#

Command:#

vlab set guacamole.enable True

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

guacamole
enable: True

Finalising changes:#

run: vlab update_one service=guacamole

FIRST RUN#

!!! DEVELOPERS: make sure that you include any information that the user requires to get started, below. !!!
!!! Below are some examples with headings, and with some example instructions !!!

ADMINISTRATOR SETUP#

Default login is user admin with password admin, please change the password immediately (see user menu).

SMTP/ MAIL#

  1. run vlab decrypt to decrypt the vault.yml file
  2. make some changes

SMTP Settings#

smtp:
host:
port:
user:
pass:
from_email:
from_name:
  1. run vlab update_one service=guacamole to complete the changes

ACCESS#

guacamole (HTTPS) link: https://guacamole.vivumlab.xyz/ guacamole (HTTP) link: http://guacamole.vivumlab.xyz/

OPTIONS#

HTTPS_ONLY#

Default: False
Options: True/False

Command:#

vlab set guacamole.https_only True

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

guacamole
https_only: True
Finalising changes:#

run: vlab update_one service=guacamole

AUTH#

Default: False
Options: True/False

Command:#

vlab set guacamole.auth True

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

guacamole
auth: True
Finalising changes:#

run: vlab update_one service=guacamole

DOMAIN#

Default: False
NOTE: include the sitename and top level domain suffix. eg. name.com, site.net

Command:#

vlab set guacamole.domain guacamole.com

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

guacamole
domain: guacamole.com
Finalising changes:#

run: vlab update_one service=guacamole

SUBDOMAIN#

Default: guacamole
NOTE: Periods/ delimiters are not required. eg. 'media' will set the full URL as 'media.vivumlab.xyz'

Command:#

vlab set guacamole.subdomain media

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

guacamole
subdomain: media
Finalising changes:#

run: vlab update_one service=guacamole

VERSION#

Default: latest
NOTE: Ensure that the version exists

Command:#

vlab set guacamole.version 2.7

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

guacamole
version: 2.7
Finalising changes:#

run: vlab update_one service=guacamole

Need more help?#

Further information regarding services can be found.
General Information can be found in the documentation.
Additional assistance can be found on our Contact Us page.