From 923d9300ede819aa45da546fafc240f40263e7c5 Mon Sep 17 00:00:00 2001
From: Travis Ralston <travpc@gmail.com>
Date: Sat, 17 Feb 2018 21:53:46 -0700
Subject: [PATCH] Add a blurb explaining the main synapse worker
Signed-off-by: Travis Ralston <travpc@gmail.com>
---
docs/workers.rst | 12 ++++++++++++
1 file changed, 12 insertions(+)
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
-----------------------------
--
GitLab