Delegation - Revision history

Array in a Matrix: 6 revisions imported: Import original IM Wiki

2024-07-14T03:24:03Z

6 revisions imported: Import original IM Wiki

← Older revision		Revision as of 03:24, 14 July 2024
(No difference)

Matrix>Sininenkissa: Remove expansion template

2024-01-16T17:13:52Z

Remove expansion template

← Older revision		Revision as of 17:13, 16 January 2024
Line 1:		Line 1:
	~~{{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.		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 ==

Matrix>Sininenkissa: Finish page

2024-01-16T17:13:19Z

Finish page

← Older revision		Revision as of 17:13, 16 January 2024
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.
	}}		}}

			=== Using Synapse's built in method ===

			If you are able to set up your domain so that {{ic\|https://<server_name>}} is routed to Synapse (i.e., the only change needed is to direct federation traffic to port 443 instead of port 8448), then it is possible to configure Synapse to serve a suitable {{ic\|.well-known/matrix/server}} file. To do so, add the following to your {{ic\|homeserver.yaml}} file:
			{{bc\|
			serve_server_wellknown: true
			}}

			{{Note\|
			* This only works if {{ic\|https://<server_name>}} is routed to Synapse, so is generally not suitable if Synapse is hosted at a subdomain such as {{ic\|<nowiki>https://matrix.example.com</nowiki>}}.
			}}

			== SRV DNS record delegation ==

			{{Warning\|This form of delegation is not generally recommended, as it can be difficult to configure the TLS certificates correctly in this case, and it offers little advantage over {{ic\|.well-known}} delegation.}}

			{{Note\|
			* Server delegation is a function of server-server communication, and as such using SRV DNS records will not cover use cases involving client-server communications. This means setting global client settings will still require that you serve a file from the {{ic\|https://<server_name>/.well-known/}} endpoints defined in the specification.
			}}

			To set up SRV DNS record delegation, create a SRV DNS record with {{ic\|_matrix-fed._tcp.<hostname>}} that points to the delegated hostname.

Matrix>Admin: Moved expansion template to top of the page

2024-01-15T23:32:45Z

Moved expansion template to top of the page

← Older revision		Revision as of 23:32, 15 January 2024
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].}}~~

Matrix>Sininenkissa: Use {{bc|example}} instead of Visual editor code block

2024-01-15T22:14:46Z

Use {{bc|example}} instead of Visual editor code block

← Older revision		Revision as of 22:14, 15 January 2024
Line 10:		Line 10:

	The URL {{ic\|https://<server_name>/.well-known/matrix/server}} should be configured to return a JSON structure containing the key {{ic\|m.server}} like this:		The URL {{ic\|https://<server_name>/.well-known/matrix/server}} should be configured to return a JSON structure containing the key {{ic\|m.server}} like this:
	~~<syntaxhighlight lang="json">~~		{{bc\|
	{		{
	"m.server": "<synapse.server.name>[:<yourport>]"		"m.server": "<synapse.server.name>[:<yourport>]"
	}		}
	~~</syntaxhighlight>~~		}}
	{{Note\|		{{Note\|
	*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.

Matrix>Sininenkissa: Use {{ic|example}} instead of


2024-01-15T22:12:44Z
Use {{ic|example}} instead of <code>

				
				
				
				
				
				← Older revision
				Revision as of 22:12, 15 January 2024
				
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 <code>*:example.com</code>, whilst having federation traffic routed to a different server and/or port (e.g. <code>matrix.example.com:443</code>). There are multiple ways to do this. This includes with the <code>.well-known</code> file and SRV DNS records. 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 ==



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



=== Using a web server === === 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 <code>https://<server_name>/.well-known/matrix/server</code> 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. 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 {{ic|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 <code>https://<server_name>/.well-known/matrix/server</code> should be configured to return a JSON structure containing the key <code>m.server</code> like this:<syntaxhighlight lang="json"> The URL {{ic|https://<server_name>/.well-known/matrix/server}} should be configured to return a JSON structure containing the key {{ic|m.server}} like this:
<syntaxhighlight lang="json">
{ {
     "m.server": "<synapse.server.name>[:<yourport>]"      "m.server": "<synapse.server.name>[:<yourport>]"



Matrix>Sininenkissa: Create delegation
2024-01-15T21:10:39Z
Create delegation
New page
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 <code>*:example.com</code>, whilst having federation traffic routed to a different server and/or port (e.g. <code>matrix.example.com:443</code>). There are multiple ways to do this. This includes with the <code>.well-known</code> file and SRV DNS records.



== .well-known delegation ==



To use this method, you need to be able to configure the server at {{ic|https://<server_name>}} to serve a file at <code>https://<server_name>/.well-known/matrix/server</code>. 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 <code>https://<server_name>/.well-known/matrix/server</code> 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 <code>https://<server_name>/.well-known/matrix/server</code> should be configured to return a JSON structure containing the key <code>m.server</code> like this:<syntaxhighlight lang="json">

{

    "m.server": "<synapse.server.name>[:<yourport>]"

}

</syntaxhighlight>

{{Note|

*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].}}

← Older revision		Revision as of 22:12, 15 January 2024
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 ~~<code>~~*:example.com~~</code>~~, whilst having federation traffic routed to a different server and/or port (e.g. ~~<code>~~matrix.example.com:443~~</code>~~). There are multiple ways to do this. This includes with the ~~<code>~~.well-known~~</code>~~ file and SRV DNS records.		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 ==

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

	=== Using a web server ===		=== 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 ~~<code>~~https://<server_name>/.well-known/matrix/server~~</code>~~ 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.		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 {{ic\|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 ~~<code>~~https://<server_name>/.well-known/matrix/server~~</code>~~ should be configured to return a JSON structure containing the key ~~<code>~~m.server~~</code>~~ like this:<syntaxhighlight lang="json">		The URL {{ic\|https://<server_name>/.well-known/matrix/server}} should be configured to return a JSON structure containing the key {{ic\|m.server}} like this:
			<syntaxhighlight lang="json">
	{		{
	"m.server": "<synapse.server.name>[:<yourport>]"		"m.server": "<synapse.server.name>[:<yourport>]"