summary refs log tree commit diff
path: root/docs
diff options
context:
space:
mode:
authorTravis Ralston <travpc@gmail.com>2018-04-04 08:45:51 -0600
committerTravis Ralston <travpc@gmail.com>2018-04-04 08:45:51 -0600
commit301b339494f473fddd04cad9a9b107615e9dfa8d (patch)
tree014b88e30963e8d647a4509b0fece34aa63d87a5 /docs
parentAdd a blurb explaining the main synapse worker (diff)
downloadsynapse-301b339494f473fddd04cad9a9b107615e9dfa8d.tar.xz
Move the mention of the main synapse worker higher up
Signed-off-by: Travis Ralston <travpc@gmail.com>
Diffstat (limited to '')
-rw-r--r--docs/workers.rst19
1 files changed, 6 insertions, 13 deletions
diff --git a/docs/workers.rst b/docs/workers.rst
index a5e084c22a..bf8dd1ee48 100644
--- a/docs/workers.rst
+++ b/docs/workers.rst
@@ -55,7 +55,12 @@ synapse process.)
 
 You then create a set of configs for the various worker processes.  These
 should be worker configuration files, and should be stored in a dedicated
-subdirectory, to allow synctl to manipulate them.
+subdirectory, to allow synctl to manipulate them. An additional configuration
+for the master synapse process will need to be created because the process will
+not be started automatically. That configuration should look like this::
+
+    worker_app: synapse.app.homeserver
+    daemonize: true
 
 Each worker configuration file inherits the configuration of the main homeserver
 configuration file.  You can then override configuration specific to that worker,
@@ -115,18 +120,6 @@ 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.
-
-**You must have a worker configuration for the main synapse process!**
-
 Available worker applications
 -----------------------------