From 87ec9540b7e69c5abcdf2e647d837c20cab63b31 Mon Sep 17 00:00:00 2001 From: villepeh <100730729+villepeh@users.noreply.github.com> Date: Tue, 28 Nov 2023 19:31:52 +0200 Subject: [PATCH 1/5] Suggest using /run instead of /var/run --- docs/usage/configuration/config_documentation.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/usage/configuration/config_documentation.md b/docs/usage/configuration/config_documentation.md index 7c4e742cd5d5..ab20e6199d86 100644 --- a/docs/usage/configuration/config_documentation.md +++ b/docs/usage/configuration/config_documentation.md @@ -566,7 +566,7 @@ listeners: # Note that x_forwarded will default to true, when using a UNIX socket. Please see # https://matrix-org.github.io/synapse/latest/reverse_proxy.html. # - - path: /var/run/synapse/main_public.sock + - path: /run/synapse/main_public.sock type: http resources: - names: [client, federation] @@ -4215,9 +4215,9 @@ Example configuration(#2, for UNIX sockets): ```yaml instance_map: main: - path: /var/run/synapse/main_replication.sock + path: /run/synapse/main_replication.sock worker1: - path: /var/run/synapse/worker1_replication.sock + path: /run/synapse/worker1_replication.sock ``` --- ### `stream_writers` @@ -4403,13 +4403,13 @@ Example configuration(#2, using UNIX sockets with a `replication` listener): ```yaml worker_listeners: - type: http - path: /var/run/synapse/worker_public.sock + path: /run/synapse/worker_replication.sock resources: - - names: [client, federation] + - names: [replication] - type: http - path: /var/run/synapse/worker_replication.sock + path: /run/synapse/worker_public.sock resources: - - names: [replication] + - names: [client, federation] ``` --- ### `worker_manhole` From 2bc52d6e9bb77bbb9f3676412af8b5a5d3c9b2f3 Mon Sep 17 00:00:00 2001 From: villepeh <100730729+villepeh@users.noreply.github.com> Date: Tue, 28 Nov 2023 19:41:40 +0200 Subject: [PATCH 2/5] Add an example HAProxy config using UNIX sockets --- docs/reverse_proxy.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/reverse_proxy.md b/docs/reverse_proxy.md index fe9519b4b624..b7e176909b94 100644 --- a/docs/reverse_proxy.md +++ b/docs/reverse_proxy.md @@ -181,7 +181,11 @@ frontend matrix-federation backend matrix server matrix 127.0.0.1:8008 ``` - +Example configuration(#2, using a UNIX socket). The configuration before the `backend` part is the same. +``` +backend matrix + server matrix unix@/run/synapse/main_public.sock +``` [Delegation](delegate.md) example: ``` From a6d5aac315f5a729044ab83e6d73450a2b6a61a2 Mon Sep 17 00:00:00 2001 From: villepeh <100730729+villepeh@users.noreply.github.com> Date: Tue, 28 Nov 2023 19:50:52 +0200 Subject: [PATCH 3/5] Create XXXXX.doc --- changelog.d/XXXXX.doc | 1 + 1 file changed, 1 insertion(+) create mode 100644 changelog.d/XXXXX.doc diff --git a/changelog.d/XXXXX.doc b/changelog.d/XXXXX.doc new file mode 100644 index 000000000000..0d55ad338a62 --- /dev/null +++ b/changelog.d/XXXXX.doc @@ -0,0 +1 @@ +Switch the example UNIX socket paths to /run. Add HAProxy example configuration for UNIX sockets. From 26f824bbbc4f4987fcb261ced018bf0fe36cf7c0 Mon Sep 17 00:00:00 2001 From: villepeh <100730729+villepeh@users.noreply.github.com> Date: Tue, 28 Nov 2023 20:01:07 +0200 Subject: [PATCH 4/5] Rename XXXXX.doc to 16700.doc --- changelog.d/{XXXXX.doc => 16700.doc} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename changelog.d/{XXXXX.doc => 16700.doc} (100%) diff --git a/changelog.d/XXXXX.doc b/changelog.d/16700.doc similarity index 100% rename from changelog.d/XXXXX.doc rename to changelog.d/16700.doc From 27a737d1ff2772ea3925a1f2d6350bd8dfb03612 Mon Sep 17 00:00:00 2001 From: villepeh <100730729+villepeh@users.noreply.github.com> Date: Tue, 28 Nov 2023 20:17:53 +0200 Subject: [PATCH 5/5] Update reverse_proxy.md --- docs/reverse_proxy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reverse_proxy.md b/docs/reverse_proxy.md index b7e176909b94..20854035d11c 100644 --- a/docs/reverse_proxy.md +++ b/docs/reverse_proxy.md @@ -181,7 +181,7 @@ frontend matrix-federation backend matrix server matrix 127.0.0.1:8008 ``` -Example configuration(#2, using a UNIX socket). The configuration before the `backend` part is the same. +Example configuration, if using a UNIX socket. The configuration lines regarding the frontends do not need to be modified. ``` backend matrix server matrix unix@/run/synapse/main_public.sock