summary refs log tree commit diff
path: root/docs
diff options
context:
space:
mode:
authorDirk Klimpel <5740567+dklimpel@users.noreply.github.com>2022-10-07 15:25:28 +0200
committerGitHub <noreply@github.com>2022-10-07 14:25:28 +0100
commit0adeccafc651f9fe0eae4fe4d67229b9be9ed7b9 (patch)
treec9b9b2175c29dfc7fc1bd36b1685154e7e98046a /docs
parentUse Pydantic to validate /devices endpoints (#14054) (diff)
downloadsynapse-0adeccafc651f9fe0eae4fe4d67229b9be9ed7b9.tar.xz
Add sample worker files for `pusher` and `federation_sender` (#14077)
Signed-off-by: Dirk Klimpel <dirk@klimpel.org>
Diffstat (limited to '')
-rw-r--r--docs/systemd-with-workers/workers/federation_sender.yaml8
-rw-r--r--docs/systemd-with-workers/workers/pusher_worker.yaml8
-rw-r--r--docs/workers.md12
3 files changed, 28 insertions, 0 deletions
diff --git a/docs/systemd-with-workers/workers/federation_sender.yaml b/docs/systemd-with-workers/workers/federation_sender.yaml
new file mode 100644
index 0000000000..5c591aec2c
--- /dev/null
+++ b/docs/systemd-with-workers/workers/federation_sender.yaml
@@ -0,0 +1,8 @@
+worker_app: synapse.app.federation_sender
+worker_name: federation_sender1
+
+# The replication listener on the main synapse process.
+worker_replication_host: 127.0.0.1
+worker_replication_http_port: 9093
+
+worker_log_config: /etc/matrix-synapse/federation-sender-log.yaml
diff --git a/docs/systemd-with-workers/workers/pusher_worker.yaml b/docs/systemd-with-workers/workers/pusher_worker.yaml
new file mode 100644
index 0000000000..46e22c6f06
--- /dev/null
+++ b/docs/systemd-with-workers/workers/pusher_worker.yaml
@@ -0,0 +1,8 @@
+worker_app: synapse.app.pusher
+worker_name: pusher_worker1
+
+# The replication listener on the main synapse process.
+worker_replication_host: 127.0.0.1
+worker_replication_http_port: 9093
+
+worker_log_config: /etc/matrix-synapse/pusher-worker-log.yaml
diff --git a/docs/workers.md b/docs/workers.md
index 25f2e13237..27041ea57c 100644
--- a/docs/workers.md
+++ b/docs/workers.md
@@ -488,6 +488,12 @@ pusher_instances:
     - pusher_worker2
 ```
 
+An example for a pusher instance:
+
+```yaml
+{{#include systemd-with-workers/workers/pusher_worker.yaml}}
+```
+
 
 ### `synapse.app.appservice`
 
@@ -518,6 +524,12 @@ federation_sender_instances:
     - federation_sender2
 ```
 
+An example for a federation sender instance:
+
+```yaml
+{{#include systemd-with-workers/workers/federation_sender.yaml}}
+```
+
 ### `synapse.app.media_repository`
 
 Handles the media repository. It can handle all endpoints starting with: