website: Use Docusaurus Frontmatter for badges (#12893)

website/docs: Reduce redundant usage of badges. Move badge logic to components.

- Fix JSX class name warning.
- Remove duplicate titles.
- Flesh out `support_level` frontmatter.
This commit is contained in:
Teffen Ellis
2025-02-19 19:03:05 +01:00
committed by GitHub
parent df2e3878d5
commit a714c781a6
214 changed files with 930 additions and 748 deletions

View File

@ -1,9 +1,8 @@
---
title: Apple
support_level: authentik
---
<span class="badge badge--primary">Support level: authentik</span>
Allows users to authenticate using their Apple ID.
## Preparation

View File

@ -1,9 +1,8 @@
---
title: Azure AD
support_level: community
---
<span class="badge badge--secondary">Support level: Community</span>
## Preparation
The following placeholders are used in this guide:
@ -112,9 +111,9 @@ return True
Try to login with a **_new_** user. You should see no prompts and the user should have the correct information.
### Machine-to-machine authentication <span class="badge badge--version">authentik 2024.12+</span>
### Machine-to-machine authentication:ak-version[2024.12]
If using [Machine-to-Machine](../../../../add-secure-apps/providers/oauth2/client_credentials.md#jwt-authentication) authentication, some specific steps need to be considered.
If using [Machine-to-Machine](../../../../add-secure-apps/providers/oauth2/client_credentials.mdx#jwt-authentication) authentication, some specific steps need to be considered.
When getting the JWT token from Azure AD, set the scope to the Application ID URI, and _not_ the Graph URL; otherwise the JWT will be in an invalid format.

View File

@ -1,9 +1,8 @@
---
title: Discord
support_level: authentik
---
<span class="badge badge--primary">Support level: authentik</span>
Allows users to authenticate using their Discord credentials
## Preparation
@ -162,13 +161,13 @@ Ensure that the Discord OAuth source in **Federation & Social login** has the ad
:::
:::info
Any authentik role that you want to sync with a Discord role needs to have the **attribute** `discord_role_id` with a value of the Discord role's ID set.
This setting can be found under `Authentik > Admin Interface > Directory > Groups > YOUR_GROUP > Attributes`
Any authentik role that you want to sync with a Discord role needs to have the **attribute** `discord_role_id` with a value of the Discord role's ID set.
This setting can be found under `Authentik > Admin Interface > Directory > Groups > YOUR_GROUP > Attributes`
Example: `discord_role_id: "<ROLE ID>"`
:::
The following two policies allow you to synchronize roles in a Discord guild with roles in authentik.
Whenever a user enrolls or signs in to authentik via a Discord source, these policies will check the user's Discord roles and apply the user's authentik roles accordingly.
The following two policies allow you to synchronize roles in a Discord guild with roles in authentik.
Whenever a user enrolls or signs in to authentik via a Discord source, these policies will check the user's Discord roles and apply the user's authentik roles accordingly.
All roles with the attribute `discord_role_id` defined will be added or removed depending on whether the user is a member of the defined Discord role.
Create a new **Expression Policy** with the content below, adjusting the variables where required.

View File

@ -1,9 +1,8 @@
---
title: Facebook
support_level: community
---
<span class="badge badge--secondary">Support level: Community</span>
Adding Facebook as a source allows users to authenticate through authentik using their Facebook credentials.
## Preparation

View File

@ -1,9 +1,8 @@
---
title: Github
support_level: authentik
---
<span class="badge badge--primary">Support level: authentik</span>
Allows users to authenticate using their Github credentials
## Preparation
@ -50,7 +49,7 @@ Save, and you now have Github as a source.
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).
:::
### Checking for membership of a GitHub Organisation <span class="badge badge--version">authentik 2021.12.5.+</span>
### Checking for membership of a GitHub Organisation
To check if the user is member of an organisation, you can use the following policy on your flows:

View File

@ -2,10 +2,9 @@
title: Google Cloud (with OAuth)
sidebar_label: Google Cloud (OAuth)
tags: [integration, oauth, google]
support_level: community
---
<span class="badge badge--secondary">Support level: Community</span>
Allows users to authenticate using their Google credentials
## Preparation

View File

@ -2,10 +2,9 @@
title: Google Workspace (with SAML)
sidebar_label: Google Workspace (SAML)
tags: [integration, saml, google]
support_level: authentik
---
<span className="badge badge--primary">Support level: authentik</span>
This topic covers configuring authentik to authenticate users with their Google Workspace credentials.
## What is Google Workspace?

View File

@ -1,9 +1,8 @@
---
title: Mailcow
support_level: community
---
<span class="badge badge--secondary">Support level: Community</span>
Allows users to authenticate using their Mailcow credentials
## Preparation

View File

@ -1,9 +1,8 @@
---
title: Plex
support_level: community
---
<span class="badge badge--secondary">Support level: Community</span>
Allows users to authenticate using their Plex credentials
## Preparation

View File

@ -1,9 +1,8 @@
---
title: Twitch
support_level: community
---
<span class="badge badge--secondary">Support level: Community</span>
Allows users to authenticate using their Twitch credentials
## Preparation

View File

@ -1,9 +1,8 @@
---
title: Twitter
support_level: authentik
---
<span class="badge badge--primary">Support level: authentik</span>
Allows users to authenticate using their twitter credentials
## Preparation