goauthentik · tanberry · Jan 29, 2025 · Jan 23, 2025 · Jan 23, 2025 · Jan 24, 2025
@@ -23,6 +23,10 @@ The following placeholders are used in this guide:
 - `actual.company` is the FQDN of the Actual Budget 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
 
 [Create](https://docs.goauthentik.io/docs/add-secure-apps/applications/manage_apps#add-new-applications) an OAuth2/OpenID provider and an application in authentik. Use the following parameters for the OAuth2/OpenID provider:

@@ -20,6 +20,10 @@ 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.
+:::
+
 Create an OAuth2/OpenID provider with the following parameters:
 
 - **Client Type**: `Confidential`

@@ -21,7 +21,7 @@ The following placeholders are used in this guide:
 - `authentik.company` is the FQDN of the authentik installation.
 
 :::note
-Only settings that have been modified from default have been listed.
+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

@@ -21,6 +21,10 @@ The following placeholders are used in this guide:
 - `authentik.company` is the FQDN of the authentik installation.
 - `SSL Certificate` is the name of the SSL certificate used to sign outgoing responses.
 
+:::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
 
 1. Log in to authentik as an admin, and go to the Admin interface.

@@ -28,6 +28,10 @@ The following placeholders are used in this guide:
 - `awx.company` is the FQDN of the AWX/RHAAP 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.
+:::
+
 Create an application in authentik and note the slug, as this will be used later. Create a SAML provider with the following parameters:
 
 - ACS URL: `https://awx.company/sso/complete/saml/`

@@ -25,6 +25,10 @@ The following placeholders are used in this guide:
 - `authentik.company` is the FQDN of authentik.
 - `METADATAURL` is the url for the SAML metadata from authentik
 
+:::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.
+:::
+
 ### Step 1
 
 In authentik, under _Providers_, create a _SAML Provider_ with these settings:

@@ -20,6 +20,10 @@ The following placeholders are used in this guide:
 - `budibase.company` is the FQDN of the Budibase 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.
+:::
+
 Create an application in authentik. Create an OAuth2/OpenID provider with the following parameters:
 
 - Client Type: `Confidential`

@@ -20,6 +20,10 @@ The following placeholders are used in this guide:
 - `chronograf.company` is the FQDN of your Chronograf installation.
 - `authentik.company` is the FQDN of your 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
 
 1. From the authentik Admin interface navigate to **Applications** -> **Applications** on the left sidebar.
@@ -33,8 +37,8 @@ The following placeholders are used in this guide:
 
 Add the following environment variables to your Chronograf setup. If you are using a configuration file for Chronograf, these settings can also be included there. You may modify the values for `GENERIC_SCOPES` and `GENERIC_API_KEY` to suit your specific requirements.
 
-:::info  
-Refer to the [Chronograf configuration options documentation](https://docs.influxdata.com/chronograf/v1/administration/config-options/) for more information.  
+:::info
+Refer to the [Chronograf configuration options documentation](https://docs.influxdata.com/chronograf/v1/administration/config-options/) for more information.
 :::
 
 ```

@@ -22,6 +22,10 @@ The following placeholders are used in this guide:
 
 To proceed, you need to register for a free Cloudflare Access account and have both a Cloudflare account and a publicly accessible authentik instance with a trusted SSL certificate.
 
+:::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
 
 1. From the Admin interface, navigate to **Applications** -> **Applications**.

@@ -20,6 +20,10 @@ The following placeholders are used in this guide:
 - `dokuwiki.company` is the FQDN of the DokiWiki 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.
+:::
+
 ## DokuWiki configuration
 
 In DokuWiki, navigate to the _Extension Manager_ section in the _Administration_ interface and install

@@ -23,6 +23,10 @@ The following placeholders are used in this guide:
 - `engomo.mapping` is the name of the Scope Mapping.
 - `ak.cert` is the self-signed certificate that will be used for the service provider.
 
+:::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
 
 In authentik, create a new scope mapping. To do so, log in and navigate to the Admin interface, then go to **Customization --> Property Mapping** and click **Create**.

@@ -25,6 +25,10 @@ The following placeholders are used in this guide:
 - `authentik.<your_company>` is the FQDN of the authentik installation.
 - `_SLUG_` is the slug you choose upon application create in authentik.
 
+:::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
 
 1. Log into authentik as an admin, and navigate to **Applications** --> **Applications**.

@@ -21,6 +21,10 @@ The following placeholders are used in this guide:
 - `authentik` is the unique ID used to generate logins for this provider.
 - `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.
+:::
+
 Create an OAuth2/OpenID provider with the following parameters:
 
 - Client type: `Confidential`

@@ -23,6 +23,10 @@ The following placeholders are used in this guide:
 - `fgt.mapping` is the name of the SAML Property Mapping.
 - `ak.cert` = The authentik self-signed certificate you use for the service provider.
 
+:::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.
+:::
+
 > [!IMPORTANT]
 > If you have changed the port of the admin login from 443 to anything else you have to append it behind `fgt.company`. So f.e. `fgt.company:10443`.
 

@@ -36,6 +36,10 @@ The following placeholders are used in this guide:
 - `fgt.user.group` = This will be the name of the user group in your Fortigate that you will use in your SSLVPN portal mapping and Firewall rules
 - `ak.user.group` = This is the user group name that you will use in authentik if you plan on limiting access to the sslvpn via groups.
 
+:::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.
+:::
+
 ## FortiGate configuration
 
 ### Preparation

@@ -22,6 +22,10 @@ The following placeholders are used in this guide:
 - `fgm.company` is the FQDN of the FortiManager 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.
+:::
+
 Create an application and Provider in authentik, note the slug, as this will be used later. Create a SAML provider with the following parameters:
 
 Provider:

@@ -25,6 +25,10 @@ The following placeholders are used in this guide:
 - `authentik.company` is the FQDN of the authentik installation.
 - `provider` is the name for the social login provider in Frappe.
 
+:::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
 
 1. Log in to authentik as an admin, and go to the Admin interface.

@@ -21,6 +21,10 @@ The following placeholders are used in this guide:
 - `port` is the port on which the FreshRSS install is running (usually 443)
 - `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
 
 1. Create an **OAuth2/OpenID Provider** under **Applications** > **Providers** using the following settings:

@@ -20,6 +20,10 @@ The following placeholders are used in this guide:
 - `gatus.company` is the FQDN of the Gatus 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
 
 Create an OIDC provider with the following settings:

@@ -21,8 +21,12 @@ This is based on authentik 2022.10.1 and Gitea 1.17.3 installed using the offici
 
 The following placeholders are used in this guide:
 
-- `authentik.company` is the FQDN of authentik.
-- `gitea.company` is the FQDN of Gitea.
+- `authentik.company` is the FQDN of the authentik installation.
+- `gitea.company` is the FQDN of the Gitea 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.
+:::
 
 ### Step 1
 

@@ -22,7 +22,7 @@ GitHub Enterprise Cloud EMU (Enterprise Managed Users) are not compatible with a
 The following placeholders are used in this guide:
 
 - `github.com/enterprises/foo` is your GitHub organization, where `foo` is the name of your enterprise
-- `authentik.company` is the FQDN of the authentik Install
+- `authentik.company` is the FQDN of the authentik installation.
 
 Create an application in authentik and note the slug, as this will be used later. Create a SAML provider with the following parameters:
 
@@ -35,6 +35,10 @@ Under _Advanced protocol settings_, set a certificate for _Signing Certificate_.
 
 Once the provider is created, it is advised to download the signing certificate as you will need it later.
 
+:::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.
+:::
+
 ## GitHub Configuration
 
 Navigate to your enterprise settings by clicking your GitHub user portrait in the top right of GitHub.com, select `Your enterprises` and click `Settings` for the enterprise you wish to configure.

@@ -24,14 +24,18 @@ sidebar_label: GitHub Enterprise Cloud EMU
 The following placeholders are used in this guide:
 
 - `github.com/enterprises/foo` is your GitHub organization, where `foo` is the name of your enterprise
-- `authentik.company` is the FQDN of the authentik Install
+- `authentik.company` is the FQDN of the authentik installation.
 - `GitHub Users` is an authentik group used for holding GitHub users.
 - `GitHub Admins` is an authentik group used for indicating GitHub administrators.
 
 Note that in order to use the EMU Enterprise, you _must_ set up both SAML and SCIM.
 
 First, create the two groups, in authentik, go to _Groups_, click _Create_ and put in `GitHub Users`, or your chosen user group name. Repeat this step with your Admin group as well.
 
+:::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.
+:::
+
 ## SAML Provider
 
 Create a SAML provider with the following parameters:

@@ -18,7 +18,7 @@ sidebar_label: GitHub Enterprise Server
 The following placeholders are used in this guide:
 
 - `https://github.company` is your GitHub Enterprise Server installation
-- `authentik.company` is the FQDN of the authentik Install
+- `authentik.company` is the FQDN of the authentik installation.
 - `GitHub Users` is an authentik group used for holding GitHub users.
 - `GitHub Admins` is an authentik group used for indicating GitHub administrators.
 
@@ -37,6 +37,10 @@ Once the provider is created, it is advised to download the signing certificate
 
 Create a matching application for your SAML provider.
 
+:::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.
+:::
+
 ## SAML Configuration
 
 If you are planning to use SCIM, (available from GHES 3.14.0) you should create a first admin user on your instance and go to your personal access tokens at `https://github.company/settings/tokens/new`, click _Generate new token_ and click _Generate new token (classic)_. Your token should have a descriptive name and ideally, no expiration date. For permission scopes, you need to select _admin:enterprise_. Click _Generate token_ and store the resulting token in a safe location.

@@ -18,7 +18,7 @@ sidebar_label: GitHub Organization
 The following placeholders are used in this guide:
 
 - `github.com/orgs/foo` is your GitHub organization, where `foo` is the name of your org
-- `authentik.company` is the FQDN of the authentik Install
+- `authentik.company` is the FQDN of the authentik installation.
 
 Create an application in authentik and note the slug, as this will be used later. Create a SAML provider with the following parameters:
 
@@ -31,6 +31,10 @@ Under _Advanced protocol settings_, set a certificate for _Signing Certificate_.
 
 Once the provider is created, it is advised to download the signing certificate as you will need it later.
 
+:::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.
+:::
+
 ## GitHub Configuration
 
 Navigate to your organization settings by going to your organization page at https://github.com/foo, then click Settings.

@@ -30,8 +30,8 @@ There are 2 ways to configure single sign on (SSO) for GitLab:
 
 The following placeholders are used in this guide:
 
-- `gitlab.company` is the FQDN of the GitLab Install
-- `authentik.company` is the FQDN of the authentik Install
+- `gitlab.company` is the FQDN of the GitLab installation.
+- `authentik.company` is the FQDN of the authentik installation.
 
 Create an application in authentik and note the slug, as this will be used later. Create a SAML provider with the following parameters:
 
@@ -42,6 +42,10 @@ Create an application in authentik and note the slug, as this will be used later
 
 Under _Advanced protocol settings_, set a certificate for _Signing Certificate_.
 
+:::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.
+:::
+
 #### GitLab Configuration
 
 Paste the following block in your `/etc/gitlab/gitlab.rb` file, after replacing the placeholder values from above.

@@ -20,6 +20,10 @@ The following placeholders are used in this guide:
 - `glitchtip.company` is the FQDN of the Glitchtip 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
 
 Create an OAuth2/OpenID provider with the following parameters:

@@ -22,6 +22,10 @@ The following placeholders are used in this guide:
 - `gp.company` is the FQDN of the GlobalProtect portal.
 - `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.
+:::
+
 :::caution
 A trusted web certificate is required to be bound to the GlobalProtect Portal. This can be signed by a trusted internal Root Certificate Authority (CA); however, a self signed certificate, a certificate outside of its validity, or a non-standard confirming certificate (such as a lifespan not trusted by modern browsers) will error out on SAML authentication.
 :::

@@ -20,6 +20,10 @@ The following placeholders are used in this guide:
 - `authentik.company` is the FQDN of the authentik installation.
 - `example.com` is the default E-mail address configured in Google workspace.
 
+:::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
 
 Create an application in authentik and note the slug, as this will be used later. Set the _Launch URL_ to `https://mail.google.com/a/example.com`.