Delegation: Difference between revisions

From IM Wiki
Jump to navigation Jump to search
Matrix>Sininenkissa
m Use {{bc|example}} instead of Visual editor code block
Matrix>Admin
m Moved expansion template to top of the page
Line 1: Line 1:
Delegation is a Matrix feature allowing a homeserver admin to retain an URL of example.com so that user IDs, etc. continue to look like {{ic|*:example.com}}, whilst having federation traffic routed to a different server and/or port (e.g. {{ic|matrix.example.com:443}}). There are multiple ways to do this. This includes with the {{ic|.well-known}} file and SRV DNS records.
{{Expansion|Finish creating/building the basics of the page using [https://matrix-org.github.io/synapse/latest/delegate.html this resource].}}Delegation is a Matrix feature allowing a homeserver admin to retain an URL of example.com so that user IDs, etc. continue to look like {{ic|*:example.com}}, whilst having federation traffic routed to a different server and/or port (e.g. {{ic|matrix.example.com:443}}). There are multiple ways to do this. This includes with the {{ic|.well-known}} file and SRV DNS records.


== .well-known delegation ==
== .well-known delegation ==
Line 18: Line 18:
*Specifying a port is optional. If no port is specified, then it defaults to 8448.
*Specifying a port is optional. If no port is specified, then it defaults to 8448.
}}
}}
{{Expansion|Finish creating/building the basics of the page using [https://matrix-org.github.io/synapse/latest/delegate.html this resource].}}

Revision as of 23:32, 15 January 2024

File:Tango-view-fullscreen.svgThis article or section needs expansion.File:Tango-view-fullscreen.svg

Reason: Finish creating/building the basics of the page using this resource. (Discuss in Talk:Delegation)

Delegation is a Matrix feature allowing a homeserver admin to retain an URL of example.com so that user IDs, etc. continue to look like *:example.com, whilst having federation traffic routed to a different server and/or port (e.g. matrix.example.com:443). There are multiple ways to do this. This includes with the .well-known file and SRV DNS records.

.well-known delegation

To use this method, you need to be able to configure the server at https://<server_name> to serve a file at https://<server_name>/.well-known/matrix/server. There are two ways to do this, shown below.

Using a web server

This is the more commonly used method, and is the only method if you are using server software that is not Synapse. You need to configure a server such as nginx or Apache to serve the https://<server_name>/.well-known/matrix/server file. Setting up such a server is out of the scope of the wiki, but note that it is often possible to configure your reverse proxy for this.

The URL https://<server_name>/.well-known/matrix/server should be configured to return a JSON structure containing the key m.server like this:

{
    "m.server": "<synapse.server.name>[:<yourport>]"
}
Note:
  • Specifying a port is optional. If no port is specified, then it defaults to 8448.