Mirrors
/
synapse-old
mirror of https://github.com/matrix-org/synapse.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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
This commit is contained in:
reivilibre 2022-04-14 15:25:22 +01:00 committed by GitHub
parent 960b4fb409
commit 7efddbebef
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
changelog.d/12451.doc Normal file
View File

@ -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.

8
docs/workers.md
View File

@ -341,9 +341,9 @@ effects of bursts of events from that bridge on events sent by normal users.
#### Stream writers #### Stream writers
Additionally, there is *experimental* support for moving writing of specific Additionally, the writing of specific streams (such as events) can be moved off
streams (such as events) off of the main process to a particular worker. (This of the main process to a particular worker.
is only supported with Redis-based replication.) (This is only supported with Redis-based replication.)
To enable this, the worker must have a HTTP replication listener configured, 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 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 #### 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 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 which tasks are configured to run depends on your Synapse configuration (e.g. if
stats is enabled). stats is enabled).