From ae16b375d2ba2750986c674106d8b053185cf66c Mon Sep 17 00:00:00 2001 From: erikjohnston Date: Tue, 12 Dec 2023 15:23:41 +0000 Subject: deploy: e108c31fc0ba4fa8b8890170ce4433df334ab58b --- develop/print.html | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) (limited to 'develop/print.html') 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.

  • system_mxid_display_name: set the display name of the "notices" user
  • system_mxid_avatar_url: set the avatar for the "notices" user
  • room_name: set the room name of the server notices room
    • +
  • room_avatar_url: optional string. The room avatar to use for server notice rooms. If set to the empty string "", notice rooms will not be given an avatar. Defaults to the empty string. Added in Synapse 1.99.0.
    • +
  • room_topic: optional string. The topic to use for server notice rooms. If set to the empty string "", notice rooms will not be given a topic. Defaults to the empty string. Added in Synapse 1.99.0.
  • auto_join: boolean. If true, the user will be automatically joined to the room instead of being invited. Defaults to false. Added in Synapse 1.98.0.
    • +

    Note that the name, topic and avatar of existing server notice rooms will only be updated when a new notice event is sent.

    Example configuration:

    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
    @@ -9443,13 +9448,15 @@ section, which should look like this:

    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

    The only compulsory setting is system_mxid_localpart, which defines the user id of the Server Notices user, as above. room_name defines the name of the -room which will be created.

    +room which will be created, room_avatar_url its avatar and room_topic its topic.

    system_mxid_display_name and system_mxid_avatar_url can be used to set the displayname and avatar of the Server Notices user.

    auto_join will autojoin users to the notices room instead of sending an invite.

    -- cgit 1.5.1