diff --git a/website/integrations/services/actual-budget/index.mdx b/website/integrations/services/actual-budget/index.mdx index b3c70dbcca67..0180ff4d15bc 100644 --- a/website/integrations/services/actual-budget/index.mdx +++ b/website/integrations/services/actual-budget/index.mdx @@ -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: diff --git a/website/integrations/services/apache-guacamole/index.mdx b/website/integrations/services/apache-guacamole/index.mdx index 2a481fde431a..cd0c27bed565 100644 --- a/website/integrations/services/apache-guacamole/index.mdx +++ b/website/integrations/services/apache-guacamole/index.mdx @@ -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` diff --git a/website/integrations/services/argocd/index.md b/website/integrations/services/argocd/index.md index d59542f0d6a2..26935541ada8 100644 --- a/website/integrations/services/argocd/index.md +++ b/website/integrations/services/argocd/index.md @@ -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 diff --git a/website/integrations/services/aruba-orchestrator/index.md b/website/integrations/services/aruba-orchestrator/index.md index 88e1a541a73d..6973d6296ebf 100644 --- a/website/integrations/services/aruba-orchestrator/index.md +++ b/website/integrations/services/aruba-orchestrator/index.md @@ -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. diff --git a/website/integrations/services/awx-tower/index.md b/website/integrations/services/awx-tower/index.md index e89b3b5f7d48..bbbbe6183c4d 100644 --- a/website/integrations/services/awx-tower/index.md +++ b/website/integrations/services/awx-tower/index.md @@ -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/` diff --git a/website/integrations/services/bookstack/index.md b/website/integrations/services/bookstack/index.md index 9382b7c2ba7c..c71b698a25b4 100644 --- a/website/integrations/services/bookstack/index.md +++ b/website/integrations/services/bookstack/index.md @@ -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: diff --git a/website/integrations/services/budibase/index.md b/website/integrations/services/budibase/index.md index 96be931932fe..d84aa72fdb2e 100644 --- a/website/integrations/services/budibase/index.md +++ b/website/integrations/services/budibase/index.md @@ -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` diff --git a/website/integrations/services/chronograf/index.md b/website/integrations/services/chronograf/index.md index 4c1938bfcfc7..66e26898b23f 100644 --- a/website/integrations/services/chronograf/index.md +++ b/website/integrations/services/chronograf/index.md @@ -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. ::: ``` diff --git a/website/integrations/services/cloudflare-access/index.md b/website/integrations/services/cloudflare-access/index.md index 882e3e583a90..2678ed61f764 100644 --- a/website/integrations/services/cloudflare-access/index.md +++ b/website/integrations/services/cloudflare-access/index.md @@ -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**. diff --git a/website/integrations/services/dokuwiki/index.md b/website/integrations/services/dokuwiki/index.md index 680dc8b16103..3e629c670b8e 100644 --- a/website/integrations/services/dokuwiki/index.md +++ b/website/integrations/services/dokuwiki/index.md @@ -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 diff --git a/website/integrations/services/engomo/index.md b/website/integrations/services/engomo/index.md index ee06e4f63056..2bd066da3d20 100644 --- a/website/integrations/services/engomo/index.md +++ b/website/integrations/services/engomo/index.md @@ -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**. diff --git a/website/integrations/services/espoCRM/index.md b/website/integrations/services/espoCRM/index.md index 7952a604304a..ee920271650a 100644 --- a/website/integrations/services/espoCRM/index.md +++ b/website/integrations/services/espoCRM/index.md @@ -25,6 +25,10 @@ The following placeholders are used in this guide: - `authentik.` 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**. diff --git a/website/integrations/services/firezone/index.md b/website/integrations/services/firezone/index.md index e3c7d14d4237..4e07884a98f0 100644 --- a/website/integrations/services/firezone/index.md +++ b/website/integrations/services/firezone/index.md @@ -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` diff --git a/website/integrations/services/fortigate-admin/index.md b/website/integrations/services/fortigate-admin/index.md index f6d63dce9c14..f4231f2c492b 100644 --- a/website/integrations/services/fortigate-admin/index.md +++ b/website/integrations/services/fortigate-admin/index.md @@ -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`. diff --git a/website/integrations/services/fortigate-ssl/index.md b/website/integrations/services/fortigate-ssl/index.md index 8349dac5c3a4..8a10bc7fc5a4 100644 --- a/website/integrations/services/fortigate-ssl/index.md +++ b/website/integrations/services/fortigate-ssl/index.md @@ -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 diff --git a/website/integrations/services/fortimanager/index.md b/website/integrations/services/fortimanager/index.md index e0a3ae385fbc..4a30e3c0f753 100644 --- a/website/integrations/services/fortimanager/index.md +++ b/website/integrations/services/fortimanager/index.md @@ -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: diff --git a/website/integrations/services/frappe/index.md b/website/integrations/services/frappe/index.md index 38ea824e5fcc..8ed977deface 100644 --- a/website/integrations/services/frappe/index.md +++ b/website/integrations/services/frappe/index.md @@ -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. diff --git a/website/integrations/services/freshrss/index.md b/website/integrations/services/freshrss/index.md index 3c7f194c9faf..6cea7111dec1 100644 --- a/website/integrations/services/freshrss/index.md +++ b/website/integrations/services/freshrss/index.md @@ -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: diff --git a/website/integrations/services/gatus/index.md b/website/integrations/services/gatus/index.md index daa70835c2b4..c467f295569b 100644 --- a/website/integrations/services/gatus/index.md +++ b/website/integrations/services/gatus/index.md @@ -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: diff --git a/website/integrations/services/gitea/index.md b/website/integrations/services/gitea/index.md index e1ed6801a685..c1a44457b0fb 100644 --- a/website/integrations/services/gitea/index.md +++ b/website/integrations/services/gitea/index.md @@ -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 diff --git a/website/integrations/services/github-enterprise-cloud/index.md b/website/integrations/services/github-enterprise-cloud/index.md index a65334501cbd..cbd4c4741662 100644 --- a/website/integrations/services/github-enterprise-cloud/index.md +++ b/website/integrations/services/github-enterprise-cloud/index.md @@ -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. diff --git a/website/integrations/services/github-enterprise-emu/index.md b/website/integrations/services/github-enterprise-emu/index.md index 397ffbbfff96..be2d5d644ff1 100644 --- a/website/integrations/services/github-enterprise-emu/index.md +++ b/website/integrations/services/github-enterprise-emu/index.md @@ -24,7 +24,7 @@ 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. @@ -32,6 +32,10 @@ Note that in order to use the EMU Enterprise, you _must_ set up both SAML and SC 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: diff --git a/website/integrations/services/github-enterprise-server/index.md b/website/integrations/services/github-enterprise-server/index.md index d7ce42df9712..165ea9ba01a4 100644 --- a/website/integrations/services/github-enterprise-server/index.md +++ b/website/integrations/services/github-enterprise-server/index.md @@ -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. diff --git a/website/integrations/services/github-organization/index.md b/website/integrations/services/github-organization/index.md index 23cf0ac68ffc..a0812fc7ddc3 100644 --- a/website/integrations/services/github-organization/index.md +++ b/website/integrations/services/github-organization/index.md @@ -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. diff --git a/website/integrations/services/gitlab/index.md b/website/integrations/services/gitlab/index.md index 87a3739e1b92..72d62d151b1d 100644 --- a/website/integrations/services/gitlab/index.md +++ b/website/integrations/services/gitlab/index.md @@ -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. diff --git a/website/integrations/services/glitchtip/index.md b/website/integrations/services/glitchtip/index.md index 495071afbb7d..4b81652c5ec3 100644 --- a/website/integrations/services/glitchtip/index.md +++ b/website/integrations/services/glitchtip/index.md @@ -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: diff --git a/website/integrations/services/globalprotect/index.md b/website/integrations/services/globalprotect/index.md index faa18139834b..ad6dbd3c9469 100644 --- a/website/integrations/services/globalprotect/index.md +++ b/website/integrations/services/globalprotect/index.md @@ -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. ::: diff --git a/website/integrations/services/google/index.md b/website/integrations/services/google/index.md index 3e8e4a76cc78..4ddd0445ec6b 100644 --- a/website/integrations/services/google/index.md +++ b/website/integrations/services/google/index.md @@ -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`. diff --git a/website/integrations/services/grafana/index.mdx b/website/integrations/services/grafana/index.mdx index 6965ae944e1a..0ff9120a39f7 100644 --- a/website/integrations/services/grafana/index.mdx +++ b/website/integrations/services/grafana/index.mdx @@ -20,6 +20,10 @@ The following placeholders are used in this guide: - `grafana.company` is the FQDN of the Grafana 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` diff --git a/website/integrations/services/gravitee/index.md b/website/integrations/services/gravitee/index.md index 0917e3a87fd9..61bba75bc650 100644 --- a/website/integrations/services/gravitee/index.md +++ b/website/integrations/services/gravitee/index.md @@ -22,6 +22,10 @@ The following placeholders are used in this guide: - `gravitee.company` is the FQDN of the Gravitee 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 1. Create an **OAuth2/OpenID Provider** under **Applications** > **Providers** using the following settings: diff --git a/website/integrations/services/harbor/index.md b/website/integrations/services/harbor/index.md index 7a38909fa2e4..91265436d59b 100644 --- a/website/integrations/services/harbor/index.md +++ b/website/integrations/services/harbor/index.md @@ -20,6 +20,10 @@ The following placeholders are used in this guide: - `harbor.company` is the FQDN of the Harbor 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` diff --git a/website/integrations/services/hashicorp-cloud/index.md b/website/integrations/services/hashicorp-cloud/index.md index 6cf2015fc819..dc36698689b8 100644 --- a/website/integrations/services/hashicorp-cloud/index.md +++ b/website/integrations/services/hashicorp-cloud/index.md @@ -17,7 +17,11 @@ sidebar_label: HashiCorp Cloud Platform The following placeholders are used in this guide: -- `authentik.company` is the FQDN of authentik. +- `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. +::: ### Step 1 - HashiCorp Cloud diff --git a/website/integrations/services/hashicorp-vault/index.md b/website/integrations/services/hashicorp-vault/index.md index 83518ef26a8c..f90b8a8f75d9 100644 --- a/website/integrations/services/hashicorp-vault/index.md +++ b/website/integrations/services/hashicorp-vault/index.md @@ -21,8 +21,12 @@ This is based on authentik 2022.2.1 and Vault 1.9.3. Instructions may differ bet The following placeholders are used in this guide: -- `authentik.company` is the FQDN of authentik. -- `vault.company` is the FQDN of Vault. +- `authentik.company` is the FQDN of the authentik installation. +- `vault.company` is the FQDN of the Vault 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 diff --git a/website/integrations/services/hedgedoc/index.md b/website/integrations/services/hedgedoc/index.md index d50f3104b780..a359362dc090 100644 --- a/website/integrations/services/hedgedoc/index.md +++ b/website/integrations/services/hedgedoc/index.md @@ -20,6 +20,10 @@ The following placeholders are used in this guide: - `hedgedoc.company` is the FQDN of the HedgeDoc 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` diff --git a/website/integrations/services/hoarder/index.md b/website/integrations/services/hoarder/index.md index c6ea66d914d5..7e945a696e61 100644 --- a/website/integrations/services/hoarder/index.md +++ b/website/integrations/services/hoarder/index.md @@ -20,6 +20,10 @@ The following placeholders are used in this guide: - `hoarder.company` is the FQDN of the Hoarder 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 ### Provider settings diff --git a/website/integrations/services/home-assistant/index.md b/website/integrations/services/home-assistant/index.md index 81966c5b902f..721e38ee004c 100644 --- a/website/integrations/services/home-assistant/index.md +++ b/website/integrations/services/home-assistant/index.md @@ -30,6 +30,10 @@ The following placeholders are used in this guide: - `hass.company` is the FQDN of the Home Assistant 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 1. Create a **Proxy Provider** under **Applications** > **Providers** using the following settings: diff --git a/website/integrations/services/immich/index.md b/website/integrations/services/immich/index.md index 16996668ad75..e2da5da48049 100644 --- a/website/integrations/services/immich/index.md +++ b/website/integrations/services/immich/index.md @@ -20,6 +20,10 @@ The following placeholders are used in this guide: - `https://immich.company` is the URL used to access the Immich instance. - `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 a new OAuth2/OpenID Provider under **Applications** > **Providers** using the following settings: diff --git a/website/integrations/services/jellyfin/index.md b/website/integrations/services/jellyfin/index.md index 34e6dc2b4a67..65f692a102c1 100644 --- a/website/integrations/services/jellyfin/index.md +++ b/website/integrations/services/jellyfin/index.md @@ -35,6 +35,10 @@ The following placeholders are used in this guide: - `dc=company,dc=com` the Base DN of the LDAP outpost. - `ldap_bind_user` the username of the desired LDAP Bind User +:::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. +::: + ## LDAP Configuration ### authentik Configuration diff --git a/website/integrations/services/jenkins/index.md b/website/integrations/services/jenkins/index.md index 2f6b591b0f84..4ee51154640f 100644 --- a/website/integrations/services/jenkins/index.md +++ b/website/integrations/services/jenkins/index.md @@ -20,6 +20,10 @@ The following placeholders are used in this guide: - `jenkins.company` is the FQDN of the Service 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` diff --git a/website/integrations/services/kimai/index.md b/website/integrations/services/kimai/index.md index 80f43639ac82..1e9f7c70bc56 100644 --- a/website/integrations/services/kimai/index.md +++ b/website/integrations/services/kimai/index.md @@ -32,6 +32,10 @@ Create a SAML provider with the following parameters: 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. +::: + ## Kimai Configuration Paste the following block in your `local.yaml` file, after replacing the placeholder values from above. The file is usually located in `/opt/kimai/config/packages/local.yaml`. diff --git a/website/integrations/services/komga/index.md b/website/integrations/services/komga/index.md index 2046021d77f5..533a35be736a 100644 --- a/website/integrations/services/komga/index.md +++ b/website/integrations/services/komga/index.md @@ -20,6 +20,10 @@ The following placeholders are used in this guide: - `komga.company` is the FQDN of the Komga 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 1. From the **authentik Admin interface**, navigate to **Applications** -> **Applications**. diff --git a/website/integrations/services/linkwarden/index.md b/website/integrations/services/linkwarden/index.md index f62fcace03f4..28fb70296467 100644 --- a/website/integrations/services/linkwarden/index.md +++ b/website/integrations/services/linkwarden/index.md @@ -20,6 +20,10 @@ The following placeholders are used in this guide: - `linkwarden.company` is the FQDN of the Linkwarden 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. +::: + ## Linkwarden configuration To configure Linkwarden to use authentik, add the following values to your `.env` file: diff --git a/website/integrations/services/mastodon/index.md b/website/integrations/services/mastodon/index.md index ca5cdaae44f6..ae54e6d5a1a3 100644 --- a/website/integrations/services/mastodon/index.md +++ b/website/integrations/services/mastodon/index.md @@ -20,6 +20,10 @@ The following placeholders are used in this guide: - `mastodon.company` is the FQDN of the mastodon 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 ### Step 1 - OAuth2/OpenID Provider diff --git a/website/integrations/services/matrix-synapse/index.md b/website/integrations/services/matrix-synapse/index.md index fffb61e81d98..a6543afe99de 100644 --- a/website/integrations/services/matrix-synapse/index.md +++ b/website/integrations/services/matrix-synapse/index.md @@ -20,6 +20,10 @@ The following placeholders are used in this guide: - `matrix.company` is the FQDN of the Matrix 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` diff --git a/website/integrations/services/meshcentral/index.md b/website/integrations/services/meshcentral/index.md index f6588b386910..9ccf6dc4683a 100644 --- a/website/integrations/services/meshcentral/index.md +++ b/website/integrations/services/meshcentral/index.md @@ -20,6 +20,10 @@ The following placeholders are used in this guide: - `meshcentral.company` is the FQDN of the MeshCentral 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: diff --git a/website/integrations/services/minio/index.md b/website/integrations/services/minio/index.md index 93d80b78c7c7..23604f2a9eda 100644 --- a/website/integrations/services/minio/index.md +++ b/website/integrations/services/minio/index.md @@ -20,6 +20,10 @@ The following placeholders are used in this guide: - `minio.company` is the FQDN of the MinIO 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. +::: + ### Mapping to MinIO policies The primary way to manage access in MinIO is via [policies](https://min.io/docs/minio/linux/administration/identity-access-management/policy-based-access-control.html#minio-policy). We need to configure authentik to return a list of which MinIO policies should be applied to a user. diff --git a/website/integrations/services/mobilizon/index.md b/website/integrations/services/mobilizon/index.md index 832d5abec6eb..223ccad0cfaf 100644 --- a/website/integrations/services/mobilizon/index.md +++ b/website/integrations/services/mobilizon/index.md @@ -20,6 +20,10 @@ The following placeholders are used in this guide: - `mobilizon.company` is the FQDN of the mobilizon 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 ### Step 1 - OAuth2/OpenID Provider diff --git a/website/integrations/services/netbird/index.md b/website/integrations/services/netbird/index.md index 5e21f98d23bc..b10677355472 100644 --- a/website/integrations/services/netbird/index.md +++ b/website/integrations/services/netbird/index.md @@ -20,6 +20,10 @@ The following placeholders are used in this guide: - `netbird.company` is the FQDN of the NetBird 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 ### Provider & application configuration diff --git a/website/integrations/services/netbox/index.md b/website/integrations/services/netbox/index.md index b12d72236ceb..b68df302f8bb 100644 --- a/website/integrations/services/netbox/index.md +++ b/website/integrations/services/netbox/index.md @@ -20,6 +20,10 @@ The following placeholders are used in this guide: - `netbox.company` is the FQDN of the NetBox 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 you choose, as this will be used later. In the Admin Interface, go to _Applications_ -> _Providers_. Create a _OAuth2/OpenID provider_ with the following parameters: - Client Type: `Confidential` diff --git a/website/integrations/services/nextcloud/index.md b/website/integrations/services/nextcloud/index.md index 95ca560b1490..8503e61a066d 100644 --- a/website/integrations/services/nextcloud/index.md +++ b/website/integrations/services/nextcloud/index.md @@ -43,6 +43,10 @@ The following placeholders are used in this guide: - `authentik.company` is the FQDN of the authentik installation. - `authentik.local` is the internal FQDN of the authentik install (only relevant when running authentik and Nextcloud behind a reverse proxy) +:::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. +::: + Lets start by thinking what user attributes need to be available in Nextcloud: - name @@ -231,6 +235,10 @@ The following placeholders are used in this guide: - `nextcloud.company` is the FQDN of the Nextcloud 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 you choose, as this will be used later. In the Admin Interface, go to _Applications_ -> _Providers_. Create a _SAML provider_ with the following parameters: - ACS URL: `https://nextcloud.company/apps/user_saml/saml/acs` diff --git a/website/integrations/services/node-red/index.md b/website/integrations/services/node-red/index.md index 44f2a6bc0699..574c337a301a 100644 --- a/website/integrations/services/node-red/index.md +++ b/website/integrations/services/node-red/index.md @@ -26,6 +26,10 @@ The following placeholders are used in this guide: - `authentik.company` is the FQDN of authentik. - `nodred.company` is the FQDN of Node-RED. +:::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, create an _OAuth2/OpenID Provider_ (under _Applications/Providers_) with these settings: diff --git a/website/integrations/services/observium/index.md b/website/integrations/services/observium/index.md index 3f7540bb24aa..fcdcd547086c 100644 --- a/website/integrations/services/observium/index.md +++ b/website/integrations/services/observium/index.md @@ -24,6 +24,10 @@ The following placeholders are used in this guide: - `observium.company` is the FQDN of the Observium 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. +::: + This guide assumes you already have a working Observium instance. It is recommended to install it with the install script, following the [instructions](https://docs.observium.org/) on Observium's website. Apache2 comes bundled with Observium, but there is also a third party module, [mod_auth_openidc](https://github.com/OpenIDC/mod_auth_openidc), which is needed for this configuration to work. diff --git a/website/integrations/services/onlyoffice/index.md b/website/integrations/services/onlyoffice/index.md index 28ce9cc03c9f..1d3ee4db0e46 100644 --- a/website/integrations/services/onlyoffice/index.md +++ b/website/integrations/services/onlyoffice/index.md @@ -32,6 +32,10 @@ Click the _Enable Single Sign-on Authentication_ checkbox to enable SSO. Scroll down to _ONLYOFFICE SP Metadata_, and copy the _SP Entity ID (link to metadata XML)_ URL. Open this URL in a new tab, and download the XML file. +:::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 Setup Create an application in authentik, and create a SAML Provider by using _SAML Provider from Metadata_. Give the provider a name, and upload the XML file you've downloaded in the previous step. diff --git a/website/integrations/services/opnsense/index.md b/website/integrations/services/opnsense/index.md index 5aaa6b16c1cf..43fe98a9d0fe 100644 --- a/website/integrations/services/opnsense/index.md +++ b/website/integrations/services/opnsense/index.md @@ -25,6 +25,10 @@ The following placeholders are used in this guide: - `opnsense` is the name of the authentik Service account we'll create. - `DC=ldap,DC=goauthentik,DC=io` is the Base DN of the LDAP Provider (default) +:::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, go and 'Create Service account' (under _Directory/Users_) for OPNsense to use as the LDAP Binder, leaving 'Create group' ticked as we'll need that group for the provider. diff --git a/website/integrations/services/oracle-cloud/index.md b/website/integrations/services/oracle-cloud/index.md index 1c4c72963fc8..40c4dc862f18 100644 --- a/website/integrations/services/oracle-cloud/index.md +++ b/website/integrations/services/oracle-cloud/index.md @@ -17,7 +17,11 @@ sidebar_label: Oracle Cloud The following placeholders are used in this guide: -- `authentik.company` is the FQDN of authentik. +- `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. +::: ### Step 1 - authentik diff --git a/website/integrations/services/organizr/index.md b/website/integrations/services/organizr/index.md index 2fda3e232d70..6264e7709264 100644 --- a/website/integrations/services/organizr/index.md +++ b/website/integrations/services/organizr/index.md @@ -22,6 +22,10 @@ The following placeholders are used in this guide: - `organizr.company` is the FQDN of the Service 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 a new user account _(or reuse an existing)_ for organizr to use for LDAP bind under _Directory_ -> _Users_ -> _Create_, in this example called `ldapservice`. Note the DN of this user will be `cn=ldapservice,ou=users,dc=ldap,dc=goauthentik,dc=io` diff --git a/website/integrations/services/outline/index.md b/website/integrations/services/outline/index.md index 700554a71926..1efeb2a22bcb 100644 --- a/website/integrations/services/outline/index.md +++ b/website/integrations/services/outline/index.md @@ -21,6 +21,10 @@ The following placeholders are used in this guide: - `outline.company` is the FQDN of the Outline 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 1. Create an OAuth2/OpenID provider with the following parameters: diff --git a/website/integrations/services/paperless-ng/index.md b/website/integrations/services/paperless-ng/index.md index 78b4593a81b7..095d6a7bb396 100644 --- a/website/integrations/services/paperless-ng/index.md +++ b/website/integrations/services/paperless-ng/index.md @@ -25,6 +25,10 @@ The following placeholders are used in this guide: - `paperless.company` is the FQDN of the Paperless-ng 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. +::: + Also set up your proxy server to use forward auth with paperless.company: https://goauthentik.io/docs/providers/proxy/forward_auth ## Paperless diff --git a/website/integrations/services/paperless-ngx/index.mdx b/website/integrations/services/paperless-ngx/index.mdx index d817afdcf497..eb791b912a3e 100644 --- a/website/integrations/services/paperless-ngx/index.mdx +++ b/website/integrations/services/paperless-ngx/index.mdx @@ -20,6 +20,10 @@ The following placeholders are used in this guide: - `paperless.company` is the FQDN of the Paperless-ngx 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 ### Step 1 - OAuth2/OpenID Provider diff --git a/website/integrations/services/pfsense/index.md b/website/integrations/services/pfsense/index.md index ef3309473203..fad6f22d5546 100644 --- a/website/integrations/services/pfsense/index.md +++ b/website/integrations/services/pfsense/index.md @@ -25,6 +25,10 @@ The following placeholders are used in this guide: - `pfsense-user` is the name of the authentik Service account we'll create. - `DC=ldap,DC=goauthentik,DC=io` is the Base DN of the LDAP Provider (default) +:::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 - Service account In authentik, create a service account (under _Directory/Users_) for pfSense to use as the LDAP Binder and take note of the password generated. diff --git a/website/integrations/services/pgadmin/index.md b/website/integrations/services/pgadmin/index.md index e06865c3431a..2a8cccb72f45 100644 --- a/website/integrations/services/pgadmin/index.md +++ b/website/integrations/services/pgadmin/index.md @@ -21,8 +21,12 @@ This is based on authentik 2024.12.2 and pgAdmin4 8.14 The following placeholders are used in this guide: -- `pgadmin.company` is the FQDN of pgAdmin. -- `authentik.company` is the FQDN of authentik. +- `pgadmin.company` is the FQDN of the pgAdmin 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 diff --git a/website/integrations/services/phpipam/index.md b/website/integrations/services/phpipam/index.md index 956d5066bc93..c11411377fd9 100644 --- a/website/integrations/services/phpipam/index.md +++ b/website/integrations/services/phpipam/index.md @@ -24,6 +24,10 @@ The following placeholders are used in this guide: - `operator-permission-group` in place of your company naming convention - `guest-permission-group` in place of your company naming convention +:::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. +::: + :::note This is based on authentik 2023.3.1 and phpIPAM 1.5.2 Only settings that have been modified from default have been listed. diff --git a/website/integrations/services/portainer/index.md b/website/integrations/services/portainer/index.md index feddc02b536b..6e3bce99faad 100644 --- a/website/integrations/services/portainer/index.md +++ b/website/integrations/services/portainer/index.md @@ -21,8 +21,12 @@ This is based on authentik 2021.7.3 and Portainer 2.6.x-CE. Portainer 2.6 suppor The following placeholders are used in this guide: -- `portainer.company` is the FQDN of Portainer. -- `authentik.company` is the FQDN of authentik. +- `portainer.company` is the FQDN of Portainer installation. +- `authentik.company` is the FQDN of 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 diff --git a/website/integrations/services/powerdns-admin/index.md b/website/integrations/services/powerdns-admin/index.md index 424bfc392dfe..412460f131f4 100644 --- a/website/integrations/services/powerdns-admin/index.md +++ b/website/integrations/services/powerdns-admin/index.md @@ -20,6 +20,10 @@ The following placeholders are used in this guide: - `pdns-admin.company` is the FQDN of the PowerDNS-Admin 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 a SAML provider with the following parameters: - ACS URL: `https://pdns-admin.company/saml/authorized` diff --git a/website/integrations/services/proftpd/index.md b/website/integrations/services/proftpd/index.md index 11819c5aece1..7d57b5a351bc 100644 --- a/website/integrations/services/proftpd/index.md +++ b/website/integrations/services/proftpd/index.md @@ -21,6 +21,10 @@ The following placeholders are used in this guide: - `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 ### Step 1 - Service account diff --git a/website/integrations/services/proxmox-ve/index.md b/website/integrations/services/proxmox-ve/index.md index b6cf519bc81b..4b6fd72c53aa 100644 --- a/website/integrations/services/proxmox-ve/index.md +++ b/website/integrations/services/proxmox-ve/index.md @@ -21,9 +21,13 @@ Requires Proxmox VE 7.0 or newer. The following placeholders are used in this guide: -- `proxmox.company` is the FQDN of the Proxmox VE server. +- `proxmox.company` is the FQDN of the Proxmox VE server 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 1. In the Admin interface, navigate to **Applications -> Providers** to create an OAuth2/OpenID provider with these settings: diff --git a/website/integrations/services/qnap-nas/index.md b/website/integrations/services/qnap-nas/index.md index 915efcf16199..263c16af4ad6 100644 --- a/website/integrations/services/qnap-nas/index.md +++ b/website/integrations/services/qnap-nas/index.md @@ -28,6 +28,10 @@ The following placeholders are used in this guide: - `qnap.serviceAccountToken` is the service account token generated by 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. +::: + Create an LDAP Provider if you don't already have one setup. This guide assumes you will be running with TLS. See the [ldap provider docs](https://docs.goauthentik.io/docs/add-secure-apps/providers/ldap) for setting up SSL on the authentik side. diff --git a/website/integrations/services/rancher/index.md b/website/integrations/services/rancher/index.md index e1b888fd4db6..4e70cc8c8632 100644 --- a/website/integrations/services/rancher/index.md +++ b/website/integrations/services/rancher/index.md @@ -21,6 +21,10 @@ The following placeholders are used in this guide: - `rancher.company` is the FQDN of the Rancher 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. +::: + Under _Customization_ -> _Property Mappings_, create a _SAML Property Mapping_. Give it a name like "SAML Rancher User ID". Set the SAML name to `rancherUidUsername` and the expression to the following ```python diff --git a/website/integrations/services/rocketchat/index.md b/website/integrations/services/rocketchat/index.md index 9f7f0097302b..de40f28fbe83 100644 --- a/website/integrations/services/rocketchat/index.md +++ b/website/integrations/services/rocketchat/index.md @@ -21,8 +21,12 @@ This is based on authentik 2022.3.1 and Rocket.chat 4.5.1 using the [Docker-Comp The following placeholders are used in this guide: -- `rocket.company` is the FQDN of Rocket.chat. -- `authentik.company` is the FQDN of authentik. +- `rocket.company` is the FQDN of Rocket.chat installation. +- `authentik.company` is the FQDN of 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. +::: ### Step 1 diff --git a/website/integrations/services/roundcube/index.md b/website/integrations/services/roundcube/index.md index c55079d64bd9..fc0ef622f806 100644 --- a/website/integrations/services/roundcube/index.md +++ b/website/integrations/services/roundcube/index.md @@ -23,6 +23,10 @@ The following placeholders are used in this guide: - `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 a new oauth2 Scope Mapping which does not return the 'group' values and associate this mapping in the provider settings instead of the default oauth mapping. diff --git a/website/integrations/services/rustdesk-pro/index.mdx b/website/integrations/services/rustdesk-pro/index.mdx index f35fb4dfe213..83c4a6b5f995 100644 --- a/website/integrations/services/rustdesk-pro/index.mdx +++ b/website/integrations/services/rustdesk-pro/index.mdx @@ -22,6 +22,10 @@ This guide uses the following placeholders: - `rustdesk.company` is the FQDN of the RustDesk Server Pro 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 1. In the authentik Admin interface, navigate to **Applications** -> **Applications**. diff --git a/website/integrations/services/semaphore/index.mdx b/website/integrations/services/semaphore/index.mdx index 0a8935594f04..c43a21634f71 100644 --- a/website/integrations/services/semaphore/index.mdx +++ b/website/integrations/services/semaphore/index.mdx @@ -22,6 +22,10 @@ The following placeholders are used in this guide: - `semaphore.company` is the FQDN of the Semaphore 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 Start the wizard for adding a new application. diff --git a/website/integrations/services/semgrep/index.md b/website/integrations/services/semgrep/index.md index 2b2ba71ff1bd..bbbf5cf8a84a 100644 --- a/website/integrations/services/semgrep/index.md +++ b/website/integrations/services/semgrep/index.md @@ -20,6 +20,10 @@ The following placeholders are used in this guide: - `authentik.company` is the FQDN of the authentik installation. - `devcompany` is the organization name on Semgrep Cloud platform. +:::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 your authentik instance as an administrator. diff --git a/website/integrations/services/sentry/index.md b/website/integrations/services/sentry/index.md index f17325b616f8..6ad2373e64e4 100644 --- a/website/integrations/services/sentry/index.md +++ b/website/integrations/services/sentry/index.md @@ -21,6 +21,10 @@ The following placeholders are used in this guide: - `sentry.company` is the FQDN of the Sentry 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 a SAML Provider with the following values - ACS URL: `https://sentry.company/saml/acs//` diff --git a/website/integrations/services/skyhigh/index.md b/website/integrations/services/skyhigh/index.md index e7631cd15588..565f96ad4815 100644 --- a/website/integrations/services/skyhigh/index.md +++ b/website/integrations/services/skyhigh/index.md @@ -24,6 +24,10 @@ The following placeholder will be used throughout this document. - `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. +::: + ## Integration for Dashboard Administrator login ### Configure Skyhigh Security diff --git a/website/integrations/services/slack/index.md b/website/integrations/services/slack/index.md index ce0390678b24..a974dc0bbd4f 100644 --- a/website/integrations/services/slack/index.md +++ b/website/integrations/services/slack/index.md @@ -18,6 +18,10 @@ The following placeholder will be used: - You can use slack.company> or my-workspace.slack.com as the FQDN of your Slack instance. - You can use authentik.company as 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. +::: + For additional information about integrating with Slack, refer to their [documentation](https://slack.com/help/articles/205168057-Custom-SAML-single-sign-on). ## authentik configuration diff --git a/website/integrations/services/snipe-it/index.md b/website/integrations/services/snipe-it/index.md index bb772afa5ee0..9ae05f300ca8 100644 --- a/website/integrations/services/snipe-it/index.md +++ b/website/integrations/services/snipe-it/index.md @@ -31,6 +31,10 @@ The following placeholders are used in this guide: - `snipeit-user` is the name of the authentik service account we will create. - `DC=ldap,DC=authentik,DC=io` is the Base DN of the LDAP Provider (default) +:::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 ### Step 1 - Service account diff --git a/website/integrations/services/sonar-qube/index.md b/website/integrations/services/sonar-qube/index.md index 49bfdedd750e..b15afd88bc7c 100644 --- a/website/integrations/services/sonar-qube/index.md +++ b/website/integrations/services/sonar-qube/index.md @@ -20,6 +20,10 @@ The following placeholders are used in this guide: - `sonarqube.company` is the FQDN of the sonarqube 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. +::: + ## Terraform provider Create an application in authentik. Create a SAML Provider with the following values diff --git a/website/integrations/services/sonarr/index.md b/website/integrations/services/sonarr/index.md index 23a866597277..244d16e19fa0 100644 --- a/website/integrations/services/sonarr/index.md +++ b/website/integrations/services/sonarr/index.md @@ -24,6 +24,10 @@ The following placeholders are used in this guide: - `sonarr.company` is the FQDN of the Sonarr 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 a Proxy Provider with the following values - Internal host diff --git a/website/integrations/services/sssd/index.md b/website/integrations/services/sssd/index.md index 7ef3799f226a..5f21c4ac5b8e 100644 --- a/website/integrations/services/sssd/index.md +++ b/website/integrations/services/sssd/index.md @@ -34,6 +34,10 @@ The following placeholders are used in this guide: - `sssd.serviceAccountToken` is the service account token generated by 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. +::: + Create an LDAP Provider if you don't already have one setup. This guide assumes you will be running with TLS and that you've correctly setup certificates both in authentik and on the host diff --git a/website/integrations/services/synology-dsm/index.md b/website/integrations/services/synology-dsm/index.md index 61a1bc2f08c6..ada486637c9b 100644 --- a/website/integrations/services/synology-dsm/index.md +++ b/website/integrations/services/synology-dsm/index.md @@ -24,6 +24,10 @@ The following placeholders are used in this guide: - `synology.company` is the FQDN of the Synology DSM server. - `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 ### Step 1 diff --git a/website/integrations/services/tautulli/index.md b/website/integrations/services/tautulli/index.md index fff40049a6b8..15f856c8bc8c 100644 --- a/website/integrations/services/tautulli/index.md +++ b/website/integrations/services/tautulli/index.md @@ -20,6 +20,10 @@ The following placeholders are used in this guide: - `tautulli.company` is the FQDN of the Tautulli 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 Setup Because Tautulli requires valid HTTP Basic credentials, you must save your HTTP Basic Credentials in authentik. The recommended way to do this is to create a Group. Name the group "Tautulli Users", for example. For this group, add the following attributes: diff --git a/website/integrations/services/terrakube/index.md b/website/integrations/services/terrakube/index.md index 194020ffd9bb..491c362bb19c 100644 --- a/website/integrations/services/terrakube/index.md +++ b/website/integrations/services/terrakube/index.md @@ -20,6 +20,10 @@ The following placeholders are used in this guide: - `terrakube-dex.company` is the FQDN of the [Dex](https://dexidp.io/) container of the Terrakube 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 1. From the Admin interface, navigate to **Applications** -> **Applications**. diff --git a/website/integrations/services/thelounge/index.md b/website/integrations/services/thelounge/index.md index 6d249b453e8c..cb9d2269fee9 100644 --- a/website/integrations/services/thelounge/index.md +++ b/website/integrations/services/thelounge/index.md @@ -26,6 +26,10 @@ The following placeholders are used in this guide: - `dc=company,dc=com` the Base DN of the LDAP outpost. If you followed the LDAP provider guide this is: `dc=goauthentik,dc=io` - `ldap_bind_user` the username of the desired LDAP Bind User. If you followed the LDAP provider guide this is: `ldapservice` +:::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. +::: + ## LDAP Configuration ### authentik Configuration diff --git a/website/integrations/services/truecommand/index.md b/website/integrations/services/truecommand/index.md index 61be528388fe..8bb3d23a7445 100644 --- a/website/integrations/services/truecommand/index.md +++ b/website/integrations/services/truecommand/index.md @@ -24,6 +24,10 @@ The following placeholders are used in this guide: - `truecommand.company` is the FQDN of the snipe-it 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 use the slug for later as `truenas-truecommand`. Create a SAML provider with the following parameters: diff --git a/website/integrations/services/ubuntu-landscape/index.md b/website/integrations/services/ubuntu-landscape/index.md index 7d70df38dcb3..cb5c76d7d174 100644 --- a/website/integrations/services/ubuntu-landscape/index.md +++ b/website/integrations/services/ubuntu-landscape/index.md @@ -24,6 +24,10 @@ The following placeholders are used in this guide: - `landscape.company` is the FQDN of the Landscape server. - `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. +::: + Landscape uses the OpenID-Connect Protocol for single-sign on. ## authentik Setup diff --git a/website/integrations/services/uptime-kuma/index.md b/website/integrations/services/uptime-kuma/index.md index 4cd1d38db84a..0c16c4cffdeb 100644 --- a/website/integrations/services/uptime-kuma/index.md +++ b/website/integrations/services/uptime-kuma/index.md @@ -22,6 +22,10 @@ The following placeholders are used in this guide: - `uptime-kuma.company` is the FQDN of the Uptime Kuma 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 a Proxy provider with the following parameters: - Internal host diff --git a/website/integrations/services/veeam-enterprise-manager/index.md b/website/integrations/services/veeam-enterprise-manager/index.md index b3dfcab65796..9ff3025290c3 100644 --- a/website/integrations/services/veeam-enterprise-manager/index.md +++ b/website/integrations/services/veeam-enterprise-manager/index.md @@ -20,6 +20,10 @@ The following placeholders are used in this guide: - `veeam.company` is the FQDN of the Veeam Enterprise Manager 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. +::: + You will need an existing group or multiple in authentik to assign roles in Veeam Enterprise Manager to. ## In Veeam Enterprise Manager diff --git a/website/integrations/services/vikunja/index.md b/website/integrations/services/vikunja/index.md index 8f37cc0ff72e..3193d5a125f7 100644 --- a/website/integrations/services/vikunja/index.md +++ b/website/integrations/services/vikunja/index.md @@ -25,6 +25,10 @@ The following placeholders are used in this guide: - `authentik.company` is the FQDN of authentik. - `authentik Login` is the name shown on Vikunja set in config.yml, and used for the Redirect URI. If the name set in config.yml has capitalization or spaces like in this example, they will be set to lowercase and no spaces in the callback URL, like `authentiklogin`. +:::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 an _OAuth2/OpenID Provider_ with these settings: diff --git a/website/integrations/services/vmware-vcenter/index.md b/website/integrations/services/vmware-vcenter/index.md index d46c59ba2319..eb6f12c3a21f 100644 --- a/website/integrations/services/vmware-vcenter/index.md +++ b/website/integrations/services/vmware-vcenter/index.md @@ -22,6 +22,10 @@ The following placeholders will be used in the examples below: - `vcenter.company` is the FQDN of the vCenter server. - `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 application and an OAuth2/OpenID provider, using the authentik Wizard. diff --git a/website/integrations/services/weblate/index.md b/website/integrations/services/weblate/index.md index 96379f38fc05..ca94dbd1685f 100644 --- a/website/integrations/services/weblate/index.md +++ b/website/integrations/services/weblate/index.md @@ -19,7 +19,11 @@ The following placeholders are used in this guide: - `weblate.company` is the FQDN of the Weblate installation. - `authentik.company` is the FQDN of the authentik installation. -- `weblate-slug` is the slug of the Weblate application +- `weblate-slug` is the slug of the Weblate application. + +:::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: diff --git a/website/integrations/services/wekan/index.mdx b/website/integrations/services/wekan/index.mdx index 99c054f3877e..52967e7f5795 100644 --- a/website/integrations/services/wekan/index.mdx +++ b/website/integrations/services/wekan/index.mdx @@ -20,6 +20,10 @@ The following placeholders are used in this guide: - `wekan.company` is the FQDN of the wekan 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` diff --git a/website/integrations/services/whats-up-docker/index.md b/website/integrations/services/whats-up-docker/index.md index d43dcb1a793f..8d63b405bf8f 100644 --- a/website/integrations/services/whats-up-docker/index.md +++ b/website/integrations/services/whats-up-docker/index.md @@ -20,6 +20,10 @@ The following placeholders are used in this guide: - `wud.company` is the FQDN of the WUD 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. +::: + ## WUD configuration To configure WUD to use authentik, add the following values to your `.env` file: diff --git a/website/integrations/services/wiki-js/index.md b/website/integrations/services/wiki-js/index.md index 5d4b3dbb27c1..1e6b873e27a9 100644 --- a/website/integrations/services/wiki-js/index.md +++ b/website/integrations/services/wiki-js/index.md @@ -21,8 +21,12 @@ This is based on authentik 2022.11 and Wiki.js 2.5. Instructions may differ betw The following placeholders are used in this guide: -- `wiki.company` is the FQDN of Wiki.js. -- `authentik.company` is the FQDN of authentik. +- `wiki.company` is the FQDN of Wiki.js installation. +- `authentik.company` is the FQDN of 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. +::: ### Step 1 diff --git a/website/integrations/services/wordpress/index.md b/website/integrations/services/wordpress/index.md index 40440f99107b..e7e14664815e 100644 --- a/website/integrations/services/wordpress/index.md +++ b/website/integrations/services/wordpress/index.md @@ -21,8 +21,12 @@ There are many different plugins for WordPress that allow you to setup SSO using The following placeholders are used in this guide: -- `wp.company` is the FQDN of WordPress. -- `authentik.company` is the FQDN of authentik. +- `wp.company` is the FQDN of WordPress installation. +- `authentik.company` is the FQDN of 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. +::: ### Step 1 - authentik diff --git a/website/integrations/services/writefreely/index.md b/website/integrations/services/writefreely/index.md index 223b55f50136..037be674e555 100644 --- a/website/integrations/services/writefreely/index.md +++ b/website/integrations/services/writefreely/index.md @@ -21,9 +21,13 @@ Currently it is not possible to connect writefreely to authentik without making The following placeholders are used in this guide: -- `writefreely.company` is the FQDN of the writefreely installation. +- `writefreely.company` is the FQDN of the Writefreely 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 ### Step 1 - OAuth2/OpenID Provider diff --git a/website/integrations/services/xen-orchestra/index.md b/website/integrations/services/xen-orchestra/index.md index 57240ef620bf..00dc4293f1c8 100644 --- a/website/integrations/services/xen-orchestra/index.md +++ b/website/integrations/services/xen-orchestra/index.md @@ -25,6 +25,10 @@ The following placeholders are used in this guide: - `xenorchestra.company` is the FQDN of the Xen Orchestra instance. - `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. Provider diff --git a/website/integrations/services/zabbix/index.md b/website/integrations/services/zabbix/index.md index 1a7dab729dfb..4647bd1ca059 100644 --- a/website/integrations/services/zabbix/index.md +++ b/website/integrations/services/zabbix/index.md @@ -22,6 +22,10 @@ The following placeholders are used in this guide: - `zabbix.company` is the FQDN of the Zabbix 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://zabbix.company/zabbix/index_sso.php?acs` diff --git a/website/integrations/services/zammad/index.md b/website/integrations/services/zammad/index.md index 6694091c2449..0dab5f41a296 100644 --- a/website/integrations/services/zammad/index.md +++ b/website/integrations/services/zammad/index.md @@ -18,9 +18,13 @@ sidebar_label: Zammad The following placeholders are used in this guide: -- `zammad.company` is the FQDN of the zammad installation. +- `zammad.company` is the FQDN of the Zammad 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 ### Step 1 - Property Mappings diff --git a/website/integrations/services/zulip/index.md b/website/integrations/services/zulip/index.md index 9da67acd3203..a03563e2fbd3 100644 --- a/website/integrations/services/zulip/index.md +++ b/website/integrations/services/zulip/index.md @@ -18,8 +18,12 @@ sidebar_label: Zulip The following placeholders are used in this guide: -- `authentik.company` is the FQDN of the authentik installation. - `zulip.company` is the FQDN of the Zulip instance. +- `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: