Skip to content
This repository was archived by the owner on Apr 26, 2024. It is now read-only.

Commit 3e83f97

Browse files
Fix the titles in the OIDC documentation (#10639)
* Fix the titles in the OIDC documentation Having them as links broke the table-of-contents rendering in mdbook. Plus there's no reason for only some of the provider titles to be links. * Changelog * Add link to google idp docs
1 parent 2efc838 commit 3e83f97

File tree

2 files changed

+11
-6
lines changed

2 files changed

+11
-6
lines changed

changelog.d/10639.doc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Fix some of the titles not rendering in the OIDC documentation.

docs/openid.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ oidc_providers:
7979
display_name_template: "{{ user.name }}"
8080
```
8181
82-
### [Dex][dex-idp]
82+
### Dex
8383
8484
[Dex][dex-idp] is a simple, open-source, certified OpenID Connect Provider.
8585
Although it is designed to help building a full-blown provider with an
@@ -117,7 +117,7 @@ oidc_providers:
117117
localpart_template: "{{ user.name }}"
118118
display_name_template: "{{ user.name|capitalize }}"
119119
```
120-
### [Keycloak][keycloak-idp]
120+
### Keycloak
121121

122122
[Keycloak][keycloak-idp] is an opensource IdP maintained by Red Hat.
123123

@@ -166,7 +166,9 @@ oidc_providers:
166166
localpart_template: "{{ user.preferred_username }}"
167167
display_name_template: "{{ user.name }}"
168168
```
169-
### [Auth0][auth0]
169+
### Auth0
170+
171+
[Auth0][auth0] is a hosted SaaS IdP solution.
170172

171173
1. Create a regular web application for Synapse
172174
2. Set the Allowed Callback URLs to `[synapse public baseurl]/_synapse/client/oidc/callback`
@@ -209,7 +211,7 @@ oidc_providers:
209211

210212
### GitHub
211213

212-
GitHub is a bit special as it is not an OpenID Connect compliant provider, but
214+
[GitHub][github-idp] is a bit special as it is not an OpenID Connect compliant provider, but
213215
just a regular OAuth2 provider.
214216

215217
The [`/user` API endpoint](https://developer.github.com/v3/users/#get-the-authenticated-user)
@@ -242,11 +244,13 @@ oidc_providers:
242244
display_name_template: "{{ user.name }}"
243245
```
244246

245-
### [Google][google-idp]
247+
### Google
248+
249+
[Google][google-idp] is an OpenID certified authentication and authorisation provider.
246250

247251
1. Set up a project in the Google API Console (see
248252
https://developers.google.com/identity/protocols/oauth2/openid-connect#appsetup).
249-
2. add an "OAuth Client ID" for a Web Application under "Credentials".
253+
2. Add an "OAuth Client ID" for a Web Application under "Credentials".
250254
3. Copy the Client ID and Client Secret, and add the following to your synapse config:
251255
```yaml
252256
oidc_providers:

0 commit comments

Comments
 (0)