diff --git a/develop/usage/configuration/config_documentation.html b/develop/usage/configuration/config_documentation.html
new file mode 100644
index 0000000000..2ae3d837a4
--- /dev/null
+++ b/develop/usage/configuration/config_documentation.html
@@ -0,0 +1,3108 @@
+<!DOCTYPE HTML>
+<html lang="en" class="sidebar-visible no-js light">
+ <head>
+ <!-- Book generated using mdBook -->
+ <meta charset="UTF-8">
+ <title>Configuration Manual - 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 class="chapter-item expanded "><a href="../../delegate.html">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" class="active">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="../../development/url_previews.html">URL Previews</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="chapter-item expanded "><a href="../../modules/third_party_rules_callbacks.html">Third-party rules callbacks</a></li><li class="chapter-item expanded "><a href="../../modules/presence_router_callbacks.html">Presence router callbacks</a></li><li class="chapter-item expanded "><a href="../../modules/account_validity_callbacks.html">Account validity callbacks</a></li><li class="chapter-item expanded "><a href="../../modules/password_auth_provider_callbacks.html">Password auth provider callbacks</a></li><li class="chapter-item expanded "><a href="../../modules/background_update_controller_callbacks.html">Background update controller callbacks</a></li><li class="chapter-item expanded "><a href="../../modules/account_data_callbacks.html">Account data callbacks</a></li><li class="chapter-item expanded "><a href="../../modules/porting_legacy_module.html">Porting a legacy module to the new interface</a></li></ol></li></ol></li><li class="chapter-item expanded "><a href="../../workers.html">Workers</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../../synctl_workers.html">Using synctl with Workers</a></li><li class="chapter-item expanded "><a href="../../systemd-with-workers/index.html">Systemd</a></li></ol></li></ol></li><li class="chapter-item expanded "><a href="../../usage/administration/index.html">Administration</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../../usage/administration/admin_api/index.html">Admin API</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../../admin_api/account_validity.html">Account Validity</a></li><li class="chapter-item expanded "><a href="../../usage/administration/admin_api/background_updates.html">Background Updates</a></li><li class="chapter-item expanded "><a href="../../admin_api/delete_group.html">Delete Group</a></li><li class="chapter-item expanded "><a href="../../admin_api/event_reports.html">Event Reports</a></li><li class="chapter-item expanded "><a href="../../admin_api/media_admin_api.html">Media</a></li><li class="chapter-item expanded "><a href="../../admin_api/purge_history_api.html">Purge History</a></li><li class="chapter-item expanded "><a href="../../admin_api/register_api.html">Register Users</a></li><li class="chapter-item expanded "><a href="../../usage/administration/admin_api/registration_tokens.html">Registration Tokens</a></li><li class="chapter-item expanded "><a href="../../admin_api/room_membership.html">Manipulate Room Membership</a></li><li class="chapter-item expanded "><a href="../../admin_api/rooms.html">Rooms</a></li><li class="chapter-item expanded "><a href="../../admin_api/server_notices.html">Server Notices</a></li><li class="chapter-item expanded "><a href="../../admin_api/statistics.html">Statistics</a></li><li class="chapter-item expanded "><a href="../../admin_api/user_admin_api.html">Users</a></li><li class="chapter-item expanded "><a href="../../admin_api/version_api.html">Server Version</a></li><li class="chapter-item expanded "><a href="../../usage/administration/admin_api/federation.html">Federation</a></li></ol></li><li class="chapter-item expanded "><a href="../../manhole.html">Manhole</a></li><li class="chapter-item expanded "><a href="../../metrics-howto.html">Monitoring</a></li><li class="chapter-item expanded "><a href="../../usage/administration/understanding_synapse_through_grafana_graphs.html">Understanding Synapse Through Grafana Graphs</a></li><li class="chapter-item expanded "><a href="../../usage/administration/useful_sql_for_admins.html">Useful SQL for Admins</a></li><li class="chapter-item expanded "><a href="../../usage/administration/database_maintenance_tools.html">Database Maintenance Tools</a></li><li class="chapter-item expanded "><a href="../../usage/administration/state_groups.html">State Groups</a></li><li class="chapter-item expanded "><a href="../../usage/administration/request_log.html">Request log format</a></li><li class="chapter-item expanded "><a href="../../usage/administration/admin_faq.html">Admin FAQ</a></li><li class="chapter-item expanded "><div>Scripts</div></li></ol></li><li class="chapter-item expanded "><li class="part-title">Development</li><li class="chapter-item expanded "><a href="../../development/contributing_guide.html">Contributing Guide</a></li><li class="chapter-item expanded "><a href="../../code_style.html">Code Style</a></li><li class="chapter-item expanded "><a href="../../development/releases.html">Release Cycle</a></li><li class="chapter-item expanded "><a href="../../development/git.html">Git Usage</a></li><li class="chapter-item expanded "><div>Testing</div></li><li><ol class="section"><li class="chapter-item expanded "><a href="../../development/demo.html">Demo scripts</a></li></ol></li><li class="chapter-item expanded "><a href="../../opentracing.html">OpenTracing</a></li><li class="chapter-item expanded "><a href="../../development/database_schema.html">Database Schemas</a></li><li class="chapter-item expanded "><a href="../../development/experimental_features.html">Experimental features</a></li><li class="chapter-item expanded "><div>Synapse Architecture</div></li><li><ol class="section"><li class="chapter-item expanded "><a href="../../log_contexts.html">Log Contexts</a></li><li class="chapter-item expanded "><a href="../../replication.html">Replication</a></li><li class="chapter-item expanded "><a href="../../tcp_replication.html">TCP Replication</a></li></ol></li><li class="chapter-item expanded "><a href="../../development/internal_documentation/index.html">Internal Documentation</a></li><li><ol class="section"><li class="chapter-item expanded "><div>Single Sign-On</div></li><li><ol class="section"><li class="chapter-item expanded "><a href="../../development/saml.html">SAML</a></li><li class="chapter-item expanded "><a href="../../development/cas.html">CAS</a></li></ol></li><li class="chapter-item expanded "><a href="../../development/room-dag-concepts.html">Room DAG concepts</a></li><li class="chapter-item expanded "><div>State Resolution</div></li><li><ol class="section"><li class="chapter-item expanded "><a href="../../auth_chain_difference_algorithm.html">The Auth Chain Difference Algorithm</a></li></ol></li><li class="chapter-item expanded "><a href="../../media_repository.html">Media Repository</a></li><li class="chapter-item expanded "><a href="../../room_and_user_statistics.html">Room and User Statistics</a></li></ol></li><li class="chapter-item expanded "><div>Scripts</div></li><li class="chapter-item expanded affix "><li class="part-title">Other</li><li class="chapter-item expanded "><a href="../../deprecation_policy.html">Dependency Deprecation Policy</a></li><li class="chapter-item expanded "><a href="../../other/running_synapse_on_single_board_computers.html">Running Synapse on a Single-Board Computer</a></li></ol>
+ </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/usage/configuration/config_documentation.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="configuring-synapse"><a class="header" href="#configuring-synapse">Configuring Synapse</a></h1>
+<p>This is intended as a guide to the Synapse configuration. The behavior of a Synapse instance can be modified
+through the many configuration settings documented here — each config option is explained,
+including what the default is, how to change the default and what sort of behaviour the setting governs.
+Also included is an example configuration for each setting. If you don't want to spend a lot of time
+thinking about options, the config as generated sets sensible defaults for all values. Do note however that the
+database defaults to SQLite, which is not recommended for production usage. You can read more on this subject
+<a href="../../setup/installation.html#using-postgresql">here</a>.</p>
+<h2 id="config-conventions"><a class="header" href="#config-conventions">Config Conventions</a></h2>
+<p>Configuration options that take a time period can be set using a number
+followed by a letter. Letters have the following meanings:</p>
+<ul>
+<li><code>s</code> = second</li>
+<li><code>m</code> = minute</li>
+<li><code>h</code> = hour</li>
+<li><code>d</code> = day</li>
+<li><code>w</code> = week</li>
+<li><code>y</code> = year</li>
+</ul>
+<p>For example, setting <code>redaction_retention_period: 5m</code> would remove redacted
+messages from the database after 5 minutes, rather than 5 months.</p>
+<h3 id="yaml"><a class="header" href="#yaml">YAML</a></h3>
+<p>The configuration file is a <a href="https://yaml.org/">YAML</a> file, which means that certain syntax rules
+apply if you want your config file to be read properly. A few helpful things to know:</p>
+<ul>
+<li>
+<p><code>#</code> before any option in the config will comment out that setting and either a default (if available) will
+be applied or Synapse will ignore the setting. Thus, in example #1 below, the setting will be read and
+applied, but in example #2 the setting will not be read and a default will be applied.</p>
+<p>Example #1:</p>
+<pre><code class="language-yaml">pid_file: DATADIR/homeserver.pid
+</code></pre>
+<p>Example #2:</p>
+<pre><code class="language-yaml">#pid_file: DATADIR/homeserver.pid
+</code></pre>
+</li>
+<li>
+<p>Indentation matters! The indentation before a setting
+will determine whether a given setting is read as part of another
+setting, or considered on its own. Thus, in example #1, the <code>enabled</code> setting
+is read as a sub-option of the <code>presence</code> setting, and will be properly applied.</p>
+<p>However, the lack of indentation before the <code>enabled</code> setting in example #2 means
+that when reading the config, Synapse will consider both <code>presence</code> and <code>enabled</code> as
+different settings. In this case, <code>presence</code> has no value, and thus a default applied, and <code>enabled</code>
+is an option that Synapse doesn't recognize and thus ignores.</p>
+<p>Example #1: </p>
+<pre><code class="language-yaml">presence:
+ enabled: false
+</code></pre>
+<p>Example #2:</p>
+<pre><code class="language-yaml">presence:
+enabled: false
+</code></pre>
+<p>In this manual, all top-level settings (ones with no indentation) are identified
+at the beginning of their section (i.e. "Config option: <code>example_setting</code>") and
+the sub-options, if any, are identified and listed in the body of the section.
+In addition, each setting has an example of its usage, with the proper indentation
+shown. </p>
+</li>
+</ul>
+<h2 id="modules"><a class="header" href="#modules">Modules</a></h2>
+<p>Server admins can expand Synapse's functionality with external modules.</p>
+<p>See <a href="../../modules/index.html">here</a> for more
+documentation on how to configure or create custom modules for Synapse.</p>
+<hr />
+<p>Config option: <code>modules</code></p>
+<p>Use the <code>module</code> sub-option to add modules under this option to extend functionality.
+The <code>module</code> setting then has a sub-option, <code>config</code>, which can be used to define some configuration
+for the <code>module</code>.</p>
+<p>Defaults to none.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">modules:
+ - module: my_super_module.MySuperClass
+ config:
+ do_thing: true
+ - module: my_other_super_module.SomeClass
+ config: {}
+</code></pre>
+<hr />
+<h2 id="server"><a class="header" href="#server">Server</a></h2>
+<p>Define your homeserver name and other base options.</p>
+<hr />
+<p>Config option: <code>server_name</code></p>
+<p>This sets the public-facing domain of the server.</p>
+<p>The <code>server_name</code> name will appear at the end of usernames and room addresses
+created on your server. For example if the <code>server_name</code> was example.com,
+usernames on your server would be in the format <code>@user:example.com</code></p>
+<p>In most cases you should avoid using a matrix specific subdomain such as
+matrix.example.com or synapse.example.com as the <code>server_name</code> for the same
+reasons you wouldn't use user@email.example.com as your email address.
+See <a href="../../delegate.html">here</a>
+for information on how to host Synapse on a subdomain while preserving
+a clean <code>server_name</code>.</p>
+<p>The <code>server_name</code> cannot be changed later so it is important to
+configure this correctly before you start Synapse. It should be all
+lowercase and may contain an explicit port.</p>
+<p>There is no default for this option. </p>
+<p>Example configuration #1:</p>
+<pre><code class="language-yaml">server_name: matrix.org
+</code></pre>
+<p>Example configuration #2:</p>
+<pre><code class="language-yaml">server_name: localhost:8080
+</code></pre>
+<hr />
+<p>Config option: <code>pid_file</code></p>
+<p>When running Synapse as a daemon, the file to store the pid in. Defaults to none.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">pid_file: DATADIR/homeserver.pid
+</code></pre>
+<hr />
+<p>Config option: <code>web_client_location</code></p>
+<p>The absolute URL to the web client which <code>/</code> will redirect to. Defaults to none. </p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">web_client_location: https://riot.example.com/
+</code></pre>
+<hr />
+<p>Config option: <code>public_baseurl</code></p>
+<p>The public-facing base URL that clients use to access this Homeserver (not
+including _matrix/...). This is the same URL a user might enter into the
+'Custom Homeserver URL' field on their client. If you use Synapse with a
+reverse proxy, this should be the URL to reach Synapse via the proxy.
+Otherwise, it should be the URL to reach Synapse's client HTTP listener (see
+'listeners' below).</p>
+<p>Defaults to <code>https://<server_name>/</code>.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">public_baseurl: https://example.com/
+</code></pre>
+<hr />
+<p>Config option: <code>serve_server_wellknown</code></p>
+<p>By default, other servers will try to reach our server on port 8448, which can
+be inconvenient in some environments.</p>
+<p>Provided <code>https://<server_name>/</code> on port 443 is routed to Synapse, this
+option configures Synapse to serve a file at <code>https://<server_name>/.well-known/matrix/server</code>.
+This will tell other servers to send traffic to port 443 instead.</p>
+<p>This option currently defaults to false.</p>
+<p>See https://matrix-org.github.io/synapse/latest/delegate.html for more
+information.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">serve_server_wellknown: true
+</code></pre>
+<hr />
+<p>Config option: <code>soft_file_limit</code></p>
+<p>Set the soft limit on the number of file descriptors synapse can use.
+Zero is used to indicate synapse should set the soft limit to the hard limit.
+Defaults to 0. </p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">soft_file_limit: 3
+</code></pre>
+<hr />
+<p>Config option: <code>presence</code></p>
+<p>Presence tracking allows users to see the state (e.g online/offline)
+of other local and remote users. Set the <code>enabled</code> sub-option to false to<br />
+disable presence tracking on this homeserver. Defaults to true.
+This option replaces the previous top-level 'use_presence' option.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">presence:
+ enabled: false
+</code></pre>
+<hr />
+<p>Config option: <code>require_auth_for_profile_requests</code></p>
+<p>Whether to require authentication to retrieve profile data (avatars, display names) of other
+users through the client API. Defaults to false. Note that profile data is also available
+via the federation API, unless <code>allow_profile_lookup_over_federation</code> is set to false.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">require_auth_for_profile_requests: true
+</code></pre>
+<hr />
+<p>Config option: <code>limit_profile_requests_to_users_who_share_rooms</code></p>
+<p>Use this option to require a user to share a room with another user in order
+to retrieve their profile information. Only checked on Client-Server
+requests. Profile requests from other servers should be checked by the
+requesting server. Defaults to false.</p>
+<p>Example configuration: </p>
+<pre><code class="language-yaml">limit_profile_requests_to_users_who_share_rooms: true
+</code></pre>
+<hr />
+<p>Config option: <code>include_profile_data_on_invite</code></p>
+<p>Use this option to prevent a user's profile data from being retrieved and
+displayed in a room until they have joined it. By default, a user's
+profile data is included in an invite event, regardless of the values
+of the above two settings, and whether or not the users share a server.
+Defaults to true.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">include_profile_data_on_invite: false
+</code></pre>
+<hr />
+<p>Config option: <code>allow_public_rooms_without_auth</code></p>
+<p>If set to true, removes the need for authentication to access the server's
+public rooms directory through the client API, meaning that anyone can
+query the room directory. Defaults to false.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">allow_public_rooms_without_auth: true
+</code></pre>
+<hr />
+<p>Config option: <code>allow_public_rooms_without_auth</code></p>
+<p>If set to true, allows any other homeserver to fetch the server's public
+rooms directory via federation. Defaults to false.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">allow_public_rooms_over_federation: true
+</code></pre>
+<hr />
+<p>Config option: <code>default_room_version</code></p>
+<p>The default room version for newly created rooms on this server.</p>
+<p>Known room versions are listed <a href="https://spec.matrix.org/latest/rooms/#complete-list-of-room-versions">here</a></p>
+<p>For example, for room version 1, <code>default_room_version</code> should be set
+to "1". </p>
+<p>Currently defaults to "9".</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">default_room_version: "8"
+</code></pre>
+<hr />
+<p>Config option: <code>gc_thresholds</code></p>
+<p>The garbage collection threshold parameters to pass to <code>gc.set_threshold</code>, if defined.
+Defaults to none. </p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">gc_thresholds: [700, 10, 10]
+</code></pre>
+<hr />
+<p>Config option: <code>gc_min_interval</code></p>
+<p>The minimum time in seconds between each GC for a generation, regardless of
+the GC thresholds. This ensures that we don't do GC too frequently. A value of <code>[1s, 10s, 30s]</code>
+indicates that a second must pass between consecutive generation 0 GCs, etc.</p>
+<p>Defaults to <code>[1s, 10s, 30s]</code>.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">gc_min_interval: [0.5s, 30s, 1m]
+</code></pre>
+<hr />
+<p>Config option: <code>filter_timeline_limit</code></p>
+<p>Set the limit on the returned events in the timeline in the get
+and sync operations. Defaults to 100. A value of -1 means no upper limit.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">filter_timeline_limit: 5000
+</code></pre>
+<hr />
+<p>Config option: <code>block_non_admin_invites</code></p>
+<p>Whether room invites to users on this server should be blocked
+(except those sent by local server admins). Defaults to false.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">block_non_admin_invites: true
+</code></pre>
+<hr />
+<p>Config option: <code>enable_search</code></p>
+<p>If set to false, new messages will not be indexed for searching and users
+will receive errors when searching for messages. Defaults to true.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">enable_search: false
+</code></pre>
+<hr />
+<p>Config option: <code>ip_range_blacklist</code></p>
+<p>This option prevents outgoing requests from being sent to the specified blacklisted IP address
+CIDR ranges. If this option is not specified then it defaults to private IP
+address ranges (see the example below).</p>
+<p>The blacklist applies to the outbound requests for federation, identity servers,
+push servers, and for checking key validity for third-party invite events.</p>
+<p>(0.0.0.0 and :: are always blacklisted, whether or not they are explicitly
+listed here, since they correspond to unroutable addresses.)</p>
+<p>This option replaces <code>federation_ip_range_blacklist</code> in Synapse v1.25.0.</p>
+<p>Note: The value is ignored when an HTTP proxy is in use.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">ip_range_blacklist:
+ - '127.0.0.0/8'
+ - '10.0.0.0/8'
+ - '172.16.0.0/12'
+ - '192.168.0.0/16'
+ - '100.64.0.0/10'
+ - '192.0.0.0/24'
+ - '169.254.0.0/16'
+ - '192.88.99.0/24'
+ - '198.18.0.0/15'
+ - '192.0.2.0/24'
+ - '198.51.100.0/24'
+ - '203.0.113.0/24'
+ - '224.0.0.0/4'
+ - '::1/128'
+ - 'fe80::/10'
+ - 'fc00::/7'
+ - '2001:db8::/32'
+ - 'ff00::/8'
+ - 'fec0::/10'
+</code></pre>
+<hr />
+<p>Config option: <code>ip_range_whitelist</code></p>
+<p>List of IP address CIDR ranges that should be allowed for federation,
+identity servers, push servers, and for checking key validity for
+third-party invite events. This is useful for specifying exceptions to
+wide-ranging blacklisted target IP ranges - e.g. for communication with
+a push server only visible in your network.</p>
+<p>This whitelist overrides <code>ip_range_blacklist</code> and defaults to an empty
+list.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">ip_range_whitelist:
+ - '192.168.1.1'
+</code></pre>
+<hr />
+<p>Config option: <code>listeners</code></p>
+<p>List of ports that Synapse should listen on, their purpose and their
+configuration.</p>
+<p>Sub-options for each listener include:</p>
+<ul>
+<li>
+<p><code>port</code>: the TCP port to bind to. </p>
+</li>
+<li>
+<p><code>bind_addresses</code>: a list of local addresses to listen on. The default is
+'all local interfaces'.</p>
+</li>
+<li>
+<p><code>type</code>: the type of listener. Normally <code>http</code>, but other valid options are:</p>
+<ul>
+<li>
+<p><code>manhole</code>: (see the docs <a href="../../manhole.html">here</a>),</p>
+</li>
+<li>
+<p><code>metrics</code>: (see the docs <a href="../../metrics-howto.html">here</a>),</p>
+</li>
+<li>
+<p><code>replication</code>: (see the docs <a href="../../workers.html">here</a>).</p>
+</li>
+</ul>
+</li>
+<li>
+<p><code>tls</code>: set to true to enable TLS for this listener. Will use the TLS key/cert specified in tls_private_key_path / tls_certificate_path.</p>
+</li>
+<li>
+<p><code>x_forwarded</code>: Only valid for an 'http' listener. Set to true to use the X-Forwarded-For header as the client IP. Useful when Synapse is
+behind a reverse-proxy.</p>
+</li>
+<li>
+<p><code>resources</code>: Only valid for an 'http' listener. A list of resources to host
+on this port. Sub-options for each resource are:</p>
+<ul>
+<li>
+<p><code>names</code>: a list of names of HTTP resources. See below for a list of valid resource names.</p>
+</li>
+<li>
+<p><code>compress</code>: set to true to enable HTTP compression for this resource.</p>
+</li>
+</ul>
+</li>
+<li>
+<p><code>additional_resources</code>: Only valid for an 'http' listener. A map of
+additional endpoints which should be loaded via dynamic modules.</p>
+</li>
+</ul>
+<p>Valid resource names are:</p>
+<ul>
+<li>
+<p><code>client</code>: the client-server API (/_matrix/client), and the synapse admin API (/_synapse/admin). Also implies 'media' and 'static'.</p>
+</li>
+<li>
+<p><code>consent</code>: user consent forms (/_matrix/consent). See <a href="../../consent_tracking.html">here</a> for more.</p>
+</li>
+<li>
+<p><code>federation</code>: the server-server API (/_matrix/federation). Also implies <code>media</code>, <code>keys</code>, <code>openid</code></p>
+</li>
+<li>
+<p><code>keys</code>: the key discovery API (/_matrix/keys).</p>
+</li>
+<li>
+<p><code>media</code>: the media API (/_matrix/media).</p>
+</li>
+<li>
+<p><code>metrics</code>: the metrics interface. See <a href="../../metrics-howto.html">here</a>.</p>
+</li>
+<li>
+<p><code>openid</code>: OpenID authentication. See <a href="../../openid.html">here</a>.</p>
+</li>
+<li>
+<p><code>replication</code>: the HTTP replication API (/_synapse/replication). See <a href="../../workers.html">here</a>.</p>
+</li>
+<li>
+<p><code>static</code>: static resources under synapse/static (/_matrix/static). (Mostly useful for 'fallback authentication'.)</p>
+</li>
+</ul>
+<p>Example configuration #1:</p>
+<pre><code class="language-yaml">listeners:
+ # TLS-enabled listener: for when matrix traffic is sent directly to synapse.
+ #
+ # (Note that you will also need to give Synapse a TLS key and certificate: see the TLS section
+ # below.)
+ #
+ - port: 8448
+ type: http
+ tls: true
+ resources:
+ - names: [client, federation]
+</code></pre>
+<p>Example configuration #2:</p>
+<pre><code class="language-yaml">listeners:
+ # Unsecure HTTP listener: for when matrix traffic passes through a reverse proxy
+ # that unwraps TLS.
+ #
+ # If you plan to use a reverse proxy, please see
+ # https://matrix-org.github.io/synapse/latest/reverse_proxy.html.
+ #
+ - port: 8008
+ tls: false
+ type: http
+ x_forwarded: true
+ bind_addresses: ['::1', '127.0.0.1']
+
+ resources:
+ - names: [client, federation]
+ compress: false
+
+ # example additional_resources:
+ additional_resources:
+ "/_matrix/my/custom/endpoint":
+ module: my_module.CustomRequestHandler
+ config: {}
+
+ # Turn on the twisted ssh manhole service on localhost on the given
+ # port.
+ - port: 9000
+ bind_addresses: ['::1', '127.0.0.1']
+ type: manhole
+</code></pre>
+<hr />
+<p>Config option: <code>manhole_settings</code></p>
+<p>Connection settings for the manhole. You can find more information
+on the manhole <a href="../../manhole.html">here</a>. Manhole sub-options include:</p>
+<ul>
+<li><code>username</code> : the username for the manhole. This defaults to 'matrix'.</li>
+<li><code>password</code>: The password for the manhole. This defaults to 'rabbithole'.</li>
+<li><code>ssh_priv_key_path</code> and <code>ssh_pub_key_path</code>: The private and public SSH key pair used to encrypt the manhole traffic.
+If these are left unset, then hardcoded and non-secret keys are used,
+which could allow traffic to be intercepted if sent over a public network.</li>
+</ul>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">manhole_settings:
+ username: manhole
+ password: mypassword
+ ssh_priv_key_path: CONFDIR/id_rsa
+ ssh_pub_key_path: CONFDIR/id_rsa.pub
+</code></pre>
+<hr />
+<p>Config option: <code>dummy_events_threshold</code></p>
+<p>Forward extremities can build up in a room due to networking delays between
+homeservers. Once this happens in a large room, calculation of the state of
+that room can become quite expensive. To mitigate this, once the number of
+forward extremities reaches a given threshold, Synapse will send an
+<code>org.matrix.dummy_event</code> event, which will reduce the forward extremities
+in the room.</p>
+<p>This setting defines the threshold (i.e. number of forward extremities in the room) at which dummy events are sent.
+The default value is 10.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">dummy_events_threshold: 5
+</code></pre>
+<hr />
+<h2 id="homeserver-blocking"><a class="header" href="#homeserver-blocking">Homeserver blocking</a></h2>
+<p>Useful options for Synapse admins.</p>
+<hr />
+<p>Config option: <code>admin_contact</code></p>
+<p>How to reach the server admin, used in <code>ResourceLimitError</code>. Defaults to none. </p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">admin_contact: 'mailto:admin@server.com'
+</code></pre>
+<hr />
+<p>Config option: <code>hs_disabled</code> and <code>hs_disabled_message</code></p>
+<p>Blocks users from connecting to the homeserver and provides a human-readable reason
+why the connection was blocked. Defaults to false. </p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">hs_disabled: true
+hs_disabled_message: 'Reason for why the HS is blocked'
+</code></pre>
+<hr />
+<p>Config option: <code>limit_usage_by_mau</code></p>
+<p>This option disables/enables monthly active user blocking. Used in cases where the admin or
+server owner wants to limit to the number of monthly active users. When enabled and a limit is
+reached the server returns a <code>ResourceLimitError</code> with error type <code>Codes.RESOURCE_LIMIT_EXCEEDED</code>.
+Defaults to false. If this is enabled, a value for <code>max_mau_value</code> must also be set.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">limit_usage_by_mau: true
+</code></pre>
+<hr />
+<p>Config option: <code>max_mau_value</code></p>
+<p>This option sets the hard limit of monthly active users above which the server will start
+blocking user actions if <code>limit_usage_by_mau</code> is enabled. Defaults to 0.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">max_mau_value: 50
+</code></pre>
+<hr />
+<p>Config option: <code>mau_trial_days</code></p>
+<p>The option <code>mau_trial_days</code> is a means to add a grace period for active users. It
+means that users must be active for the specified number of days before they
+can be considered active and guards against the case where lots of users
+sign up in a short space of time never to return after their initial
+session. Defaults to 0. </p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">mau_trial_days: 5
+</code></pre>
+<hr />
+<p>Config option: <code>mau_limit_alerting</code></p>
+<p>The option <code>mau_limit_alerting</code> is a means of limiting client-side alerting
+should the mau limit be reached. This is useful for small instances
+where the admin has 5 mau seats (say) for 5 specific people and no
+interest increasing the mau limit further. Defaults to true, which
+means that alerting is enabled.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">mau_limit_alerting: false
+</code></pre>
+<hr />
+<p>Config option: <code>mau_stats_only</code></p>
+<p>If enabled, the metrics for the number of monthly active users will
+be populated, however no one will be limited based on these numbers. If <code>limit_usage_by_mau</code>
+is true, this is implied to be true. Defaults to false. </p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">mau_stats_only: true
+</code></pre>
+<hr />
+<p>Config option: <code>mau_limit_reserved_threepids</code></p>
+<p>Sometimes the server admin will want to ensure certain accounts are
+never blocked by mau checking. These accounts are specified by this option.
+Defaults to none. Add accounts by specifying the <code>medium</code> and <code>address</code> of the
+reserved threepid (3rd party identifier).</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">mau_limit_reserved_threepids:
+ - medium: 'email'
+ address: 'reserved_user@example.com'
+</code></pre>
+<hr />
+<p>Config option: <code>server_context</code></p>
+<p>This option is used by phonehome stats to group together related servers.
+Defaults to none. </p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">server_context: context
+</code></pre>
+<hr />
+<p>Config option: <code>limit_remote_rooms</code></p>
+<p>When this option is enabled, the room "complexity" will be checked before a user
+joins a new remote room. If it is above the complexity limit, the server will
+disallow joining, or will instantly leave. This is useful for homeservers that are
+resource-constrained. Options for this setting include:</p>
+<ul>
+<li><code>enabled</code>: whether this check is enabled. Defaults to false.</li>
+<li><code>complexity</code>: the limit above which rooms cannot be joined. The default is 1.0.</li>
+<li><code>complexity_error</code>: override the error which is returned when the room is too complex with a
+custom message. </li>
+<li><code>admins_can_join</code>: allow server admins to join complex rooms. Default is false.</li>
+</ul>
+<p>Room complexity is an arbitrary measure based on factors such as the number of
+users in the room. </p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">limit_remote_rooms:
+ enabled: true
+ complexity: 0.5
+ complexity_error: "I can't let you do that, Dave."
+ admins_can_join: true
+</code></pre>
+<hr />
+<p>Config option: <code>require_membership_for_aliases</code></p>
+<p>Whether to require a user to be in the room to add an alias to it.
+Defaults to true.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">require_membership_for_aliases: false
+</code></pre>
+<hr />
+<p>Config option: <code>allow_per_room_profiles</code></p>
+<p>Whether to allow per-room membership profiles through the sending of membership
+events with profile information that differs from the target's global profile.
+Defaults to true.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">allow_per_room_profiles: false
+</code></pre>
+<hr />
+<p>Config option: <code>max_avatar_size</code></p>
+<p>The largest permissible file size in bytes for a user avatar. Defaults to no restriction.
+Use M for MB and K for KB. </p>
+<p>Note that user avatar changes will not work if this is set without using Synapse's media repository.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">max_avatar_size: 10M
+</code></pre>
+<hr />
+<p>Config option: <code>allowed_avatar_mimetypes</code></p>
+<p>The MIME types allowed for user avatars. Defaults to no restriction.</p>
+<p>Note that user avatar changes will not work if this is set without
+using Synapse's media repository.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">allowed_avatar_mimetypes: ["image/png", "image/jpeg", "image/gif"]
+</code></pre>
+<hr />
+<p>Config option: <code>redaction_retention_period</code></p>
+<p>How long to keep redacted events in unredacted form in the database. After
+this period redacted events get replaced with their redacted form in the DB.</p>
+<p>Defaults to <code>7d</code>. Set to <code>null</code> to disable.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">redaction_retention_period: 28d
+</code></pre>
+<hr />
+<p>Config option: <code>user_ips_max_age</code> </p>
+<p>How long to track users' last seen time and IPs in the database.</p>
+<p>Defaults to <code>28d</code>. Set to <code>null</code> to disable clearing out of old rows.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">user_ips_max_age: 14d
+</code></pre>
+<hr />
+<p>Config option: <code>request_token_inhibit_3pid_errors</code></p>
+<p>Inhibits the <code>/requestToken</code> endpoints from returning an error that might leak
+information about whether an e-mail address is in use or not on this
+homeserver. Defaults to false.
+Note that for some endpoints the error situation is the e-mail already being
+used, and for others the error is entering the e-mail being unused.
+If this option is enabled, instead of returning an error, these endpoints will
+act as if no error happened and return a fake session ID ('sid') to clients.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">request_token_inhibit_3pid_errors: true
+</code></pre>
+<hr />
+<p>Config option: <code>next_link_domain_whitelist</code></p>
+<p>A list of domains that the domain portion of <code>next_link</code> parameters
+must match.</p>
+<p>This parameter is optionally provided by clients while requesting
+validation of an email or phone number, and maps to a link that
+users will be automatically redirected to after validation
+succeeds. Clients can make use this parameter to aid the validation
+process.</p>
+<p>The whitelist is applied whether the homeserver or an identity server is handling validation.</p>
+<p>The default value is no whitelist functionality; all domains are
+allowed. Setting this value to an empty list will instead disallow
+all domains.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">next_link_domain_whitelist: ["matrix.org"]
+</code></pre>
+<hr />
+<p>Config option: <code>templates</code> and <code>custom_template_directory</code></p>
+<p>These options define templates to use when generating email or HTML page contents.
+The <code>custom_template_directory</code> determines which directory Synapse will try to
+find template files in to use to generate email or HTML page contents.
+If not set, or a file is not found within the template directory, a default
+template from within the Synapse package will be used.</p>
+<p>See <a href="../../templates.html">here</a> for more
+information about using custom templates.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">templates:
+ custom_template_directory: /path/to/custom/templates/
+</code></pre>
+<hr />
+<p>Config option: <code>retention</code></p>
+<p>This option and the associated options determine message retention policy at the
+server level.</p>
+<p>Room admins and mods can define a retention period for their rooms using the
+<code>m.room.retention</code> state event, and server admins can cap this period by setting
+the <code>allowed_lifetime_min</code> and <code>allowed_lifetime_max</code> config options.</p>
+<p>If this feature is enabled, Synapse will regularly look for and purge events
+which are older than the room's maximum retention period. Synapse will also
+filter events received over federation so that events that should have been
+purged are ignored and not stored again. </p>
+<p>The message retention policies feature is disabled by default.</p>
+<p>This setting has the following sub-options:</p>
+<ul>
+<li>
+<p><code>default_policy</code>: Default retention policy. If set, Synapse will apply it to rooms that lack the
+'m.room.retention' state event. This option is further specified by the
+<code>min_lifetime</code> and <code>max_lifetime</code> sub-options associated with it. Note that the
+value of <code>min_lifetime</code> doesn't matter much because Synapse doesn't take it into account yet. </p>
+</li>
+<li>
+<p><code>allowed_lifetime_min</code> and <code>allowed_lifetime_max</code>: Retention policy limits. If
+set, and the state of a room contains a <code>m.room.retention</code> event in its state
+which contains a <code>min_lifetime</code> or a <code>max_lifetime</code> that's out of these bounds,
+Synapse will cap the room's policy to these limits when running purge jobs.</p>
+</li>
+<li>
+<p><code>purge_jobs</code> and the associated <code>shortest_max_lifetime</code> and <code>longest_max_lifetime</code> sub-options:
+Server admins can define the settings of the background jobs purging the
+events whose lifetime has expired under the <code>purge_jobs</code> section.</p>
+<p>If no configuration is provided for this option, a single job will be set up to delete
+expired events in every room daily.</p>
+<p>Each job's configuration defines which range of message lifetimes the job
+takes care of. For example, if <code>shortest_max_lifetime</code> is '2d' and
+<code>longest_max_lifetime</code> is '3d', the job will handle purging expired events in
+rooms whose state defines a <code>max_lifetime</code> that's both higher than 2 days, and
+lower than or equal to 3 days. Both the minimum and the maximum value of a
+range are optional, e.g. a job with no <code>shortest_max_lifetime</code> and a
+<code>longest_max_lifetime</code> of '3d' will handle every room with a retention policy
+whose <code>max_lifetime</code> is lower than or equal to three days.</p>
+<p>The rationale for this per-job configuration is that some rooms might have a
+retention policy with a low <code>max_lifetime</code>, where history needs to be purged
+of outdated messages on a more frequent basis than for the rest of the rooms
+(e.g. every 12h), but not want that purge to be performed by a job that's
+iterating over every room it knows, which could be heavy on the server.</p>
+<p>If any purge job is configured, it is strongly recommended to have at least
+a single job with neither <code>shortest_max_lifetime</code> nor <code>longest_max_lifetime</code>
+set, or one job without <code>shortest_max_lifetime</code> and one job without
+<code>longest_max_lifetime</code> set. Otherwise some rooms might be ignored, even if
+<code>allowed_lifetime_min</code> and <code>allowed_lifetime_max</code> are set, because capping a
+room's policy to these values is done after the policies are retrieved from
+Synapse's database (which is done using the range specified in a purge job's
+configuration).</p>
+</li>
+</ul>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">retention:
+ enabled: true
+ default_policy:
+ min_lifetime: 1d
+ max_lifetime: 1y
+ allowed_lifetime_min: 1d
+ allowed_lifetime_max: 1y
+ purge_jobs:
+ - longest_max_lifetime: 3d
+ interval: 12h
+ - shortest_max_lifetime: 3d
+ interval: 1d
+</code></pre>
+<hr />
+<h2 id="tls"><a class="header" href="#tls">TLS</a></h2>
+<p>Options related to TLS.</p>
+<hr />
+<p>Config option: <code>tls_certificate_path</code></p>
+<p>This option specifies a PEM-encoded X509 certificate for TLS.
+This certificate, as of Synapse 1.0, will need to be a valid and verifiable
+certificate, signed by a recognised Certificate Authority. Defaults to none. </p>
+<p>Be sure to use a <code>.pem</code> file that includes the full certificate chain including
+any intermediate certificates (for instance, if using certbot, use
+<code>fullchain.pem</code> as your certificate, not <code>cert.pem</code>). </p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">tls_certificate_path: "CONFDIR/SERVERNAME.tls.crt"
+</code></pre>
+<hr />
+<p>Config option: <code>tls_private_key_path</code></p>
+<p>PEM-encoded private key for TLS. Defaults to none. </p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">tls_private_key_path: "CONFDIR/SERVERNAME.tls.key"
+</code></pre>
+<hr />
+<p>Config option: <code>federation_verify_certificates</code>
+Whether to verify TLS server certificates for outbound federation requests.</p>
+<p>Defaults to true. To disable certificate verification, set the option to false.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">federation_verify_certificates: false
+</code></pre>
+<hr />
+<p>Config option: <code>federation_client_minimum_tls_version</code></p>
+<p>The minimum TLS version that will be used for outbound federation requests.</p>
+<p>Defaults to <code>1</code>. Configurable to <code>1</code>, <code>1.1</code>, <code>1.2</code>, or <code>1.3</code>. Note
+that setting this value higher than <code>1.2</code> will prevent federation to most
+of the public Matrix network: only configure it to <code>1.3</code> if you have an
+entirely private federation setup and you can ensure TLS 1.3 support.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">federation_client_minimum_tls_version: 1.2
+</code></pre>
+<hr />
+<p>Config option: <code>federation_certificate_verification_whitelist</code></p>
+<p>Skip federation certificate verification on a given whitelist
+of domains.</p>
+<p>This setting should only be used in very specific cases, such as
+federation over Tor hidden services and similar. For private networks
+of homeservers, you likely want to use a private CA instead.</p>
+<p>Only effective if <code>federation_verify_certicates</code> is <code>true</code>.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">federation_certificate_verification_whitelist:
+ - lon.example.com
+ - "*.domain.com"
+ - "*.onion"
+</code></pre>
+<hr />
+<p>Config option: <code>federation_custom_ca_list</code></p>
+<p>List of custom certificate authorities for federation traffic.</p>
+<p>This setting should only normally be used within a private network of
+homeservers.</p>
+<p>Note that this list will replace those that are provided by your
+operating environment. Certificates must be in PEM format.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">federation_custom_ca_list:
+ - myCA1.pem
+ - myCA2.pem
+ - myCA3.pem
+</code></pre>
+<hr />
+<h2 id="federation"><a class="header" href="#federation">Federation</a></h2>
+<p>Options related to federation.</p>
+<hr />
+<p>Config option: <code>federation_domain_whitelist</code></p>
+<p>Restrict federation to the given whitelist of domains.
+N.B. we recommend also firewalling your federation listener to limit
+inbound federation traffic as early as possible, rather than relying
+purely on this application-layer restriction. If not specified, the
+default is to whitelist everything.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">federation_domain_whitelist:
+ - lon.example.com
+ - nyc.example.com
+ - syd.example.com
+</code></pre>
+<hr />
+<p>Config option: <code>federation_metrics_domains</code></p>
+<p>Report prometheus metrics on the age of PDUs being sent to and received from
+the given domains. This can be used to give an idea of "delay" on inbound
+and outbound federation, though be aware that any delay can be due to problems
+at either end or with the intermediate network.</p>
+<p>By default, no domains are monitored in this way.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">federation_metrics_domains:
+ - matrix.org
+ - example.com
+</code></pre>
+<hr />
+<p>Config option: <code>allow_profile_lookup_over_federation</code></p>
+<p>Set to false to disable profile lookup over federation. By default, the
+Federation API allows other homeservers to obtain profile data of any user
+on this homeserver.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">allow_profile_lookup_over_federation: false
+</code></pre>
+<hr />
+<p>Config option: <code>allow_device_name_lookup_over_federation</code></p>
+<p>Set this option to false to disable device display name lookup over federation. By default, the
+Federation API allows other homeservers to obtain device display names of any user
+on this homeserver.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">allow_device_name_lookup_over_federation: false
+</code></pre>
+<hr />
+<h2 id="caching"><a class="header" href="#caching">Caching</a></h2>
+<p>Options related to caching</p>
+<hr />
+<p>Config option: <code>event_cache_size</code></p>
+<p>The number of events to cache in memory. Not affected by
+<code>caches.global_factor</code>. Defaults to 10K.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">event_cache_size: 15K
+</code></pre>
+<hr />
+<p>Config option: <code>cache</code> and associated values</p>
+<p>A cache 'factor' is a multiplier that can be applied to each of
+Synapse's caches in order to increase or decrease the maximum
+number of entries that can be stored.</p>
+<p>Caching can be configured through the following sub-options:</p>
+<ul>
+<li>
+<p><code>global_factor</code>: Controls the global cache factor, which is the default cache factor
+for all caches if a specific factor for that cache is not otherwise
+set.</p>
+<p>This can also be set by the <code>SYNAPSE_CACHE_FACTOR</code> environment
+variable. Setting by environment variable takes priority over
+setting through the config file.</p>
+<p>Defaults to 0.5, which will halve the size of all caches.</p>
+</li>
+<li>
+<p><code>per_cache_factors</code>: A dictionary of cache name to cache factor for that individual
+cache. Overrides the global cache factor for a given cache.</p>
+<p>These can also be set through environment variables comprised
+of <code>SYNAPSE_CACHE_FACTOR_</code> + the name of the cache in capital
+letters and underscores. Setting by environment variable
+takes priority over setting through the config file.
+Ex. <code>SYNAPSE_CACHE_FACTOR_GET_USERS_WHO_SHARE_ROOM_WITH_USER=2.0</code></p>
+<p>Some caches have '*' and other characters that are not
+alphanumeric or underscores. These caches can be named with or
+without the special characters stripped. For example, to specify
+the cache factor for <code>*stateGroupCache*</code> via an environment
+variable would be <code>SYNAPSE_CACHE_FACTOR_STATEGROUPCACHE=2.0</code>.</p>
+</li>
+<li>
+<p><code>expire_caches</code>: Controls whether cache entries are evicted after a specified time
+period. Defaults to true. Set to false to disable this feature. Note that never expiring
+caches may result in excessive memory usage. </p>
+</li>
+<li>
+<p><code>cache_entry_ttl</code>: If <code>expire_caches</code> is enabled, this flag controls how long an entry can
+be in a cache without having been accessed before being evicted.
+Defaults to 30m. </p>
+</li>
+<li>
+<p><code>sync_response_cache_duration</code>: Controls how long the results of a /sync request are
+cached for after a successful response is returned. A higher duration can help clients
+with intermittent connections, at the cost of higher memory usage.
+By default, this is zero, which means that sync responses are not cached
+at all.</p>
+</li>
+</ul>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">caches:
+ global_factor: 1.0
+ per_cache_factors:
+ get_users_who_share_room_with_user: 2.0
+ expire_caches: false
+ sync_response_cache_duration: 2m
+</code></pre>
+<hr />
+<h2 id="database"><a class="header" href="#database">Database</a></h2>
+<p>Config options related to database settings.</p>
+<hr />
+<p>Config option: <code>database</code></p>
+<p>The <code>database</code> setting defines the database that synapse uses to store all of
+its data.</p>
+<p>Associated sub-options:</p>
+<ul>
+<li>
+<p><code>name</code>: this option specifies the database engine to use: either <code>sqlite3</code> (for SQLite)
+or <code>psycopg2</code> (for PostgreSQL). If no name is specified Synapse will default to SQLite. </p>
+</li>
+<li>
+<p><code>txn_limit</code> gives the maximum number of transactions to run per connection
+before reconnecting. Defaults to 0, which means no limit.</p>
+</li>
+<li>
+<p><code>allow_unsafe_locale</code> is an option specific to Postgres. Under the default behavior, Synapse will refuse to
+start if the postgres db is set to a non-C locale. You can override this behavior (which is <em>not</em> recommended)
+by setting <code>allow_unsafe_locale</code> to true. Note that doing so may corrupt your database. You can find more information
+<a href="../../postgres.html#fixing-incorrect-collate-or-ctype">here</a> and <a href="https://wiki.postgresql.org/wiki/Locale_data_changes">here</a>.</p>
+</li>
+<li>
+<p><code>args</code> gives options which are passed through to the database engine,
+except for options starting with <code>cp_</code>, which are used to configure the Twisted
+connection pool. For a reference to valid arguments, see:</p>
+<ul>
+<li>for <a href="https://docs.python.org/3/library/sqlite3.html#sqlite3.connect">sqlite</a></li>
+<li>for <a href="https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-PARAMKEYWORDS">postgres</a></li>
+<li>for <a href="https://twistedmatrix.com/documents/current/api/twisted.enterprise.adbapi.ConnectionPool.html#__init__">the connection pool</a></li>
+</ul>
+</li>
+</ul>
+<p>For more information on using Synapse with Postgres,
+see <a href="../../postgres.html">here</a>.</p>
+<p>Example SQLite configuration:</p>
+<pre><code>database:
+ name: sqlite3
+ args:
+ database: /path/to/homeserver.db
+</code></pre>
+<p>Example Postgres configuration:</p>
+<pre><code>database:
+ name: psycopg2
+ txn_limit: 10000
+ args:
+ user: synapse_user
+ password: secretpassword
+ database: synapse
+ host: localhost
+ port: 5432
+ cp_min: 5
+ cp_max: 10
+</code></pre>
+<hr />
+<h2 id="logging"><a class="header" href="#logging">Logging</a></h2>
+<p>Config options related to logging. </p>
+<hr />
+<p>Config option: <code>log_config</code></p>
+<p>This option specifies a yaml python logging config file as described <a href="https://docs.python.org/3.7/library/logging.config.html#configuration-dictionary-schema">here</a>.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">log_config: "CONFDIR/SERVERNAME.log.config"
+</code></pre>
+<hr />
+<h2 id="ratelimiting"><a class="header" href="#ratelimiting">Ratelimiting</a></h2>
+<p>Options related to ratelimiting in Synapse. </p>
+<p>Each ratelimiting configuration is made of two parameters:</p>
+<ul>
+<li><code>per_second</code>: number of requests a client can send per second.</li>
+<li><code>burst_count</code>: number of requests a client can send before being throttled.</li>
+</ul>
+<hr />
+<p>Config option: <code>rc_message</code></p>
+<p>Ratelimiting settings for client messaging.</p>
+<p>This is a ratelimiting option for messages that ratelimits sending based on the account the client
+is using. It defaults to: <code>per_second: 0.2</code>, <code>burst_count: 10</code>.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">rc_message:
+ per_second: 0.5
+ burst_count: 15
+</code></pre>
+<hr />
+<p>Config option: <code>rc_registration</code></p>
+<p>This option ratelimits registration requests based on the client's IP address.
+It defaults to <code>per_second: 0.17</code>, <code>burst_count: 3</code>. </p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">rc_registration:
+ per_second: 0.15
+ burst_count: 2
+</code></pre>
+<hr />
+<p>Config option: <code>rc_registration_token_validity</code></p>
+<p>This option checks the validity of registration tokens that ratelimits requests based on
+the client's IP address.
+Defaults to <code>per_second: 0.1</code>, <code>burst_count: 5</code>.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">rc_registration_token_validity:
+ per_second: 0.3
+ burst_count: 6
+</code></pre>
+<hr />
+<p>Config option: <code>rc_login</code></p>
+<p>This option specifies several limits for login:</p>
+<ul>
+<li>
+<p><code>address</code> ratelimits login requests based on the client's IP
+address. Defaults to <code>per_second: 0.17</code>, <code>burst_count: 3</code>.</p>
+</li>
+<li>
+<p><code>account</code> ratelimits login requests based on the account the
+client is attempting to log into. Defaults to <code>per_second: 0.17</code>,
+<code>burst_count: 3</code>.</p>
+</li>
+<li>
+<p><code>failted_attempts</code> ratelimits login requests based on the account the
+client is attempting to log into, based on the amount of failed login
+attempts for this account. Defaults to <code>per_second: 0.17</code>, <code>burst_count: 3</code>.</p>
+</li>
+</ul>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">rc_login:
+ address:
+ per_second: 0.15
+ burst_count: 5
+ account:
+ per_second: 0.18
+ burst_count: 4
+ failed_attempts:
+ per_second: 0.19
+ burst_count: 7
+</code></pre>
+<hr />
+<p>Config option: <code>rc_admin_redaction</code></p>
+<p>This option sets ratelimiting redactions by room admins. If this is not explicitly
+set then it uses the same ratelimiting as per <code>rc_message</code>. This is useful
+to allow room admins to deal with abuse quickly. </p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">rc_admin_redaction:
+ per_second: 1
+ burst_count: 50
+</code></pre>
+<hr />
+<p>Config option: <code>rc_joins</code></p>
+<p>This option allows for ratelimiting number of rooms a user can join. This setting has the following sub-options:</p>
+<ul>
+<li>
+<p><code>local</code>: ratelimits when users are joining rooms the server is already in.
+Defaults to <code>per_second: 0.1</code>, <code>burst_count: 10</code>.</p>
+</li>
+<li>
+<p><code>remote</code>: ratelimits when users are trying to join rooms not on the server (which
+can be more computationally expensive than restricting locally). Defaults to
+<code>per_second: 0.01</code>, <code>burst_count: 10</code> </p>
+</li>
+</ul>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">rc_joins:
+ local:
+ per_second: 0.2
+ burst_count: 15
+ remote:
+ per_second: 0.03
+ burst_count: 12
+</code></pre>
+<hr />
+<p>Config option: <code>rc_3pid_validation</code></p>
+<p>This option ratelimits how often a user or IP can attempt to validate a 3PID.
+Defaults to <code>per_second: 0.003</code>, <code>burst_count: 5</code>.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">rc_3pid_validation:
+ per_second: 0.003
+ burst_count: 5
+</code></pre>
+<hr />
+<p>Config option: <code>rc_invites</code></p>
+<p>This option sets ratelimiting how often invites can be sent in a room or to a
+specific user. <code>per_room</code> defaults to <code>per_second: 0.3</code>, <code>burst_count: 10</code> and
+<code>per_user</code> defaults to <code>per_second: 0.003</code>, <code>burst_count: 5</code>. </p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">rc_invites:
+ per_room:
+ per_second: 0.5
+ burst_count: 5
+ per_user:
+ per_second: 0.004
+ burst_count: 3
+</code></pre>
+<hr />
+<p>Config option: <code>rc_third_party_invite</code></p>
+<p>This option ratelimits 3PID invites (i.e. invites sent to a third-party ID
+such as an email address or a phone number) based on the account that's
+sending the invite. Defaults to <code>per_second: 0.2</code>, <code>burst_count: 10</code>.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">rc_third_party_invite:
+ per_second: 0.2
+ burst_count: 10
+</code></pre>
+<hr />
+<p>Config option: <code>rc_federation</code></p>
+<p>Defines limits on federation requests. </p>
+<p>The <code>rc_federation</code> configuration has the following sub-options:</p>
+<ul>
+<li><code>window_size</code>: window size in milliseconds. Defaults to 1000.</li>
+<li><code>sleep_limit</code>: number of federation requests from a single server in
+a window before the server will delay processing the request. Defaults to 10.</li>
+<li><code>sleep_delay</code>: duration in milliseconds to delay processing events
+from remote servers by if they go over the sleep limit. Defaults to 500.</li>
+<li><code>reject_limit</code>: maximum number of concurrent federation requests
+allowed from a single server. Defaults to 50.</li>
+<li><code>concurrent</code>: number of federation requests to concurrently process
+from a single server. Defaults to 3.</li>
+</ul>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">rc_federation:
+ window_size: 750
+ sleep_limit: 15
+ sleep_delay: 400
+ reject_limit: 40
+ concurrent: 5
+</code></pre>
+<hr />
+<p>Config option: <code>federation_rr_transactions_per_room_per_second</code></p>
+<p>Sets outgoing federation transaction frequency for sending read-receipts,
+per-room.</p>
+<p>If we end up trying to send out more read-receipts, they will get buffered up
+into fewer transactions. Defaults to 50. </p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">federation_rr_transactions_per_room_per_second: 40
+</code></pre>
+<hr />
+<h2 id="media-store"><a class="header" href="#media-store">Media Store</a></h2>
+<p>Config options relating to Synapse media store.</p>
+<hr />
+<p>Config option: <code>enable_media_repo</code> </p>
+<p>Enable the media store service in the Synapse master. Defaults to true.
+Set to false if you are using a separate media store worker.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">enable_media_repo: false
+</code></pre>
+<hr />
+<p>Config option: <code>media_store_path</code></p>
+<p>Directory where uploaded images and attachments are stored.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">media_store_path: "DATADIR/media_store"
+</code></pre>
+<hr />
+<p>Config option: <code>media_storage_providers</code></p>
+<p>Media storage providers allow media to be stored in different
+locations. Defaults to none. Associated sub-options are:</p>
+<ul>
+<li><code>module</code>: type of resource, e.g. <code>file_system</code>.</li>
+<li><code>store_local</code>: whether to store newly uploaded local files</li>
+<li><code>store_remote</code>: whether to store newly downloaded local files</li>
+<li><code>store_synchronous</code>: whether to wait for successful storage for local uploads</li>
+<li><code>config</code>: sets a path to the resource through the <code>directory</code> option </li>
+</ul>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">media_storage_providers:
+ - module: file_system
+ store_local: false
+ store_remote: false
+ store_synchronous: false
+ config:
+ directory: /mnt/some/other/directory
+</code></pre>
+<hr />
+<p>Config option: <code>max_upload_size</code></p>
+<p>The largest allowed upload size in bytes.</p>
+<p>If you are using a reverse proxy you may also need to set this value in
+your reverse proxy's config. Defaults to 50M. Notably Nginx has a small max body size by default.
+See <a href="../../reverse_proxy.html">here</a> for more on using a reverse proxy with Synapse. </p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">max_upload_size: 60M
+</code></pre>
+<hr />
+<p>Config option: <code>max_image_pixels</code></p>
+<p>Maximum number of pixels that will be thumbnailed. Defaults to 32M.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">max_image_pixels: 35M
+</code></pre>
+<hr />
+<p>Config option: <code>dynamic_thumbnails</code></p>
+<p>Whether to generate new thumbnails on the fly to precisely match
+the resolution requested by the client. If true then whenever
+a new resolution is requested by the client the server will
+generate a new thumbnail. If false the server will pick a thumbnail
+from a precalculated list. Defaults to false. </p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">dynamic_thumbnails: true
+</code></pre>
+<hr />
+<p>Config option: <code>thumbnail_sizes</code></p>
+<p>List of thumbnails to precalculate when an image is uploaded. Associated sub-options are:</p>
+<ul>
+<li><code>width</code></li>
+<li><code>height</code></li>
+<li><code>method</code>: i.e. <code>crop</code>, <code>scale</code>, etc.</li>
+</ul>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">thumbnail_sizes:
+ - width: 32
+ height: 32
+ method: crop
+ - width: 96
+ height: 96
+ method: crop
+ - width: 320
+ height: 240
+ method: scale
+ - width: 640
+ height: 480
+ method: scale
+ - width: 800
+ height: 600
+ method: scale
+</code></pre>
+<p>Config option: <code>url_preview_enabled</code></p>
+<p>This setting determines whether the preview URL API is enabled.
+It is disabled by default. Set to true to enable. If enabled you must specify a
+<code>url_preview_ip_range_blacklist</code> blacklist.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">url_preview_enabled: true
+</code></pre>
+<hr />
+<p>Config option: <code>url_preview_ip_range_blacklist</code></p>
+<p>List of IP address CIDR ranges that the URL preview spider is denied
+from accessing. There are no defaults: you must explicitly
+specify a list for URL previewing to work. You should specify any
+internal services in your network that you do not want synapse to try
+to connect to, otherwise anyone in any Matrix room could cause your
+synapse to issue arbitrary GET requests to your internal services,
+causing serious security issues.</p>
+<p>(0.0.0.0 and :: are always blacklisted, whether or not they are explicitly
+listed here, since they correspond to unroutable addresses.)</p>
+<p>This must be specified if <code>url_preview_enabled</code> is set. It is recommended that
+you use the following example list as a starting point.</p>
+<p>Note: The value is ignored when an HTTP proxy is in use.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">url_preview_ip_range_blacklist:
+ - '127.0.0.0/8'
+ - '10.0.0.0/8'
+ - '172.16.0.0/12'
+ - '192.168.0.0/16'
+ - '100.64.0.0/10'
+ - '192.0.0.0/24'
+ - '169.254.0.0/16'
+ - '192.88.99.0/24'
+ - '198.18.0.0/15'
+ - '192.0.2.0/24'
+ - '198.51.100.0/24'
+ - '203.0.113.0/24'
+ - '224.0.0.0/4'
+ - '::1/128'
+ - 'fe80::/10'
+ - 'fc00::/7'
+ - '2001:db8::/32'
+ - 'ff00::/8'
+ - 'fec0::/10'
+</code></pre>
+<hr />
+<p>Config option: <code>url_preview_ip_range_whitelist</code></p>
+<p>This option sets a list of IP address CIDR ranges that the URL preview spider is allowed
+to access even if they are specified in <code>url_preview_ip_range_blacklist</code>.
+This is useful for specifying exceptions to wide-ranging blacklisted
+target IP ranges - e.g. for enabling URL previews for a specific private
+website only visible in your network. Defaults to none. </p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">url_preview_ip_range_whitelist:
+ - '192.168.1.1'
+</code></pre>
+<hr />
+<p>Config option: <code>url_preview_url_blacklist</code></p>
+<p>Optional list of URL matches that the URL preview spider is
+denied from accessing. You should use <code>url_preview_ip_range_blacklist</code>
+in preference to this, otherwise someone could define a public DNS
+entry that points to a private IP address and circumvent the blacklist.
+This is more useful if you know there is an entire shape of URL that
+you know that will never want synapse to try to spider.</p>
+<p>Each list entry is a dictionary of url component attributes as returned
+by urlparse.urlsplit as applied to the absolute form of the URL. See
+<a href="https://docs.python.org/2/library/urlparse.html#urlparse.urlsplit">here</a> for more
+information. Some examples are:</p>
+<ul>
+<li><code>username</code></li>
+<li><code>netloc</code></li>
+<li><code>scheme</code></li>
+<li><code>path</code></li>
+</ul>
+<p>The values of the dictionary are treated as a filename match pattern
+applied to that component of URLs, unless they start with a ^ in which
+case they are treated as a regular expression match. If all the
+specified component matches for a given list item succeed, the URL is
+blacklisted.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">url_preview_url_blacklist:
+ # blacklist any URL with a username in its URI
+ - username: '*'
+
+ # blacklist all *.google.com URLs
+ - netloc: 'google.com'
+ - netloc: '*.google.com'
+
+ # blacklist all plain HTTP URLs
+ - scheme: 'http'
+
+ # blacklist http(s)://www.acme.com/foo
+ - netloc: 'www.acme.com'
+ path: '/foo'
+
+ # blacklist any URL with a literal IPv4 address
+ - netloc: '^[0-9]+\.[0-9]+\.[0-9]+\.[0-9]+$'
+</code></pre>
+<hr />
+<p>Config option: <code>max_spider_size</code></p>
+<p>The largest allowed URL preview spidering size in bytes. Defaults to 10M.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">max_spider_size: 8M
+</code></pre>
+<hr />
+<p>Config option: <code>url_preview_language</code></p>
+<p>A list of values for the Accept-Language HTTP header used when
+downloading webpages during URL preview generation. This allows
+Synapse to specify the preferred languages that URL previews should
+be in when communicating with remote servers.</p>
+<p>Each value is a IETF language tag; a 2-3 letter identifier for a
+language, optionally followed by subtags separated by '-', specifying
+a country or region variant.</p>
+<p>Multiple values can be provided, and a weight can be added to each by
+using quality value syntax (;q=). '*' translates to any language.</p>
+<p>Defaults to "en".</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml"> url_preview_accept_language:
+ - en-UK
+ - en-US;q=0.9
+ - fr;q=0.8
+ - *;q=0.7
+</code></pre>
+<hr />
+<p>Config option: <code>oembed</code></p>
+<p>oEmbed allows for easier embedding content from a website. It can be
+used for generating URLs previews of services which support it. A default list of oEmbed providers
+is included with Synapse. Set <code>disable_default_providers</code> to true to disable using
+these default oEmbed URLs. Use <code>additional_providers</code> to specify additional files with oEmbed configuration (each
+should be in the form of providers.json). By default this list is empty. </p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">oembed:
+ disable_default_providers: true
+ additional_providers:
+ - oembed/my_providers.json
+</code></pre>
+<hr />
+<h2 id="captcha"><a class="header" href="#captcha">Captcha</a></h2>
+<p>See <a href="../../CAPTCHA_SETUP.html">here</a> for full details on setting up captcha.</p>
+<hr />
+<p>Config option: <code>recaptcha_public_key</code></p>
+<p>This homeserver's ReCAPTCHA public key. Must be specified if <code>enable_registration_captcha</code> is
+enabled.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">recaptcha_public_key: "YOUR_PUBLIC_KEY"
+</code></pre>
+<hr />
+<p>Config option: <code>recaptcha_private_key</code> </p>
+<p>This homeserver's ReCAPTCHA private key. Must be specified if <code>enable_registration_captcha</code> is
+enabled.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">recaptcha_private_key: "YOUR_PRIVATE_KEY"
+</code></pre>
+<hr />
+<p>Config option: <code>enable_registration_captcha</code></p>
+<p>Set to true to enable ReCaptcha checks when registering, preventing signup
+unless a captcha is answered. Requires a valid ReCaptcha public/private key.
+Defaults to false.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">enable_registration_captcha: true
+</code></pre>
+<hr />
+<p>Config option: <code>recaptcha_siteverify_api</code></p>
+<p>The API endpoint to use for verifying <code>m.login.recaptcha</code> responses.
+Defaults to <code>https://www.recaptcha.net/recaptcha/api/siteverify</code>.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">recaptcha_siteverify_api: "https://my.recaptcha.site"
+</code></pre>
+<hr />
+<h2 id="turn"><a class="header" href="#turn">TURN</a></h2>
+<p>Options related to adding a TURN server to Synapse.</p>
+<hr />
+<p>Config option: <code>turn_uris</code></p>
+<p>The public URIs of the TURN server to give to clients.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">turn_uris: [turn:example.org]
+</code></pre>
+<hr />
+<p>Config option: <code>turn_shared_secret</code></p>
+<p>The shared secret used to compute passwords for the TURN server.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">turn_shared_secret: "YOUR_SHARED_SECRET"
+</code></pre>
+<hr />
+<p>Config options: <code>turn_username</code> and <code>turn_password</code></p>
+<p>The Username and password if the TURN server needs them and does not use a token.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">turn_username: "TURNSERVER_USERNAME"
+turn_password: "TURNSERVER_PASSWORD"
+</code></pre>
+<hr />
+<p>Config option: <code>turn_user_lifetime</code></p>
+<p>How long generated TURN credentials last. Defaults to 1h.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">turn_user_lifetime: 2h
+</code></pre>
+<hr />
+<p>Config option: <code>turn_allow_guests</code></p>
+<p>Whether guests should be allowed to use the TURN server. This defaults to true, otherwise
+VoIP will be unreliable for guests. However, it does introduce a slight security risk as
+it allows users to connect to arbitrary endpoints without having first signed up for a valid account (e.g. by passing a CAPTCHA).</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">turn_allow_guests: false
+</code></pre>
+<hr />
+<h2 id="registration"><a class="header" href="#registration">Registration</a></h2>
+<p>Registration can be rate-limited using the parameters in the <a href="#ratelimiting">Ratelimiting</a> section of this manual.</p>
+<hr />
+<p>Config option: <code>enable_registration</code></p>
+<p>Enable registration for new users. Defaults to false. It is highly recommended that if you enable registration,
+you use either captcha, email, or token-based verification to verify that new users are not bots. In order to enable registration
+without any verification, you must also set <code>enable_registration_without_verification</code> to true.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">enable_registration: true
+</code></pre>
+<hr />
+<p>Config option: <code>enable_registration_without_verification</code>
+Enable registration without email or captcha verification. Note: this option is <em>not</em> recommended,
+as registration without verification is a known vector for spam and abuse. Defaults to false. Has no effect
+unless <code>enable_registration</code> is also enabled.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">enable_registration_without_verification: true
+</code></pre>
+<hr />
+<p>Config option: <code>session_lifetime</code></p>
+<p>Time that a user's session remains valid for, after they log in.</p>
+<p>Note that this is not currently compatible with guest logins.</p>
+<p>Note also that this is calculated at login time: changes are not applied retrospectively to users who have already
+logged in.</p>
+<p>By default, this is infinite.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">session_lifetime: 24h
+</code></pre>
+<hr />
+<p>Config option: <code>refresh_access_token_lifetime</code></p>
+<p>Time that an access token remains valid for, if the session is using refresh tokens.</p>
+<p>For more information about refresh tokens, please see the <a href="user_authentication/refresh_tokens.html">manual</a>.</p>
+<p>Note that this only applies to clients which advertise support for refresh tokens.</p>
+<p>Note also that this is calculated at login time and refresh time: changes are not applied to
+existing sessions until they are refreshed.</p>
+<p>By default, this is 5 minutes.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">refreshable_access_token_lifetime: 10m
+</code></pre>
+<hr />
+<p>Config option: <code>refresh_token_lifetime: 24h</code></p>
+<p>Time that a refresh token remains valid for (provided that it is not
+exchanged for another one first).
+This option can be used to automatically log-out inactive sessions.
+Please see the manual for more information.</p>
+<p>Note also that this is calculated at login time and refresh time:
+changes are not applied to existing sessions until they are refreshed.</p>
+<p>By default, this is infinite.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">refresh_token_lifetime: 24h
+</code></pre>
+<hr />
+<p>Config option: <code>nonrefreshable_access_token_lifetime</code></p>
+<p>Time that an access token remains valid for, if the session is NOT
+using refresh tokens.</p>
+<p>Please note that not all clients support refresh tokens, so setting
+this to a short value may be inconvenient for some users who will
+then be logged out frequently.</p>
+<p>Note also that this is calculated at login time: changes are not applied
+retrospectively to existing sessions for users that have already logged in.</p>
+<p>By default, this is infinite.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">nonrefreshable_access_token_lifetime: 24h
+</code></pre>
+<hr />
+<p>Config option: <code>registrations_require_3pid</code></p>
+<p>If this is set, the user must provide all of the specified types of 3PID when registering.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">registrations_require_3pid:
+ - email
+ - msisdn
+</code></pre>
+<hr />
+<p>Config option: <code>disable_msisdn_registration</code></p>
+<p>Explicitly disable asking for MSISDNs from the registration
+flow (overrides <code>registrations_require_3pid</code> if MSISDNs are set as required).</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">disable_msisdn_registration: true
+</code></pre>
+<hr />
+<p>Config option: <code>allowed_local_3pids</code></p>
+<p>Mandate that users are only allowed to associate certain formats of
+3PIDs with accounts on this server, as specified by the <code>medium</code> and <code>pattern</code> sub-options.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">allowed_local_3pids:
+ - medium: email
+ pattern: '^[^@]+@matrix\.org$'
+ - medium: email
+ pattern: '^[^@]+@vector\.im$'
+ - medium: msisdn
+ pattern: '\+44'
+</code></pre>
+<hr />
+<p>Config option: <code>enable_3pid_lookup</code></p>
+<p>Enable 3PIDs lookup requests to identity servers from this server. Defaults to true.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">enable_3pid_lookup: false
+</code></pre>
+<hr />
+<p>Config option: <code>registration_requires_token</code></p>
+<p>Require users to submit a token during registration.
+Tokens can be managed using the admin <a href="../administration/admin_api/registration_tokens.html">API</a>.
+Note that <code>enable_registration</code> must be set to true.
+Disabling this option will not delete any tokens previously generated.
+Defaults to false. Set to true to enable.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">registration_requires_token: true
+</code></pre>
+<hr />
+<p>Config option: <code>registration_shared_secret</code></p>
+<p>If set, allows registration of standard or admin accounts by anyone who
+has the shared secret, even if registration is otherwise disabled.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">registration_shared_secret: <PRIVATE STRING>
+</code></pre>
+<hr />
+<p>Config option: <code>bcrypt_rounds</code></p>
+<p>Set the number of bcrypt rounds used to generate password hash.
+Larger numbers increase the work factor needed to generate the hash.
+The default number is 12 (which equates to 2^12 rounds).
+N.B. that increasing this will exponentially increase the time required
+to register or login - e.g. 24 => 2^24 rounds which will take >20 mins.
+Example configuration:</p>
+<pre><code class="language-yaml">bcrypt_rounds: 14
+</code></pre>
+<hr />
+<p>Config option: <code>allow_guest_access</code></p>
+<p>Allows users to register as guests without a password/email/etc, and
+participate in rooms hosted on this server which have been made
+accessible to anonymous users. Defaults to false.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">allow_guest_access: true
+</code></pre>
+<hr />
+<p>Config option: <code>default_identity_server</code></p>
+<p>The identity server which we suggest that clients should use when users log
+in on this server.</p>
+<p>(By default, no suggestion is made, so it is left up to the client.
+This setting is ignored unless <code>public_baseurl</code> is also explicitly set.)</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">default_identity_server: https://matrix.org
+</code></pre>
+<hr />
+<p>Config option: <code>account_threepid_delegates</code></p>
+<p>Handle threepid (email/phone etc) registration and password resets through a set of
+<em>trusted</em> identity servers. Note that this allows the configured identity server to
+reset passwords for accounts!</p>
+<p>Be aware that if <code>email</code> is not set, and SMTP options have not been
+configured in the email config block, registration and user password resets via
+email will be globally disabled.</p>
+<p>Additionally, if <code>msisdn</code> is not set, registration and password resets via msisdn
+will be disabled regardless, and users will not be able to associate an msisdn
+identifier to their account. This is due to Synapse currently not supporting
+any method of sending SMS messages on its own.</p>
+<p>To enable using an identity server for operations regarding a particular third-party
+identifier type, set the value to the URL of that identity server as shown in the
+examples below.</p>
+<p>Servers handling the these requests must answer the <code>/requestToken</code> endpoints defined
+by the Matrix Identity Service API <a href="https://matrix.org/docs/spec/identity_service/latest">specification</a>.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">account_threepid_delegates:
+ email: https://example.com # Delegate email sending to example.com
+ msisdn: http://localhost:8090 # Delegate SMS sending to this local process
+</code></pre>
+<hr />
+<p>Config option: <code>enable_set_displayname</code></p>
+<p>Whether users are allowed to change their displayname after it has
+been initially set. Useful when provisioning users based on the
+contents of a third-party directory.</p>
+<p>Does not apply to server administrators. Defaults to true.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">enable_set_displayname: false
+</code></pre>
+<hr />
+<p>Config option: <code>enable_set_avatar_url</code></p>
+<p>Whether users are allowed to change their avatar after it has been
+initially set. Useful when provisioning users based on the contents
+of a third-party directory.</p>
+<p>Does not apply to server administrators. Defaults to true.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">enable_set_avatar_url: false
+</code></pre>
+<hr />
+<p>Config option: <code>enable_3pid_changes</code></p>
+<p>Whether users can change the third-party IDs associated with their accounts
+(email address and msisdn).</p>
+<p>Defaults to true.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">enable_3pid_changes: false
+</code></pre>
+<hr />
+<p>Config option: <code>auto_join_rooms</code></p>
+<p>Users who register on this homeserver will automatically be joined
+to the rooms listed under this option.</p>
+<p>By default, any room aliases included in this list will be created
+as a publicly joinable room when the first user registers for the
+homeserver. If the room already exists, make certain it is a publicly joinable
+room, i.e. the join rule of the room must be set to 'public'. You can find more options
+relating to auto-joining rooms below. </p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">auto_join_rooms:
+ - "#exampleroom:example.com"
+ - "#anotherexampleroom:example.com"
+</code></pre>
+<hr />
+<p>Config option: <code>autocreate_auto_join_rooms</code></p>
+<p>Where <code>auto_join_rooms</code> are specified, setting this flag ensures that
+the rooms exist by creating them when the first user on the
+homeserver registers.</p>
+<p>By default the auto-created rooms are publicly joinable from any federated
+server. Use the <code>autocreate_auto_join_rooms_federated</code> and
+<code>autocreate_auto_join_room_preset</code> settings to customise this behaviour.</p>
+<p>Setting to false means that if the rooms are not manually created,
+users cannot be auto-joined since they do not exist.</p>
+<p>Defaults to true.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">autocreate_auto_join_rooms: false
+</code></pre>
+<hr />
+<p>Config option: <code>autocreate_auto_join_rooms_federated</code></p>
+<p>Whether the rooms listen in <code>auto_join_rooms</code> that are auto-created are available
+via federation. Only has an effect if <code>autocreate_auto_join_rooms</code> is true.</p>
+<p>Note that whether a room is federated cannot be modified after
+creation.</p>
+<p>Defaults to true: the room will be joinable from other servers.
+Set to false to prevent users from other homeservers from
+joining these rooms.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">autocreate_auto_join_rooms_federated: false
+</code></pre>
+<hr />
+<p>Config option: <code>autocreate_auto_join_room_preset</code></p>
+<p>The room preset to use when auto-creating one of <code>auto_join_rooms</code>. Only has an
+effect if <code>autocreate_auto_join_rooms</code> is true.</p>
+<p>Possible values for this option are:</p>
+<ul>
+<li>"public_chat": the room is joinable by anyone, including
+federated servers if <code>autocreate_auto_join_rooms_federated</code> is true (the default).</li>
+<li>"private_chat": an invitation is required to join these rooms. </li>
+<li>"trusted_private_chat": an invitation is required to join this room and the invitee is
+assigned a power level of 100 upon joining the room. </li>
+</ul>
+<p>If a value of "private_chat" or "trusted_private_chat" is used then
+<code>auto_join_mxid_localpart</code> must also be configured.</p>
+<p>Defaults to "public_chat".</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">autocreate_auto_join_room_preset: private_chat
+</code></pre>
+<hr />
+<p>Config option: <code>auto_join_mxid_localpart</code></p>
+<p>The local part of the user id which is used to create <code>auto_join_rooms</code> if
+<code>autocreate_auto_join_rooms</code> is true. If this is not provided then the
+initial user account that registers will be used to create the rooms.</p>
+<p>The user id is also used to invite new users to any auto-join rooms which
+are set to invite-only.</p>
+<p>It <em>must</em> be configured if <code>autocreate_auto_join_room_preset</code> is set to
+"private_chat" or "trusted_private_chat".</p>
+<p>Note that this must be specified in order for new users to be correctly
+invited to any auto-join rooms which have been set to invite-only (either
+at the time of creation or subsequently).</p>
+<p>Note that, if the room already exists, this user must be joined and
+have the appropriate permissions to invite new members.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">auto_join_mxid_localpart: system
+</code></pre>
+<hr />
+<p>Config option: <code>auto_join_rooms_for_guests</code></p>
+<p>When <code>auto_join_rooms</code> is specified, setting this flag to false prevents
+guest accounts from being automatically joined to the rooms.</p>
+<p>Defaults to true.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">auto_join_rooms_for_guests: false
+</code></pre>
+<hr />
+<p>Config option: <code>inhibit_user_in_use_error</code></p>
+<p>Whether to inhibit errors raised when registering a new account if the user ID
+already exists. If turned on, requests to <code>/register/available</code> will always
+show a user ID as available, and Synapse won't raise an error when starting
+a registration with a user ID that already exists. However, Synapse will still
+raise an error if the registration completes and the username conflicts.</p>
+<p>Defaults to false.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">inhibit_user_in_use_error: true
+</code></pre>
+<hr />
+<h2 id="metrics"><a class="header" href="#metrics">Metrics</a></h2>
+<p>Config options related to metrics.</p>
+<hr />
+<p>Config option: <code>enable_metrics</code></p>
+<p>Set to true to enable collection and rendering of performance metrics.
+Defaults to false.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">enable_metrics: true
+</code></pre>
+<hr />
+<p>Config option: <code>sentry</code></p>
+<p>Use this option to enable sentry integration. Provide the DSN assigned to you by sentry
+with the <code>dsn</code> setting. </p>
+<p>NOTE: While attempts are made to ensure that the logs don't contain
+any sensitive information, this cannot be guaranteed. By enabling
+this option the sentry server may therefore receive sensitive
+information, and it in turn may then disseminate sensitive information
+through insecure notification channels if so configured.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">sentry:
+ dsn: "..."
+</code></pre>
+<hr />
+<p>Config option: <code>metrics_flags</code></p>
+<p>Flags to enable Prometheus metrics which are not suitable to be
+enabled by default, either for performance reasons or limited use.
+Currently the only option is <code>known_servers</code>, which publishes
+<code>synapse_federation_known_servers</code>, a gauge of the number of
+servers this homeserver knows about, including itself. May cause
+performance problems on large homeservers.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">metrics_flags:
+ known_servers: true
+</code></pre>
+<hr />
+<p>Config option: <code>report_stats</code></p>
+<p>Whether or not to report anonymized homeserver usage statistics. This is originally
+set when generating the config. Set this option to true or false to change the current
+behavior. </p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">report_stats: true
+</code></pre>
+<hr />
+<p>Config option: <code>report_stats_endpoint</code></p>
+<p>The endpoint to report the anonymized homeserver usage statistics to.
+Defaults to https://matrix.org/report-usage-stats/push</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">report_stats_endpoint: https://example.com/report-usage-stats/push
+</code></pre>
+<hr />
+<h2 id="api-configuration"><a class="header" href="#api-configuration">API Configuration</a></h2>
+<p>Config settings related to the client/server API</p>
+<hr />
+<p>Config option: <code>room_prejoin_state:</code></p>
+<p>Controls for the state that is shared with users who receive an invite
+to a room. By default, the following state event types are shared with users who
+receive invites to the room:</p>
+<ul>
+<li>m.room.join_rules</li>
+<li>m.room.canonical_alias</li>
+<li>m.room.avatar</li>
+<li>m.room.encryption</li>
+<li>m.room.name</li>
+<li>m.room.create</li>
+<li>m.room.topic</li>
+</ul>
+<p>To change the default behavior, use the following sub-options:</p>
+<ul>
+<li><code>disable_default_event_types</code>: set to true to disable the above defaults. If this
+is enabled, only the event types listed in <code>additional_event_types</code> are shared.
+Defaults to false.</li>
+<li><code>additional_event_types</code>: Additional state event types to share with users when they are invited
+to a room. By default, this list is empty (so only the default event types are shared).</li>
+</ul>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">room_prejoin_state:
+ disable_default_event_types: true
+ additional_event_types:
+ - org.example.custom.event.type
+ - m.room.join_rules
+</code></pre>
+<hr />
+<p>Config option: <code>track_puppeted_user_ips</code></p>
+<p>We record the IP address of clients used to access the API for various
+reasons, including displaying it to the user in the "Where you're signed in"
+dialog.</p>
+<p>By default, when puppeting another user via the admin API, the client IP
+address is recorded against the user who created the access token (ie, the
+admin user), and <em>not</em> the puppeted user.</p>
+<p>Set this option to true to also record the IP address against the puppeted
+user. (This also means that the puppeted user will count as an "active" user
+for the purpose of monthly active user tracking - see <code>limit_usage_by_mau</code> etc
+above.)</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">track_puppeted_user_ips: true
+</code></pre>
+<hr />
+<p>Config option: <code>app_service_config_files</code></p>
+<p>A list of application service config files to use.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">app_service_config_files:
+ - app_service_1.yaml
+ - app_service_2.yaml
+</code></pre>
+<hr />
+<p>Config option: <code>track_appservice_user_ips</code></p>
+<p>Defaults to false. Set to true to enable tracking of application service IP addresses.
+Implicitly enables MAU tracking for application service users.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">track_appservice_user_ips: true
+</code></pre>
+<hr />
+<p>Config option: <code>macaroon_secret_key</code></p>
+<p>A secret which is used to sign access tokens. If none is specified,
+the <code>registration_shared_secret</code> is used, if one is given; otherwise,
+a secret key is derived from the signing key.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">macaroon_secret_key: <PRIVATE STRING>
+</code></pre>
+<hr />
+<p>Config option: <code>form_secret</code></p>
+<p>A secret which is used to calculate HMACs for form values, to stop
+falsification of values. Must be specified for the User Consent
+forms to work.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">form_secret: <PRIVATE STRING>
+</code></pre>
+<hr />
+<h2 id="signing-keys"><a class="header" href="#signing-keys">Signing Keys</a></h2>
+<p>Config options relating to signing keys</p>
+<hr />
+<p>Config option: <code>signing_key_path</code></p>
+<p>Path to the signing key to sign messages with.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">signing_key_path: "CONFDIR/SERVERNAME.signing.key"
+</code></pre>
+<hr />
+<p>Config option: <code>old_signing_keys</code></p>
+<p>The keys that the server used to sign messages with but won't use
+to sign new messages. For each key, <code>key</code> should be the base64-encoded public key, and
+<code>expired_ts</code>should be the time (in milliseconds since the unix epoch) that
+it was last used.</p>
+<p>It is possible to build an entry from an old <code>signing.key</code> file using the
+<code>export_signing_key</code> script which is provided with synapse.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">old_signing_keys:
+ "ed25519:id": { key: "base64string", expired_ts: 123456789123 }
+</code></pre>
+<hr />
+<p>Config option: <code>key_refresh_interval</code></p>
+<p>How long key response published by this server is valid for.
+Used to set the <code>valid_until_ts</code> in <code>/key/v2</code> APIs.
+Determines how quickly servers will query to check which keys
+are still valid. Defaults to 1d.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">key_refresh_interval: 2d
+</code></pre>
+<hr />
+<p>Config option: <code>trusted_key_servers:</code></p>
+<p>The trusted servers to download signing keys from.</p>
+<p>When we need to fetch a signing key, each server is tried in parallel.</p>
+<p>Normally, the connection to the key server is validated via TLS certificates.
+Additional security can be provided by configuring a <code>verify key</code>, which
+will make synapse check that the response is signed by that key.</p>
+<p>This setting supercedes an older setting named <code>perspectives</code>. The old format
+is still supported for backwards-compatibility, but it is deprecated.</p>
+<p><code>trusted_key_servers</code> defaults to matrix.org, but using it will generate a
+warning on start-up. To suppress this warning, set
+<code>suppress_key_server_warning</code> to true.</p>
+<p>Options for each entry in the list include:</p>
+<ul>
+<li><code>server_name</code>: the name of the server. Required.</li>
+<li><code>verify_keys</code>: an optional map from key id to base64-encoded public key.
+If specified, we will check that the response is signed by at least
+one of the given keys.</li>
+<li><code>accept_keys_insecurely</code>: a boolean. Normally, if <code>verify_keys</code> is unset,
+and <code>federation_verify_certificates</code> is not <code>true</code>, synapse will refuse
+to start, because this would allow anyone who can spoof DNS responses
+to masquerade as the trusted key server. If you know what you are doing
+and are sure that your network environment provides a secure connection
+to the key server, you can set this to <code>true</code> to override this behaviour.</li>
+</ul>
+<p>Example configuration #1:</p>
+<pre><code class="language-yaml">trusted_key_servers:
+ - server_name: "my_trusted_server.example.com"
+ verify_keys:
+ "ed25519:auto": "abcdefghijklmnopqrstuvwxyzabcdefghijklmopqr"
+ - server_name: "my_other_trusted_server.example.com"
+</code></pre>
+<p>Example configuration #2:</p>
+<pre><code class="language-yaml">trusted_key_servers:
+ - server_name: "matrix.org"
+</code></pre>
+<hr />
+<p>Config option: <code>suppress_key_server_warning</code></p>
+<p>Set the following to true to disable the warning that is emitted when the
+<code>trusted_key_servers</code> include 'matrix.org'. See above.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">suppress_key_server_warning: true
+</code></pre>
+<hr />
+<p>Config option: <code>key_server_signing_keys_path</code></p>
+<p>The signing keys to use when acting as a trusted key server. If not specified
+defaults to the server signing key.</p>
+<p>Can contain multiple keys, one per line.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">key_server_signing_keys_path: "key_server_signing_keys.key"
+</code></pre>
+<hr />
+<h2 id="single-sign-on-integration"><a class="header" href="#single-sign-on-integration">Single sign-on integration</a></h2>
+<p>The following settings can be used to make Synapse use a single sign-on
+provider for authentication, instead of its internal password database.</p>
+<p>You will probably also want to set the following options to false to
+disable the regular login/registration flows:</p>
+<ul>
+<li><code>enable_registration</code></li>
+<li><code>password_config.enabled</code></li>
+</ul>
+<p>You will also want to investigate the settings under the "sso" configuration
+section below.</p>
+<hr />
+<p>Config option: <code>saml2_config</code></p>
+<p>Enable SAML2 for registration and login. Uses pysaml2. To learn more about pysaml and
+to find a full list options for configuring pysaml, read the docs <a href="https://pysaml2.readthedocs.io/en/latest/">here</a>.</p>
+<p>At least one of <code>sp_config</code> or <code>config_path</code> must be set in this section to
+enable SAML login. You can either put your entire pysaml config inline using the <code>sp_config</code>
+option, or you can specify a path to a psyaml config file with the sub-option <code>config_path</code>.
+This setting has the following sub-options:</p>
+<ul>
+<li><code>sp_config</code>: the configuration for the pysaml2 Service Provider. See pysaml2 docs for format of config.
+Default values will be used for the <code>entityid</code> and <code>service</code> settings,
+so it is not normally necessary to specify them unless you need to
+override them. Here are a few useful sub-options for configuring pysaml:
+<ul>
+<li><code>metadata</code>: Point this to the IdP's metadata. You must provide either a local
+file via the <code>local</code> attribute or (preferably) a URL via the
+<code>remote</code> attribute.</li>
+<li><code>accepted_time_diff: 3</code>: Allowed clock difference in seconds between the homeserver and IdP.
+Defaults to 0.</li>
+<li><code>service</code>: By default, the user has to go to our login page first. If you'd like
+to allow IdP-initiated login, set <code>allow_unsolicited</code> to true under <code>sp</code> in the <code>service</code>
+section.</li>
+</ul>
+</li>
+<li><code>config_path</code>: specify a separate pysaml2 configuration file thusly:
+<code>config_path: "CONFDIR/sp_conf.py"</code></li>
+<li><code>saml_session_lifetime</code>: The lifetime of a SAML session. This defines how long a user has to
+complete the authentication process, if <code>allow_unsolicited</code> is unset. The default is 15 minutes.</li>
+<li><code>user_mapping_provider</code>: Using this option, an external module can be provided as a
+custom solution to mapping attributes returned from a saml provider onto a matrix user. The
+<code>user_mapping_provider</code> has the following attributes:
+<ul>
+<li><code>module</code>: The custom module's class. </li>
+<li><code>config</code>: Custom configuration values for the module. Use the values provided in the
+example if you are using the built-in user_mapping_provider, or provide your own
+config values for a custom class if you are using one. This section will be passed as a Python
+dictionary to the module's <code>parse_config</code> method. The built-in provider takes the following two
+options:
+<ul>
+<li><code>mxid_source_attribute</code>: The SAML attribute (after mapping via the attribute maps) to use
+to derive the Matrix ID from. It is 'uid' by default. Note: This used to be configured by the
+<code>saml2_config.mxid_source_attribute option</code>. If that is still defined, its value will be used instead.</li>
+<li><code>mxid_mapping</code>: The mapping system to use for mapping the saml attribute onto a
+matrix ID. Options include: <code>hexencode</code> (which maps unpermitted characters to '=xx')
+and <code>dotreplace</code> (which replaces unpermitted characters with '.').
+The default is <code>hexencode</code>. Note: This used to be configured by the
+<code>saml2_config.mxid_mapping option</code>. If that is still defined, its value will be used instead.</li>
+</ul>
+</li>
+</ul>
+</li>
+<li><code>grandfathered_mxid_source_attribute</code>: In previous versions of synapse, the mapping from SAML attribute to
+MXID was always calculated dynamically rather than stored in a table. For backwards- compatibility, we will look for <code>user_ids</code>
+matching such a pattern before creating a new account. This setting controls the SAML attribute which will be used for this
+backwards-compatibility lookup. Typically it should be 'uid', but if the attribute maps are changed, it may be necessary to change it.
+The default is 'uid'. </li>
+<li><code>attribute_requirements</code>: It is possible to configure Synapse to only allow logins if SAML attributes
+match particular values. The requirements can be listed under
+<code>attribute_requirements</code> as shown in the example. All of the listed attributes must
+match for the login to be permitted.</li>
+<li><code>idp_entityid</code>: If the metadata XML contains multiple IdP entities then the <code>idp_entityid</code>
+option must be set to the entity to redirect users to.
+Most deployments only have a single IdP entity and so should omit this option.</li>
+</ul>
+<p>Once SAML support is enabled, a metadata file will be exposed at
+<code>https://<server>:<port>/_synapse/client/saml2/metadata.xml</code>, which you may be able to
+use to configure your SAML IdP with. Alternatively, you can manually configure
+the IdP to use an ACS location of
+<code>https://<server>:<port>/_synapse/client/saml2/authn_response</code>.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">saml2_config:
+ sp_config:
+ metadata:
+ local: ["saml2/idp.xml"]
+ remote:
+ - url: https://our_idp/metadata.xml
+ accepted_time_diff: 3
+
+ service:
+ sp:
+ allow_unsolicited: true
+
+ # The examples below are just used to generate our metadata xml, and you
+ # may well not need them, depending on your setup. Alternatively you
+ # may need a whole lot more detail - see the pysaml2 docs!
+ description: ["My awesome SP", "en"]
+ name: ["Test SP", "en"]
+
+ ui_info:
+ display_name:
+ - lang: en
+ text: "Display Name is the descriptive name of your service."
+ description:
+ - lang: en
+ text: "Description should be a short paragraph explaining the purpose of the service."
+ information_url:
+ - lang: en
+ text: "https://example.com/terms-of-service"
+ privacy_statement_url:
+ - lang: en
+ text: "https://example.com/privacy-policy"
+ keywords:
+ - lang: en
+ text: ["Matrix", "Element"]
+ logo:
+ - lang: en
+ text: "https://example.com/logo.svg"
+ width: "200"
+ height: "80"
+
+ organization:
+ name: Example com
+ display_name:
+ - ["Example co", "en"]
+ url: "http://example.com"
+
+ contact_person:
+ - given_name: Bob
+ sur_name: "the Sysadmin"
+ email_address": ["admin@example.com"]
+ contact_type": technical
+
+ saml_session_lifetime: 5m
+
+ user_mapping_provider:
+ # Below options are intended for the built-in provider, they should be
+ # changed if using a custom module.
+ config:
+ mxid_source_attribute: displayName
+ mxid_mapping: dotreplace
+
+ grandfathered_mxid_source_attribute: upn
+
+ attribute_requirements:
+ - attribute: userGroup
+ value: "staff"
+ - attribute: department
+ value: "sales"
+
+ idp_entityid: 'https://our_idp/entityid'
+</code></pre>
+<hr />
+<p>Config option: <code>oidc_providers</code></p>
+<p>List of OpenID Connect (OIDC) / OAuth 2.0 identity providers, for registration
+and login. See <a href="../../openid.html">here</a>
+for information on how to configure these options.</p>
+<p>For backwards compatibility, it is also possible to configure a single OIDC
+provider via an <code>oidc_config</code> setting. This is now deprecated and admins are
+advised to migrate to the <code>oidc_providers</code> format. (When doing that migration,
+use <code>oidc</code> for the <code>idp_id</code> to ensure that existing users continue to be
+recognised.)</p>
+<p>Options for each entry include:</p>
+<ul>
+<li>
+<p><code>idp_id</code>: a unique identifier for this identity provider. Used internally
+by Synapse; should be a single word such as 'github'.
+Note that, if this is changed, users authenticating via that provider
+will no longer be recognised as the same user!
+(Use "oidc" here if you are migrating from an old <code>oidc_config</code> configuration.)</p>
+</li>
+<li>
+<p><code>idp_name</code>: A user-facing name for this identity provider, which is used to
+offer the user a choice of login mechanisms.</p>
+</li>
+<li>
+<p><code>idp_icon</code>: An optional icon for this identity provider, which is presented
+by clients and Synapse's own IdP picker page. If given, must be an
+MXC URI of the format mxc://<server-name>/<media-id>. (An easy way to
+obtain such an MXC URI is to upload an image to an (unencrypted) room
+and then copy the "url" from the source of the event.)</p>
+</li>
+<li>
+<p><code>idp_brand</code>: An optional brand for this identity provider, allowing clients
+to style the login flow according to the identity provider in question.
+See the <a href="https://spec.matrix.org/latest/">spec</a> for possible options here.</p>
+</li>
+<li>
+<p><code>discover</code>: set to false to disable the use of the OIDC discovery mechanism
+to discover endpoints. Defaults to true.</p>
+</li>
+<li>
+<p><code>issuer</code>: Required. The OIDC issuer. Used to validate tokens and (if discovery
+is enabled) to discover the provider's endpoints.</p>
+</li>
+<li>
+<p><code>client_id</code>: Required. oauth2 client id to use.</p>
+</li>
+<li>
+<p><code>client_secret</code>: oauth2 client secret to use. May be omitted if
+<code>client_secret_jwt_key</code> is given, or if <code>client_auth_method</code> is 'none'.</p>
+</li>
+<li>
+<p><code>client_secret_jwt_key</code>: Alternative to client_secret: details of a key used
+to create a JSON Web Token to be used as an OAuth2 client secret. If
+given, must be a dictionary with the following properties:</p>
+<ul>
+<li>
+<p><code>key</code>: a pem-encoded signing key. Must be a suitable key for the
+algorithm specified. Required unless <code>key_file</code> is given.</p>
+</li>
+<li>
+<p><code>key_file</code>: the path to file containing a pem-encoded signing key file.
+Required unless <code>key</code> is given.</p>
+</li>
+<li>
+<p><code>jwt_header</code>: a dictionary giving properties to include in the JWT
+header. Must include the key <code>alg</code>, giving the algorithm used to
+sign the JWT, such as "ES256", using the JWA identifiers in
+RFC7518.</p>
+</li>
+<li>
+<p><code>jwt_payload</code>: an optional dictionary giving properties to include in
+the JWT payload. Normally this should include an <code>iss</code> key.</p>
+</li>
+</ul>
+</li>
+<li>
+<p><code>client_auth_method</code>: auth method to use when exchanging the token. Valid
+values are <code>client_secret_basic</code> (default), <code>client_secret_post</code> and
+<code>none</code>.</p>
+</li>
+<li>
+<p><code>scopes</code>: list of scopes to request. This should normally include the "openid"
+scope. Defaults to ["openid"].</p>
+</li>
+<li>
+<p><code>authorization_endpoint</code>: the oauth2 authorization endpoint. Required if
+provider discovery is disabled.</p>
+</li>
+<li>
+<p><code>token_endpoint</code>: the oauth2 token endpoint. Required if provider discovery is
+disabled.</p>
+</li>
+<li>
+<p><code>userinfo_endpoint</code>: the OIDC userinfo endpoint. Required if discovery is
+disabled and the 'openid' scope is not requested.</p>
+</li>
+<li>
+<p><code>jwks_uri</code>: URI where to fetch the JWKS. Required if discovery is disabled and
+the 'openid' scope is used.</p>
+</li>
+<li>
+<p><code>skip_verification</code>: set to 'true' to skip metadata verification. Use this if
+you are connecting to a provider that is not OpenID Connect compliant.
+Defaults to false. Avoid this in production.</p>
+</li>
+<li>
+<p><code>user_profile_method</code>: Whether to fetch the user profile from the userinfo
+endpoint, or to rely on the data returned in the id_token from the <code>token_endpoint</code>.
+Valid values are: <code>auto</code> or <code>userinfo_endpoint</code>.
+Defaults to <code>auto</code>, which uses the userinfo endpoint if <code>openid</code> is
+not included in <code>scopes</code>. Set to <code>userinfo_endpoint</code> to always use the
+userinfo endpoint.</p>
+</li>
+<li>
+<p><code>allow_existing_users</code>: set to true to allow a user logging in via OIDC to
+match a pre-existing account instead of failing. This could be used if
+switching from password logins to OIDC. Defaults to false.</p>
+</li>
+<li>
+<p><code>user_mapping_provider</code>: Configuration for how attributes returned from a OIDC
+provider are mapped onto a matrix user. This setting has the following
+sub-properties:</p>
+<ul>
+<li>
+<p><code>module</code>: The class name of a custom mapping module. Default is
+<code>synapse.handlers.oidc.JinjaOidcMappingProvider</code>.
+See https://matrix-org.github.io/synapse/latest/sso_mapping_providers.html#openid-mapping-providers
+for information on implementing a custom mapping provider.</p>
+</li>
+<li>
+<p><code>config</code>: Configuration for the mapping provider module. This section will
+be passed as a Python dictionary to the user mapping provider
+module's <code>parse_config</code> method.</p>
+<p>For the default provider, the following settings are available:</p>
+<ul>
+<li>
+<p>subject_claim: name of the claim containing a unique identifier
+for the user. Defaults to 'sub', which OpenID Connect
+compliant providers should provide.</p>
+</li>
+<li>
+<p><code>localpart_template</code>: Jinja2 template for the localpart of the MXID.
+If this is not set, the user will be prompted to choose their
+own username (see the documentation for the <code>sso_auth_account_details.html</code>
+template). This template can use the <code>localpart_from_email</code> filter.</p>
+</li>
+<li>
+<p><code>confirm_localpart</code>: Whether to prompt the user to validate (or
+change) the generated localpart (see the documentation for the
+'sso_auth_account_details.html' template), instead of
+registering the account right away.</p>
+</li>
+<li>
+<p><code>display_name_template</code>: Jinja2 template for the display name to set
+on first login. If unset, no displayname will be set.</p>
+</li>
+<li>
+<p><code>email_template</code>: Jinja2 template for the email address of the user.
+If unset, no email address will be added to the account.</p>
+</li>
+<li>
+<p><code>extra_attributes</code>: a map of Jinja2 templates for extra attributes
+to send back to the client during login. Note that these are non-standard and clients will ignore them
+without modifications.</p>
+</li>
+</ul>
+</li>
+</ul>
+<p>When rendering, the Jinja2 templates are given a 'user' variable,
+which is set to the claims returned by the UserInfo Endpoint and/or
+in the ID Token.</p>
+</li>
+</ul>
+<p>It is possible to configure Synapse to only allow logins if certain attributes
+match particular values in the OIDC userinfo. The requirements can be listed under
+<code>attribute_requirements</code> as shown here:</p>
+<pre><code class="language-yaml">attribute_requirements:
+ - attribute: family_name
+ value: "Stephensson"
+ - attribute: groups
+ value: "admin"
+</code></pre>
+<p>All of the listed attributes must match for the login to be permitted. Additional attributes can be added to
+userinfo by expanding the <code>scopes</code> section of the OIDC config to retrieve
+additional information from the OIDC provider.</p>
+<p>If the OIDC claim is a list, then the attribute must match any value in the list.
+Otherwise, it must exactly match the value of the claim. Using the example
+above, the <code>family_name</code> claim MUST be "Stephensson", but the <code>groups</code>
+claim MUST contain "admin".</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">oidc_providers:
+ # Generic example
+ #
+ - idp_id: my_idp
+ idp_name: "My OpenID provider"
+ idp_icon: "mxc://example.com/mediaid"
+ discover: false
+ issuer: "https://accounts.example.com/"
+ client_id: "provided-by-your-issuer"
+ client_secret: "provided-by-your-issuer"
+ client_auth_method: client_secret_post
+ scopes: ["openid", "profile"]
+ authorization_endpoint: "https://accounts.example.com/oauth2/auth"
+ token_endpoint: "https://accounts.example.com/oauth2/token"
+ userinfo_endpoint: "https://accounts.example.com/userinfo"
+ jwks_uri: "https://accounts.example.com/.well-known/jwks.json"
+ skip_verification: true
+ user_mapping_provider:
+ config:
+ subject_claim: "id"
+ localpart_template: "{{ user.login }}"
+ display_name_template: "{{ user.name }}"
+ email_template: "{{ user.email }}"
+ attribute_requirements:
+ - attribute: userGroup
+ value: "synapseUsers"
+</code></pre>
+<hr />
+<p>Config option: <code>cas_config</code></p>
+<p>Enable Central Authentication Service (CAS) for registration and login.
+Has the following sub-options:</p>
+<ul>
+<li><code>enabled</code>: Set this to true to enable authorization against a CAS server.
+Defaults to false.</li>
+<li><code>server_url</code>: The URL of the CAS authorization endpoint.</li>
+<li><code>displayname_attribute</code>: The attribute of the CAS response to use as the display name.
+If no name is given here, no displayname will be set.</li>
+<li><code>required_attributes</code>: It is possible to configure Synapse to only allow logins if CAS attributes
+match particular values. All of the keys given below must exist
+and the values must match the given value. Alternately if the given value
+is <code>None</code> then any value is allowed (the attribute just must exist).
+All of the listed attributes must match for the login to be permitted.</li>
+</ul>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">cas_config:
+ enabled: true
+ server_url: "https://cas-server.com"
+ displayname_attribute: name
+ required_attributes:
+ userGroup: "staff"
+ department: None
+</code></pre>
+<hr />
+<p>Config option: <code>sso</code></p>
+<p>Additional settings to use with single-sign on systems such as OpenID Connect,
+SAML2 and CAS.</p>
+<p>Server admins can configure custom templates for pages related to SSO. See
+<a href="../../templates.html">here</a> for more information.</p>
+<p>Options include:</p>
+<ul>
+<li><code>client_whitelist</code>: A list of client URLs which are whitelisted so that the user does not
+have to confirm giving access to their account to the URL. Any client
+whose URL starts with an entry in the following list will not be subject
+to an additional confirmation step after the SSO login is completed.
+WARNING: An entry such as "https://my.client" is insecure, because it
+will also match "https://my.client.evil.site", exposing your users to
+phishing attacks from evil.site. To avoid this, include a slash after the
+hostname: "https://my.client/".
+The login fallback page (used by clients that don't natively support the
+required login flows) is whitelisted in addition to any URLs in this list.
+By default, this list contains only the login fallback page.</li>
+<li><code>update_profile_information</code>: Use this setting to keep a user's profile fields in sync with information from
+the identity provider. Currently only syncing the displayname is supported. Fields
+are checked on every SSO login, and are updated if necessary.
+Note that enabling this option will override user profile information,
+regardless of whether users have opted-out of syncing that
+information when first signing in. Defaults to false.</li>
+</ul>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">sso:
+ client_whitelist:
+ - https://riot.im/develop
+ - https://my.custom.client/
+ update_profile_information: true
+</code></pre>
+<hr />
+<p>Config option: <code>jwt_config</code></p>
+<p>JSON web token integration. The following settings can be used to make
+Synapse JSON web tokens for authentication, instead of its internal
+password database.</p>
+<p>Each JSON Web Token needs to contain a "sub" (subject) claim, which is
+used as the localpart of the mxid.</p>
+<p>Additionally, the expiration time ("exp"), not before time ("nbf"),
+and issued at ("iat") claims are validated if present.</p>
+<p>Note that this is a non-standard login type and client support is
+expected to be non-existent.</p>
+<p>See <a href="../../jwt.html">here</a> for more.</p>
+<p>Additional sub-options for this setting include:</p>
+<ul>
+<li><code>enabled</code>: Set to true to enable authorization using JSON web
+tokens. Defaults to false.</li>
+<li><code>secret</code>: This is either the private shared secret or the public key used to
+decode the contents of the JSON web token. Required if <code>enabled</code> is set to true.</li>
+<li><code>algorithm</code>: The algorithm used to sign the JSON web token. Supported algorithms are listed at
+https://pyjwt.readthedocs.io/en/latest/algorithms.html Required if <code>enabled</code> is set to true.</li>
+<li><code>subject_claim</code>: Name of the claim containing a unique identifier for the user.
+Optional, defaults to <code>sub</code>.</li>
+<li><code>issuer</code>: The issuer to validate the "iss" claim against. Optional. If provided the
+"iss" claim will be required and validated for all JSON web tokens.</li>
+<li><code>audiences</code>: A list of audiences to validate the "aud" claim against. Optional.
+If provided the "aud" claim will be required and validated for all JSON web tokens.
+Note that if the "aud" claim is included in a JSON web token then
+validation will fail without configuring audiences.</li>
+</ul>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">jwt_config:
+ enabled: true
+ secret: "provided-by-your-issuer"
+ algorithm: "provided-by-your-issuer"
+ subject_claim: "name_of_claim"
+ issuer: "provided-by-your-issuer"
+ audiences:
+ - "provided-by-your-issuer"
+</code></pre>
+<hr />
+<p>Config option: <code>password_config</code></p>
+<p>Use this setting to enable password-based logins. </p>
+<p>This setting has the following sub-options:</p>
+<ul>
+<li><code>enabled</code>: Defaults to true.</li>
+<li><code>localdb_enabled</code>: Set to false to disable authentication against the local password
+database. This is ignored if <code>enabled</code> is false, and is only useful
+if you have other <code>password_providers</code>. Defaults to true. </li>
+<li><code>pepper</code>: Set the value here to a secret random string for extra security. # Uncomment and change to a secret random string for extra security.
+DO NOT CHANGE THIS AFTER INITIAL SETUP!</li>
+<li><code>policy</code>: Define and enforce a password policy, such as minimum lengths for passwords, etc.
+Each parameter is optional. This is an implementation of MSC2000. Parameters are as follows:
+<ul>
+<li><code>enabled</code>: Defaults to false. Set to true to enable.</li>
+<li><code>minimum_length</code>: Minimum accepted length for a password. Defaults to 0.</li>
+<li><code>require_digit</code>: Whether a password must contain at least one digit.
+Defaults to false.</li>
+<li><code>require_symbol</code>: Whether a password must contain at least one symbol.
+A symbol is any character that's not a number or a letter. Defaults to false.</li>
+<li><code>require_lowercase</code>: Whether a password must contain at least one lowercase letter.
+Defaults to false.</li>
+<li><code>require_uppercase</code>: Whether a password must contain at least one uppercase letter.
+Defaults to false.</li>
+</ul>
+</li>
+</ul>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">password_config:
+ enabled: false
+ localdb_enabled: false
+ pepper: "EVEN_MORE_SECRET"
+
+ policy:
+ enabled: true
+ minimum_length: 15
+ require_digit: true
+ require_symbol: true
+ require_lowercase: true
+ require_uppercase: true
+</code></pre>
+<hr />
+<p>Config option: <code>ui_auth</code></p>
+<p>The amount of time to allow a user-interactive authentication session to be active.</p>
+<p>This defaults to 0, meaning the user is queried for their credentials
+before every action, but this can be overridden to allow a single
+validation to be re-used. This weakens the protections afforded by
+the user-interactive authentication process, by allowing for multiple
+(and potentially different) operations to use the same validation session.</p>
+<p>This is ignored for potentially "dangerous" operations (including
+deactivating an account, modifying an account password, and
+adding a 3PID).</p>
+<p>Use the <code>session_timeout</code> sub-option here to change the time allowed for credential validation.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">ui_auth:
+ session_timeout: "15s"
+</code></pre>
+<hr />
+<p>Config option: <code>email</code></p>
+<p>Configuration for sending emails from Synapse.</p>
+<p>Server admins can configure custom templates for email content. See
+<a href="../../templates.html">here</a> for more information.</p>
+<p>This setting has the following sub-options:</p>
+<ul>
+<li>
+<p><code>smtp_host</code>: The hostname of the outgoing SMTP server to use. Defaults to 'localhost'.</p>
+</li>
+<li>
+<p><code>smtp_port</code>: The port on the mail server for outgoing SMTP. Defaults to 25.</p>
+</li>
+<li>
+<p><code>smtp_user</code> and <code>smtp_pass</code>: Username/password for authentication to the SMTP server. By default, no
+authentication is attempted.</p>
+</li>
+<li>
+<p><code>require_transport_security</code>: Set to true to require TLS transport security for SMTP.
+By default, Synapse will connect over plain text, and will then switch to
+TLS via STARTTLS <em>if the SMTP server supports it</em>. If this option is set,
+Synapse will refuse to connect unless the server supports STARTTLS.</p>
+</li>
+<li>
+<p><code>enable_tls</code>: By default, if the server supports TLS, it will be used, and the server
+must present a certificate that is valid for 'smtp_host'. If this option
+is set to false, TLS will not be used.</p>
+</li>
+<li>
+<p><code>notif_from</code>: defines the "From" address to use when sending emails.
+It must be set if email sending is enabled. The placeholder '%(app)s' will be replaced by the application name,
+which is normally set in <code>app_name</code>, but may be overridden by the
+Matrix client application. Note that the placeholder must be written '%(app)s', including the
+trailing 's'.</p>
+</li>
+<li>
+<p><code>app_name</code>: <code>app_name</code> defines the default value for '%(app)s' in <code>notif_from</code> and email
+subjects. It defaults to 'Matrix'.</p>
+</li>
+<li>
+<p><code>enable_notifs</code>: Set to true to enable sending emails for messages that the user
+has missed. Disabled by default.</p>
+</li>
+<li>
+<p><code>notif_for_new_users</code>: Set to false to disable automatic subscription to email
+notifications for new users. Enabled by default.</p>
+</li>
+<li>
+<p><code>client_base_url</code>: Custom URL for client links within the email notifications. By default
+links will be based on "https://matrix.to". (This setting used to be called <code>riot_base_url</code>;
+the old name is still supported for backwards-compatibility but is now deprecated.)</p>
+</li>
+<li>
+<p><code>validation_token_lifetime</code>: Configures the time that a validation email will expire after sending.
+Defaults to 1h.</p>
+</li>
+<li>
+<p><code>invite_client_location</code>: The web client location to direct users to during an invite. This is passed
+to the identity server as the <code>org.matrix.web_client_location</code> key. Defaults
+to unset, giving no guidance to the identity server.</p>
+</li>
+<li>
+<p><code>subjects</code>: Subjects to use when sending emails from Synapse. The placeholder '%(app)s' will
+be replaced with the value of the <code>app_name</code> setting, or by a value dictated by the Matrix client application.
+In addition, each subject can use the following placeholders: '%(person)s', which will be replaced by the displayname
+of the user(s) that sent the message(s), e.g. "Alice and Bob", and '%(room)s', which will be replaced by the name of the room the
+message(s) have been sent to, e.g. "My super room". In addition, emails related to account administration will
+can use the '%(server_name)s' placeholder, which will be replaced by the value of the
+<code>server_name</code> setting in your Synapse configuration.</p>
+<p>Here is a list of subjects for notification emails that can be set: </p>
+<ul>
+<li><code>message_from_person_in_room</code>: Subject to use to notify about one message from one or more user(s) in a
+room which has a name. Defaults to "[%(app)s] You have a message on %(app)s from %(person)s in the %(room)s room..."</li>
+<li><code>message_from_person</code>: Subject to use to notify about one message from one or more user(s) in a
+room which doesn't have a name. Defaults to "[%(app)s] You have a message on %(app)s from %(person)s..."</li>
+<li><code>messages_from_person</code>: Subject to use to notify about multiple messages from one or more users in
+a room which doesn't have a name. Defaults to "[%(app)s] You have messages on %(app)s from %(person)s..."</li>
+<li><code>messages_in_room</code>: Subject to use to notify about multiple messages in a room which has a
+name. Defaults to "[%(app)s] You have messages on %(app)s in the %(room)s room..."</li>
+<li><code>messages_in_room_and_others</code>: Subject to use to notify about multiple messages in multiple rooms.
+Defaults to "[%(app)s] You have messages on %(app)s in the %(room)s room and others..."</li>
+<li><code>messages_from_person_and_others</code>: Subject to use to notify about multiple messages from multiple persons in
+multiple rooms. This is similar to the setting above except it's used when
+the room in which the notification was triggered has no name. Defaults to
+"[%(app)s] You have messages on %(app)s from %(person)s and others..."</li>
+<li><code>invite_from_person_to_room</code>: Subject to use to notify about an invite to a room which has a name.
+Defaults to "[%(app)s] %(person)s has invited you to join the %(room)s room on %(app)s..."</li>
+<li><code>invite_from_person</code>: Subject to use to notify about an invite to a room which doesn't have a
+name. Defaults to "[%(app)s] %(person)s has invited you to chat on %(app)s..."</li>
+<li><code>password_reset</code>: Subject to use when sending a password reset email. Defaults to "[%(server_name)s] Password reset"</li>
+<li><code>email_validation</code>: Subject to use when sending a verification email to assert an address's
+ownership. Defaults to "[%(server_name)s] Validate your email"</li>
+</ul>
+</li>
+</ul>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">email:
+ smtp_host: mail.server
+ smtp_port: 587
+ smtp_user: "exampleusername"
+ smtp_pass: "examplepassword"
+ require_transport_security: true
+ enable_tls: false
+ notif_from: "Your Friendly %(app)s homeserver <noreply@example.com>"
+ app_name: my_branded_matrix_server
+ enable_notifs: true
+ notif_for_new_users: false
+ client_base_url: "http://localhost/riot"
+ validation_token_lifetime: 15m
+ invite_client_location: https://app.element.io
+
+ subjects:
+ message_from_person_in_room: "[%(app)s] You have a message on %(app)s from %(person)s in the %(room)s room..."
+ message_from_person: "[%(app)s] You have a message on %(app)s from %(person)s..."
+ messages_from_person: "[%(app)s] You have messages on %(app)s from %(person)s..."
+ messages_in_room: "[%(app)s] You have messages on %(app)s in the %(room)s room..."
+ messages_in_room_and_others: "[%(app)s] You have messages on %(app)s in the %(room)s room and others..."
+ messages_from_person_and_others: "[%(app)s] You have messages on %(app)s from %(person)s and others..."
+ invite_from_person_to_room: "[%(app)s] %(person)s has invited you to join the %(room)s room on %(app)s..."
+ invite_from_person: "[%(app)s] %(person)s has invited you to chat on %(app)s..."
+ password_reset: "[%(server_name)s] Password reset"
+ email_validation: "[%(server_name)s] Validate your email"
+</code></pre>
+<hr />
+<h2 id="push"><a class="header" href="#push">Push</a></h2>
+<p>Configuration settings related to push notifications</p>
+<hr />
+<p>Config option: <code>push</code></p>
+<p>This setting defines options for push notifications. </p>
+<p>This option has a number of sub-options. They are as follows:</p>
+<ul>
+<li><code>include_content</code>: Clients requesting push notifications can either have the body of
+the message sent in the notification poke along with other details
+like the sender, or just the event ID and room ID (<code>event_id_only</code>).
+If clients choose the to have the body sent, this option controls whether the
+notification request includes the content of the event (other details
+like the sender are still included). If <code>event_id_only</code> is enabled, it
+has no effect.
+For modern android devices the notification content will still appear
+because it is loaded by the app. iPhone, however will send a
+notification saying only that a message arrived and who it came from.
+Defaults to true. Set to false to only include the event ID and room ID in push notification payloads.</li>
+<li><code>group_unread_count_by_room: false</code>: When a push notification is received, an unread count is also sent.
+This number can either be calculated as the number of unread messages for the user, or the number of <em>rooms</em> the
+user has unread messages in. Defaults to true, meaning push clients will see the number of
+rooms with unread messages in them. Set to false to instead send the number
+of unread messages.</li>
+</ul>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">push:
+ include_content: false
+ group_unread_count_by_room: false
+</code></pre>
+<hr />
+<h2 id="rooms"><a class="header" href="#rooms">Rooms</a></h2>
+<p>Config options relating to rooms.</p>
+<hr />
+<p>Config option: <code>encryption_enabled_by_default</code></p>
+<p>Controls whether locally-created rooms should be end-to-end encrypted by
+default.</p>
+<p>Possible options are "all", "invite", and "off". They are defined as:</p>
+<ul>
+<li>"all": any locally-created room</li>
+<li>"invite": any room created with the <code>private_chat</code> or <code>trusted_private_chat</code>
+room creation presets</li>
+<li>"off": this option will take no effect</li>
+</ul>
+<p>The default value is "off".</p>
+<p>Note that this option will only affect rooms created after it is set. It
+will also not affect rooms created by other servers.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">encryption_enabled_by_default_for_room_type: invite
+</code></pre>
+<hr />
+<p>Config option: <code>enable_group_creation</code></p>
+<p>Set to true to allow non-server-admin users to create groups on this server</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">enable_group_creation: true
+</code></pre>
+<hr />
+<p>Config option: <code>group_creation_prefix</code></p>
+<p>If enabled/present, non-server admins can only create groups with local parts
+starting with this prefix.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">group_creation_prefix: "unofficial_"
+</code></pre>
+<hr />
+<p>Config option: <code>user_directory</code></p>
+<p>This setting defines options related to the user directory. </p>
+<p>This option has the following sub-options:</p>
+<ul>
+<li><code>enabled</code>: Defines whether users can search the user directory. If false then
+empty responses are returned to all queries. Defaults to true.</li>
+<li><code>search_all_users</code>: Defines whether to search all users visible to your HS when searching
+the user directory. If false, search results will only contain users
+visible in public rooms and users sharing a room with the requester.
+Defaults to false.
+NB. If you set this to true, and the last time the user_directory search
+indexes were (re)built was before Synapse 1.44, you'll have to
+rebuild the indexes in order to search through all known users.
+These indexes are built the first time Synapse starts; admins can
+manually trigger a rebuild via API following the instructions at
+https://matrix-org.github.io/synapse/latest/usage/administration/admin_api/background_updates.html#run
+Set to true to return search results containing all known users, even if that
+user does not share a room with the requester.</li>
+<li><code>prefer_local_users</code>: Defines whether to prefer local users in search query results.
+If set to true, local users are more likely to appear above remote users when searching the
+user directory. Defaults to false.</li>
+</ul>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">user_directory:
+ enabled: false
+ search_all_users: true
+ prefer_local_users: true
+</code></pre>
+<hr />
+<p>Config option: <code>user_consent</code></p>
+<p>For detailed instructions on user consent configuration, see <a href="../../consent_tracking.html">here</a>.</p>
+<p>Parts of this section are required if enabling the <code>consent</code> resource under
+<code>listeners</code>, in particular <code>template_dir</code> and <code>version</code>. # TODO: link <code>listeners</code></p>
+<ul>
+<li>
+<p><code>template_dir</code>: gives the location of the templates for the HTML forms.
+This directory should contain one subdirectory per language (eg, <code>en</code>, <code>fr</code>),
+and each language directory should contain the policy document (named as
+<version>.html) and a success page (success.html).</p>
+</li>
+<li>
+<p><code>version</code>: specifies the 'current' version of the policy document. It defines
+the version to be served by the consent resource if there is no 'v'
+parameter.</p>
+</li>
+<li>
+<p><code>server_notice_content</code>: if enabled, will send a user a "Server Notice"
+asking them to consent to the privacy policy. The <code>server_notices</code> section ##TODO: link
+must also be configured for this to work. Notices will <em>not</em> be sent to
+guest users unless <code>send_server_notice_to_guests</code> is set to true.</p>
+</li>
+<li>
+<p><code>block_events_error</code>, if set, will block any attempts to send events
+until the user consents to the privacy policy. The value of the setting is
+used as the text of the error.</p>
+</li>
+<li>
+<p><code>require_at_registration</code>, if enabled, will add a step to the registration
+process, similar to how captcha works. Users will be required to accept the
+policy before their account is created.</p>
+</li>
+<li>
+<p><code>policy_name</code> is the display name of the policy users will see when registering
+for an account. Has no effect unless <code>require_at_registration</code> is enabled.
+Defaults to "Privacy Policy".</p>
+</li>
+</ul>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">user_consent:
+ template_dir: res/templates/privacy
+ version: 1.0
+ server_notice_content:
+ msgtype: m.text
+ body: >-
+ To continue using this homeserver you must review and agree to the
+ terms and conditions at %(consent_uri)s
+ send_server_notice_to_guests: true
+ block_events_error: >-
+ To continue using this homeserver you must review and agree to the
+ terms and conditions at %(consent_uri)s
+ require_at_registration: false
+ policy_name: Privacy Policy
+</code></pre>
+<hr />
+<p>Config option: <code>stats</code></p>
+<p>Settings for local room and user statistics collection. See <a href="../../room_and_user_statistics.html">here</a>
+for more. </p>
+<ul>
+<li><code>enabled</code>: Set to false to disable room and user statistics. Note that doing
+so may cause certain features (such as the room directory) not to work
+correctly. Defaults to true. </li>
+</ul>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">stats:
+ enabled: false
+</code></pre>
+<hr />
+<p>Config option: <code>server_notices</code></p>
+<p>Use this setting to enable a room which can be used to send notices
+from the server to users. It is a special room which users cannot leave; notices
+in the room come from a special "notices" user id.</p>
+<p>If you use this setting, you <em>must</em> define the <code>system_mxid_localpart</code>
+sub-setting, which defines the id of the user which will be used to send the
+notices.</p>
+<p>Sub-options for this setting include:</p>
+<ul>
+<li><code>system_mxid_display_name</code>: set the display name of the "notices" user</li>
+<li><code>system_mxid_avatar_url</code>: set the avatar for the "notices" user</li>
+<li><code>room_name</code>: set the room name of the server notices room</li>
+</ul>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">server_notices:
+ system_mxid_localpart: notices
+ system_mxid_display_name: "Server Notices"
+ system_mxid_avatar_url: "mxc://server.com/oumMVlgDnLYFaPVkExemNVVZ"
+ room_name: "Server Notices"
+</code></pre>
+<hr />
+<p>Config option: <code>enable_room_list_search</code></p>
+<p>Set to false to disable searching the public room list. When disabled
+blocks searching local and remote room lists for local and remote
+users by always returning an empty list for all queries. Defaults to true. </p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">enable_room_list_search: false
+</code></pre>
+<hr />
+<p>Config option: <code>alias_creation</code></p>
+<p>The <code>alias_creation</code> option controls who is allowed to create aliases
+on this server.</p>
+<p>The format of this option is a list of rules that contain globs that
+match against user_id, room_id and the new alias (fully qualified with
+server name). The action in the first rule that matches is taken,
+which can currently either be "allow" or "deny".</p>
+<p>Missing user_id/room_id/alias fields default to "*".</p>
+<p>If no rules match the request is denied. An empty list means no one
+can create aliases.</p>
+<p>Options for the rules include:</p>
+<ul>
+<li><code>user_id</code>: Matches against the creator of the alias. Defaults to "*".</li>
+<li><code>alias</code>: Matches against the alias being created. Defaults to "*".</li>
+<li><code>room_id</code>: Matches against the room ID the alias is being pointed at. Defaults to "*"</li>
+<li><code>action</code>: Whether to "allow" or "deny" the request if the rule matches. Defaults to allow. </li>
+</ul>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">alias_creation_rules:
+ - user_id: "bad_user"
+ alias: "spammy_alias"
+ room_id: "*"
+ action: deny
+</code></pre>
+<hr />
+<p>Config options: <code>room_list_publication_rules</code></p>
+<p>The <code>room_list_publication_rules</code> option controls who can publish and
+which rooms can be published in the public room list.</p>
+<p>The format of this option is the same as that for
+<code>alias_creation_rules</code>.</p>
+<p>If the room has one or more aliases associated with it, only one of
+the aliases needs to match the alias rule. If there are no aliases
+then only rules with <code>alias: *</code> match.</p>
+<p>If no rules match the request is denied. An empty list means no one
+can publish rooms.</p>
+<p>Options for the rules include:</p>
+<ul>
+<li><code>user_id</code>: Matches against the creator of the alias. Defaults to "*".</li>
+<li><code>alias</code>: Matches against any current local or canonical aliases associated with the room. Defaults to "*".</li>
+<li><code>room_id</code>: Matches against the room ID being published. Defaults to "*".</li>
+<li><code>action</code>: Whether to "allow" or "deny" the request if the rule matches. Defaults to allow. </li>
+</ul>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">room_list_publication_rules:
+ - user_id: "*"
+ alias: "*"
+ room_id: "*"
+ action: allow
+</code></pre>
+<hr />
+<h2 id="opentracing"><a class="header" href="#opentracing">Opentracing</a></h2>
+<p>Configuration options related to Opentracing support.</p>
+<hr />
+<p>Config option: <code>opentracing</code></p>
+<p>These settings enable and configure opentracing, which implements distributed tracing.
+This allows you to observe the causal chains of events across servers
+including requests, key lookups etc., across any server running
+synapse or any other services which support opentracing
+(specifically those implemented with Jaeger).</p>
+<p>Sub-options include:</p>
+<ul>
+<li><code>enabled</code>: whether tracing is enabled. Set to true to enable. Disabled by default.</li>
+<li><code>homeserver_whitelist</code>: The list of homeservers we wish to send and receive span contexts and span baggage.
+See <a href="../../opentracing.html">here</a> for more.
+This is a list of regexes which are matched against the <code>server_name</code> of the homeserver.
+By default, it is empty, so no servers are matched.</li>
+<li><code>force_tracing_for_users</code>: # A list of the matrix IDs of users whose requests will always be traced,
+even if the tracing system would otherwise drop the traces due to probabilistic sampling.
+By default, the list is empty.</li>
+<li><code>jaeger_config</code>: Jaeger can be configured to sample traces at different rates.
+All configuration options provided by Jaeger can be set here. Jaeger's configuration is
+mostly related to trace sampling which is documented <a href="https://www.jaegertracing.io/docs/latest/sampling/">here</a>.</li>
+</ul>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">opentracing:
+ enabled: true
+ homeserver_whitelist:
+ - ".*"
+ force_tracing_for_users:
+ - "@user1:server_name"
+ - "@user2:server_name"
+
+ jaeger_config:
+ sampler:
+ type: const
+ param: 1
+ logging:
+ false
+</code></pre>
+<hr />
+<h2 id="workers"><a class="header" href="#workers">Workers</a></h2>
+<p>Configuration options related to workers.</p>
+<hr />
+<p>Config option: <code>send_federation</code></p>
+<p>Controls sending of outbound federation transactions on the main process.
+Set to false if using a federation sender worker. Defaults to true. </p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">send_federation: false
+</code></pre>
+<hr />
+<p>Config option: <code>federation_sender_instances</code></p>
+<p>It is possible to run multiple federation sender workers, in which case the
+work is balanced across them. Use this setting to list the senders. </p>
+<p>This configuration setting must be shared between all federation sender workers, and if
+changed all federation sender workers must be stopped at the same time and then
+started, to ensure that all instances are running with the same config (otherwise
+events may be dropped). </p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">federation_sender_instances:
+ - federation_sender1
+</code></pre>
+<hr />
+<p>Config option: <code>instance_map</code></p>
+<p>When using workers this should be a map from worker name to the
+HTTP replication listener of the worker, if configured. </p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">instance_map:
+ worker1:
+ host: localhost
+ port: 8034
+</code></pre>
+<hr />
+<p>Config option: <code>stream_writers</code></p>
+<p>Experimental: When using workers you can define which workers should
+handle event persistence and typing notifications. Any worker
+specified here must also be in the <code>instance_map</code>.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">stream_writers:
+ events: worker1
+ typing: worker1
+</code></pre>
+<hr />
+<p>Config option: <code>run_background_task_on</code></p>
+<p>The worker that is used to run background tasks (e.g. cleaning up expired
+data). If not provided this defaults to the main process.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">run_background_tasks_on: worker1
+</code></pre>
+<hr />
+<p>Config option: <code>worker_replication_secret</code></p>
+<p>A shared secret used by the replication APIs to authenticate HTTP requests
+from workers.</p>
+<p>By default this is unused and traffic is not authenticated.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">worker_replication_secret: "secret_secret"
+</code></pre>
+<p>Config option: <code>redis</code></p>
+<p>Configuration for Redis when using workers. This <em>must</em> be enabled when
+using workers (unless using old style direct TCP configuration).
+This setting has the following sub-options:</p>
+<ul>
+<li><code>enabled</code>: whether to use Redis support. Defaults to false. </li>
+<li><code>host</code> and <code>port</code>: Optional host and port to use to connect to redis. Defaults to
+localhost and 6379</li>
+<li><code>password</code>: Optional password if configured on the Redis instance.</li>
+</ul>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">redis:
+ enabled: true
+ host: localhost
+ port: 6379
+ password: <secret_password>
+</code></pre>
+<h2 id="background-updates"><a class="header" href="#background-updates">Background Updates</a></h2>
+<p>Configuration settings related to background updates. </p>
+<hr />
+<p>Config option: <code>background_updates</code></p>
+<p>Background updates are database updates that are run in the background in batches.
+The duration, minimum batch size, default batch size, whether to sleep between batches and if so, how long to
+sleep can all be configured. This is helpful to speed up or slow down the updates.
+This setting has the following sub-options:</p>
+<ul>
+<li><code>background_update_duration_ms</code>: How long in milliseconds to run a batch of background updates for. Defaults to 100.
+Set a different time to change the default.</li>
+<li><code>sleep_enabled</code>: Whether to sleep between updates. Defaults to true. Set to false to change the default.</li>
+<li><code>sleep_duration_ms</code>: If sleeping between updates, how long in milliseconds to sleep for. Defaults to 1000.
+Set a duration to change the default.</li>
+<li><code>min_batch_size</code>: Minimum size a batch of background updates can be. Must be greater than 0. Defaults to 1.
+Set a size to change the default.</li>
+<li><code>default_batch_size</code>: The batch size to use for the first iteration of a new background update. The default is 100.
+Set a size to change the default.</li>
+</ul>
+<p>Example configuration: </p>
+<pre><code class="language-yaml">background_updates:
+ background_update_duration_ms: 500
+ sleep_enabled: false
+ sleep_duration_ms: 300
+ min_batch_size: 10
+ default_batch_size: 50
+</code></pre>
+
+ </main>
+
+ <nav class="nav-wrapper" aria-label="Page navigation">
+ <!-- Mobile navigation buttons -->
+ <a rel="prev" href="../../usage/configuration/index.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="../../usage/configuration/homeserver_sample_config.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="../../usage/configuration/index.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="../../usage/configuration/homeserver_sample_config.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>
\ No newline at end of file
|
