summary refs log tree commit diff
path: root/docs
diff options
context:
space:
mode:
authorMateusz Reszka <mateusz.reszka@outlook.com>2025-06-04 22:44:25 +0200
committerGitHub <noreply@github.com>2025-06-04 20:44:25 +0000
commit586b82e5800d8a4811b44cef49298cfacacb2ba7 (patch)
tree2a9f31f2a76bf3d8bf67477d10ea45fc77d38066 /docs
parentAdd ratelimit callbacks to module API to allow dynamic ratelimiting (#18458) (diff)
downloadsynapse-586b82e5800d8a4811b44cef49298cfacacb2ba7.tar.xz
Propose `CAP_NET_BIND_SERVICE` instead running Synapse with root (#18408)
There are alternative ways to use low numbered ports besides root. Users
might be mislead into thinking they should run Synapse with root
privileges.
Diffstat (limited to 'docs')
-rw-r--r--docs/reverse_proxy.md8
1 files changed, 4 insertions, 4 deletions
diff --git a/docs/reverse_proxy.md b/docs/reverse_proxy.md

index 45de2b1f65..f871a39939 100644 --- a/docs/reverse_proxy.md +++ b/docs/reverse_proxy.md
@@ -5,10 +5,10 @@ It is recommended to put a reverse proxy such as [Apache](https://httpd.apache.org/docs/current/mod/mod_proxy_http.html), [Caddy](https://caddyserver.com/docs/quick-starts/reverse-proxy), [HAProxy](https://www.haproxy.org/) or -[relayd](https://man.openbsd.org/relayd.8) in front of Synapse. One advantage -of doing so is that it means that you can expose the default https port -(443) to Matrix clients without needing to run Synapse with root -privileges. +[relayd](https://man.openbsd.org/relayd.8) in front of Synapse. +This has the advantage of being able to expose the default HTTPS port (443) to Matrix +clients without requiring Synapse to bind to a privileged port (port numbers less than +1024), avoiding the need for `CAP_NET_BIND_SERVICE` or running as root. You should configure your reverse proxy to forward requests to `/_matrix` or `/_synapse/client` to Synapse, and have it set the `X-Forwarded-For` and