From 154fba12e0f09299c1dd37e018e680356e20d2fc Mon Sep 17 00:00:00 2001 From: Dewi Roberts Date: Tue, 27 May 2025 18:31:23 +0100 Subject: [PATCH] website/docs: add login page source note to all source docs (#14667) * Updates all source documents with note on how to add source to login page * Updated the wording on the guide itself * Updated wording on notes * Fixes capitalization on header * Fixed broken links in google docs --- website/docs/users-sources/sources/index.md | 13 +++++++------ .../sources/social-logins/apple/index.md | 2 +- .../sources/social-logins/azure-ad/index.mdx | 4 ++++ .../sources/social-logins/discord/index.md | 4 ++++ .../sources/social-logins/facebook/index.md | 2 +- .../sources/social-logins/github/index.mdx | 4 ++++ .../sources/social-logins/google/cloud/index.md | 4 ++++ .../sources/social-logins/google/workspace/index.md | 4 ++++ .../sources/social-logins/mailcow/index.md | 2 +- .../sources/social-logins/plex/index.md | 2 +- .../sources/social-logins/twitch/index.md | 2 +- .../sources/social-logins/twitter/index.md | 2 +- 12 files changed, 33 insertions(+), 12 deletions(-) diff --git a/website/docs/users-sources/sources/index.md b/website/docs/users-sources/sources/index.md index 0ca0848205..4d34dc18a0 100644 --- a/website/docs/users-sources/sources/index.md +++ b/website/docs/users-sources/sources/index.md @@ -15,12 +15,13 @@ Sources are in the following general categories: For instructions to add a specific source, refer to the documentation links in the left navigation pane. -### Add Sources to Default Login Page +### Add sources to default login page To have sources show on the default login screen you will need to add them to the flow. The process below assumes that you have not created or renamed the default stages and flows. -1. In the Admin interface, navigate to the **Flows** section. -2. Click on **default-authentication-flow**. -3. Click the **Stage Bindings** tab. -4. Chose **Edit Stage** for the _default-authentication-identification_ stage. -5. Under **Sources** you should see the additional sources that you have configured. Click all applicable sources to have them displayed on the Login page. +1. Log in to authentik as an admin, and open the authentik Admin interface. +2. Navigate to **Flows and Stages** > **Flows**. +3. Click the **default-authentication-flow**. +4. Click the **Stage Bindings** tab. +5. Click **Edit Stage** on the **default-authentication-identification** stage. +6. Under **Source settings**, add sources to **Selected sources** to have them displayed on the authentik login page. diff --git a/website/docs/users-sources/sources/social-logins/apple/index.md b/website/docs/users-sources/sources/social-logins/apple/index.md index 59bd2116f1..24bc7b5590 100644 --- a/website/docs/users-sources/sources/social-logins/apple/index.md +++ b/website/docs/users-sources/sources/social-logins/apple/index.md @@ -68,5 +68,5 @@ The following placeholders are used in this guide: Save, and you now have Apple as a source. :::note -For more details on how-to have the new source display on the Login Page see [here](../../index.md#add-sources-to-default-login-page). +For instructions on how to display the new source on the authentik login page, refer to the [Add sources to default login page documentation](../../index.md#add-sources-to-default-login-page). ::: diff --git a/website/docs/users-sources/sources/social-logins/azure-ad/index.mdx b/website/docs/users-sources/sources/social-logins/azure-ad/index.mdx index 161dbc21c9..3856705a1f 100644 --- a/website/docs/users-sources/sources/social-logins/azure-ad/index.mdx +++ b/website/docs/users-sources/sources/social-logins/azure-ad/index.mdx @@ -129,3 +129,7 @@ client_secret= ``` The JWT returned from the request above can be used with authentik to exchange it for an authentik JWT. + +:::note +For instructions on how to display the new source on the authentik login page, refer to the [Add sources to default login page documentation](../../index.md#add-sources-to-default-login-page). +::: diff --git a/website/docs/users-sources/sources/social-logins/discord/index.md b/website/docs/users-sources/sources/social-logins/discord/index.md index 3cf5727495..2c50fa9143 100644 --- a/website/docs/users-sources/sources/social-logins/discord/index.md +++ b/website/docs/users-sources/sources/social-logins/discord/index.md @@ -380,3 +380,7 @@ return True ``` Now bind this policy to the chosen enrollment and authentication flows for the Discord OAuth source. + +:::note +For instructions on how to display the new source on the authentik login page, refer to the [Add sources to default login page documentation](../../index.md#add-sources-to-default-login-page). +::: diff --git a/website/docs/users-sources/sources/social-logins/facebook/index.md b/website/docs/users-sources/sources/social-logins/facebook/index.md index 88d1c3cc7b..e93ecc48af 100644 --- a/website/docs/users-sources/sources/social-logins/facebook/index.md +++ b/website/docs/users-sources/sources/social-logins/facebook/index.md @@ -69,5 +69,5 @@ Finally, you need to publish the Facebook app. You now have Facebook as a source. Verify by checking that appears on the **Directory -> Federation & Social login** page in authentik. :::note -For more details on how to display the new source on the authentik Login page refer to [Add Sources to default Login form](../../index.md#add-sources-to-default-login-page). +For instructions on how to display the new source on the authentik login page, refer to the [Add sources to default login page documentation](../../index.md#add-sources-to-default-login-page). ::: diff --git a/website/docs/users-sources/sources/social-logins/github/index.mdx b/website/docs/users-sources/sources/social-logins/github/index.mdx index bdcc4950ef..fa4535b1ed 100644 --- a/website/docs/users-sources/sources/social-logins/github/index.mdx +++ b/website/docs/users-sources/sources/social-logins/github/index.mdx @@ -99,3 +99,7 @@ return user_matched If a user is not member of the chosen organisation, they will see this message ![](./github_org_membership.png) + +:::note +For instructions on how to display the new source on the authentik login page, refer to the [Add sources to default login page documentation](../../index.md#add-sources-to-default-login-page). +::: diff --git a/website/docs/users-sources/sources/social-logins/google/cloud/index.md b/website/docs/users-sources/sources/social-logins/google/cloud/index.md index d0b00d5ced..f4b2da1587 100644 --- a/website/docs/users-sources/sources/social-logins/google/cloud/index.md +++ b/website/docs/users-sources/sources/social-logins/google/cloud/index.md @@ -101,3 +101,7 @@ return False Afterwards, edit the source's enrollment flow (by default _default-source-enrollment_), expand the policies bound to the first stage (_default-source-enrollment-prompt_), and bind the policy created above. Make sure the newly created policy comes before _default-source-enrollment-if-username_. Afterwards, any new logins will automatically have their google email address used as their username. This can be combined with disallowing users from changing their usernames, see [Configuration](../../../../../sys-mgmt/settings.md#allow-users-to-change-username). + +:::note +For instructions on how to display the new source on the authentik login page, refer to the [Add sources to default login page documentation](../../../index.md#add-sources-to-default-login-page). +::: diff --git a/website/docs/users-sources/sources/social-logins/google/workspace/index.md b/website/docs/users-sources/sources/social-logins/google/workspace/index.md index 0c817f736e..8a6315ef2b 100644 --- a/website/docs/users-sources/sources/social-logins/google/workspace/index.md +++ b/website/docs/users-sources/sources/social-logins/google/workspace/index.md @@ -202,3 +202,7 @@ This may take a few minutes to propagate, so try logging in again after a short - [Setting up SAML with Google Workspace](https://support.google.com/a/answer/6087519) - [SAML app error messages](https://support.google.com/a/answer/6301076) - [SAML authentication flow](https://infosec.mozilla.org/guidelines/iam/saml.html) + +:::note +For instructions on how to display the new source on the authentik login page, refer to the [Add sources to default login page documentation](../../../index.md#add-sources-to-default-login-page). +::: diff --git a/website/docs/users-sources/sources/social-logins/mailcow/index.md b/website/docs/users-sources/sources/social-logins/mailcow/index.md index 02ad2f8f5f..f0a95db8be 100644 --- a/website/docs/users-sources/sources/social-logins/mailcow/index.md +++ b/website/docs/users-sources/sources/social-logins/mailcow/index.md @@ -49,5 +49,5 @@ Here is an example of a complete authentik Mailcow OAuth Source Save, and you now have Mailcow as a source. :::note -For more details on how-to have the new source display on the Login Page see [here](../../index.md#add-sources-to-default-login-page). +For instructions on how to display the new source on the authentik login page, refer to the [Add sources to default login page documentation](../../index.md#add-sources-to-default-login-page). ::: diff --git a/website/docs/users-sources/sources/social-logins/plex/index.md b/website/docs/users-sources/sources/social-logins/plex/index.md index 2f3fc53a4b..cb31b53e20 100644 --- a/website/docs/users-sources/sources/social-logins/plex/index.md +++ b/website/docs/users-sources/sources/social-logins/plex/index.md @@ -22,7 +22,7 @@ Add _Plex_ as a _source_ Save, and you now have Plex as a source. :::note -For more details on how-to have the new source display on the Login Page see [here](../../index.md#add-sources-to-default-login-page). +For instructions on how to display the new source on the authentik login page, refer to the [Add sources to default login page documentation](../../index.md#add-sources-to-default-login-page). ::: ## Plex source property mappings diff --git a/website/docs/users-sources/sources/social-logins/twitch/index.md b/website/docs/users-sources/sources/social-logins/twitch/index.md index a801f8d18c..8171bd8142 100644 --- a/website/docs/users-sources/sources/social-logins/twitch/index.md +++ b/website/docs/users-sources/sources/social-logins/twitch/index.md @@ -55,5 +55,5 @@ Here is an example of a complete authentik Twitch OAuth Source Save, and you now have Twitch as a source. :::note -For more details on how-to have the new source display on the Login Page see [here](../../index.md#add-sources-to-default-login-page). +For instructions on how to display the new source on the authentik login page, refer to the [Add sources to default login page documentation](../../index.md#add-sources-to-default-login-page). ::: diff --git a/website/docs/users-sources/sources/social-logins/twitter/index.md b/website/docs/users-sources/sources/social-logins/twitter/index.md index afb6392d15..32d4729baa 100644 --- a/website/docs/users-sources/sources/social-logins/twitter/index.md +++ b/website/docs/users-sources/sources/social-logins/twitter/index.md @@ -43,5 +43,5 @@ You will need to create a new project, and OAuth credentials in the Twitter Deve 5. **Consumer Secret:** Your Client Secret from step 25 :::note -For more details on how-to have the new source display on the Login Page see [here](../../index.md#add-sources-to-default-login-page). +For instructions on how to display the new source on the authentik login page, refer to the [Add sources to default login page documentation](../../index.md#add-sources-to-default-login-page). :::