From 2940bec64501e21181ae38b393d8409b5f0060d5 Mon Sep 17 00:00:00 2001 From: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com> Date: Wed, 17 Nov 2021 12:13:24 +0000 Subject: Remove erroneous v1.45.0 docs folder (#11367) --- v1.45.0/synctl_workers.html | 278 -------------------------------------------- 1 file changed, 278 deletions(-) delete mode 100644 v1.45.0/synctl_workers.html (limited to 'v1.45.0/synctl_workers.html') diff --git a/v1.45.0/synctl_workers.html b/v1.45.0/synctl_workers.html deleted file mode 100644 index 036ba07688..0000000000 --- a/v1.45.0/synctl_workers.html +++ /dev/null @@ -1,278 +0,0 @@ - - - - - - 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