From 74007ef5eee52d565048a68f870200c84a3e5721 Mon Sep 17 00:00:00 2001 From: richvdh Date: Wed, 7 Jul 2021 09:44:14 +0000 Subject: deploy: 7c823789921ac34f1fee670be7ef7f6c8266832b --- latest/synctl_workers.html | 278 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 278 insertions(+) create mode 100644 latest/synctl_workers.html (limited to 'latest/synctl_workers.html') diff --git a/latest/synctl_workers.html b/latest/synctl_workers.html new file mode 100644 index 0000000000..7ba3aea0c8 --- /dev/null +++ b/latest/synctl_workers.html @@ -0,0 +1,278 @@ + + + + + + Using synctl with Workers - Synapse + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + + + + + + +
+
+ +
+ +
+ +

Using synctl with workers

+

If you want to use synctl to manage your synapse processes, you will need to +create an an additional configuration file for the main synapse process. That +configuration should look like this:

+
worker_app: synapse.app.homeserver
+
+

Additionally, each worker app must be configured with the name of a "pid file", +to which it will write its process ID when it starts. For example, for a +synchrotron, you might write:

+
worker_pid_file: /home/matrix/synapse/worker1.pid
+
+

Finally, to actually run your worker-based synapse, you must pass synctl the -a +commandline option to tell it to operate on all the worker configurations found +in the given directory, e.g.:

+
synctl -a $CONFIG/workers start
+
+

Currently one should always restart all workers when restarting or upgrading +synapse, unless you explicitly know it's safe not to. For instance, restarting +synapse without restarting all the synchrotrons may result in broken typing +notifications.

+

To manipulate a specific worker, you pass the -w option to synctl:

+
synctl -w $CONFIG/workers/worker1.yaml restart
+
+ +
+ + +
+
+ + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file -- cgit 1.5.1