Synapse

Tested Versions

Before You Begin

You are required to utilize a unique client id and a unique and random client secret for all OpenID Connect relying parties. You should not use the client secret in this example, you should randomly generate one yourself. You may also choose to utilize a different client id, it’s completely up to you.

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:

  1. Edit your Synapse homeserver.yaml configuration file and add configure the following:
oidc_providers:
  - idp_id: synapse
    idp_name: "Authelia"
    issuer: "https://auth.example.com"
    client_id: "synapse"
    client_secret: "synapse_client_secret"
    allow_existing_users: true
    scopes: ["openid", "profile"]
    user_mapping_provider:
      config:
        localpart_template: "{{ openid.preferred_username }}"

Authelia

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

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

See Also