summary refs log tree commit diff
path: root/docs/workers.md
diff options
context:
space:
mode:
authorPatrick Cloke <clokep@users.noreply.github.com>2020-09-30 13:02:43 -0400
committerGitHub <noreply@github.com>2020-09-30 13:02:43 -0400
commit8b40843392e2df80d4f1108295ae6acd972100b0 (patch)
treec86f29ea058cf0587c213f20a969fb70baf8e2fa /docs/workers.md
parentDrop support for ancient prometheus_client (#8426) (diff)
downloadsynapse-8b40843392e2df80d4f1108295ae6acd972100b0.tar.xz
Allow additional SSO properties to be passed to the client (#8413)
Diffstat (limited to 'docs/workers.md')
-rw-r--r--docs/workers.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/docs/workers.md b/docs/workers.md
index df0ac84d94..ad4d8ca9f2 100644
--- a/docs/workers.md
+++ b/docs/workers.md
@@ -243,6 +243,22 @@ for the room are in flight:
 
     ^/_matrix/client/(api/v1|r0|unstable)/rooms/.*/messages$
 
+Additionally, the following endpoints should be included if Synapse is configured
+to use SSO (you only need to include the ones for whichever SSO provider you're
+using):
+
+    # OpenID Connect requests.
+    ^/_matrix/client/(api/v1|r0|unstable)/login/sso/redirect$
+    ^/_synapse/oidc/callback$
+
+    # SAML requests.
+    ^/_matrix/client/(api/v1|r0|unstable)/login/sso/redirect$
+    ^/_matrix/saml2/authn_response$
+
+    # CAS requests.
+    ^/_matrix/client/(api/v1|r0|unstable)/login/(cas|sso)/redirect$
+    ^/_matrix/client/(api/v1|r0|unstable)/login/cas/ticket$
+
 Note that a HTTP listener with `client` and `federation` resources must be
 configured in the `worker_listeners` option in the worker config.