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

Fix the titles in the OIDC documentation #10639

Merged
merged 3 commits into from
Aug 23, 2021
Merged

Fix the titles in the OIDC documentation #10639

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
dc3ef44
Fix the titles in the OIDC documentation
anoadragon453 Aug 18, 2021
aa5c110
Changelog
anoadragon453 Aug 18, 2021
233b8c0
Add link to google idp docs
anoadragon453 Aug 23, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelog.d/10639.doc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Fix some of the titles not rendering in the OIDC documentation.
16 changes: 10 additions & 6 deletions docs/openid.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ oidc_providers:
display_name_template: "{{ user.name }}"
```

### [Dex][dex-idp]
### Dex

[Dex][dex-idp] is a simple, open-source, certified OpenID Connect Provider.
Although it is designed to help building a full-blown provider with an
Expand Down Expand Up @@ -117,7 +117,7 @@ oidc_providers:
localpart_template: "{{ user.name }}"
display_name_template: "{{ user.name|capitalize }}"
```
### [Keycloak][keycloak-idp]
### Keycloak

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

Expand Down Expand Up @@ -166,7 +166,9 @@ oidc_providers:
localpart_template: "{{ user.preferred_username }}"
display_name_template: "{{ user.name }}"
```
### [Auth0][auth0]
### Auth0

[Auth0][auth0] is a hosted SaaS IdP solution.

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

### GitHub

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

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

### [Google][google-idp]
### Google
anoadragon453 marked this conversation as resolved.
Show resolved Hide resolved

[Google][google-idp] is an OpenID certified authentication and authorisation provider.

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