Clarifications to reverse_proxy.md (#10708)

* Update reverse_proxy.md * Create 10708.doc
matrix-org · Aug 27, 2021 · 051ddac · 051ddac
1 parent 029b7ad
commit 051ddac
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 5 deletions.
diff --git a/changelog.d/10708.doc 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
@@ -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 {
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Minor clarifications to the documentation for reverse proxies.