Formatting for reverse-proxy docs (#7514)

also a small clarification to nginx
This commit is contained in:
Richard van der Hoff 2020-05-15 15:13:39 +01:00 committed by GitHub
parent 572b444dab
commit 24d9151a08
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 75 additions and 64 deletions

1
changelog.d/7514.doc Normal file
View File

@ -0,0 +1 @@
Improve the formatting of `reverse_proxy.md`.

View File

@ -34,6 +34,7 @@ the reverse proxy and the homeserver.
### nginx ### nginx
```
server { server {
listen 443 ssl; listen 443 ssl;
listen [::]:443 ssl; listen [::]:443 ssl;
@ -58,12 +59,14 @@ the reverse proxy and the homeserver.
proxy_set_header X-Forwarded-For $remote_addr; proxy_set_header X-Forwarded-For $remote_addr;
} }
} }
```
> **NOTE**: Do not add a `/` after the port in `proxy_pass`, otherwise nginx will **NOTE**: Do not add a path after the port in `proxy_pass`, otherwise nginx will
canonicalise/normalise the URI. canonicalise/normalise the URI.
### Caddy 1 ### Caddy 1
```
matrix.example.com { matrix.example.com {
proxy /_matrix http://localhost:8008 { proxy /_matrix http://localhost:8008 {
transparent transparent
@ -75,9 +78,11 @@ canonicalise/normalise the URI.
transparent transparent
} }
} }
```
### Caddy 2 ### Caddy 2
```
matrix.example.com { matrix.example.com {
reverse_proxy /_matrix/* http://localhost:8008 reverse_proxy /_matrix/* http://localhost:8008
} }
@ -85,9 +90,11 @@ canonicalise/normalise the URI.
example.com:8448 { example.com:8448 {
reverse_proxy http://localhost:8008 reverse_proxy http://localhost:8008
} }
```
### Apache ### Apache
```
<VirtualHost *:443> <VirtualHost *:443>
SSLEngine on SSLEngine on
ServerName matrix.example.com; ServerName matrix.example.com;
@ -105,11 +112,13 @@ canonicalise/normalise the URI.
ProxyPass /_matrix http://127.0.0.1:8008/_matrix nocanon ProxyPass /_matrix http://127.0.0.1:8008/_matrix nocanon
ProxyPassReverse /_matrix http://127.0.0.1:8008/_matrix ProxyPassReverse /_matrix http://127.0.0.1:8008/_matrix
</VirtualHost> </VirtualHost>
```
> **NOTE**: ensure the `nocanon` options are included. **NOTE**: ensure the `nocanon` options are included.
### HAProxy ### HAProxy
```
frontend https frontend https
bind :::443 v4v6 ssl crt /etc/ssl/haproxy/ strict-sni alpn h2,http/1.1 bind :::443 v4v6 ssl crt /etc/ssl/haproxy/ strict-sni alpn h2,http/1.1
@ -125,6 +134,7 @@ canonicalise/normalise the URI.
backend matrix backend matrix
server matrix 127.0.0.1:8008 server matrix 127.0.0.1:8008
```
## Homeserver Configuration ## Homeserver Configuration