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 kcm package.
Production use of this file is not recommended.
| ### Installing and configuring included extensions Supported extensions, such as those provided by the Keeper Connection Manager packages, are installed through installing their corresponding packages. If you are using [the keeper/guacamole Docker image,](broken://pages/PrGlvnEjhFxQkUuBMC4I) extensions are automatically installed using the above packages depending on the environment variables provided when the container is first started. | Extension | Package name | Docker image environment variables | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ | ---------------------------------- | | [Active Directory / LDAP support](/kcm-linux-rpm-method/authentication/authenticating-users-with-ldap.md) | `kcm-guacamole-auth-ldap` | `LDAP_*` | | [Duo two-factor authentication](/kcm-linux-rpm-method/advanced-configuration/guacamole.properties/duo-two-factor-authentication-configuration-properties.md) | `kcm-guacamole-auth-duo` | `DUO_*` | | [Encrypted JSON authentication](/kcm-linux-rpm-method/using-keeper-connection-manager/dynamic-connections.md) | `kcm-guacamole-auth-json` | `JSON_*` | | [My](/kcm-linux-rpm-method/authentication/using-keeper-connection-manager-with-a-mysql-database.md)[SQL / MariaDB database support](/kcm-linux-rpm-method/authentication/using-keeper-connection-manager-with-a-mysql-database.md) | `kcm-guacamole-auth-jdbc-mysql` | `MYSQL_*` | | [PostgreSQL database support](/kcm-linux-rpm-method/authentication/using-keeper-connection-manager-with-a-postgresql-database.md) | `kcm-guacamole-auth-jdbc-postgresql` | `POSTGRES_*` | | [SQL Server database support](/kcm-linux-rpm-method/authentication/using-guacamole-with-a-sql-server-database.md) | `kcm-guacamole-auth-jdbc-sqlserver` | `SQLSERVER_*` | | [TOTP two-factor authentication](/kcm-linux-rpm-method/authentication/using-totp-for-multi-factor-authentication.md) | `kcm-guacamole-auth-totp` | `TOTP_*` | | [SAML 2.0 / SSO Integration](/kcm-linux-rpm-method/authentication/authenticating-users-with-saml.md) | `kcm-guacamole-auth-saml` | `SAML_*` | | [OpenID Connect Integration](/kcm-linux-rpm-method/authentication/authenticating-users-with-openid-connect.md) | `kcm-guacamole-auth-openid` | `OPENID_*` | The Keeper Connection Manager 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 Keeper Connection Manager repository.** ### Installing custom / third-party extensions Custom extensions, such as[ custom branding provided as part of a Keeper Connection Manager subscription](/kcm-linux-rpm-method/scope-of-support.md), 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`. | Filename | Description | | ---------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `/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: * [Branding extensions which we have provided as part of a subscription](https://newdocs.keeper.io/kcm-linux-rpm-method/pages/FKONKgHxjpmWDU89PY4X#id-.scopeofsupportv2.x-custom-brandingcustom-brandingcustombranding) * [Subscriptions which explicitly extend support to include custom / third-party extensions](https://newdocs.keeper.io/kcm-linux-rpm-method/pages/FKONKgHxjpmWDU89PY4X#id-.scopeofsupportv2.x-integration-consultingintegration-consultingintegration-deploymentconsulting) ### Applying custom branding Custom branding is applied through branding extensions, such as[ the branding extensions we provide on request as part of a Keeper Connection Manager subscription](https://newdocs.keeper.io/kcm-linux-rpm-method/pages/FKONKgHxjpmWDU89PY4X#id-.scopeofsupportv2.x-custom-brandingcustom-brandingcustombranding). If you have a custom branding extension and wish to apply that branding to your deployment of Keeper Connection Manager, you must: 1. Remove the symbolic link to the default Keeper Connection Manager branding, located at `/etc/guacamole/extensions/_kcm-branding.jar`. The `kcm-guacamole` package 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 [keeper/guacamole](broken://pages/PrGlvnEjhFxQkUuBMC4I) Docker image, this can also be accomplished by setting the `USE_DEFAULT_BRANDING` environment variable to "N". 2. Copy the extension's .jar file to `/etc/guacamole/extensions/`. 3. Restart Tomcat You may need to clear cache within browsers that have already visited your deployment. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://newdocs.keeper.io/kcm-linux-rpm-method/advanced-configuration.md?ask=