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

Add a blurb explaining the main synapse worker #2886

Merged
merged 4 commits into from
Apr 5, 2018
Merged

Add a blurb explaining the main synapse worker #2886

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
923d930
Add a blurb explaining the main synapse worker
turt2live Feb 18, 2018
301b339
Move the mention of the main synapse worker higher up
turt2live Apr 4, 2018
204fc98
Document the additional routes for the event_creator worker
turt2live Apr 4, 2018
88964b9
Merge remote-tracking branch 'matrix-org/develop' into travis/new-wor…
turt2live Apr 4, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions docs/workers.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,18 @@ To manipulate a specific worker, you pass the -w option to synctl::
synctl -w $CONFIG/workers/synchrotron.yaml restart


After setting up your workers, you'll need to create a worker configuration for
the main synapse process. That worker configuration should look like this:::

worker_app: synapse.app.homeserver
daemonize: true

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.
Copy link
Member

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?

Copy link
Member Author

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.

Copy link
Member

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.


**You must have a worker configuration for the main synapse process!**

Available worker applications
-----------------------------

Expand Down