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

Commit e897ff1

Browse files
committed
Update workers config for new endpoints
Add documentation for endpoints recently added (#8942, #9017, #9262)
1 parent 64f5b6c commit e897ff1

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

docs/workers.md

+10-7
Original file line numberDiff line numberDiff line change
@@ -256,25 +256,28 @@ Additionally, the following endpoints should be included if Synapse is configure
256256
to use SSO (you only need to include the ones for whichever SSO provider you're
257257
using):
258258

259+
# for all SSO providers
260+
^/_matrix/client/(api/v1|r0|unstable)/login/sso/redirect
261+
^/_synapse/client/pick_idp$
262+
^/_synapse/client/pick_username
263+
^/_synapse/client/sso_register$
264+
259265
# OpenID Connect requests.
260-
^/_matrix/client/(api/v1|r0|unstable)/login/sso/redirect$
261266
^/_synapse/oidc/callback$
262267

263268
# SAML requests.
264-
^/_matrix/client/(api/v1|r0|unstable)/login/sso/redirect$
265269
^/_matrix/saml2/authn_response$
266270

267271
# CAS requests.
268-
^/_matrix/client/(api/v1|r0|unstable)/login/(cas|sso)/redirect$
269272
^/_matrix/client/(api/v1|r0|unstable)/login/cas/ticket$
270273

271-
Note that a HTTP listener with `client` and `federation` resources must be
272-
configured in the `worker_listeners` option in the worker config.
273-
274-
Ensure that all SSO logins go to a single process (usually the main process).
274+
Ensure that all SSO logins go to a single process.
275275
For multiple workers not handling the SSO endpoints properly, see
276276
[#7530](https://github.com/matrix-org/synapse/issues/7530).
277277

278+
Note that a HTTP listener with `client` and `federation` resources must be
279+
configured in the `worker_listeners` option in the worker config.
280+
278281
#### Load balancing
279282

280283
It is possible to run multiple instances of this worker app, with incoming requests

0 commit comments

Comments
 (0)