authelia

2.6 KiB

Raw Blame History

title

description

lead

date

draft

images

weight

toc

community

Synapse

Integrating Synapse with the Authelia OpenID Connect Provider.

2022-06-15T17:51:47+10:00

false

integration

parent
openid-connect

620

true

Tested Versions

Authelia
- v4.35.6
Synapse
- v1.60.0

Before You Begin

Common Notes

You are required to utilize a unique client id for every client.
The client id on this page is merely an example and you can theoretically use any alphanumeric string.
You should not use the client secret in this example, We strongly recommend reading the [Generating Client Secrets] guide instead.

Assumptions

This example makes the following assumptions:

Application Root URL: https://matrix.example.com/
Authelia Root URL: https://auth.example.com
Client ID: synapse
Client Secret: synapse_client_secret

Configuration

Application

To configure Synapse to utilize Authelia as an OpenID Connect Provider:

Edit your Synapse homeserver.yaml configuration file and add configure the following:

oidc_providers:
  - idp_id: authelia
    idp_name: "Authelia"
    idp_icon: "mxc://authelia.com/cKlrTPsGvlpKxAYeHWJsdVHI"
    discover: true
    issuer: "https://auth.example.com"
    client_id: "synapse"
    client_secret: "synapse_client_secret"
    scopes: ["openid", "profile", "email"]
    allow_existing_users: true
    user_mapping_provider:
      config:
        subject_claim: "sub"
        localpart_template: "{{ user.preferred_username }}"
        display_name_template: "{{ user.name }}"
        email_template: "{{ user.email }}"

Authelia

The following YAML configuration is an example Authelia client configuration for use with Synapse which will operate with the above example:

- id: synapse
  description: Synapse
  secret: '$plaintext$synapse_client_secret'
  public: false
  authorization_policy: two_factor
  redirect_uris:
    - https://synapse.example.com/_synapse/client/oidc/callback
  scopes:
    - openid
    - profile
    - email
  userinfo_signing_algorithm: none

2.6 KiB Raw Blame History