mirror of
https://github.com/element-hq/synapse.git
synced 2024-12-14 11:57:44 +00:00
269 lines
28 KiB
HTML
269 lines
28 KiB
HTML
|
<!DOCTYPE HTML>
|
||
|
|
<html lang="en" class="sidebar-visible no-js light">
|
||
|
|
<head>
|
||
|
|
<!-- Book generated using mdBook -->
|
||
|
|
<meta charset="UTF-8">
|
||
|
|
<title>Delegation - Synapse</title>
|
||
|
|
<!-- Custom HTML head -->
|
||
|
|
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
|
||
|
|
<meta name="description" content="">
|
||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||
|
|
<meta name="theme-color" content="#ffffff" />
|
||
|
|
|
||
|
|
<link rel="icon" href="favicon.svg">
|
||
|
|
<link rel="shortcut icon" href="favicon.png">
|
||
|
|
<link rel="stylesheet" href="css/variables.css">
|
||
|
|
<link rel="stylesheet" href="css/general.css">
|
||
|
|
<link rel="stylesheet" href="css/chrome.css">
|
||
|
|
<link rel="stylesheet" href="css/print.css" media="print">
|
||
|
|
<!-- Fonts -->
|
||
|
|
<link rel="stylesheet" href="FontAwesome/css/font-awesome.css">
|
||
|
|
<link rel="stylesheet" href="fonts/fonts.css">
|
||
|
|
<!-- Highlight.js Stylesheets -->
|
||
|
|
<link rel="stylesheet" href="highlight.css">
|
||
|
|
<link rel="stylesheet" href="tomorrow-night.css">
|
||
|
|
<link rel="stylesheet" href="ayu-highlight.css">
|
||
|
|
|
||
|
|
<!-- Custom theme stylesheets -->
|
||
|
|
<link rel="stylesheet" href="docs/website_files/table-of-contents.css">
|
||
|
|
<link rel="stylesheet" href="docs/website_files/remove-nav-buttons.css">
|
||
|
|
<link rel="stylesheet" href="docs/website_files/indent-section-headers.css">
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<!-- Provide site root to javascript -->
|
||
|
|
<script type="text/javascript">
|
||
|
|
var path_to_root = "";
|
||
|
|
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "light";
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<!-- Work around some values being stored in localStorage wrapped in quotes -->
|
||
|
|
<script type="text/javascript">
|
||
|
|
try {
|
||
|
|
var theme = localStorage.getItem('mdbook-theme');
|
||
|
|
var sidebar = localStorage.getItem('mdbook-sidebar');
|
||
|
|
if (theme.startsWith('"') && theme.endsWith('"')) {
|
||
|
|
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
|
||
|
|
}
|
||
|
|
if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
|
||
|
|
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
|
||
|
|
}
|
||
|
|
} catch (e) { }
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<!-- Set the theme before any content is loaded, prevents flash -->
|
||
|
|
<script type="text/javascript">
|
||
|
|
var theme;
|
||
|
|
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
|
||
|
|
if (theme === null || theme === undefined) { theme = default_theme; }
|
||
|
|
var html = document.querySelector('html');
|
||
|
|
html.classList.remove('no-js')
|
||
|
|
html.classList.remove('light')
|
||
|
|
html.classList.add(theme);
|
||
|
|
html.classList.add('js');
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<!-- Hide / unhide sidebar before it is displayed -->
|
||
|
|
<script type="text/javascript">
|
||
|
|
var html = document.querySelector('html');
|
||
|
|
var sidebar = 'hidden';
|
||
|
|
if (document.body.clientWidth >= 1080) {
|
||
|
|
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
|
||
|
|
sidebar = sidebar || 'visible';
|
||
|
|
}
|
||
|
|
html.classList.remove('sidebar-visible');
|
||
|
|
html.classList.add("sidebar-" + sidebar);
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<nav id="sidebar" class="sidebar" aria-label="Table of contents">
|
||
|
|
<div class="sidebar-scrollbox">
|
||
|
|
<ol class="chapter"><li class="chapter-item expanded affix "><li class="part-title">Introduction</li><li class="chapter-item expanded "><a href="welcome_and_overview.html">Welcome and Overview</a></li><li class="chapter-item expanded affix "><li class="part-title">Setup</li><li class="chapter-item expanded "><a href="setup/installation.html">Installation</a></li><li class="chapter-item expanded "><a href="postgres.html">Using Postgres</a></li><li class="chapter-item expanded "><a href="reverse_proxy.html">Configuring a Reverse Proxy</a></li><li class="chapter-item expanded "><a href="setup/forward_proxy.html">Configuring a Forward/Outbound Proxy</a></li><li class="chapter-item expanded "><a href="turn-howto.html">Configuring a Turn Server</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="setup/turn/coturn.html">coturn TURN server</a></li><li class="chapter-item expanded "><a href="setup/turn/eturnal.html">eturnal TURN server</a></li></ol></li><li class="chapter-item expanded "><a href="delegate.html" class="active">Delegation</a></li><li class="chapter-item expanded affix "><li class="part-title">Upgrading</li><li class="chapter-item expanded "><a href="upgrade.html">Upgrading between Synapse Versions</a></li><li class="chapter-item expanded affix "><li class="part-title">Usage</li><li class="chapter-item expanded "><a href="federate.html">Federation</a></li><li class="chapter-item expanded "><a href="usage/configuration/index.html">Configuration</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="usage/configuration/config_documentation.html">Configuration Manual</a></li><li class="chapter-item expanded "><a href="usage/configuration/homeserver_sample_config.html">Homeserver Sample Config File</a></li><li class="chapter-item expanded "><a href="usage/configuration/logging_sample_config.html">Logging Sample Config File</a></li><li class="chapter-item expanded "><a href="structured_logging.html">Structured Logging</a></li><li class="chapter-item expanded "><a href="templates.html">Templates</a></li><li class="chapter-item expanded "><a href="usage/configuration/user_authentication/index.html">User Authentication</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="usage/configuration/user_authentication/single_sign_on/index.html">Single-Sign On</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="openid.html">OpenID Connect</a></li><li class="chapter-item expanded "><a href="usage/configuration/user_authentication/single_sign_on/saml.html">SAML</a></li><li class="chapter-item expanded "><a href="usage/configuration/user_authentication/single_sign_on/cas.html">CAS</a></li><li class="chapter-item expanded "><a href="sso_mapping_providers.html">SSO Mapping Providers</a></li></ol></li><li class="chapter-item expanded "><a href="password_auth_providers.html">Password Auth Providers</a></li><li class="chapter-item expanded "><a href="jwt.html">JSON Web Tokens</a></li><li class="chapter-item expanded "><a href="usage/configuration/user_authentication/refresh_tokens.html">Refresh Tokens</a></li></ol></li><li class="chapter-item expanded "><a href="CAPTCHA_SETUP.html">Registration Captcha</a></li><li class="chapter-item expanded "><a href="application_services.html">Application Services</a></li><li class="chapter-item expanded "><a href="server_notices.html">Server Notices</a></li><li class="chapter-item expanded "><a href="consent_tracking.html">Consent Tracking</a></li><li class="chapter-item expanded "><a href="user_directory.html">User Directory</a></li><li class="chapter-item expanded "><a href="message_retention_policies.html">Message Retention Policies</a></li><li class="chapter-item expanded "><a href="modules/index.html">Pluggable Modules</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="modules/writing_a_module.html">Writing a module</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="modules/spam_checker_callbacks.html">Spam checker callbacks</a></li><li class
|
||
|
|
</div>
|
||
|
|
<div id="sidebar-resize-handle" class="sidebar-resize-handle"></div>
|
||
|
|
</nav>
|
||
|
|
|
||
|
|
<div id="page-wrapper" class="page-wrapper">
|
||
|
|
|
||
|
|
<div class="page">
|
||
|
|
<div id="menu-bar-hover-placeholder"></div>
|
||
|
|
<div id="menu-bar" class="menu-bar sticky bordered">
|
||
|
|
<div class="left-buttons">
|
||
|
|
<button id="sidebar-toggle" class="icon-button" type="button" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
|
||
|
|
<i class="fa fa-bars"></i>
|
||
|
|
</button>
|
||
|
|
<button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
|
||
|
|
<i class="fa fa-paint-brush"></i>
|
||
|
|
</button>
|
||
|
|
<ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
|
||
|
|
<li role="none"><button role="menuitem" class="theme" id="light">Light (default)</button></li>
|
||
|
|
<li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
|
||
|
|
<li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
|
||
|
|
<li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
|
||
|
|
<li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
|
||
|
|
</ul>
|
||
|
|
<button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar">
|
||
|
|
<i class="fa fa-search"></i>
|
||
|
|
</button>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<h1 class="menu-title">Synapse</h1>
|
||
|
|
|
||
|
|
<div class="right-buttons">
|
||
|
|
<a href="print.html" title="Print this book" aria-label="Print this book">
|
||
|
|
<i id="print-button" class="fa fa-print"></i>
|
||
|
|
</a>
|
||
|
|
<a href="https://github.com/matrix-org/synapse" title="Git repository" aria-label="Git repository">
|
||
|
|
<i id="git-repository-button" class="fa fa-github"></i>
|
||
|
|
</a>
|
||
|
|
<a href="https://github.com/matrix-org/synapse/edit/develop/docs/delegate.md" title="Suggest an edit" aria-label="Suggest an edit">
|
||
|
|
<i id="git-edit-button" class="fa fa-edit"></i>
|
||
|
|
</a>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div id="search-wrapper" class="hidden">
|
||
|
|
<form id="searchbar-outer" class="searchbar-outer">
|
||
|
|
<input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
|
||
|
|
</form>
|
||
|
|
<div id="searchresults-outer" class="searchresults-outer hidden">
|
||
|
|
<div id="searchresults-header" class="searchresults-header"></div>
|
||
|
|
<ul id="searchresults">
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
|
||
|
|
<script type="text/javascript">
|
||
|
|
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
|
||
|
|
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
|
||
|
|
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
|
||
|
|
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
|
||
|
|
});
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<div id="content" class="content">
|
||
|
|
<main>
|
||
|
|
<!-- Page table of contents -->
|
||
|
|
<div class="sidetoc">
|
||
|
|
<nav class="pagetoc"></nav>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<h1 id="delegation-of-incoming-federation-traffic"><a class="header" href="#delegation-of-incoming-federation-traffic">Delegation of incoming federation traffic</a></h1>
|
||
|
|
<p>In the following documentation, we use the term <code>server_name</code> to refer to that setting
|
||
|
|
in your homeserver configuration file. It appears at the ends of user ids, and tells
|
||
|
|
other homeservers where they can find your server.</p>
|
||
|
|
<p>By default, other homeservers will expect to be able to reach yours via
|
||
|
|
your <code>server_name</code>, on port 8448. For example, if you set your <code>server_name</code>
|
||
|
|
to <code>example.com</code> (so that your user names look like <code>@user:example.com</code>),
|
||
|
|
other servers will try to connect to yours at <code>https://example.com:8448/</code>.</p>
|
||
|
|
<p>Delegation is a Matrix feature allowing a homeserver admin to retain a
|
||
|
|
<code>server_name</code> of <code>example.com</code> so that user IDs, room aliases, etc continue
|
||
|
|
to look like <code>*:example.com</code>, whilst having federation traffic routed
|
||
|
|
to a different server and/or port (e.g. <code>synapse.example.com:443</code>).</p>
|
||
|
|
<h2 id="well-known-delegation"><a class="header" href="#well-known-delegation">.well-known delegation</a></h2>
|
||
|
|
<p>To use this method, you need to be able to configure the server at
|
||
|
|
<code>https://<server_name></code> to serve a file at
|
||
|
|
<code>https://<server_name>/.well-known/matrix/server</code>. There are two ways to do this, shown below.</p>
|
||
|
|
<p>Note that the <code>.well-known</code> file is hosted on the default port for <code>https</code> (port 443).</p>
|
||
|
|
<h3 id="external-server"><a class="header" href="#external-server">External server</a></h3>
|
||
|
|
<p>For maximum flexibility, you need to configure an external server such as nginx, Apache
|
||
|
|
or HAProxy to serve the <code>https://<server_name>/.well-known/matrix/server</code> file. Setting
|
||
|
|
up such a server is out of the scope of this documentation, but note that it is often
|
||
|
|
possible to configure your <a href="reverse_proxy.html">reverse proxy</a> for this.</p>
|
||
|
|
<p>The URL <code>https://<server_name>/.well-known/matrix/server</code> should be configured
|
||
|
|
return a JSON structure containing the key <code>m.server</code> like this:</p>
|
||
|
|
<pre><code class="language-json">{
|
||
|
|
"m.server": "<synapse.server.name>[:<yourport>]"
|
||
|
|
}
|
||
|
|
</code></pre>
|
||
|
|
<p>In our example (where we want federation traffic to be routed to
|
||
|
|
<code>https://synapse.example.com</code>, on port 443), this would mean that
|
||
|
|
<code>https://example.com/.well-known/matrix/server</code> should return:</p>
|
||
|
|
<pre><code class="language-json">{
|
||
|
|
"m.server": "synapse.example.com:443"
|
||
|
|
}
|
||
|
|
</code></pre>
|
||
|
|
<p>Note, specifying a port is optional. If no port is specified, then it defaults
|
||
|
|
to 8448.</p>
|
||
|
|
<h3 id="serving-a-well-knownmatrixserver-file-with-synapse"><a class="header" href="#serving-a-well-knownmatrixserver-file-with-synapse">Serving a <code>.well-known/matrix/server</code> file with Synapse</a></h3>
|
||
|
|
<p>If you are able to set up your domain so that <code>https://<server_name></code> 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
|
||
|
|
<code>.well-known/matrix/server</code> file. To do so, add the following to your <code>homeserver.yaml</code>
|
||
|
|
file:</p>
|
||
|
|
<pre><code class="language-yaml">serve_server_wellknown: true
|
||
|
|
</code></pre>
|
||
|
|
<p><strong>Note</strong>: this <em>only</em> works if <code>https://<server_name></code> is routed to Synapse, so is
|
||
|
|
generally not suitable if Synapse is hosted at a subdomain such as
|
||
|
|
<code>https://synapse.example.com</code>.</p>
|
||
|
|
<h2 id="srv-dns-record-delegation"><a class="header" href="#srv-dns-record-delegation">SRV DNS record delegation</a></h2>
|
||
|
|
<p>It is also possible to do delegation using a SRV DNS record. However, that is generally
|
||
|
|
not recommended, as it can be difficult to configure the TLS certificates correctly in
|
||
|
|
this case, and it offers little advantage over <code>.well-known</code> delegation.</p>
|
||
|
|
<p>Please keep in mind that server delegation is a function of server-server communication,
|
||
|
|
and as such using SRV DNS records will not cover use cases involving client-server comms.
|
||
|
|
This means setting global client settings (such as a Jitsi endpoint, or disabling
|
||
|
|
creating new rooms as encrypted by default, etc) will still require that you serve a file
|
||
|
|
from the <code>https://<server_name>/.well-known/</code> endpoints defined in the spec! If you are
|
||
|
|
considering using SRV DNS delegation to avoid serving files from this endpoint, consider
|
||
|
|
the impact that you will not be able to change those client-based default values globally,
|
||
|
|
and will be relegated to the featureset of the configuration of each individual client.</p>
|
||
|
|
<p>However, if you really need it, you can find some documentation on what such a
|
||
|
|
record should look like and how Synapse will use it in <a href="https://matrix.org/docs/spec/server_server/latest#resolving-server-names">the Matrix
|
||
|
|
specification</a>.</p>
|
||
|
|
<h2 id="delegation-faq"><a class="header" href="#delegation-faq">Delegation FAQ</a></h2>
|
||
|
|
<h3 id="when-do-i-need-delegation"><a class="header" href="#when-do-i-need-delegation">When do I need delegation?</a></h3>
|
||
|
|
<p>If your homeserver's APIs are accessible on the default federation port (8448)
|
||
|
|
and the domain your <code>server_name</code> points to, you do not need any delegation.</p>
|
||
|
|
<p>For instance, if you registered <code>example.com</code> and pointed its DNS A record at a
|
||
|
|
fresh server, you could install Synapse on that host, giving it a <code>server_name</code>
|
||
|
|
of <code>example.com</code>, and once a reverse proxy has been set up to proxy all requests
|
||
|
|
sent to the port <code>8448</code> and serve TLS certificates for <code>example.com</code>, you
|
||
|
|
wouldn't need any delegation set up.</p>
|
||
|
|
<p><strong>However</strong>, if your homeserver's APIs aren't accessible on port 8448 and on the
|
||
|
|
domain <code>server_name</code> points to, you will need to let other servers know how to
|
||
|
|
find it using delegation.</p>
|
||
|
|
<h3 id="should-i-use-a-reverse-proxy-for-federation-traffic"><a class="header" href="#should-i-use-a-reverse-proxy-for-federation-traffic">Should I use a reverse proxy for federation traffic?</a></h3>
|
||
|
|
<p>Generally, using a reverse proxy for both the federation and client traffic is a good
|
||
|
|
idea, since it saves handling TLS traffic in Synapse. See
|
||
|
|
<a href="reverse_proxy.html">the reverse proxy documentation</a> for information on setting up a
|
||
|
|
reverse proxy.</p>
|
||
|
|
|
||
|
|
</main>
|
||
|
|
|
||
|
|
<nav class="nav-wrapper" aria-label="Page navigation">
|
||
|
|
<!-- Mobile navigation buttons -->
|
||
|
|
<a rel="prev" href="setup/turn/eturnal.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
||
|
|
<i class="fa fa-angle-left"></i>
|
||
|
|
</a>
|
||
|
|
<a rel="next" href="upgrade.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
||
|
|
<i class="fa fa-angle-right"></i>
|
||
|
|
</a>
|
||
|
|
<div style="clear: both"></div>
|
||
|
|
</nav>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<nav class="nav-wide-wrapper" aria-label="Page navigation">
|
||
|
|
<a rel="prev" href="setup/turn/eturnal.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
||
|
|
<i class="fa fa-angle-left"></i>
|
||
|
|
</a>
|
||
|
|
<a rel="next" href="upgrade.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
||
|
|
<i class="fa fa-angle-right"></i>
|
||
|
|
</a>
|
||
|
|
</nav>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<script type="text/javascript">
|
||
|
|
window.playground_copyable = true;
|
||
|
|
</script>
|
||
|
|
<script src="elasticlunr.min.js" type="text/javascript" charset="utf-8"></script>
|
||
|
|
<script src="mark.min.js" type="text/javascript" charset="utf-8"></script>
|
||
|
|
<script src="searcher.js" type="text/javascript" charset="utf-8"></script>
|
||
|
|
<script src="clipboard.min.js" type="text/javascript" charset="utf-8"></script>
|
||
|
|
<script src="highlight.js" type="text/javascript" charset="utf-8"></script>
|
||
|
|
<script src="book.js" type="text/javascript" charset="utf-8"></script>
|
||
|
|
|
||
|
|
<!-- Custom JS scripts -->
|
||
|
|
<script type="text/javascript" src="docs/website_files/table-of-contents.js"></script>
|
||
|
|
</body>
|
||
|
|
</html>
|