From 2965c9970c0b2742885dc345f6d70df7d5686423 Mon Sep 17 00:00:00 2001 From: Sebastian Spaeth Date: Thu, 1 May 2025 16:11:59 +0200 Subject: [PATCH] docs/workers.md: Add ^/_matrix/federation/v1/event/ to list of delegatable endpoints (#18377) --- changelog.d/18377.doc | 1 + docker/configure_workers_and_start.py | 1 + docs/upgrade.md | 10 ++++++++++ docs/workers.md | 1 + 4 files changed, 13 insertions(+) create mode 100644 changelog.d/18377.doc diff --git a/changelog.d/18377.doc b/changelog.d/18377.doc new file mode 100644 index 000000000..ceb2b64e5 --- /dev/null +++ b/changelog.d/18377.doc @@ -0,0 +1 @@ +Add `/_matrix/federation/v1/version` to list of federation endpoints that can be handled by workers. diff --git a/docker/configure_workers_and_start.py b/docker/configure_workers_and_start.py index 8f96e57e5..df34d51f7 100755 --- a/docker/configure_workers_and_start.py +++ b/docker/configure_workers_and_start.py @@ -202,6 +202,7 @@ WORKERS_CONFIG: Dict[str, Dict[str, Any]] = { "app": "synapse.app.generic_worker", "listener_resources": ["federation"], "endpoint_patterns": [ + "^/_matrix/federation/v1/version$", "^/_matrix/federation/(v1|v2)/event/", "^/_matrix/federation/(v1|v2)/state/", "^/_matrix/federation/(v1|v2)/state_ids/", diff --git a/docs/upgrade.md b/docs/upgrade.md index 07a9641fd..d508e2231 100644 --- a/docs/upgrade.md +++ b/docs/upgrade.md @@ -117,6 +117,16 @@ each upgrade are complete before moving on to the next upgrade, to avoid stacking them up. You can monitor the currently running background updates with [the Admin API](usage/administration/admin_api/background_updates.html#status). +# Upgrading to v1.130.0 + +## Documented endpoint which can be delegated to a federation worker + +The endpoint `^/_matrix/federation/v1/version$` can be delegated to a federation +worker. This is not new behaviour, but had not been documented yet. The +[list of delegatable endpoints](workers.md#synapseappgeneric_worker) has +been updated to include it. Make sure to check your reverse proxy rules if you +are using workers. + # Upgrading to v1.126.0 ## Room list publication rules change diff --git a/docs/workers.md b/docs/workers.md index 9ebcc886b..2597e7821 100644 --- a/docs/workers.md +++ b/docs/workers.md @@ -200,6 +200,7 @@ information. ^/_matrix/client/(api/v1|r0|v3)/rooms/[^/]+/initialSync$ # Federation requests + ^/_matrix/federation/v1/version$ ^/_matrix/federation/v1/event/ ^/_matrix/federation/v1/state/ ^/_matrix/federation/v1/state_ids/