From 1f0c2bc3e480861008f7f2093006129df0e6eb62 Mon Sep 17 00:00:00 2001 From: Maximilian Bosch Date: Mon, 22 Jun 2026 10:57:10 +0200 Subject: [PATCH] docs/config: make it explicit that auto_join_rooms can be used for invite-only rooms (#19660) --- changelog.d/19660.doc | 1 + docs/usage/configuration/config_documentation.md | 2 ++ schema/synapse-config.schema.yaml | 4 ++++ 3 files changed, 7 insertions(+) create mode 100644 changelog.d/19660.doc diff --git a/changelog.d/19660.doc b/changelog.d/19660.doc new file mode 100644 index 0000000000..f03bc6090c --- /dev/null +++ b/changelog.d/19660.doc @@ -0,0 +1 @@ +Update `auto_join_rooms` config documentation to cover requirements for auto-joining invite-only rooms. diff --git a/docs/usage/configuration/config_documentation.md b/docs/usage/configuration/config_documentation.md index d1a8a064c9..92eca4a7ff 100644 --- a/docs/usage/configuration/config_documentation.md +++ b/docs/usage/configuration/config_documentation.md @@ -2870,6 +2870,8 @@ enable_3pid_changes: false By default, any room aliases included in this list will be created as a publicly joinable room when the first user registers for the homeserver. If the room already exists, make certain it is a publicly joinable room, i.e. the join rule of the room must be set to `public`. You can find more options relating to auto-joining rooms below. +Invite-only rooms can also be auto-joined when setting `auto_join_mxid_localpart` to a user who's part of the invite-only rooms. + As Spaces are just rooms under the hood, Space aliases may also be used. Defaults to `[]`. diff --git a/schema/synapse-config.schema.yaml b/schema/synapse-config.schema.yaml index d7ad88b0fc..f58b923add 100644 --- a/schema/synapse-config.schema.yaml +++ b/schema/synapse-config.schema.yaml @@ -3227,6 +3227,10 @@ properties: options relating to auto-joining rooms below. + Invite-only rooms can also be auto-joined when setting `auto_join_mxid_localpart` + to a user who's part of the invite-only rooms. + + As Spaces are just rooms under the hood, Space aliases may also be used. items: type: string