diff --git a/latest/usage/administration/admin_api/background_updates.html b/latest/usage/administration/admin_api/background_updates.html
index a67f7d869b..499f27c4db 100644
--- a/latest/usage/administration/admin_api/background_updates.html
+++ b/latest/usage/administration/admin_api/background_updates.html
@@ -28,6 +28,7 @@
<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">
+ <link rel="stylesheet" href="../../../docs/website_files/version-picker.css">
</head>
<body>
<!-- Provide site root to javascript -->
@@ -103,6 +104,18 @@
<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 class="version-picker">
+ <div class="dropdown">
+ <div class="select">
+ <span></span>
+ <i class="fa fa-chevron-down"></i>
+ </div>
+ <input type="hidden" name="version">
+ <ul class="dropdown-menu">
+ <!-- Versions will be added dynamically in version-picker.js -->
+ </ul>
+ </div>
+ </div>
</div>
<h1 class="menu-title">Synapse</h1>
@@ -255,5 +268,7 @@ background updates which won't be cancelled once started.</p>
<!-- Custom JS scripts -->
<script type="text/javascript" src="../../../docs/website_files/table-of-contents.js"></script>
+ <script type="text/javascript" src="../../../docs/website_files/version-picker.js"></script>
+ <script type="text/javascript" src="../../../docs/website_files/version.js"></script>
</body>
-</html>
\ No newline at end of file
+</html>
diff --git a/latest/usage/administration/admin_api/federation.html b/latest/usage/administration/admin_api/federation.html
index de6a55d40d..7fc104437c 100644
--- a/latest/usage/administration/admin_api/federation.html
+++ b/latest/usage/administration/admin_api/federation.html
@@ -28,6 +28,7 @@
<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">
+ <link rel="stylesheet" href="../../../docs/website_files/version-picker.css">
</head>
<body>
<!-- Provide site root to javascript -->
@@ -103,6 +104,18 @@
<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 class="version-picker">
+ <div class="dropdown">
+ <div class="select">
+ <span></span>
+ <i class="fa fa-chevron-down"></i>
+ </div>
+ <input type="hidden" name="version">
+ <ul class="dropdown-menu">
+ <!-- Versions will be added dynamically in version-picker.js -->
+ </ul>
+ </div>
+ </div>
</div>
<h1 class="menu-title">Synapse</h1>
@@ -357,5 +370,7 @@ even if the API already returns the http status 200.</p>
<!-- Custom JS scripts -->
<script type="text/javascript" src="../../../docs/website_files/table-of-contents.js"></script>
+ <script type="text/javascript" src="../../../docs/website_files/version-picker.js"></script>
+ <script type="text/javascript" src="../../../docs/website_files/version.js"></script>
</body>
-</html>
\ No newline at end of file
+</html>
diff --git a/latest/usage/administration/admin_api/index.html b/latest/usage/administration/admin_api/index.html
index 0e8be5c8b6..f09b4462a4 100644
--- a/latest/usage/administration/admin_api/index.html
+++ b/latest/usage/administration/admin_api/index.html
@@ -28,6 +28,7 @@
<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">
+ <link rel="stylesheet" href="../../../docs/website_files/version-picker.css">
</head>
<body>
<!-- Provide site root to javascript -->
@@ -103,6 +104,18 @@
<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 class="version-picker">
+ <div class="dropdown">
+ <div class="select">
+ <span></span>
+ <i class="fa fa-chevron-down"></i>
+ </div>
+ <input type="hidden" name="version">
+ <ul class="dropdown-menu">
+ <!-- Versions will be added dynamically in version-picker.js -->
+ </ul>
+ </div>
+ </div>
</div>
<h1 class="menu-title">Synapse</h1>
@@ -217,5 +230,7 @@ information from the Admin API.</p>
<!-- Custom JS scripts -->
<script type="text/javascript" src="../../../docs/website_files/table-of-contents.js"></script>
+ <script type="text/javascript" src="../../../docs/website_files/version-picker.js"></script>
+ <script type="text/javascript" src="../../../docs/website_files/version.js"></script>
</body>
-</html>
\ No newline at end of file
+</html>
diff --git a/latest/usage/administration/admin_api/registration_tokens.html b/latest/usage/administration/admin_api/registration_tokens.html
index e9ac3206ea..d01834b7bb 100644
--- a/latest/usage/administration/admin_api/registration_tokens.html
+++ b/latest/usage/administration/admin_api/registration_tokens.html
@@ -28,6 +28,7 @@
<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">
+ <link rel="stylesheet" href="../../../docs/website_files/version-picker.css">
</head>
<body>
<!-- Provide site root to javascript -->
@@ -103,6 +104,18 @@
<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 class="version-picker">
+ <div class="dropdown">
+ <div class="select">
+ <span></span>
+ <i class="fa fa-chevron-down"></i>
+ </div>
+ <input type="hidden" name="version">
+ <ul class="dropdown-menu">
+ <!-- Versions will be added dynamically in version-picker.js -->
+ </ul>
+ </div>
+ </div>
</div>
<h1 class="menu-title">Synapse</h1>
@@ -424,5 +437,7 @@ the <a href="https://matrix.org/docs/spec/client_server/r0.6.1#api-standards">Ma
<!-- Custom JS scripts -->
<script type="text/javascript" src="../../../docs/website_files/table-of-contents.js"></script>
+ <script type="text/javascript" src="../../../docs/website_files/version-picker.js"></script>
+ <script type="text/javascript" src="../../../docs/website_files/version.js"></script>
</body>
-</html>
\ No newline at end of file
+</html>
diff --git a/latest/usage/administration/admin_faq.html b/latest/usage/administration/admin_faq.html
index d98443f665..d771ea5dc1 100644
--- a/latest/usage/administration/admin_faq.html
+++ b/latest/usage/administration/admin_faq.html
@@ -28,6 +28,7 @@
<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">
+ <link rel="stylesheet" href="../../docs/website_files/version-picker.css">
</head>
<body>
<!-- Provide site root to javascript -->
@@ -103,6 +104,18 @@
<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 class="version-picker">
+ <div class="dropdown">
+ <div class="select">
+ <span></span>
+ <i class="fa fa-chevron-down"></i>
+ </div>
+ <input type="hidden" name="version">
+ <ul class="dropdown-menu">
+ <!-- Versions will be added dynamically in version-picker.js -->
+ </ul>
+ </div>
+ </div>
</div>
<h1 class="menu-title">Synapse</h1>
@@ -394,5 +407,7 @@ you see this failure mode so we can help debug it, however.</p>
<!-- Custom JS scripts -->
<script type="text/javascript" src="../../docs/website_files/table-of-contents.js"></script>
+ <script type="text/javascript" src="../../docs/website_files/version-picker.js"></script>
+ <script type="text/javascript" src="../../docs/website_files/version.js"></script>
</body>
-</html>
\ No newline at end of file
+</html>
diff --git a/latest/usage/administration/database_maintenance_tools.html b/latest/usage/administration/database_maintenance_tools.html
index 4fc7a88391..69a78a90d6 100644
--- a/latest/usage/administration/database_maintenance_tools.html
+++ b/latest/usage/administration/database_maintenance_tools.html
@@ -28,6 +28,7 @@
<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">
+ <link rel="stylesheet" href="../../docs/website_files/version-picker.css">
</head>
<body>
<!-- Provide site root to javascript -->
@@ -103,6 +104,18 @@
<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 class="version-picker">
+ <div class="dropdown">
+ <div class="select">
+ <span></span>
+ <i class="fa fa-chevron-down"></i>
+ </div>
+ <input type="hidden" name="version">
+ <ul class="dropdown-menu">
+ <!-- Versions will be added dynamically in version-picker.js -->
+ </ul>
+ </div>
+ </div>
</div>
<h1 class="menu-title">Synapse</h1>
@@ -197,5 +210,7 @@
<!-- Custom JS scripts -->
<script type="text/javascript" src="../../docs/website_files/table-of-contents.js"></script>
+ <script type="text/javascript" src="../../docs/website_files/version-picker.js"></script>
+ <script type="text/javascript" src="../../docs/website_files/version.js"></script>
</body>
-</html>
\ No newline at end of file
+</html>
diff --git a/latest/usage/administration/index.html b/latest/usage/administration/index.html
index b1a6d96192..515c40611e 100644
--- a/latest/usage/administration/index.html
+++ b/latest/usage/administration/index.html
@@ -28,6 +28,7 @@
<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">
+ <link rel="stylesheet" href="../../docs/website_files/version-picker.css">
</head>
<body>
<!-- Provide site root to javascript -->
@@ -103,6 +104,18 @@
<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 class="version-picker">
+ <div class="dropdown">
+ <div class="select">
+ <span></span>
+ <i class="fa fa-chevron-down"></i>
+ </div>
+ <input type="hidden" name="version">
+ <ul class="dropdown-menu">
+ <!-- Versions will be added dynamically in version-picker.js -->
+ </ul>
+ </div>
+ </div>
</div>
<h1 class="menu-title">Synapse</h1>
@@ -192,5 +205,7 @@
<!-- Custom JS scripts -->
<script type="text/javascript" src="../../docs/website_files/table-of-contents.js"></script>
+ <script type="text/javascript" src="../../docs/website_files/version-picker.js"></script>
+ <script type="text/javascript" src="../../docs/website_files/version.js"></script>
</body>
-</html>
\ No newline at end of file
+</html>
diff --git a/latest/usage/administration/monitoring/reporting_homeserver_usage_statistics.html b/latest/usage/administration/monitoring/reporting_homeserver_usage_statistics.html
index 52611e11ef..901a6c0de0 100644
--- a/latest/usage/administration/monitoring/reporting_homeserver_usage_statistics.html
+++ b/latest/usage/administration/monitoring/reporting_homeserver_usage_statistics.html
@@ -28,6 +28,7 @@
<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">
+ <link rel="stylesheet" href="../../../docs/website_files/version-picker.css">
</head>
<body>
<!-- Provide site root to javascript -->
@@ -103,6 +104,18 @@
<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 class="version-picker">
+ <div class="dropdown">
+ <div class="select">
+ <span></span>
+ <i class="fa fa-chevron-down"></i>
+ </div>
+ <input type="hidden" name="version">
+ <ul class="dropdown-menu">
+ <!-- Versions will be added dynamically in version-picker.js -->
+ </ul>
+ </div>
+ </div>
</div>
<h1 class="menu-title">Synapse</h1>
@@ -254,5 +267,7 @@ consider using one of the following known implementations:</p>
<!-- Custom JS scripts -->
<script type="text/javascript" src="../../../docs/website_files/table-of-contents.js"></script>
+ <script type="text/javascript" src="../../../docs/website_files/version-picker.js"></script>
+ <script type="text/javascript" src="../../../docs/website_files/version.js"></script>
</body>
-</html>
\ No newline at end of file
+</html>
diff --git a/latest/usage/administration/monthly_active_users.html b/latest/usage/administration/monthly_active_users.html
index 6b21ea3bf7..6efacdf47a 100644
--- a/latest/usage/administration/monthly_active_users.html
+++ b/latest/usage/administration/monthly_active_users.html
@@ -28,6 +28,7 @@
<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">
+ <link rel="stylesheet" href="../../docs/website_files/version-picker.css">
</head>
<body>
<!-- Provide site root to javascript -->
@@ -103,6 +104,18 @@
<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 class="version-picker">
+ <div class="dropdown">
+ <div class="select">
+ <span></span>
+ <i class="fa fa-chevron-down"></i>
+ </div>
+ <input type="hidden" name="version">
+ <ul class="dropdown-menu">
+ <!-- Versions will be added dynamically in version-picker.js -->
+ </ul>
+ </div>
+ </div>
</div>
<h1 class="menu-title">Synapse</h1>
@@ -249,5 +262,7 @@ registered accounts on the homeserver.</p>
<!-- Custom JS scripts -->
<script type="text/javascript" src="../../docs/website_files/table-of-contents.js"></script>
+ <script type="text/javascript" src="../../docs/website_files/version-picker.js"></script>
+ <script type="text/javascript" src="../../docs/website_files/version.js"></script>
</body>
-</html>
\ No newline at end of file
+</html>
diff --git a/latest/usage/administration/request_log.html b/latest/usage/administration/request_log.html
index 43db860ef4..adf42d8f6d 100644
--- a/latest/usage/administration/request_log.html
+++ b/latest/usage/administration/request_log.html
@@ -28,6 +28,7 @@
<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">
+ <link rel="stylesheet" href="../../docs/website_files/version-picker.css">
</head>
<body>
<!-- Provide site root to javascript -->
@@ -103,6 +104,18 @@
<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 class="version-picker">
+ <div class="dropdown">
+ <div class="select">
+ <span></span>
+ <i class="fa fa-chevron-down"></i>
+ </div>
+ <input type="hidden" name="version">
+ <ul class="dropdown-menu">
+ <!-- Versions will be added dynamically in version-picker.js -->
+ </ul>
+ </div>
+ </div>
</div>
<h1 class="menu-title">Synapse</h1>
@@ -220,5 +233,7 @@ small processing times.</p>
<!-- Custom JS scripts -->
<script type="text/javascript" src="../../docs/website_files/table-of-contents.js"></script>
+ <script type="text/javascript" src="../../docs/website_files/version-picker.js"></script>
+ <script type="text/javascript" src="../../docs/website_files/version.js"></script>
</body>
-</html>
\ No newline at end of file
+</html>
diff --git a/latest/usage/administration/state_groups.html b/latest/usage/administration/state_groups.html
index 1e035d2bb0..3136f29dd1 100644
--- a/latest/usage/administration/state_groups.html
+++ b/latest/usage/administration/state_groups.html
@@ -28,6 +28,7 @@
<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">
+ <link rel="stylesheet" href="../../docs/website_files/version-picker.css">
</head>
<body>
<!-- Provide site root to javascript -->
@@ -103,6 +104,18 @@
<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 class="version-picker">
+ <div class="dropdown">
+ <div class="select">
+ <span></span>
+ <i class="fa fa-chevron-down"></i>
+ </div>
+ <input type="hidden" name="version">
+ <ul class="dropdown-menu">
+ <!-- Versions will be added dynamically in version-picker.js -->
+ </ul>
+ </div>
+ </div>
</div>
<h1 class="menu-title">Synapse</h1>
@@ -198,5 +211,7 @@
<!-- Custom JS scripts -->
<script type="text/javascript" src="../../docs/website_files/table-of-contents.js"></script>
+ <script type="text/javascript" src="../../docs/website_files/version-picker.js"></script>
+ <script type="text/javascript" src="../../docs/website_files/version.js"></script>
</body>
-</html>
\ No newline at end of file
+</html>
diff --git a/latest/usage/administration/understanding_synapse_through_grafana_graphs.html b/latest/usage/administration/understanding_synapse_through_grafana_graphs.html
index 5e044a0bcc..9fa2b487ec 100644
--- a/latest/usage/administration/understanding_synapse_through_grafana_graphs.html
+++ b/latest/usage/administration/understanding_synapse_through_grafana_graphs.html
@@ -28,6 +28,7 @@
<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">
+ <link rel="stylesheet" href="../../docs/website_files/version-picker.css">
</head>
<body>
<!-- Provide site root to javascript -->
@@ -103,6 +104,18 @@
<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 class="version-picker">
+ <div class="dropdown">
+ <div class="select">
+ <span></span>
+ <i class="fa fa-chevron-down"></i>
+ </div>
+ <input type="hidden" name="version">
+ <ul class="dropdown-menu">
+ <!-- Versions will be added dynamically in version-picker.js -->
+ </ul>
+ </div>
+ </div>
</div>
<h1 class="menu-title">Synapse</h1>
@@ -235,5 +248,7 @@ to make use of multiple CPU cores / multiple machines for your homeserver.</p>
<!-- Custom JS scripts -->
<script type="text/javascript" src="../../docs/website_files/table-of-contents.js"></script>
+ <script type="text/javascript" src="../../docs/website_files/version-picker.js"></script>
+ <script type="text/javascript" src="../../docs/website_files/version.js"></script>
</body>
-</html>
\ No newline at end of file
+</html>
diff --git a/latest/usage/administration/useful_sql_for_admins.html b/latest/usage/administration/useful_sql_for_admins.html
index c5753465f7..37f3b8c213 100644
--- a/latest/usage/administration/useful_sql_for_admins.html
+++ b/latest/usage/administration/useful_sql_for_admins.html
@@ -28,6 +28,7 @@
<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">
+ <link rel="stylesheet" href="../../docs/website_files/version-picker.css">
</head>
<body>
<!-- Provide site root to javascript -->
@@ -103,6 +104,18 @@
<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 class="version-picker">
+ <div class="dropdown">
+ <div class="select">
+ <span></span>
+ <i class="fa fa-chevron-down"></i>
+ </div>
+ <input type="hidden" name="version">
+ <ul class="dropdown-menu">
+ <!-- Versions will be added dynamically in version-picker.js -->
+ </ul>
+ </div>
+ </div>
</div>
<h1 class="menu-title">Synapse</h1>
@@ -355,5 +368,7 @@ WHERE room_stats_state.room_id = event_json.room_id" | psql -d synapse -h l
<!-- Custom JS scripts -->
<script type="text/javascript" src="../../docs/website_files/table-of-contents.js"></script>
+ <script type="text/javascript" src="../../docs/website_files/version-picker.js"></script>
+ <script type="text/javascript" src="../../docs/website_files/version.js"></script>
</body>
-</html>
\ No newline at end of file
+</html>
diff --git a/latest/usage/configuration/config_documentation.html b/latest/usage/configuration/config_documentation.html
index 93a8d5b5eb..c0b3f44ce9 100644
--- a/latest/usage/configuration/config_documentation.html
+++ b/latest/usage/configuration/config_documentation.html
@@ -28,6 +28,7 @@
<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">
+ <link rel="stylesheet" href="../../docs/website_files/version-picker.css">
</head>
<body>
<!-- Provide site root to javascript -->
@@ -103,6 +104,18 @@
<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 class="version-picker">
+ <div class="dropdown">
+ <div class="select">
+ <span></span>
+ <i class="fa fa-chevron-down"></i>
+ </div>
+ <input type="hidden" name="version">
+ <ul class="dropdown-menu">
+ <!-- Versions will be added dynamically in version-picker.js -->
+ </ul>
+ </div>
+ </div>
</div>
<h1 class="menu-title">Synapse</h1>
@@ -176,6 +189,16 @@ messages from the database after 5 minutes, rather than 5 months.</p>
</ul>
<p>For example, setting <code>max_avatar_size: 10M</code> means that Synapse will not accept files larger than 10,485,760 bytes
for a user avatar.</p>
+<h2 id="config-validation"><a class="header" href="#config-validation">Config Validation</a></h2>
+<p>The configuration file can be validated with the following command:</p>
+<pre><code class="language-bash">python -m synapse.config read <config key to print> -c <path to config>
+</code></pre>
+<p>To validate the entire file, omit <code>read <config key to print></code>:</p>
+<pre><code class="language-bash">python -m synapse.config -c <path to config>
+</code></pre>
+<p>To see how to set other options, check the help reference:</p>
+<pre><code class="language-bash">python -m synapse.config --help
+</code></pre>
<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>
@@ -635,7 +658,7 @@ for <a href="../../workers.html">workers</a> and containers without listener e.g
# Note that x_forwarded will default to true, when using a UNIX socket. Please see
# https://matrix-org.github.io/synapse/latest/reverse_proxy.html.
#
- - path: /var/run/synapse/main_public.sock
+ - path: /run/synapse/main_public.sock
type: http
resources:
- names: [client, federation]
@@ -1390,7 +1413,7 @@ see <a href="../../postgres.html">here</a>.</p>
args:
user: synapse_user
password: secretpassword
- database: synapse
+ dbname: synapse
host: localhost
port: 5432
cp_min: 5
@@ -1472,7 +1495,7 @@ when Synapse is started.</p>
args:
user: synapse_user
password: secretpassword
- database: synapse_main
+ dbname: synapse_main
host: localhost
port: 5432
cp_min: 5
@@ -1485,7 +1508,7 @@ when Synapse is started.</p>
args:
user: synapse_user
password: secretpassword
- database: synapse_state
+ dbname: synapse_state
host: localhost
port: 5432
cp_min: 5
@@ -1665,6 +1688,16 @@ sending the invite. Defaults to <code>per_second: 0.2</code>, <code>burst_count:
burst_count: 10
</code></pre>
<hr />
+<h3 id="rc_media_create"><a class="header" href="#rc_media_create"><code>rc_media_create</code></a></h3>
+<p>This option ratelimits creation of MXC URIs via the <code>/_matrix/media/v1/create</code>
+endpoint based on the account that's creating the media. Defaults to
+<code>per_second: 10</code>, <code>burst_count: 50</code>.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">rc_media_create:
+ per_second: 10
+ burst_count: 50
+</code></pre>
+<hr />
<h3 id="rc_federation"><a class="header" href="#rc_federation"><code>rc_federation</code></a></h3>
<p>Defines limits on federation requests.</p>
<p>The <code>rc_federation</code> configuration has the following sub-options:</p>
@@ -1713,6 +1746,21 @@ Set to false if you are using a separate media store worker.</p>
<pre><code class="language-yaml">media_store_path: "DATADIR/media_store"
</code></pre>
<hr />
+<h3 id="max_pending_media_uploads"><a class="header" href="#max_pending_media_uploads"><code>max_pending_media_uploads</code></a></h3>
+<p>How many <em>pending media uploads</em> can a given user have? A pending media upload
+is a created MXC URI that (a) is not expired (the <code>unused_expires_at</code> timestamp
+has not passed) and (b) the media has not yet been uploaded for. Defaults to 5.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">max_pending_media_uploads: 5
+</code></pre>
+<hr />
+<h3 id="unused_expiration_time"><a class="header" href="#unused_expiration_time"><code>unused_expiration_time</code></a></h3>
+<p>How long to wait in milliseconds before expiring created media IDs. Defaults to
+"24h"</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">unused_expiration_time: "1h"
+</code></pre>
+<hr />
<h3 id="media_storage_providers"><a class="header" href="#media_storage_providers"><code>media_storage_providers</code></a></h3>
<p>Media storage providers allow media to be stored in different
locations. Defaults to none. Associated sub-options are:</p>
@@ -3425,6 +3473,8 @@ notices.</p>
<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>
+<li><code>auto_join</code>: boolean. If true, the user will be automatically joined to the room instead of being invited.
+Defaults to false. <em>Added in Synapse 1.98.0.</em></li>
</ul>
<p>Example configuration:</p>
<pre><code class="language-yaml">server_notices:
@@ -3432,6 +3482,7 @@ notices.</p>
system_mxid_display_name: "Server Notices"
system_mxid_avatar_url: "mxc://server.com/oumMVlgDnLYFaPVkExemNVVZ"
room_name: "Server Notices"
+ auto_join: true
</code></pre>
<hr />
<h3 id="enable_room_list_search"><a class="header" href="#enable_room_list_search"><code>enable_room_list_search</code></a></h3>
@@ -3741,9 +3792,9 @@ declared inside the <code>listener</code> block for a <code>replication</code> l
<p>Example configuration(#2, for UNIX sockets):</p>
<pre><code class="language-yaml">instance_map:
main:
- path: /var/run/synapse/main_replication.sock
+ path: /run/synapse/main_replication.sock
worker1:
- path: /var/run/synapse/worker1_replication.sock
+ path: /run/synapse/worker1_replication.sock
</code></pre>
<hr />
<h3 id="stream_writers"><a class="header" href="#stream_writers"><code>stream_writers</code></a></h3>
@@ -3768,9 +3819,11 @@ authorize inter-worker communication.</p>
- federation_sender1
- federation_sender2
</code></pre>
-<h2>Also see the <a href="../../workers.html#restrict-outbound-federation-traffic-to-a-specific-set-of-workers">worker
+<p>Also see the <a href="../../workers.html#restrict-outbound-federation-traffic-to-a-specific-set-of-workers">worker
documentation</a>
-for more info.</h2>
+for more info.</p>
+<p><em>Added in Synapse 1.89.0.</em></p>
+<hr />
<h3 id="run_background_tasks_on"><a class="header" href="#run_background_tasks_on"><code>run_background_tasks_on</code></a></h3>
<p>The <a href="../../workers.html#background-tasks">worker</a> that is used to run
background tasks (e.g. cleaning up expired data). If not provided this
@@ -3900,13 +3953,13 @@ requests from other workers.</p>
<p>Example configuration(#2, using UNIX sockets with a <code>replication</code> listener):</p>
<pre><code class="language-yaml">worker_listeners:
- type: http
- path: /var/run/synapse/worker_public.sock
+ path: /run/synapse/worker_replication.sock
resources:
- - names: [client, federation]
+ - names: [replication]
- type: http
- path: /var/run/synapse/worker_replication.sock
+ path: /run/synapse/worker_public.sock
resources:
- - names: [replication]
+ - names: [client, federation]
</code></pre>
<hr />
<h3 id="worker_manhole"><a class="header" href="#worker_manhole"><code>worker_manhole</code></a></h3>
@@ -4017,5 +4070,7 @@ Set a size to change the default.</li>
<!-- Custom JS scripts -->
<script type="text/javascript" src="../../docs/website_files/table-of-contents.js"></script>
+ <script type="text/javascript" src="../../docs/website_files/version-picker.js"></script>
+ <script type="text/javascript" src="../../docs/website_files/version.js"></script>
</body>
-</html>
\ No newline at end of file
+</html>
diff --git a/latest/usage/configuration/homeserver_sample_config.html b/latest/usage/configuration/homeserver_sample_config.html
index b69f0f0ba5..965a308d9f 100644
--- a/latest/usage/configuration/homeserver_sample_config.html
+++ b/latest/usage/configuration/homeserver_sample_config.html
@@ -28,6 +28,7 @@
<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">
+ <link rel="stylesheet" href="../../docs/website_files/version-picker.css">
</head>
<body>
<!-- Provide site root to javascript -->
@@ -103,6 +104,18 @@
<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 class="version-picker">
+ <div class="dropdown">
+ <div class="select">
+ <span></span>
+ <i class="fa fa-chevron-down"></i>
+ </div>
+ <input type="hidden" name="version">
+ <ul class="dropdown-menu">
+ <!-- Versions will be added dynamically in version-picker.js -->
+ </ul>
+ </div>
+ </div>
</div>
<h1 class="menu-title">Synapse</h1>
@@ -239,5 +252,7 @@ trusted_key_servers:
<!-- Custom JS scripts -->
<script type="text/javascript" src="../../docs/website_files/table-of-contents.js"></script>
+ <script type="text/javascript" src="../../docs/website_files/version-picker.js"></script>
+ <script type="text/javascript" src="../../docs/website_files/version.js"></script>
</body>
-</html>
\ No newline at end of file
+</html>
diff --git a/latest/usage/configuration/index.html b/latest/usage/configuration/index.html
index dc23ebb711..81f3e1647a 100644
--- a/latest/usage/configuration/index.html
+++ b/latest/usage/configuration/index.html
@@ -28,6 +28,7 @@
<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">
+ <link rel="stylesheet" href="../../docs/website_files/version-picker.css">
</head>
<body>
<!-- Provide site root to javascript -->
@@ -103,6 +104,18 @@
<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 class="version-picker">
+ <div class="dropdown">
+ <div class="select">
+ <span></span>
+ <i class="fa fa-chevron-down"></i>
+ </div>
+ <input type="hidden" name="version">
+ <ul class="dropdown-menu">
+ <!-- Versions will be added dynamically in version-picker.js -->
+ </ul>
+ </div>
+ </div>
</div>
<h1 class="menu-title">Synapse</h1>
@@ -188,5 +201,7 @@ file should have been generated when you <a href="../../setup/installation.html"
<!-- Custom JS scripts -->
<script type="text/javascript" src="../../docs/website_files/table-of-contents.js"></script>
+ <script type="text/javascript" src="../../docs/website_files/version-picker.js"></script>
+ <script type="text/javascript" src="../../docs/website_files/version.js"></script>
</body>
-</html>
\ No newline at end of file
+</html>
diff --git a/latest/usage/configuration/logging_sample_config.html b/latest/usage/configuration/logging_sample_config.html
index 958e3a879d..a12ad8b96d 100644
--- a/latest/usage/configuration/logging_sample_config.html
+++ b/latest/usage/configuration/logging_sample_config.html
@@ -28,6 +28,7 @@
<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">
+ <link rel="stylesheet" href="../../docs/website_files/version-picker.css">
</head>
<body>
<!-- Provide site root to javascript -->
@@ -103,6 +104,18 @@
<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 class="version-picker">
+ <div class="dropdown">
+ <div class="select">
+ <span></span>
+ <i class="fa fa-chevron-down"></i>
+ </div>
+ <input type="hidden" name="version">
+ <ul class="dropdown-menu">
+ <!-- Versions will be added dynamically in version-picker.js -->
+ </ul>
+ </div>
+ </div>
</div>
<h1 class="menu-title">Synapse</h1>
@@ -270,5 +283,7 @@ disable_existing_loggers: false
<!-- Custom JS scripts -->
<script type="text/javascript" src="../../docs/website_files/table-of-contents.js"></script>
+ <script type="text/javascript" src="../../docs/website_files/version-picker.js"></script>
+ <script type="text/javascript" src="../../docs/website_files/version.js"></script>
</body>
-</html>
\ No newline at end of file
+</html>
diff --git a/latest/usage/configuration/user_authentication/index.html b/latest/usage/configuration/user_authentication/index.html
index 3349f6e13f..4fd169364b 100644
--- a/latest/usage/configuration/user_authentication/index.html
+++ b/latest/usage/configuration/user_authentication/index.html
@@ -28,6 +28,7 @@
<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">
+ <link rel="stylesheet" href="../../../docs/website_files/version-picker.css">
</head>
<body>
<!-- Provide site root to javascript -->
@@ -103,6 +104,18 @@
<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 class="version-picker">
+ <div class="dropdown">
+ <div class="select">
+ <span></span>
+ <i class="fa fa-chevron-down"></i>
+ </div>
+ <input type="hidden" name="version">
+ <ul class="dropdown-menu">
+ <!-- Versions will be added dynamically in version-picker.js -->
+ </ul>
+ </div>
+ </div>
</div>
<h1 class="menu-title">Synapse</h1>
@@ -198,5 +211,7 @@ modules.</p>
<!-- Custom JS scripts -->
<script type="text/javascript" src="../../../docs/website_files/table-of-contents.js"></script>
+ <script type="text/javascript" src="../../../docs/website_files/version-picker.js"></script>
+ <script type="text/javascript" src="../../../docs/website_files/version.js"></script>
</body>
-</html>
\ No newline at end of file
+</html>
diff --git a/latest/usage/configuration/user_authentication/refresh_tokens.html b/latest/usage/configuration/user_authentication/refresh_tokens.html
index d3e0ec936c..2caa7c9c0f 100644
--- a/latest/usage/configuration/user_authentication/refresh_tokens.html
+++ b/latest/usage/configuration/user_authentication/refresh_tokens.html
@@ -28,6 +28,7 @@
<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">
+ <link rel="stylesheet" href="../../../docs/website_files/version-picker.css">
</head>
<body>
<!-- Provide site root to javascript -->
@@ -103,6 +104,18 @@
<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 class="version-picker">
+ <div class="dropdown">
+ <div class="select">
+ <span></span>
+ <i class="fa fa-chevron-down"></i>
+ </div>
+ <input type="hidden" name="version">
+ <ul class="dropdown-menu">
+ <!-- Versions will be added dynamically in version-picker.js -->
+ </ul>
+ </div>
+ </div>
</div>
<h1 class="menu-title">Synapse</h1>
@@ -307,5 +320,7 @@ above requirements will still hold.</em></p>
<!-- Custom JS scripts -->
<script type="text/javascript" src="../../../docs/website_files/table-of-contents.js"></script>
+ <script type="text/javascript" src="../../../docs/website_files/version-picker.js"></script>
+ <script type="text/javascript" src="../../../docs/website_files/version.js"></script>
</body>
-</html>
\ No newline at end of file
+</html>
diff --git a/latest/usage/configuration/user_authentication/single_sign_on/cas.html b/latest/usage/configuration/user_authentication/single_sign_on/cas.html
index f39810dba9..8f8cda4024 100644
--- a/latest/usage/configuration/user_authentication/single_sign_on/cas.html
+++ b/latest/usage/configuration/user_authentication/single_sign_on/cas.html
@@ -28,6 +28,7 @@
<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">
+ <link rel="stylesheet" href="../../../../docs/website_files/version-picker.css">
</head>
<body>
<!-- Provide site root to javascript -->
@@ -103,6 +104,18 @@
<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 class="version-picker">
+ <div class="dropdown">
+ <div class="select">
+ <span></span>
+ <i class="fa fa-chevron-down"></i>
+ </div>
+ <input type="hidden" name="version">
+ <ul class="dropdown-menu">
+ <!-- Versions will be added dynamically in version-picker.js -->
+ </ul>
+ </div>
+ </div>
</div>
<h1 class="menu-title">Synapse</h1>
@@ -191,5 +204,7 @@ sections of the configuration manual for more details.</p>
<!-- Custom JS scripts -->
<script type="text/javascript" src="../../../../docs/website_files/table-of-contents.js"></script>
+ <script type="text/javascript" src="../../../../docs/website_files/version-picker.js"></script>
+ <script type="text/javascript" src="../../../../docs/website_files/version.js"></script>
</body>
-</html>
\ No newline at end of file
+</html>
diff --git a/latest/usage/configuration/user_authentication/single_sign_on/index.html b/latest/usage/configuration/user_authentication/single_sign_on/index.html
index e4b8d24a55..0ccfd922bc 100644
--- a/latest/usage/configuration/user_authentication/single_sign_on/index.html
+++ b/latest/usage/configuration/user_authentication/single_sign_on/index.html
@@ -28,6 +28,7 @@
<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">
+ <link rel="stylesheet" href="../../../../docs/website_files/version-picker.css">
</head>
<body>
<!-- Provide site root to javascript -->
@@ -103,6 +104,18 @@
<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 class="version-picker">
+ <div class="dropdown">
+ <div class="select">
+ <span></span>
+ <i class="fa fa-chevron-down"></i>
+ </div>
+ <input type="hidden" name="version">
+ <ul class="dropdown-menu">
+ <!-- Versions will be added dynamically in version-picker.js -->
+ </ul>
+ </div>
+ </div>
</div>
<h1 class="menu-title">Synapse</h1>
@@ -189,5 +202,7 @@ auth provider modules.</p>
<!-- Custom JS scripts -->
<script type="text/javascript" src="../../../../docs/website_files/table-of-contents.js"></script>
+ <script type="text/javascript" src="../../../../docs/website_files/version-picker.js"></script>
+ <script type="text/javascript" src="../../../../docs/website_files/version.js"></script>
</body>
-</html>
\ No newline at end of file
+</html>
diff --git a/latest/usage/configuration/user_authentication/single_sign_on/saml.html b/latest/usage/configuration/user_authentication/single_sign_on/saml.html
index 9365206e05..62be5445f0 100644
--- a/latest/usage/configuration/user_authentication/single_sign_on/saml.html
+++ b/latest/usage/configuration/user_authentication/single_sign_on/saml.html
@@ -28,6 +28,7 @@
<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">
+ <link rel="stylesheet" href="../../../../docs/website_files/version-picker.css">
</head>
<body>
<!-- Provide site root to javascript -->
@@ -103,6 +104,18 @@
<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 class="version-picker">
+ <div class="dropdown">
+ <div class="select">
+ <span></span>
+ <i class="fa fa-chevron-down"></i>
+ </div>
+ <input type="hidden" name="version">
+ <ul class="dropdown-menu">
+ <!-- Versions will be added dynamically in version-picker.js -->
+ </ul>
+ </div>
+ </div>
</div>
<h1 class="menu-title">Synapse</h1>
@@ -191,5 +204,7 @@ file</a> for more details.</p>
<!-- Custom JS scripts -->
<script type="text/javascript" src="../../../../docs/website_files/table-of-contents.js"></script>
+ <script type="text/javascript" src="../../../../docs/website_files/version-picker.js"></script>
+ <script type="text/javascript" src="../../../../docs/website_files/version.js"></script>
</body>
-</html>
\ No newline at end of file
+</html>
|
