summary refs log tree commit diff
path: root/docs/workers.md
diff options
context:
space:
mode:
authorAndrew Morgan <andrew@amorgan.xyz>2021-04-22 18:33:37 +0100
committerAndrew Morgan <andrew@amorgan.xyz>2021-04-22 18:33:37 +0100
commit3518cc79b61c47f7406317ccf95f422fe9b592a9 (patch)
tree1d61c75439f195f9ec327762b2909a2458321215 /docs/workers.md
parentMerge commit 'e19396d62' into anoa/dinsic_release_1_31_0 (diff)
parentFix SSO on workers (#9271) (diff)
downloadsynapse-3518cc79b61c47f7406317ccf95f422fe9b592a9.tar.xz
Merge commit '9c715a5f1' into anoa/dinsic_release_1_31_0
Diffstat (limited to 'docs/workers.md')
-rw-r--r--docs/workers.md18
1 files changed, 10 insertions, 8 deletions
diff --git a/docs/workers.md b/docs/workers.md

index d2927d95a6..bd8c9f95cb 100644 --- a/docs/workers.md +++ b/docs/workers.md
@@ -228,7 +228,6 @@ expressions: ^/_matrix/client/(api/v1|r0|unstable)/joined_groups$ ^/_matrix/client/(api/v1|r0|unstable)/publicised_groups$ ^/_matrix/client/(api/v1|r0|unstable)/publicised_groups/ - ^/_synapse/client/password_reset/email/submit_token$ # Registration/login requests ^/_matrix/client/(api/v1|r0|unstable)/login$ @@ -259,25 +258,28 @@ Additionally, the following endpoints should be included if Synapse is configure to use SSO (you only need to include the ones for whichever SSO provider you're using): + # for all SSO providers + ^/_matrix/client/(api/v1|r0|unstable)/login/sso/redirect + ^/_synapse/client/pick_idp$ + ^/_synapse/client/pick_username + ^/_synapse/client/sso_register$ + # 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. - -Ensure that all SSO logins go to a single process (usually the main process). +Ensure that all SSO logins go to a single process. For multiple workers not handling the SSO endpoints properly, see [#7530](https://github.com/matrix-org/synapse/issues/7530). +Note that a HTTP listener with `client` and `federation` resources must be +configured in the `worker_listeners` option in the worker config. + #### Load balancing It is possible to run multiple instances of this worker app, with incoming requests