diff options
| author | erikjohnston <erikjohnston@users.noreply.github.com> | 2023-12-12 15:23:41 +0000 |
|---|---|---|
| committer | erikjohnston <erikjohnston@users.noreply.github.com> | 2023-12-12 15:23:41 +0000 |
| commit | ae16b375d2ba2750986c674106d8b053185cf66c (patch) | |
| tree | aeed97b8587cc09eca7d47a63a50dc57ac04eb38 /develop/print.html | |
| parent | deploy: 128aad4fe3f4c5c11286512b64e2480febf4567c (diff) | |
| download | synapse-ae16b375d2ba2750986c674106d8b053185cf66c.tar.xz | |
deploy: e108c31fc0ba4fa8b8890170ce4433df334ab58b
Diffstat (limited to 'develop/print.html')
| -rw-r--r-- | develop/print.html | 13 |
1 files changed, 10 insertions, 3 deletions
diff --git a/develop/print.html b/develop/print.html index 4bbb68ecb8..aee65cf9f2 100644 --- a/develop/print.html +++ b/develop/print.html @@ -7052,15 +7052,20 @@ 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>room_avatar_url</code>: optional string. The room avatar to use for server notice rooms. If set to the empty string <code>""</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>""</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: "Server Notices" - system_mxid_avatar_url: "mxc://server.com/oumMVlgDnLYFaPVkExemNVVZ" + system_mxid_avatar_url: "mxc://example.com/oumMVlgDnLYFaPVkExemNVVZ" room_name: "Server Notices" + room_avatar_url: "mxc://example.com/oumMVlgDnLYFaPVkExemNVVZ" + room_topic: "Room used by your server admin to notice you of important information" auto_join: true </code></pre> <hr /> @@ -9443,13 +9448,15 @@ section, which should look like this:</p> <pre><code class="language-yaml">server_notices: system_mxid_localpart: server system_mxid_display_name: "Server Notices" - system_mxid_avatar_url: "mxc://server.com/oumMVlgDnLYFaPVkExemNVVZ" + system_mxid_avatar_url: "mxc://example.com/oumMVlgDnLYFaPVkExemNVVZ" room_name: "Server Notices" + room_avatar_url: "mxc://example.com/oumMVlgDnLYFaPVkExemNVVZ" + room_topic: "Room used by your server admin to notice you of important information" 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> |