summary refs log tree commit diff
path: root/docs/workers.md
diff options
context:
space:
mode:
authorErik Johnston <erik@matrix.org>2020-10-13 13:29:50 +0100
committerErik Johnston <erik@matrix.org>2020-10-13 13:29:50 +0100
commit43bcb1e54ecb89806529b8daf8d87369f74e9b5f (patch)
treede76fa57336d6b9bbf45f943a6dac6d8e9424e3c /docs/workers.md
parentblock membership events from spammy freenode bridge (diff)
parentMove additional tasks to the background worker, part 4 (#8513) (diff)
downloadsynapse-43bcb1e54ecb89806529b8daf8d87369f74e9b5f.tar.xz
Merge remote-tracking branch 'origin/develop' into matrix-org-hotfixes
Diffstat (limited to 'docs/workers.md')
-rw-r--r--docs/workers.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/docs/workers.md b/docs/workers.md

index ad4d8ca9f2..84a9759e34 100644 --- a/docs/workers.md +++ b/docs/workers.md
@@ -319,6 +319,23 @@ stream_writers: events: event_persister1 ``` +#### Background tasks + +There is also *experimental* support for moving background tasks to a separate +worker. Background tasks are run periodically or started via replication. Exactly +which tasks are configured to run depends on your Synapse configuration (e.g. if +stats is enabled). + +To enable this, the worker must have a `worker_name` and can be configured to run +background tasks. For example, to move background tasks to a dedicated worker, +the shared configuration would include: + +```yaml +run_background_tasks_on: background_worker +``` + +You might also wish to investigate the `update_user_directory` and +`media_instance_running_background_jobs` settings. ### `synapse.app.pusher`