summary refs log tree commit diff
path: root/docs/workers.md
diff options
context:
space:
mode:
authorSami Olmari <sami@olmari.fi>2022-05-19 14:03:12 +0300
committerGitHub <noreply@github.com>2022-05-19 12:03:12 +0100
commit47619017f97e04733e2a2fe511d6865d0294f063 (patch)
tree65f15945f56c31178d74e0e820df7f3c8c98a90d /docs/workers.md
parentopenid.md: fix some links (diff)
downloadsynapse-47619017f97e04733e2a2fe511d6865d0294f063.tar.xz
Add missing user directory search endpoint to the generic worker documentation (#12773)
Signed-off-by: Sami Olmari <sami@olmari.fi>
Diffstat (limited to 'docs/workers.md')
-rw-r--r--docs/workers.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/docs/workers.md b/docs/workers.md

index 553792d238..779069b817 100644 --- a/docs/workers.md +++ b/docs/workers.md
@@ -251,6 +251,8 @@ information. # Presence requests ^/_matrix/client/(api/v1|r0|v3|unstable)/presence/ + # User directory search requests + ^/_matrix/client/(r0|v3|unstable)/user_directory/search$ Additionally, the following REST endpoints can be handled for GET requests: @@ -448,6 +450,14 @@ update_user_directory_from_worker: worker_name This work cannot be load-balanced; please ensure the main process is restarted after setting this option in the shared configuration! +User directory updates allow REST endpoints matching the following regular +expressions to work: + + ^/_matrix/client/(r0|v3|unstable)/user_directory/search$ + +The above endpoints can be routed to any worker, though you may choose to route +it to the chosen user directory worker. + This style of configuration supersedes the legacy `synapse.app.user_dir` worker application type.