-
-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Add a blurb explaining the main synapse worker #2886
Conversation
Signed-off-by: Travis Ralston <[email protected]>
Can one of the admins verify this patch? |
1 similar comment
Can one of the admins verify this patch? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thanks very much for this, travis. sorry that the docs were lagging here.
It feels a bit odd to put this doc at the end of the configuration section though - surely it's needed as a prerequisite for setting up any workers at all?
docs/workers.rst
Outdated
|
||
Be sure to keep this particular configuration limited as synapse may refuse to | ||
start if the regular ``worker_*`` options are given. The ``homeserver.yaml`` | ||
configuration will be used to set up the main synapse process. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
isn't homeserver.yaml used for all of the processes?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It is, however the main worker is different in that it refuses to work with the standard worker_* options. I wanted to add a reminder that the homeserver.yaml is used instead.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think your phrasing is a bit misleading then.
The only reason it's at the end of the section is because everything before it talks about how workers are supposed to work. I'll update this to work it in more prominently though |
Signed-off-by: Travis Ralston <[email protected]>
Fixes matrix-org#3018 Signed-off-by: Travis Ralston <[email protected]>
\o/ |
While setting this up I ran into a couple issues that should hopefully be resolved by the documentation in this PR:
worker_*
config options (because copy/paste is a thing)