summary refs log tree commit diff
path: root/docs
diff options
context:
space:
mode:
authorMathieu Velten <matmaul@gmail.com>2023-12-04 13:31:42 +0100
committerGitHub <noreply@github.com>2023-12-04 12:31:42 +0000
commit9e7f80037d08619cdd193831540d34e9ed5aacd7 (patch)
tree6571e3ff2821fb876e3b37fe57ee15a20b0a8ca8 /docs
parentBump matrix-org/netlify-pr-preview from 2 to 3 (#16719) (diff)
downloadsynapse-9e7f80037d08619cdd193831540d34e9ed5aacd7.tar.xz
Server notices: add an autojoin setting for the notices room (#16699)
Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/server_notices.md3
-rw-r--r--docs/usage/configuration/config_documentation.md3
2 files changed, 6 insertions, 0 deletions
diff --git a/docs/server_notices.md b/docs/server_notices.md
index 339d10a0ab..aae25d23b8 100644
--- a/docs/server_notices.md
+++ b/docs/server_notices.md
@@ -46,6 +46,7 @@ server_notices:
    system_mxid_display_name: "Server Notices"
    system_mxid_avatar_url: "mxc://server.com/oumMVlgDnLYFaPVkExemNVVZ"
    room_name: "Server Notices"
+   auto_join: true
 ```
 
 The only compulsory setting is `system_mxid_localpart`, which defines the user
@@ -55,6 +56,8 @@ room which will be created.
 `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.
+
 ## Sending notices
 
 To send server notices to users you can use the
diff --git a/docs/usage/configuration/config_documentation.md b/docs/usage/configuration/config_documentation.md
index 7c4e742cd5..812a7d429b 100644
--- a/docs/usage/configuration/config_documentation.md
+++ b/docs/usage/configuration/config_documentation.md
@@ -3815,6 +3815,8 @@ Sub-options for this setting include:
 * `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
+* `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._
 
 Example configuration:
 ```yaml
@@ -3823,6 +3825,7 @@ server_notices:
   system_mxid_display_name: "Server Notices"
   system_mxid_avatar_url: "mxc://server.com/oumMVlgDnLYFaPVkExemNVVZ"
   room_name: "Server Notices"
+  auto_join: true
 ```
 ---
 ### `enable_room_list_search`