diff options
| author | richvdh <richvdh@users.noreply.github.com> | 2021-08-09 15:13:21 +0000 |
|---|---|---|
| committer | richvdh <richvdh@users.noreply.github.com> | 2021-08-09 15:13:21 +0000 |
| commit | 589a5c1756b805cde8b95b7d1328ce73066bd0fa (patch) | |
| tree | b10d5a11651a19c6bac6345cada5bd99b76ef92c /develop/print.html | |
| parent | deploy: 74d7336686e7de1d0923d67af61b510ec801fa84 (diff) | |
| download | synapse-589a5c1756b805cde8b95b7d1328ce73066bd0fa.tar.xz | |
deploy: 189c055eb6d8a0db7aa520ecec23819d15bfaa26
Diffstat (limited to 'develop/print.html')
| -rw-r--r-- | develop/print.html | 15 |
1 files changed, 8 insertions, 7 deletions
diff --git a/develop/print.html b/develop/print.html index 8e0e68c76a..cb2d07ee7d 100644 --- a/develop/print.html +++ b/develop/print.html @@ -864,6 +864,14 @@ Beware that Apache <em>will</em> canonicalise URIs unless you specify <code>https://matrix.example.com</code>, and other servers to connect at <code>https://example.com:8448</code>. The following sections detail the configuration of the reverse proxy and the homeserver.</p> +<h2 id="homeserver-configuration"><a class="header" href="#homeserver-configuration">Homeserver Configuration</a></h2> +<p>The HTTP configuration will need to be updated for Synapse to correctly record +client IP addresses and generate redirect URLs while behind a reverse proxy. </p> +<p>In <code>homeserver.yaml</code> set <code>x_forwarded: true</code> in the port 8008 section and +consider setting <code>bind_addresses: ['127.0.0.1']</code> so that the server only +listens to traffic on localhost. (Do not change <code>bind_addresses</code> to <code>127.0.0.1</code> +when using a containerized Synapse, as that will prevent it from responding +to proxied traffic.)</p> <h2 id="reverse-proxy-configuration-examples"><a class="header" href="#reverse-proxy-configuration-examples">Reverse-proxy configuration examples</a></h2> <p><strong>NOTE</strong>: You only need one of these.</p> <h3 id="nginx"><a class="header" href="#nginx">nginx</a></h3> @@ -1043,13 +1051,6 @@ relay "matrix_federation" { forward to <matrixserver> port 8008 check tcp } </code></pre> -<h2 id="homeserver-configuration"><a class="header" href="#homeserver-configuration">Homeserver Configuration</a></h2> -<p>You will also want to set <code>bind_addresses: ['127.0.0.1']</code> and -<code>x_forwarded: true</code> for port 8008 in <code>homeserver.yaml</code> to ensure that -client IP addresses are recorded correctly.</p> -<p>Having done so, you can then use <code>https://matrix.example.com</code> (instead -of <code>https://matrix.example.com:8448</code>) as the "Custom server" when -connecting to Synapse from a client.</p> <h2 id="health-check-endpoint"><a class="header" href="#health-check-endpoint">Health check endpoint</a></h2> <p>Synapse exposes a health check endpoint for use by reverse proxies. Each configured HTTP listener has a <code>/health</code> endpoint which always returns |