diff options
| author | Jonathan de Jong <jonathan@automatia.nl> | 2022-03-23 13:47:07 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-03-23 12:47:07 +0000 |
| commit | c5776780f0621eb9440277cfd9ffd41b1443f34e (patch) | |
| tree | 30925eec6c819606fe4e5cb4a3b26ee56740bb1a /docs/workers.md | |
| parent | Allow registering admin users using the module API (#12250) (diff) | |
| download | synapse-c5776780f0621eb9440277cfd9ffd41b1443f34e.tar.xz | |
Remove mutual_rooms `update_user_directory` check, and add extra documentation (#12038)
Resolves #10339
Diffstat (limited to 'docs/workers.md')
| -rw-r--r-- | docs/workers.md | 11 |
1 files changed, 10 insertions, 1 deletions
diff --git a/docs/workers.md b/docs/workers.md index 9eb4194e4d..8ac95e39bb 100644 --- a/docs/workers.md +++ b/docs/workers.md @@ -528,10 +528,19 @@ the following regular expressions: ^/_matrix/client/(r0|v3|unstable)/user_directory/search$ -When using this worker you must also set `update_user_directory: False` in the +When using this worker you must also set `update_user_directory: false` in the shared configuration file to stop the main synapse running background jobs related to updating the user directory. +Above endpoint is not *required* to be routed to this worker. By default, +`update_user_directory` is set to `true`, which means the main process +will handle updates. All workers configured with `client` can handle the above +endpoint as long as either this worker or the main process are configured to +handle it, and are online. + +If `update_user_directory` is set to `false`, and this worker is not running, +the above endpoint may give outdated results. + ### `synapse.app.frontend_proxy` Proxies some frequently-requested client endpoints to add caching and remove |