From 2519bcef890f295f7a131b5655f0f329895c82cc Mon Sep 17 00:00:00 2001 From: Dewi Roberts Date: Thu, 29 May 2025 12:42:48 +0100 Subject: [PATCH] website/integrations: move resource section to end of documents (#14668) Moves the resource section to the end of each document Signed-off-by: Dewi Roberts --- website/integrations/services/actual-budget/index.mdx | 8 ++++---- website/integrations/services/adventurelog/index.mdx | 8 ++++---- website/integrations/services/apache-guacamole/index.mdx | 8 ++++---- website/integrations/services/bookstack/index.mdx | 8 ++++---- website/integrations/services/budibase/index.md | 8 ++++---- website/integrations/services/chronograf/index.mdx | 8 ++++---- website/integrations/services/cloudflare-access/index.md | 8 ++++---- website/integrations/services/coder/index.md | 8 ++++---- website/integrations/services/dokuwiki/index.md | 8 ++++---- website/integrations/services/espocrm/index.md | 8 ++++---- website/integrations/services/firezone/index.md | 8 ++++---- website/integrations/services/fortigate-admin/index.md | 4 ++-- website/integrations/services/fortimanager/index.md | 8 ++++---- website/integrations/services/frappe/index.md | 8 ++++---- website/integrations/services/freshrss/index.mdx | 8 ++++---- website/integrations/services/gatus/index.mdx | 8 ++++---- website/integrations/services/gitea/index.md | 8 ++++---- website/integrations/services/youtrack/index.md | 8 ++++---- 18 files changed, 70 insertions(+), 70 deletions(-) diff --git a/website/integrations/services/actual-budget/index.mdx b/website/integrations/services/actual-budget/index.mdx index 8d9c47d4c7..caa95a6210 100644 --- a/website/integrations/services/actual-budget/index.mdx +++ b/website/integrations/services/actual-budget/index.mdx @@ -102,10 +102,10 @@ The first user to log into Actual Budget via OpenID will become the owner and ad To do so, navigate to **Server online** > **User Directory**, and create users matching exiting authentik usernames. Then, grant access to the budget via the **User Access** tab. ::: -## Resources - -- [Official Actual Budget documentation on OpenID Connect integration](https://actualbudget.org/docs/experimental/oauth-auth/) - ## Configuration verification To confirm that authentik is properly configured with Actual Budget, visit your Actual Budget installation, select the OpenID login method from the dropdown menu, and click **Sign in with OpenID**. + +## Resources + +- [Official Actual Budget documentation on OpenID Connect integration](https://actualbudget.org/docs/experimental/oauth-auth/) diff --git a/website/integrations/services/adventurelog/index.mdx b/website/integrations/services/adventurelog/index.mdx index abcbdea169..ddb23240da 100644 --- a/website/integrations/services/adventurelog/index.mdx +++ b/website/integrations/services/adventurelog/index.mdx @@ -73,10 +73,10 @@ Ensure the `https://adventurelog.company/accounts` path is routed to the backend Launch your authentik dashboard as an admin and find the AdventureLog app. Click **More details** then **Edit**. In the admin interface, click **Test** under **Check Access**. If you get a 403 error, you need to grant the user the correct permissions. This can be done by going to the user's profile and adding the correct permissions. -## Resources - -- [AdventureLog's official documentation](https://adventurelog.app/docs/configuration/social_auth/authentik.html) - ## Configuration verification To confirm authentik is correctly integrated with AdventureLog, log out and attempt to log back in using OpenID Connect by clicking the **authentik** button on the AdventureLog login page. + +## Resources + +- [AdventureLog's official documentation](https://adventurelog.app/docs/configuration/social_auth/authentik.html) diff --git a/website/integrations/services/apache-guacamole/index.mdx b/website/integrations/services/apache-guacamole/index.mdx index a1f3761792..039be6d5b3 100644 --- a/website/integrations/services/apache-guacamole/index.mdx +++ b/website/integrations/services/apache-guacamole/index.mdx @@ -188,10 +188,10 @@ This section depends on the operating system hosting Apache Guacamole. More information on the keytool command can be found in the [Oracle documentation.](https://docs.oracle.com/en/java/javase/21/docs/specs/man/keytool.html) ::: -## Resources - -- [Apache Guacamole official documentation on OpenID Connect integrations](https://guacamole.apache.org/doc/gug/openid-auth.html#configuring-guacamole-for-single-sign-on-with-openid-connect) - ## Configuration verification To verify that authentik is correctly configured with Apache Guacamole, log out and log back in through authentik. You should notice a new button appearing at the bottom left of the login page. + +## Resources + +- [Apache Guacamole official documentation on OpenID Connect integrations](https://guacamole.apache.org/doc/gug/openid-auth.html#configuring-guacamole-for-single-sign-on-with-openid-connect) diff --git a/website/integrations/services/bookstack/index.mdx b/website/integrations/services/bookstack/index.mdx index 8cda0b880d..12b795c703 100644 --- a/website/integrations/services/bookstack/index.mdx +++ b/website/integrations/services/bookstack/index.mdx @@ -122,12 +122,12 @@ Once that's done, the next step is to update your `.env` file to include the fol +## Configuration verification + +To confirm that authentik is properly configured with BookStack, visit your BookStack installation, and click **Login with authentik**. + ## Resources - [BookStack Administrator Documentation for OpenID Connect](https://www.bookstackapp.com/docs/admin/oidc-auth/) - [Bookstack Administrator Documentation for SAML2](https://www.bookstackapp.com/docs/admin/saml2-auth/) - [PeerTube video detailing a setup with authentik (OpenID Connect)](https://foss.video/w/a744K8GxFF1LqBFSadAsuV) - -## Configuration verification - -To confirm that authentik is properly configured with BookStack, visit your BookStack installation, and click **Login with authentik**. diff --git a/website/integrations/services/budibase/index.md b/website/integrations/services/budibase/index.md index 5ce167f920..56f35a192b 100644 --- a/website/integrations/services/budibase/index.md +++ b/website/integrations/services/budibase/index.md @@ -50,10 +50,10 @@ From the main page of your Budibase installation, add the following values under - **Callback URL**: https://budibase.company/api/global/auth/oidc/callback/ - **Name**: authentik -## Resources - -- [Budibase official documentation on OpenID Connect](https://docs.budibase.com/docs/openid-connect) - ## Configuration verification To confirm that authentik is properly configured with Budibase, visit your Budibase installation, and click **Sign in with authentik**. + +## Resources + +- [Budibase official documentation on OpenID Connect](https://docs.budibase.com/docs/openid-connect) diff --git a/website/integrations/services/chronograf/index.mdx b/website/integrations/services/chronograf/index.mdx index 34adc13ab1..4beafcf75b 100644 --- a/website/integrations/services/chronograf/index.mdx +++ b/website/integrations/services/chronograf/index.mdx @@ -65,10 +65,10 @@ Refer to the [Chronograf configuration options documentation](https://docs.influ USE_ID_TOKEN=true ``` -## Resources - -- [Chronograf official documentation on OpenID Connect integration](https://docs.influxdata.com/chronograf/v1/administration/managing-security/#configure-chronograf-to-use-any-oauth-20-provider) - ## Configuration verification To confirm that authentik is properly configured with Chronograf, visit your Chronograf installation, and click **Log in with authentik**. + +## Resources + +- [Chronograf official documentation on OpenID Connect integration](https://docs.influxdata.com/chronograf/v1/administration/managing-security/#configure-chronograf-to-use-any-oauth-20-provider) diff --git a/website/integrations/services/cloudflare-access/index.md b/website/integrations/services/cloudflare-access/index.md index 7d5fa6086e..0fc249f871 100644 --- a/website/integrations/services/cloudflare-access/index.md +++ b/website/integrations/services/cloudflare-access/index.md @@ -55,10 +55,10 @@ To support the integration of Cloudflare Access with authentik, you need to crea 4. Click **Save**. 5. Click **Test** to verify the login provider. -## Resources - -- [Cloudflare Access Generic OIDC documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/generic-oidc/) - ## Configuration verification To confirm that authentik is properly configured with Cloudflare Access, click the **Test** button found right next-to the **Save** button from the previous step. + +## Resources + +- [Cloudflare Access Generic OIDC documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/generic-oidc/) diff --git a/website/integrations/services/coder/index.md b/website/integrations/services/coder/index.md index dc0f8ac4b6..2e35f8e64c 100644 --- a/website/integrations/services/coder/index.md +++ b/website/integrations/services/coder/index.md @@ -53,10 +53,10 @@ CODER_OIDC_SIGN_IN_TEXT=Log in with authentik CODER_OIDC_ICON_URL=https://authentik.company/static/dist/assets/icons/icon.png ``` -## Resources - -- [Coder OIDC authentication documentation](https://coder.com/docs/admin/users/oidc-auth/) - ## Configuration verification To confirm that authentik is properly configured with Coder, log out and attempt to log back in by clicking **Log in with authentik**. + +## Resources + +- [Coder OIDC authentication documentatiom](https://coder.com/docs/admin/users/oidc-auth/) diff --git a/website/integrations/services/dokuwiki/index.md b/website/integrations/services/dokuwiki/index.md index 4c37c493dd..aa829391f1 100644 --- a/website/integrations/services/dokuwiki/index.md +++ b/website/integrations/services/dokuwiki/index.md @@ -75,11 +75,11 @@ For **oauthgeneric**: Once that is done, navigate to the **Authentication** sub-section of the **Administration** interface's **Configuration Settings** section and enable **oauth** under **Authentication backend**. +## Configuration verification + +To verify that authentik is correctly configured with DocuWiki, log out and log back in through authentik. You should notice a new button on the login page. + ## Resources - [DocuWiki OAuth plugin](https://www.dokuwiki.org/plugin:oauth) - [DocuWiki plugin for generic OAuth](https://www.dokuwiki.org/plugin:oauthgeneric) - -## Configuration verification - -To verify that authentik is correctly configured with DocuWiki, log out and log back in through authentik. You should notice a new button on the login page. diff --git a/website/integrations/services/espocrm/index.md b/website/integrations/services/espocrm/index.md index 9e7b74f614..8500e688f7 100644 --- a/website/integrations/services/espocrm/index.md +++ b/website/integrations/services/espocrm/index.md @@ -61,10 +61,10 @@ Configure the following fields: - **JSON Web Key Set Endpoint**: https://authentik.company/application/o/your-application-slug/jwks - **Logout URL**: https://authentik.company/application/o/your-application-slug/end_session -## Resources - -- [EspoCRM administrator documentation on OpenID Connect authentication](https://docs.espocrm.com/administration/oidc/) - ## Configuration verification To confirm that authentik is properly configured with EspoCRM, log out and log back in via authentik. Clicking the "Login" button on the homepage should redirect you to authentik. + +## Resources + +- [EspoCRM administrator documentation on OpenID Connect authentication](https://docs.espocrm.com/administration/oidc/) diff --git a/website/integrations/services/firezone/index.md b/website/integrations/services/firezone/index.md index aa3af1a707..de67852d68 100644 --- a/website/integrations/services/firezone/index.md +++ b/website/integrations/services/firezone/index.md @@ -60,11 +60,11 @@ Set the following values in the Firezone UI: - **Redirect URI**: https://firezone.company/auth/oidc/authentik/callback/ - **Auth-create Users**: Turn this on +## Configuration verification + +To verify that authentik is correctly set up with Firezone, navigate to your Firezone installation and click **authentik**. A successful login should redirect you to the main page of your installation. + ## Resources - [Firezone administration documentation on OpenID Connect authentication](https://www.firezone.dev/docs/authenticate/oidc/) - [Firezone OIDC troubleshooting documentation](https://www.firezone.dev/docs/administer/troubleshoot/#re-enable-local-authentication-via-cli) - -## Configuration verification - -To verify that authentik is correctly set up with Firezone, navigate to your Firezone installation and click **authentik**. A successful login should redirect you to the main page of your installation. diff --git a/website/integrations/services/fortigate-admin/index.md b/website/integrations/services/fortigate-admin/index.md index 8c29b12503..9b829b207a 100644 --- a/website/integrations/services/fortigate-admin/index.md +++ b/website/integrations/services/fortigate-admin/index.md @@ -117,8 +117,8 @@ config system saml end ``` +## Configuration verification + ## Resources - [Offocial Fortigate documentation on SAML authentication](https://community.fortinet.com/t5/FortiGate/Technical-Tip-Configuring-SAML-SSO-login-for-FortiGate/ta-p/194656) - -## Configuration verification diff --git a/website/integrations/services/fortimanager/index.md b/website/integrations/services/fortimanager/index.md index 9d71eb6b2a..a536c0a4bb 100644 --- a/website/integrations/services/fortimanager/index.md +++ b/website/integrations/services/fortimanager/index.md @@ -53,10 +53,10 @@ To support the integration of FortiManager with authentik, you need to create an 9. Set the **IdP Logout URL** to: https://authentik.company/ 10. In the **IdP Certificate** field, import your authentik certificate (either self-signed or valid). -## Resources - -- [Community post on the Fortinet forum](https://community.fortinet.com/t5/FortiAnalyzer/Technical-Tip-Configure-SAML-SSO-login-with-Azure-AD/ta-p/198324) - ## Configuration verification To confirm that authentik is properly configured with FortiManager, log out and log back in via authentik. + +## Resources + +- [Community post on the Fortinet forum](https://community.fortinet.com/t5/FortiAnalyzer/Technical-Tip-Configure-SAML-SSO-login-with-Azure-AD/ta-p/198324) diff --git a/website/integrations/services/frappe/index.md b/website/integrations/services/frappe/index.md index 4bf64f7347..7fd4c54e00 100644 --- a/website/integrations/services/frappe/index.md +++ b/website/integrations/services/frappe/index.md @@ -90,10 +90,10 @@ To support the integration of Frappe with authentik, you need to create an appli 4. **Save the Configuration** - Click the black **Save** button in the top-right corner to complete the setup. -## Resources - -- [Frappe's official OpenID Connect guide](https://docs.frappe.io/framework/user/en/guides/integration/openid_connect_and_frappe_social_login) - ## Configuration verification To verify that authentik is correctly set up with Frappe, navigate to your Frappe installation and click **Login with Provider**. A successful login should redirect you to the main page of your installation. + +## Resources + +- [Frappe's official OpenID Connect guide](https://docs.frappe.io/framework/user/en/guides/integration/openid_connect_and_frappe_social_login) diff --git a/website/integrations/services/freshrss/index.mdx b/website/integrations/services/freshrss/index.mdx index 8745d8599f..1a65f63fe3 100644 --- a/website/integrations/services/freshrss/index.mdx +++ b/website/integrations/services/freshrss/index.mdx @@ -63,11 +63,11 @@ To enable OIDC login with FreshRSS, update your `.env` file to include the follo Once your container or pod is restarted, attempt to login as a user that exists in both FreshRSS and authentik. Go to **Settings** -> **Authentication** and set the authentication method to **HTTP**. +## Configuration verification + +To verify that authentik is correctly set up with FreshRSS, log out of FreshRSS and try logging back in using authentik. You should see a new button on the login page for OIDC authentication. + ## Resources - [FreshRSS documentation for OpenID Connect](https://freshrss.github.io/FreshRSS/en/admins/16_OpenID-Connect.html). - [FreshRSS documentation for OIDC with authentik](https://freshrss.github.io/FreshRSS/en/admins/16_OpenID-Connect-Authentik.html) - -## Configuration verification - -To verify that authentik is correctly set up with FreshRSS, log out of FreshRSS and try logging back in using authentik. You should see a new button on the login page for OIDC authentication. diff --git a/website/integrations/services/gatus/index.mdx b/website/integrations/services/gatus/index.mdx index ea5ce2b0e1..93b93ee90f 100644 --- a/website/integrations/services/gatus/index.mdx +++ b/website/integrations/services/gatus/index.mdx @@ -63,10 +63,10 @@ Gatus automatically updates its configuration approximately every 30 seconds. If scopes: [openid] ``` -## Resources - -- [Gatus Security documentation for OpenID Connect](https://github.com/TwiN/gatus?tab=readme-ov-file#oidc) - ## Configuration verification To confirm that authentik is properly configured with Gatus, click the **Login with SSO** button found on the main page of your Gatus installation. A successful login should redirect you to your status page. + +## Resources + +- [Gatus Security documentation for OpenID Connect](https://github.com/TwiN/gatus?tab=readme-ov-file#oidc) diff --git a/website/integrations/services/gitea/index.md b/website/integrations/services/gitea/index.md index 1f793a3360..7d777659c7 100644 --- a/website/integrations/services/gitea/index.md +++ b/website/integrations/services/gitea/index.md @@ -193,10 +193,10 @@ gitea: scopes: "email profile" ``` -## Resources - -- [Official Gitea Documentation](https://docs.gitea.com/) - ## Configuration verification To verify that authentik is correctly set up with Gitea, log out and then log back in using the **Sign in with authentik** button. + +## Resources + +- [Official Gitea Documentation](https://docs.gitea.com/) diff --git a/website/integrations/services/youtrack/index.md b/website/integrations/services/youtrack/index.md index a43efc6dd0..01e2d31441 100644 --- a/website/integrations/services/youtrack/index.md +++ b/website/integrations/services/youtrack/index.md @@ -65,10 +65,10 @@ To support the integration of YouTrack with authentik, you need to create an app 2. Navigate to **Applications** > **Providers** > **_application name_**, then click **Edit**. 3. Replace the placeholder value for the **ACS URL** with the value copied from the previous section. -## Resources - -- [YouTrack SAML 2.0 Auth Module Documentation](https://www.jetbrains.com/help/youtrack/server/saml-authentication-module.html) - ## Configuration verification To confirm that authentik is properly configured with YouTrack, log out and attempt to log back in. You should be redirected to authentik to complete authentication. + +## Resources + +- [YouTrack SAML 2.0 Auth Module Documentation](https://www.jetbrains.com/help/youtrack/server/saml-authentication-module.html)