pub-solar/matrix-docker-ansible-deploy
5
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

Merge pull request #1957 from mholt/patch-1

Browse source 
Update configuring-well-known.md
This commit is contained in:
Slavi Pantaleev 2022-07-21 10:30:34 +03:00 committed by GitHub
parent 4f4646dabd 9e87f9d885
commit b9d7e24859
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 33 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

46
docs/configuring-well-known.md
View file

@ -15,7 +15,7 @@ All services created by this playbook are meant to be installed on their own ser
As [per the Server-Server specification](https://matrix.org/docs/spec/server_server/r0.1.0.html#server-discovery), to use a Matrix user identifier like `@<username>:<your-domain>` while hosting services on a subdomain like `matrix.<your-domain>`, the Matrix network needs to be instructed of such delegation/redirection. As [per the Server-Server specification](https://matrix.org/docs/spec/server_server/r0.1.0.html#server-discovery), to use a Matrix user identifier like `@<username>:<your-domain>` while hosting services on a subdomain like `matrix.<your-domain>`, the Matrix network needs to be instructed of such delegation/redirection.
Server delegation can be configured using DNS SRV records or by setting up a `/.well-known/matrix/server` file on the base domain (`<your-domain.com>`). Server delegation can be configured using DNS SRV records or by setting up a `/.well-known/matrix/server` file on the base domain (`<your-domain>`).
Both methods have their place and will continue to do so. You only need to use just one of these delegation methods. Both methods have their place and will continue to do so. You only need to use just one of these delegation methods.
For simplicity reasons, our setup advocates for the `/.well-known/matrix/server` method and guides you into using that. For simplicity reasons, our setup advocates for the `/.well-known/matrix/server` method and guides you into using that.
@ -116,12 +116,12 @@ With this method, you **don't need** to add special HTTP headers for [CORS](http
**For nginx**, it would be something like this: **For nginx**, it would be something like this:
```nginx ```nginx
# This is your HTTPS-enabled server for DOMAIN. # This is your HTTPS-enabled server for example.com.
server { server {
server_name DOMAIN; server_name example.com;
location /.well-known/matrix { location /.well-known/matrix {
proxy_pass https://matrix.DOMAIN/.well-known/matrix; proxy_pass https://matrix.example.com/.well-known/matrix;
proxy_set_header X-Forwarded-For $remote_addr; proxy_set_header X-Forwarded-For $remote_addr;
} }
@ -133,11 +133,11 @@ server {
```apache ```apache
<VirtualHost *:443> <VirtualHost *:443>
ServerName DOMAIN ServerName example.com
SSLProxyEngine on SSLProxyEngine on
ProxyPass /.well-known/matrix https://matrix.DOMAIN/.well-known/matrix nocanon ProxyPass /.well-known/matrix https://matrix.example.com/.well-known/matrix nocanon
ProxyPassReverse /.well-known/matrix https://matrix.DOMAIN/.well-known/matrix nocanon ProxyPassReverse /.well-known/matrix https://matrix.example.com/.well-known/matrix nocanon
# other configuration # other configuration
</VirtualHost> </VirtualHost>
@ -146,30 +146,10 @@ server {
**For Caddy 2**, it would be something like this: **For Caddy 2**, it would be something like this:
```caddy ```caddy
DOMAIN.com { example.com {
@wellknown { reverse_proxy /.well-known/matrix/* https://matrix.example.com {
path /.well-known/matrix/*:x header_up Host {upstream_hostport}
} }
handle @wellknown {
reverse_proxy https://matrix.DOMAIN.com {
header_up Host {http.reverse_proxy.upstream.hostport}
}
}
# Configration for the base domain goes here
# handle {
# header -Server
# encode zstd gzip
# reverse_proxy localhost:4020
# }
}
```
**For Caddy 1**, it would be something like this:
```caddy
proxy /.well-known/matrix/ https://matrix.DOMAIN {
header_upstream Host {http.reverse_proxy.upstream.hostport}
} }
``` ```
@ -196,7 +176,7 @@ backend matrix-backend
``` ```
# In the _redirects file in the website's root # In the _redirects file in the website's root
/.well-known/matrix/* https://matrix.DOMAIN/.well-known/matrix/:splat 200! /.well-known/matrix/* https://matrix.example.com/.well-known/matrix/:splat 200!
``` ```
**For AWS CloudFront** **For AWS CloudFront**
@ -206,7 +186,7 @@ backend matrix-backend
Make sure to: Make sure to:
- **replace `DOMAIN`** in the server configuration with your actual domain name - **replace `example.com`** in the server configuration with your actual domain name
- and: to **do this for the HTTPS-enabled server block**, as that's where Matrix expects the file to be - and: to **do this for the HTTPS-enabled server block**, as that's where Matrix expects the file to be