Skip to content

Commit

Permalink
Clarify how this module should work in a Synapse worker deployment (#14)
Browse files Browse the repository at this point in the history
  • Loading branch information
anoadragon453 authored Feb 14, 2023
1 parent 2beb3e1 commit 85725a0
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,17 @@ modules:
accept_invites_only_for_direct_messages: false

# (For workerised Synapse deployments)
# If you want to accept invites on a specific worker, specify its instance
# name here. Otherwise, invites will be processed on the main process.
#
# Any worker can be used.
# This module should only be active on a single worker process at once,
# otherwise invites may be accepted by multiple workers simultaneously.
#
# By default, this module is only enabled on the main process, and is disabled
# on workers. To choose a worker to run this module on (to reduce load on the
# main process), specify that worker's configured 'worker_name' below.
#
# Any worker may be specified. If this worker does not have the ability to
# write to Synapse's events stream, it will end up calling out to one that
# does.
#
#worker_to_run_on: workername1
```
Expand Down

0 comments on commit 85725a0

Please sign in to comment.