a714c781a6
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.
1.8 KiB
title, sidebar_label, support_level
| title | sidebar_label | support_level |
|---|---|---|
| Integrate with Matrix Synapse | Matrix Synapse | community |
What is Matrix Synapse
Matrix is an open source project that publishes the Matrix open standard for secure, decentralised, real-time communication, and its Apache licensed reference implementations.
Preparation
The following placeholders are used in this guide:
matrix.companyis the FQDN of the Matrix installation.authentik.companyis 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 - Scopes: OpenID, Email and Profile
- Signing Key: Select any available key
- Redirect URIs:
https://matrix.company/_synapse/client/oidc/callback
Note the Client ID and Client Secret values. Create an application, using the provider you've created above. Note the slug of the application you've created.
Matrix
Add the following block to your Matrix config
:::info For more info, see https://matrix-org.github.io/synapse/latest/openid.html?highlight=authentik#authentik :::
oidc_providers:
- idp_id: authentik
idp_name: authentik
discover: true
issuer: "https://authentik.company/application/o/app-slug/"
client_id: "*client id*"
client_secret: "*client secret*"
scopes:
- "openid"
- "profile"
- "email"
user_mapping_provider:
config:
localpart_template: "{{ user.preferred_username }}"
display_name_template: "{{ user.name|capitalize }}"