Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Commit

Permalink
Update documentation to reflect that run_background_tasks_on is no …
Browse files Browse the repository at this point in the history
…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
  • Loading branch information
reivilibre authored Apr 14, 2022
1 parent 960b4fb commit 7efddbe
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 4 deletions.
1 change: 1 addition & 0 deletions changelog.d/12451.doc
Original file line number Diff line number Diff line change
@@ -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 changes: 4 additions & 4 deletions docs/workers.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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).
Expand Down

0 comments on commit 7efddbe

Please sign in to comment.