Add sample worker files for pusher and federation_sender (#14077)

Signed-off-by: Dirk Klimpel <dirk@klimpel.org>
matrix-org · Oct 7, 2022 · 0adecca · 0adecca
1 parent 2295095
commit 0adecca
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 0 deletions.
diff --git a/changelog.d/14077.doc b/changelog.d/14077.doc
@@ -0,0 +1 @@
+Add sample worker files for `pusher` and `federation_sender`.
diff --git a/docs/systemd-with-workers/workers/federation_sender.yaml 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
@@ -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
@@ -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:
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Add sample worker files for `pusher` and `federation_sender`.