From 305ffc78f6b5c3bbed6a5146f4b188af54e3aa8e Mon Sep 17 00:00:00 2001 From: LRVT <21357789+l4rm4nd@users.noreply.github.com> Date: Wed, 22 Jul 2026 13:43:44 +0200 Subject: [PATCH] Update README.md --- examples/guacamole/README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/examples/guacamole/README.md b/examples/guacamole/README.md index 0e2e899..8351284 100644 --- a/examples/guacamole/README.md +++ b/examples/guacamole/README.md @@ -5,6 +5,8 @@ # Notes +## Installation + Before spawning up the Docker Compose stack you have to pre-supply an `initdb.sql` initialization file for the Postgresql database. Please go ahead and create this init file in the corresponding Docker Volume bind mount. @@ -23,12 +25,21 @@ Afterwards, you can spawn up the Docker stack as follows: docker compose up -d ```` +## Authentication + The Guacamole login is available at `http://:8080/guacamole`. The default username is `guacadmin`. The default password is `guacadmin`. - > [!TIP] > You can also access internal hosts somewhere else. Just use gluetun to force guacamole over vpn. > > See `docker-compose-gluetun-traefik-authentik-oidc.yml` for an example with wireguard and Authentik OIDC SSO. + +## Custom Extensions + +https://guacamole.apache.org/doc/gug/configuring-guacamole.html#overriding-guacamole-home + +The docker container makes use of the path `/opt/guacamole/extensions`. One may bind-mount this volume but there is a better alternative. + +One can advice the container to use a different home path via the environment variable `GUACAMOLE_HOME`. This way, every file placed there will be read-only copied to the real `/opt/guacamole/extensions` path inside the container, without affecting the regular extensions and install files. Please inspect the compose examples, which add the `GUACAMOLE_HOME=/etc/guacamole` env to support custom extensions.