summary refs log tree commit diff
path: root/docs/openid.md
diff options
context:
space:
mode:
authorThomas Mortagne <thomas.mortagne@gmail.com>2021-02-09 17:54:52 +0100
committerGitHub <noreply@github.com>2021-02-09 11:54:52 -0500
commit5f716fa7771a567eb2e64a635e9f1a7eea7b9640 (patch)
treeb9b372531050a2460d6d11e65c3db4309094096f /docs/openid.md
parentType hints and validation improvements. (#9321) (diff)
downloadsynapse-5f716fa7771a567eb2e64a635e9f1a7eea7b9640.tar.xz
Add XWiki OIDC provider example. (#9324)
Diffstat (limited to '')
-rw-r--r--docs/openid.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/docs/openid.md b/docs/openid.md
index 9d19368845..0be79591b1 100644
--- a/docs/openid.md
+++ b/docs/openid.md
@@ -388,3 +388,25 @@ oidc_providers:
         localpart_template: "{{ user.login }}"
         display_name_template: "{{ user.full_name }}" 
 ```
+
+### XWiki
+
+Install [OpenID Connect Provider](https://extensions.xwiki.org/xwiki/bin/view/Extension/OpenID%20Connect/OpenID%20Connect%20Provider/) extension in your [XWiki](https://www.xwiki.org) instance.
+
+Synapse config:
+
+```yaml
+oidc_providers:
+  - idp_id: xwiki
+    idp_name: "XWiki"
+    issuer: "https://myxwikihost/xwiki/oidc/"
+    client_id: "your-client-id" # TO BE FILLED
+    # Needed until https://github.com/matrix-org/synapse/issues/9212 is fixed
+    client_secret: "dontcare"
+    scopes: ["openid", "profile"]
+    user_profile_method: "userinfo_endpoint"
+    user_mapping_provider:
+      config:
+        localpart_template: "{{ user.preferred_username }}"
+        display_name_template: "{{ user.name }}"
+```