84 lines
4.1 KiB
Plaintext
84 lines
4.1 KiB
Plaintext
---
|
|
title: Integrate with Apache Guacamole™
|
|
sidebar_label: Apache Guacamole™
|
|
support_level: authentik
|
|
---
|
|
|
|
## What is Apache Guacamole™
|
|
|
|
> Apache Guacamole is a clientless remote desktop gateway. It supports standard protocols like VNC, RDP, and SSH.
|
|
>
|
|
> -- https://guacamole.apache.org/
|
|
|
|
## Preparation
|
|
|
|
The following placeholders are used in this guide:
|
|
|
|
- `guacamole.company` is the FQDN of the Guacamole installation.
|
|
- `authentik.company` is the FQDN of the authentik installation.
|
|
|
|
:::note
|
|
This documentation lists only the settings that you need to change from their default values. Be aware that any changes other than those explicitly mentioned in this guide could cause issues accessing your application.
|
|
:::
|
|
|
|
## authentik configuration
|
|
|
|
To support the integration of Apache Guacamole with authentik, you need to create an application/provider pair in authentik.
|
|
|
|
### Create an application and provider in authentik
|
|
|
|
1. Log in to authentik as an admin, and open the authentik Admin interface.
|
|
2. Navigate to **Applications** > **Applications** and click **Create with Provider** to create an application and provider pair. (Alternatively you can first create a provider separately, then create the application and connect it with the provider.)
|
|
|
|
- **Application**: provide a descriptive name, an optional group for the type of application, the policy engine mode, and optional UI settings.
|
|
- **Choose a Provider type**: select **OAuth2/OpenID Connect** as the provider type.
|
|
- **Configure the Provider**: provide a name (or accept the auto-provided name), the authorization flow to use for this provider, and the following required configurations.
|
|
- Note the **Client ID**,**Client Secret**, and **slug** values because they will be required later.
|
|
- Set a `Strict` redirect URI to <kbd>https://<em>guacamole.company</em>/</kbd>. If you have configured [Apache Tomcat](https://tomcat.apache.org/) to run Apache Guacamole on a subpath, you will need to update this value accordingly.
|
|
- Select any available signing key.
|
|
- Note that Apache Guacamole does not support session tokens longer than 300 minutes (5 hours).
|
|
- **Configure Bindings** _(optional)_: you can create a [binding](/docs/add-secure-apps/flows-stages/bindings/) (policy, group, or user) to manage the listing and access to applications on a user's **My applications** page.
|
|
|
|
3. Click **Submit** to save the new application and provider.
|
|
|
|
## Guacamole configuration
|
|
|
|
It is recommended you configure an admin account in Guacamole before setting up SSO to make things easier. Create a user in Guacamole using the username of your user in authentik and give them admin permissions. Without this, you might lose access to the Guacamole admin settings and have to revert the settings below.
|
|
|
|
import Tabs from "@theme/Tabs";
|
|
import TabItem from "@theme/TabItem";
|
|
|
|
<Tabs
|
|
defaultValue="docker"
|
|
values={[
|
|
{ label: 'Docker', value: 'docker' },
|
|
{ label: 'Standalone', value: 'standalone' },
|
|
]}>
|
|
<TabItem value="docker">
|
|
The Docker containers are configured via environment variables. The following variables are required:
|
|
|
|
```yaml
|
|
OPENID_AUTHORIZATION_ENDPOINT: https://authentik.company/application/o/authorize/
|
|
OPENID_CLIENT_ID: # client ID from above
|
|
OPENID_ISSUER: https://authentik.company/application/o/*Slug of the application from above*/
|
|
OPENID_JWKS_ENDPOINT: https://authentik.company/application/o/*Slug of the application from above*/jwks/
|
|
OPENID_REDIRECT_URI: https://guacamole.company/ # This must match the redirect URI above
|
|
OPENID_USERNAME_CLAIM_TYPE: preferred_username
|
|
```
|
|
|
|
</TabItem>
|
|
<TabItem value="standalone">
|
|
Standalone Guacamole is configured using the `guacamole.properties` file. Add the following settings:
|
|
|
|
```
|
|
openid-authorization-endpoint=https://authentik.company/application/o/authorize/
|
|
openid-client-id=# client ID from above
|
|
openid-issuer=https://authentik.company/application/o/*Slug of the application from above*/
|
|
openid-jwks-endpoint=https://authentik.company/application/o/*Slug of the application from above*/jwks/
|
|
openid-redirect-uri=https://guacamole.company/ # This must match the redirect URI above
|
|
openid-username-claim-type=preferred_username
|
|
```
|
|
|
|
</TabItem>
|
|
</Tabs>
|