d111740f6b
* website/integrations: all: install -> installation * fix for new integr Signed-off-by: 4d62 <git@sdko.org> --------- Signed-off-by: 4d62 <git@sdko.org>
76 lines
2.9 KiB
Plaintext
76 lines
2.9 KiB
Plaintext
---
|
|
title: Integrate with Apache Guacamole™
|
|
sidebar_label: Apache Guacamole™
|
|
---
|
|
|
|
# Apache Guacamole™
|
|
|
|
<span class="badge badge--primary">Support level: authentik</span>
|
|
|
|
## 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.
|
|
|
|
Create an OAuth2/OpenID provider with the following parameters:
|
|
|
|
- **Client Type**: `Confidential`
|
|
- **Redirect URIs**: `https://guacamole.company/` (depending on your Tomcat setup, you might have to add `/guacamole/` if the application runs in a subfolder)
|
|
- **Scopes**: OpenID, Email, and Profile
|
|
|
|
Under **Advanced protocol settings**, set the following:
|
|
|
|
- **Token validity**: Any value to configure how long the session should last. Guacamole will not accept any tokens valid longer than 300 Minutes.
|
|
- **Signing Key**: Set the key as `authentik Self-signed Certificate`
|
|
|
|
Note the Client ID value. Create an application, using the provider you've created above.
|
|
|
|
## Guacamole
|
|
|
|
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>
|