summary refs log tree commit diff
diff options
context:
space:
mode:
authorRichard van der Hoff <1389908+richvdh@users.noreply.github.com>2021-08-27 12:54:21 +0100
committerGitHub <noreply@github.com>2021-08-27 12:54:21 +0100
commit051ddac53b733e5768488bac7548a0c31bf68982 (patch)
tree5413234aec1ecd20d16f4c5345e669b67d4720f1
parentRemove unused `compare_digest` function. (#10706) (diff)
downloadsynapse-051ddac53b733e5768488bac7548a0c31bf68982.tar.xz
Clarifications to reverse_proxy.md (#10708)
* Update reverse_proxy.md

* Create 10708.doc
Diffstat (limited to '')
-rw-r--r--changelog.d/10708.doc1
-rw-r--r--docs/reverse_proxy.md10
2 files changed, 6 insertions, 5 deletions
diff --git a/changelog.d/10708.doc b/changelog.d/10708.doc
new file mode 100644
index 0000000000..99f9d69288
--- /dev/null
+++ b/changelog.d/10708.doc
@@ -0,0 +1 @@
+Minor clarifications to the documentation for reverse proxies.
diff --git a/docs/reverse_proxy.md b/docs/reverse_proxy.md
index 5f8d20129e..bc351d604e 100644
--- a/docs/reverse_proxy.md
+++ b/docs/reverse_proxy.md
@@ -64,6 +64,9 @@ server {
     server_name matrix.example.com;
 
     location ~* ^(\/_matrix|\/_synapse\/client) {
+        # note: do not add a path (even a single /) after the port in `proxy_pass`,
+        # otherwise nginx will canonicalise the URI and cause signature verification
+        # errors.
         proxy_pass http://localhost:8008;
         proxy_set_header X-Forwarded-For $remote_addr;
         proxy_set_header X-Forwarded-Proto $scheme;
@@ -76,10 +79,7 @@ server {
 }
 ```
 
-**NOTE**: Do not add a path after the port in `proxy_pass`, otherwise nginx will
-canonicalise/normalise the URI.
-
-### Caddy 1
+### Caddy v1
 
 ```
 matrix.example.com {
@@ -99,7 +99,7 @@ example.com:8448 {
 }
 ```
 
-### Caddy 2
+### Caddy v2
 
 ```
 matrix.example.com {