diff options
| author | Oliver Hanikel <68649699+Oliver-Hanikel@users.noreply.github.com> | 2021-02-01 22:21:09 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-02-01 16:21:09 -0500 |
| commit | d1f13c7485768b45bfc1a2a674830c681c52e2a1 (patch) | |
| tree | 31cac8bc343c1ff71dd73bcda8afbab89e98b3e8 | |
| parent | Merge branch 'social_login' into develop (diff) | |
| download | synapse-d1f13c7485768b45bfc1a2a674830c681c52e2a1.tar.xz | |
Add an OpenID example config for Gitea. (#9134)
| -rw-r--r-- | changelog.d/9134.doc | 1 | ||||
| -rw-r--r-- | docs/openid.md | 34 |
2 files changed, 35 insertions, 0 deletions
diff --git a/changelog.d/9134.doc b/changelog.d/9134.doc new file mode 100644 index 0000000000..04120918c2 --- /dev/null +++ b/changelog.d/9134.doc @@ -0,0 +1 @@ +Add docs for using Gitea as OpenID provider. diff --git a/docs/openid.md b/docs/openid.md index 4ba3559e38..3d07220967 100644 --- a/docs/openid.md +++ b/docs/openid.md @@ -353,3 +353,37 @@ Relevant documents: * https://developers.facebook.com/docs/facebook-login/manually-build-a-login-flow * Using Facebook's Graph API: https://developers.facebook.com/docs/graph-api/using-graph-api/ * Reference to the User endpoint: https://developers.facebook.com/docs/graph-api/reference/user + +### Gitea + +Gitea is, like Github, not an OpenID provider, but just an OAuth2 provider. + +The [`/user` API endpoint](https://try.gitea.io/api/swagger#/user/userGetCurrent) +can be used to retrieve information on the authenticated user. As the Synapse +login mechanism needs an attribute to uniquely identify users, and that endpoint +does not return a `sub` property, an alternative `subject_claim` has to be set. + +1. Create a new application. +2. Add this Callback URL: `[synapse public baseurl]/_synapse/oidc/callback` + +Synapse config: + +```yaml +oidc_providers: + - idp_id: gitea + idp_name: Gitea + discover: false + issuer: "https://your-gitea.com/" + client_id: "your-client-id" # TO BE FILLED + client_secret: "your-client-secret" # TO BE FILLED + client_auth_method: client_secret_post + scopes: [] # Gitea doesn't support Scopes + authorization_endpoint: "https://your-gitea.com/login/oauth/authorize" + token_endpoint: "https://your-gitea.com/login/oauth/access_token" + userinfo_endpoint: "https://your-gitea.com/api/v1/user" + user_mapping_provider: + config: + subject_claim: "id" + localpart_template: "{{ user.login }}" + display_name_template: "{{ user.full_name }}" +``` |