deploy: e108cde669

develop/print.html

@@ -1822,6 +1822,7 @@ v1.61.0.</p>
 <tr><td>v1.83.0 – v1.84.1</td><td>v1.77.0</td></tr>
 <tr><td>v1.85.0 – v1.91.2</td><td>v1.83.0</td></tr>
 <tr><td>v1.92.0 – v1.97.0</td><td>v1.90.0</td></tr>
+<tr><td>v1.98.0 – v1.98.0</td><td>v1.96.0</td></tr>
 </tbody></table>
 <h1 id="upgrading-to-v1930"><a class="header" href="#upgrading-to-v1930">Upgrading to v1.93.0</a></h1>
 <h2 id="minimum-supported-rust-version"><a class="header" href="#minimum-supported-rust-version">Minimum supported Rust version</a></h2>
@@ -4334,6 +4335,12 @@ has missed. Disabled by default.</p>
 notifications for new users. Enabled by default.</p>
 </li>
 <li>
+<p><code>notif_delay_before_mail</code>: The time to wait before emailing about a notification.
+This gives the user a chance to view the message via push or an open client.
+Defaults to 10 minutes.</p>
+<p><em>New in Synapse 1.99.0.</em></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 &quot;https://matrix.to&quot;. (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>
@@ -6012,7 +6019,10 @@ Defaults to false.</p>
 <hr />
 <h3 id="sentry"><a class="header" href="#sentry"><code>sentry</code></a></h3>
 <p>Use this option to enable sentry integration. Provide the DSN assigned to you by sentry
-with the <code>dsn</code> setting.</p>
+with the <code>dsn</code> setting. </p>
+<p>An optional <code>environment</code> field can be used to specify an environment. This allows
+for log maintenance based on different environments, ensuring better organization
+and analysis..</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
@@ -6020,6 +6030,7 @@ 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:
+    environment: &quot;production&quot;
     dsn: &quot;...&quot;
 </code></pre>
 <hr />
@@ -7046,15 +7057,20 @@ notices.</p>
 <li><code>system_mxid_display_name</code>: set the display name of the &quot;notices&quot; user</li>
 <li><code>system_mxid_avatar_url</code>: set the avatar for the &quot;notices&quot; user</li>
 <li><code>room_name</code>: set the room name of the server notices room</li>
+<li><code>room_avatar_url</code>: optional string. The room avatar to use for server notice rooms. If set to the empty string <code>&quot;&quot;</code>, notice rooms will not be given an avatar. Defaults to the empty string. <em>Added in Synapse 1.99.0.</em></li>
+<li><code>room_topic</code>: optional string. The topic to use for server notice rooms. If set to the empty string <code>&quot;&quot;</code>, notice rooms will not be given a topic. Defaults to the empty string.  <em>Added in Synapse 1.99.0.</em></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>Note that the name, topic and avatar of existing server notice rooms will only be updated when a new notice event is sent.</p>
 <p>Example configuration:</p>
 <pre><code class="language-yaml">server_notices:
   system_mxid_localpart: notices
   system_mxid_display_name: &quot;Server Notices&quot;
-  system_mxid_avatar_url: &quot;mxc://server.com/oumMVlgDnLYFaPVkExemNVVZ&quot;
+  system_mxid_avatar_url: &quot;mxc://example.com/oumMVlgDnLYFaPVkExemNVVZ&quot;
   room_name: &quot;Server Notices&quot;
+  room_avatar_url: &quot;mxc://example.com/oumMVlgDnLYFaPVkExemNVVZ&quot;
+  room_topic: &quot;Room used by your server admin to notice you of important information&quot;
   auto_join: true
 </code></pre>
 <hr />
@@ -9437,13 +9453,15 @@ section, which should look like this:</p>
 <pre><code class="language-yaml">server_notices:
    system_mxid_localpart: server
    system_mxid_display_name: &quot;Server Notices&quot;
-   system_mxid_avatar_url: &quot;mxc://server.com/oumMVlgDnLYFaPVkExemNVVZ&quot;
+   system_mxid_avatar_url: &quot;mxc://example.com/oumMVlgDnLYFaPVkExemNVVZ&quot;
    room_name: &quot;Server Notices&quot;
+   room_avatar_url: &quot;mxc://example.com/oumMVlgDnLYFaPVkExemNVVZ&quot;
+   room_topic: &quot;Room used by your server admin to notice you of important information&quot;
    auto_join: true
 </code></pre>
 <p>The only compulsory setting is <code>system_mxid_localpart</code>, which defines the user
 id of the Server Notices user, as above. <code>room_name</code> defines the name of the
-room which will be created.</p>
+room which will be created, <code>room_avatar_url</code> its avatar and <code>room_topic</code> its topic.</p>
 <p><code>system_mxid_display_name</code> and <code>system_mxid_avatar_url</code> can be used to set the
 displayname and avatar of the Server Notices user.</p>
 <p><code>auto_join</code> will autojoin users to the notices room instead of sending an invite.</p>

develop/server_notices.html

@@ -192,13 +192,15 @@ section, which should look like this:</p>
 <pre><code class="language-yaml">server_notices:
    system_mxid_localpart: server
    system_mxid_display_name: &quot;Server Notices&quot;
-   system_mxid_avatar_url: &quot;mxc://server.com/oumMVlgDnLYFaPVkExemNVVZ&quot;
+   system_mxid_avatar_url: &quot;mxc://example.com/oumMVlgDnLYFaPVkExemNVVZ&quot;
    room_name: &quot;Server Notices&quot;
+   room_avatar_url: &quot;mxc://example.com/oumMVlgDnLYFaPVkExemNVVZ&quot;
+   room_topic: &quot;Room used by your server admin to notice you of important information&quot;
    auto_join: true
 </code></pre>
 <p>The only compulsory setting is <code>system_mxid_localpart</code>, which defines the user
 id of the Server Notices user, as above. <code>room_name</code> defines the name of the
-room which will be created.</p>
+room which will be created, <code>room_avatar_url</code> its avatar and <code>room_topic</code> its topic.</p>
 <p><code>system_mxid_display_name</code> and <code>system_mxid_avatar_url</code> can be used to set the
 displayname and avatar of the Server Notices user.</p>
 <p><code>auto_join</code> will autojoin users to the notices room instead of sending an invite.</p>

develop/upgrade.html

@@ -266,6 +266,7 @@ v1.61.0.</p>
 <tr><td>v1.83.0 – v1.84.1</td><td>v1.77.0</td></tr>
 <tr><td>v1.85.0 – v1.91.2</td><td>v1.83.0</td></tr>
 <tr><td>v1.92.0 – v1.97.0</td><td>v1.90.0</td></tr>
+<tr><td>v1.98.0 – v1.98.0</td><td>v1.96.0</td></tr>
 </tbody></table>
 <h1 id="upgrading-to-v1930"><a class="header" href="#upgrading-to-v1930">Upgrading to v1.93.0</a></h1>
 <h2 id="minimum-supported-rust-version"><a class="header" href="#minimum-supported-rust-version">Minimum supported Rust version</a></h2>

develop/usage/configuration/config_documentation.html

@@ -761,6 +761,12 @@ has missed. Disabled by default.</p>
 notifications for new users. Enabled by default.</p>
 </li>
 <li>
+<p><code>notif_delay_before_mail</code>: The time to wait before emailing about a notification.
+This gives the user a chance to view the message via push or an open client.
+Defaults to 10 minutes.</p>
+<p><em>New in Synapse 1.99.0.</em></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 &quot;https://matrix.to&quot;. (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>
@@ -2439,7 +2445,10 @@ Defaults to false.</p>
 <hr />
 <h3 id="sentry"><a class="header" href="#sentry"><code>sentry</code></a></h3>
 <p>Use this option to enable sentry integration. Provide the DSN assigned to you by sentry
-with the <code>dsn</code> setting.</p>
+with the <code>dsn</code> setting. </p>
+<p>An optional <code>environment</code> field can be used to specify an environment. This allows
+for log maintenance based on different environments, ensuring better organization
+and analysis..</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
@@ -2447,6 +2456,7 @@ 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:
+    environment: &quot;production&quot;
     dsn: &quot;...&quot;
 </code></pre>
 <hr />
@@ -3473,15 +3483,20 @@ notices.</p>
 <li><code>system_mxid_display_name</code>: set the display name of the &quot;notices&quot; user</li>
 <li><code>system_mxid_avatar_url</code>: set the avatar for the &quot;notices&quot; user</li>
 <li><code>room_name</code>: set the room name of the server notices room</li>
+<li><code>room_avatar_url</code>: optional string. The room avatar to use for server notice rooms. If set to the empty string <code>&quot;&quot;</code>, notice rooms will not be given an avatar. Defaults to the empty string. <em>Added in Synapse 1.99.0.</em></li>
+<li><code>room_topic</code>: optional string. The topic to use for server notice rooms. If set to the empty string <code>&quot;&quot;</code>, notice rooms will not be given a topic. Defaults to the empty string.  <em>Added in Synapse 1.99.0.</em></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>Note that the name, topic and avatar of existing server notice rooms will only be updated when a new notice event is sent.</p>
 <p>Example configuration:</p>
 <pre><code class="language-yaml">server_notices:
   system_mxid_localpart: notices
   system_mxid_display_name: &quot;Server Notices&quot;
-  system_mxid_avatar_url: &quot;mxc://server.com/oumMVlgDnLYFaPVkExemNVVZ&quot;
+  system_mxid_avatar_url: &quot;mxc://example.com/oumMVlgDnLYFaPVkExemNVVZ&quot;
   room_name: &quot;Server Notices&quot;
+  room_avatar_url: &quot;mxc://example.com/oumMVlgDnLYFaPVkExemNVVZ&quot;
+  room_topic: &quot;Room used by your server admin to notice you of important information&quot;
   auto_join: true
 </code></pre>
 <hr />

v1.98/.nojekyll

@@ -0,0 +1 @@
+This file makes sure that Github Pages doesn't process mdBook's output.

v1.98/.sample_config_header.yaml

@@ -0,0 +1,12 @@
+# This file is maintained as an up-to-date snapshot of the default
+# homeserver.yaml configuration generated by Synapse. You can find a
+# complete accounting of possible configuration options at
+# https://matrix-org.github.io/synapse/latest/usage/configuration/config_documentation.html
+#
+# It is *not* intended to be copied and used as the basis for a real
+# homeserver.yaml. Instead, if you are starting from scratch, please generate
+# a fresh config using Synapse by following the instructions in
+# https://matrix-org.github.io/synapse/latest/setup/installation.html.
+#
+################################################################################
+

v1.98/print.html

@@ -1806,7 +1806,24 @@ The following table gives the version ranges and the earliest version they can
 be rolled back to. E.g. Synapse versions v1.58.0 through v1.61.1 can be rolled
 back safely to v1.57.0, but starting with v1.62.0 it is only safe to rollback to
 v1.61.0.</p>
-<!-- REPLACE_WITH_SCHEMA_VERSIONS -->
+<table><thead><tr><th>Versions</th><th>Compatible version</th></tr></thead><tbody>
+<tr><td>v1.0.0 – v1.2.1</td><td>v1.0.0</td></tr>
+<tr><td>v1.3.0 – v1.8.0</td><td>v1.3.0</td></tr>
+<tr><td>v1.9.0 – v1.12.4</td><td>v1.9.0</td></tr>
+<tr><td>v1.13.0 – v1.25.0</td><td>v1.13.0</td></tr>
+<tr><td>v1.26.0 – v1.44.0</td><td>v1.26.0</td></tr>
+<tr><td>v1.45.0 – v1.47.1</td><td>v1.38.0</td></tr>
+<tr><td>v1.48.0 – v1.51.0</td><td>v1.39.0</td></tr>
+<tr><td>v1.52.0 – v1.57.1</td><td>v1.49.0</td></tr>
+<tr><td>v1.58.0 – v1.61.1</td><td>v1.57.0</td></tr>
+<tr><td>v1.62.0 – v1.63.1</td><td>v1.61.0</td></tr>
+<tr><td>v1.64.0 – v1.69.0</td><td>v1.62.0</td></tr>
+<tr><td>v1.70.0 – v1.82.0</td><td>v1.68.0</td></tr>
+<tr><td>v1.83.0 – v1.84.1</td><td>v1.77.0</td></tr>
+<tr><td>v1.85.0 – v1.91.2</td><td>v1.83.0</td></tr>
+<tr><td>v1.92.0 – v1.97.0</td><td>v1.90.0</td></tr>
+<tr><td>v1.98.0 – v1.98.0</td><td>v1.96.0</td></tr>
+</tbody></table>
 <h1 id="upgrading-to-v1930"><a class="header" href="#upgrading-to-v1930">Upgrading to v1.93.0</a></h1>
 <h2 id="minimum-supported-rust-version"><a class="header" href="#minimum-supported-rust-version">Minimum supported Rust version</a></h2>
 <p>The minimum supported Rust version has been increased from v1.60.0 to v1.61.0.

v1.98/upgrade.html

@@ -250,7 +250,24 @@ The following table gives the version ranges and the earliest version they can
 be rolled back to. E.g. Synapse versions v1.58.0 through v1.61.1 can be rolled
 back safely to v1.57.0, but starting with v1.62.0 it is only safe to rollback to
 v1.61.0.</p>
-<!-- REPLACE_WITH_SCHEMA_VERSIONS -->
+<table><thead><tr><th>Versions</th><th>Compatible version</th></tr></thead><tbody>
+<tr><td>v1.0.0 – v1.2.1</td><td>v1.0.0</td></tr>
+<tr><td>v1.3.0 – v1.8.0</td><td>v1.3.0</td></tr>
+<tr><td>v1.9.0 – v1.12.4</td><td>v1.9.0</td></tr>
+<tr><td>v1.13.0 – v1.25.0</td><td>v1.13.0</td></tr>
+<tr><td>v1.26.0 – v1.44.0</td><td>v1.26.0</td></tr>
+<tr><td>v1.45.0 – v1.47.1</td><td>v1.38.0</td></tr>
+<tr><td>v1.48.0 – v1.51.0</td><td>v1.39.0</td></tr>
+<tr><td>v1.52.0 – v1.57.1</td><td>v1.49.0</td></tr>
+<tr><td>v1.58.0 – v1.61.1</td><td>v1.57.0</td></tr>
+<tr><td>v1.62.0 – v1.63.1</td><td>v1.61.0</td></tr>
+<tr><td>v1.64.0 – v1.69.0</td><td>v1.62.0</td></tr>
+<tr><td>v1.70.0 – v1.82.0</td><td>v1.68.0</td></tr>
+<tr><td>v1.83.0 – v1.84.1</td><td>v1.77.0</td></tr>
+<tr><td>v1.85.0 – v1.91.2</td><td>v1.83.0</td></tr>
+<tr><td>v1.92.0 – v1.97.0</td><td>v1.90.0</td></tr>
+<tr><td>v1.98.0 – v1.98.0</td><td>v1.96.0</td></tr>
+</tbody></table>
 <h1 id="upgrading-to-v1930"><a class="header" href="#upgrading-to-v1930">Upgrading to v1.93.0</a></h1>
 <h2 id="minimum-supported-rust-version"><a class="header" href="#minimum-supported-rust-version">Minimum supported Rust version</a></h2>
 <p>The minimum supported Rust version has been increased from v1.60.0 to v1.61.0.