mirror of
https://github.com/element-hq/synapse
synced 2024-08-18 19:10:52 +00:00
deploy: a19bf32a03
This commit is contained in:
parent
fe35a0497c
commit
4aa8c47ffe
4 changed files with 70 additions and 2 deletions
|
@ -371,6 +371,40 @@ to install Dex.</p>
|
|||
localpart_template: "{{ user.preferred_username }}"
|
||||
display_name_template: "{{ user.name }}"
|
||||
</code></pre>
|
||||
<h3 id="authentik"><a class="header" href="#authentik">Authentik</a></h3>
|
||||
<p><a href="https://goauthentik.io/">Authentik</a> is an open-source IdP solution.</p>
|
||||
<ol>
|
||||
<li>Create a provider in Authentik, with type OAuth2/OpenID.</li>
|
||||
<li>The parameters are:</li>
|
||||
</ol>
|
||||
<ul>
|
||||
<li>Client Type: Confidential</li>
|
||||
<li>JWT Algorithm: RS256</li>
|
||||
<li>Scopes: OpenID, Email and Profile</li>
|
||||
<li>RSA Key: Select any available key</li>
|
||||
<li>Redirect URIs: <code>[synapse public baseurl]/_synapse/client/oidc/callback</code></li>
|
||||
</ul>
|
||||
<ol start="3">
|
||||
<li>Create an application for synapse in Authentik and link it to the provider.</li>
|
||||
<li>Note the slug of your application, Client ID and Client Secret.</li>
|
||||
</ol>
|
||||
<p>Synapse config:</p>
|
||||
<pre><code class="language-yaml">oidc_providers:
|
||||
- idp_id: authentik
|
||||
idp_name: authentik
|
||||
discover: true
|
||||
issuer: "https://your.authentik.example.org/application/o/your-app-slug/" # TO BE FILLED: domain and slug
|
||||
client_id: "your client id" # TO BE FILLED
|
||||
client_secret: "your client secret" # TO BE FILLED
|
||||
scopes:
|
||||
- "openid"
|
||||
- "profile"
|
||||
- "email"
|
||||
user_mapping_provider:
|
||||
config:
|
||||
localpart_template: "{{ user.preferred_username }}}"
|
||||
display_name_template: "{{ user.preferred_username|capitalize }}" # TO BE FILLED: If your users have names in Authentik and you want those in Synapse, this should be replaced with user.name|capitalize.
|
||||
</code></pre>
|
||||
<h3 id="github"><a class="header" href="#github">GitHub</a></h3>
|
||||
<p><a href="https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps">GitHub</a> is a bit special as it is not an OpenID Connect compliant provider, but
|
||||
just a regular OAuth2 provider.</p>
|
||||
|
|
|
@ -6366,6 +6366,40 @@ to install Dex.</p>
|
|||
localpart_template: "{{ user.preferred_username }}"
|
||||
display_name_template: "{{ user.name }}"
|
||||
</code></pre>
|
||||
<h3 id="authentik"><a class="header" href="#authentik">Authentik</a></h3>
|
||||
<p><a href="https://goauthentik.io/">Authentik</a> is an open-source IdP solution.</p>
|
||||
<ol>
|
||||
<li>Create a provider in Authentik, with type OAuth2/OpenID.</li>
|
||||
<li>The parameters are:</li>
|
||||
</ol>
|
||||
<ul>
|
||||
<li>Client Type: Confidential</li>
|
||||
<li>JWT Algorithm: RS256</li>
|
||||
<li>Scopes: OpenID, Email and Profile</li>
|
||||
<li>RSA Key: Select any available key</li>
|
||||
<li>Redirect URIs: <code>[synapse public baseurl]/_synapse/client/oidc/callback</code></li>
|
||||
</ul>
|
||||
<ol start="3">
|
||||
<li>Create an application for synapse in Authentik and link it to the provider.</li>
|
||||
<li>Note the slug of your application, Client ID and Client Secret.</li>
|
||||
</ol>
|
||||
<p>Synapse config:</p>
|
||||
<pre><code class="language-yaml">oidc_providers:
|
||||
- idp_id: authentik
|
||||
idp_name: authentik
|
||||
discover: true
|
||||
issuer: "https://your.authentik.example.org/application/o/your-app-slug/" # TO BE FILLED: domain and slug
|
||||
client_id: "your client id" # TO BE FILLED
|
||||
client_secret: "your client secret" # TO BE FILLED
|
||||
scopes:
|
||||
- "openid"
|
||||
- "profile"
|
||||
- "email"
|
||||
user_mapping_provider:
|
||||
config:
|
||||
localpart_template: "{{ user.preferred_username }}}"
|
||||
display_name_template: "{{ user.preferred_username|capitalize }}" # TO BE FILLED: If your users have names in Authentik and you want those in Synapse, this should be replaced with user.name|capitalize.
|
||||
</code></pre>
|
||||
<h3 id="github"><a class="header" href="#github">GitHub</a></h3>
|
||||
<p><a href="https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps">GitHub</a> is a bit special as it is not an OpenID Connect compliant provider, but
|
||||
just a regular OAuth2 provider.</p>
|
||||
|
|
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
Loading…
Reference in a new issue