diff options
| author | Patrick Cloke <clokep@users.noreply.github.com> | 2020-10-02 08:23:15 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-10-02 08:23:15 -0400 |
| commit | 62894673e69f7beb0d0a748ad01c2e95c5fed106 (patch) | |
| tree | f3f70c95bc635045e833f8a62e1572258dee3bf9 /docs | |
| parent | Merge tag 'v1.21.0rc2' into develop (diff) | |
| download | synapse-62894673e69f7beb0d0a748ad01c2e95c5fed106.tar.xz | |
Allow background tasks to be run on a separate worker. (#8369)
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/sample_config.yaml | 5 | ||||
| -rw-r--r-- | docs/workers.md | 17 |
2 files changed, 22 insertions, 0 deletions
diff --git a/docs/sample_config.yaml b/docs/sample_config.yaml index b2c1d7a737..7126ade2de 100644 --- a/docs/sample_config.yaml +++ b/docs/sample_config.yaml @@ -2504,6 +2504,11 @@ opentracing: # events: worker1 # typing: worker1 +# The worker that is used to run background tasks (e.g. cleaning up expired +# data). If not provided this defaults to the main process. +# +#run_background_tasks_on: worker1 + # Configuration for Redis when using workers. This *must* be enabled when # using workers (unless using old style direct TCP configuration). 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` |