diff options
| author | reivilibre <oliverw@matrix.org> | 2022-04-14 15:25:22 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-04-14 15:25:22 +0100 |
| commit | 7efddbebefbadce3e5f0938ea123e7e37ad2503c (patch) | |
| tree | b414b4555e9b8faf3858ed54ad976f322aa67f7e | |
| parent | complement-synapse-workers: factor out separate entry point script (#12467) (diff) | |
| download | synapse-7efddbebefbadce3e5f0938ea123e7e37ad2503c.tar.xz | |
Update documentation to reflect that `run_background_tasks_on` is no longer experimental. (#12451)
* Background workers aren't experimental anymore * Newsfile Signed-off-by: Olivier Wilkinson (reivilibre) <oliverw@matrix.org> * Stream writers aren't experimental either
Diffstat (limited to '')
| -rw-r--r-- | changelog.d/12451.doc | 1 | ||||
| -rw-r--r-- | docs/workers.md | 8 |
2 files changed, 5 insertions, 4 deletions
diff --git a/changelog.d/12451.doc b/changelog.d/12451.doc new file mode 100644 index 0000000000..c8b23c1285 --- /dev/null +++ b/changelog.d/12451.doc @@ -0,0 +1 @@ +Update documentation to reflect that both the `run_background_tasks_on` option and the options for moving stream writers off of the main process are no longer experimental. diff --git a/docs/workers.md b/docs/workers.md index 446b7e5064..858411b15e 100644 --- a/docs/workers.md +++ b/docs/workers.md @@ -341,9 +341,9 @@ effects of bursts of events from that bridge on events sent by normal users. #### Stream writers -Additionally, there is *experimental* support for moving writing of specific -streams (such as events) off of the main process to a particular worker. (This -is only supported with Redis-based replication.) +Additionally, the writing of specific streams (such as events) can be moved off +of the main process to a particular worker. +(This is only supported with Redis-based replication.) To enable this, the worker must have a HTTP replication listener configured, have a `worker_name` and be listed in the `instance_map` config. The same worker @@ -420,7 +420,7 @@ the stream writer for the `presence` stream: #### Background tasks -There is also *experimental* support for moving background tasks to a separate +There is also 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). |