summary refs log tree commit diff
path: root/docs
diff options
context:
space:
mode:
authorRichard van der Hoff <1389908+richvdh@users.noreply.github.com>2018-04-05 17:33:09 +0100
committerGitHub <noreply@github.com>2018-04-05 17:33:09 +0100
commit551422051b703a142c8ba5146392ebad4a7ee771 (patch)
treed962cb150448d5efb9f6ee33986af26e19366145 /docs
parentMerge pull request #2986 from jplatte/join_reponse_room_id (diff)
parentMerge remote-tracking branch 'matrix-org/develop' into travis/new-worker-docs (diff)
downloadsynapse-551422051b703a142c8ba5146392ebad4a7ee771.tar.xz
Merge pull request #2886 from turt2live/travis/new-worker-docs
Add a blurb explaining the main synapse worker
Diffstat (limited to 'docs')
-rw-r--r--docs/workers.rst11
1 files changed, 9 insertions, 2 deletions
diff --git a/docs/workers.rst b/docs/workers.rst
index 80f8d2181a..1d521b9ec5 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,
@@ -230,9 +235,11 @@ file. For example::
 ``synapse.app.event_creator``
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Handles non-state event creation. It can handle REST endpoints matching::
+Handles some event creation. It can handle REST endpoints matching::
 
     ^/_matrix/client/(api/v1|r0|unstable)/rooms/.*/send
+    ^/_matrix/client/(api/v1|r0|unstable)/rooms/.*/(join|invite|leave|ban|unban|kick)$
+    ^/_matrix/client/(api/v1|r0|unstable)/join/
 
 It will create events locally and then send them on to the main synapse
 instance to be persisted and handled.