summary refs log tree commit diff
path: root/docs
diff options
context:
space:
mode:
authorTravis Ralston <travpc@gmail.com>2018-02-17 21:53:46 -0700
committerTravis Ralston <travpc@gmail.com>2018-02-17 21:53:46 -0700
commit923d9300ede819aa45da546fafc240f40263e7c5 (patch)
treecc13c63fd921d8c2ab989eee22b1fd85da532859 /docs
parentMerge pull request #2882 from matrix-org/rav/fix_purge_tablescan (diff)
downloadsynapse-923d9300ede819aa45da546fafc240f40263e7c5.tar.xz
Add a blurb explaining the main synapse worker
Signed-off-by: Travis Ralston <travpc@gmail.com>
Diffstat (limited to '')
-rw-r--r--docs/workers.rst12
1 files changed, 12 insertions, 0 deletions
diff --git a/docs/workers.rst b/docs/workers.rst
index dee04bbf3e..a5e084c22a 100644
--- a/docs/workers.rst
+++ b/docs/workers.rst
@@ -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.
+
+**You must have a worker configuration for the main synapse process!**
+
 Available worker applications
 -----------------------------