Advanced Configuration
This is the legacy v1.x documentation. For the latest Glyptodon documentation please visit: https://docs.keeper.io/glyptodon
Apache Guacamole is configured using files within the /etc/guacamole directory, commonly referred to as GUACAMOLE_HOME. The two primary components of the Apache Guacamole stack, guacd and the Guacamole web application, both have their own dedicated configuration files within /etc/guacamole. Glyptodon Enterprise includes default, skeleton versions of these files.
The configuration file for the Apache Guacamole proxy daemon, "guacd". This file and the guacd service are provided by the glyptodon-guacd package.
The configuration file for the Apache Guacamole web application. This file and the Guacamole web application are provided by the glyptodon-guacamole package.
/etc/guacamole/user-mapping.xml
An XML mapping of users to connections which Apache Guacamole can use by default without any additional extensions, primarily intended for initial testing. A skeleton version of this file is provided by the glyptodon-guacamole package.
Production use of this file is not recommended.
Installing and configuring included extensions
Supported extensions, such as those provided by the Glyptodon Enterprise packages, are installed through installing their corresponding packages. If using the glyptodon/guacamole Docker image, extensions are automatically installed using the above packages depending on the environment variables provided when the container is first started.
The Glyptodon Enterprise packages for supported extensions will automatically create symbolic links to install themselves and any needed libraries/drivers. You do not need to manually create links, copy files, etc. for the extensions which are provided within the Glyptodon Enterprise repository.
Installing custom / third-party extensions
Custom extensions, such as custom branding provided as part of a Glyptodon Enterprise subscription, are installed by placing their corresponding .jar files within /etc/guacamole/extensions. If those extensions require additional libraries, such as JDBC drivers, the .jar files for those libraries are placed within /etc/guacamole/lib.
/etc/guacamole/extensions/
The directory in which extension .jar files should be placed. Tomcat must be restarted after extension .jar files are added or removed.
/etc/guacamole/lib/
The directory in which library .jar files required by installed extensions should be placed. Libraries within this directory will be available within the classpath for all extensions.
Note that support is not provided for custom extensions with the following exceptions:
Applying custom branding
Custom branding is applied through branding extensions, such as the branding extensions we provide on request as part of a Glyptodon Enterprise subscription. If you have a custom branding extension and wish to apply that branding to your deployment of Glyptodon Enterprise, you must:
Remove the symbolic link to the default Glyptodon Enterprise branding, located at
/etc/guacamole/extensions/_glyptodon-enterprise-branding.jar. Theglyptodon-guacamolepackage considers the existence/absence of this link to be an aspect of configuration and is designed to allow this symbolic link to be removed. If using the glyptodon/guacamole Docker image, this can also be accomplished by setting theUSE_DEFAULT_BRANDINGenvironment variable to "N".Copy the extension's .jar file to
/etc/guacamole/extensions/.Restart Tomcat
You may need to clear cache within browsers that have already visited your deployment.
Last updated