Matrix-Mirrors/synapse-product
1
0
Fork 0
mirror of https://git.anonymousland.org/anonymousland/synapse-product.git synced 2024-10-01 08:25:44 -04:00
Code Issues Packages Projects Releases Wiki Activity

Incorporate review

Browse Source
This commit is contained in:
Brendan Abolivier 2020-02-18 17:20:03 +00:00
parent a0d2f9d089
commit 61b457e3ec
No known key found for this signature in database
GPG Key ID: 1E015C145F1916CD
2 changed files with 17 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
docs/delegate.md
View File

@ -1,14 +1,13 @@
# Delegation # Delegation
For a more flexible configuration, you can have `server_name` Without configuring delegation, homeservers will expect the server
resources (eg: `@user:example.com`) served by a different host and responsible for resources using e.g. `example.com` as their `server_name`
port (eg: `synapse.example.com:443`). (e.g. `@user:example.com`) to be served at `example.com:8448`.
Without configuring delegation, the matrix federation will Delegation is a Matrix feature allowing a homeserver admin to retain a
expect to find your server via `example.com:8448`. The following methods `server_name` of `example.com` so that your user IDs, room aliases, etc
allow you retain a `server_name` of `example.com` so that your user IDs, room continue to look like `*:example.com`, whilst having your federation
aliases, etc continue to look like `*:example.com`, whilst having your traffic routed to a different server and/or port (e.g. `synapse.example.com:443`).
federation traffic routed to a different server (e.g. `synapse.example.com`).
## .well-known delegation ## .well-known delegation
@ -38,11 +37,8 @@ should return:
Note, specifying a port is optional. If no port is specified, then it defaults Note, specifying a port is optional. If no port is specified, then it defaults
to 8448. to 8448.
Most installations will not need to configure .well-known. However, it can be With .well-known, federation servers will check for a valid TLS certificate
useful in cases where the admin is hosting on behalf of someone else and for the delegated hostname (in our example: `synapse.example.com`).
therefore cannot gain access to the necessary certificate. With .well-known,
federation servers will check for a valid TLS certificate for the delegated
hostname (in our example: `synapse.example.com`).
## SRV DNS record delegation ## SRV DNS record delegation

16
docs/federate.md
View File

@ -17,13 +17,13 @@ on port 8448. The preferred way to do that is by using a reverse proxy,
see [reverse_proxy.md](<reverse_proxy.md>) for instructions on how to see [reverse_proxy.md](<reverse_proxy.md>) for instructions on how to
correctly set one up. correctly set one up.
In some cases you might not want Synapse to be running on the machine that In some cases you might not want to run Synapse on the machine that has
has the `server_name` as its public DNS hostname, or federation traffic the `server_name` as its public DNS hostname, or you might want federation
to use port than 8448 (e.g. you want to use `example.com` as your `server_name` traffic to use a different port than 8448. For example, you might want to
but want Synapse to be reachable on `synapse.example.com:443`). This can have your user names look like `@user:example.com`, but you want to run
be done using delegation, which allows an admin to dictate where federation Synapse on `synapse.example.com` on port 443. This can be done using
traffic should be sent, see [delegate.md](<delegate.md>) for instructions on delegation, which allows an admin to control where federation traffic should
how to set this up. be sent. See [delegate.md](delegate.md) for instructions on how to set this up.
Once federation has been configured, you should be able to join a room over Once federation has been configured, you should be able to join a room over
federation. A good place to start is `#synapse:matrix.org` - a room for federation. A good place to start is `#synapse:matrix.org` - a room for
@ -31,7 +31,7 @@ Synapse admins.
## Troubleshooting ## Troubleshooting
You can use the [federation tester](<https://matrix.org/federationtester>) You can use the [federation tester](https://matrix.org/federationtester)
to check if your homeserver is configured correctly. Alternatively try the to check if your homeserver is configured correctly. Alternatively try the
[JSON API used by the federation tester](https://matrix.org/federationtester/api/report?server_name=DOMAIN). [JSON API used by the federation tester](https://matrix.org/federationtester/api/report?server_name=DOMAIN).
Note that you'll have to modify this URL to replace `DOMAIN` with your Note that you'll have to modify this URL to replace `DOMAIN` with your