about summary refs log tree commit diff
path: root/nixos/modules/services/matrix
diff options
context:
space:
mode:
authorSophie Tauchert <sophie.tauchert@relaxdays.de>2023-09-14 09:34:34 +0200
committerSophie Tauchert <sophie@999eagle.moe>2023-09-18 08:24:38 +0200
commitaed8a5c6cd849a8fa819ccdbd6877915227d500a (patch)
tree40bc91dbd401346e278deda4b26457e4ccd6559a /nixos/modules/services/matrix
parent6b95c618e231487a3cd105b59d3f7df199abcd4b (diff)
nixos/synapse: add documentation for required reverse proxy setup
Diffstat (limited to 'nixos/modules/services/matrix')
-rw-r--r--nixos/modules/services/matrix/synapse.nix6
1 files changed, 6 insertions, 0 deletions
diff --git a/nixos/modules/services/matrix/synapse.nix b/nixos/modules/services/matrix/synapse.nix
index e49c0d12a4f46..0ece1cb48ce01 100644
--- a/nixos/modules/services/matrix/synapse.nix
+++ b/nixos/modules/services/matrix/synapse.nix
@@ -850,6 +850,12 @@ in {
 
             A redis server is required for running workers. A local one can be enabled
             using [`services.matrix-synapse.configureRedisLocally`](#opt-services.matrix-synapse.configureRedisLocally).
+
+            Workers also require a proper reverse proxy setup to direct incoming requests to the appropriate process. See
+            the [reverse proxy documentation](https://matrix-org.github.io/synapse/latest/reverse_proxy.html) for a
+            general reverse proxying setup and
+            the [worker documentation](https://matrix-org.github.io/synapse/latest/workers.html#available-worker-applications)
+            for the available endpoints per worker application.
           :::
         '';
         type = types.attrsOf (types.submodule ({name, ...}: {