Skip to content

Commit 1f0c2bc

Browse files
authored
docs/config: make it explicit that auto_join_rooms can be used for invite-only rooms (#19660)
1 parent 42138ad commit 1f0c2bc

3 files changed

Lines changed: 7 additions & 0 deletions

File tree

changelog.d/19660.doc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Update `auto_join_rooms` config documentation to cover requirements for auto-joining invite-only rooms.

docs/usage/configuration/config_documentation.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2870,6 +2870,8 @@ enable_3pid_changes: false
28702870

28712871
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.
28722872

2873+
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.
2874+
28732875
As Spaces are just rooms under the hood, Space aliases may also be used.
28742876

28752877
Defaults to `[]`.

schema/synapse-config.schema.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3227,6 +3227,10 @@ properties:
32273227
options relating to auto-joining rooms below.
32283228
32293229
3230+
Invite-only rooms can also be auto-joined when setting `auto_join_mxid_localpart`
3231+
to a user who's part of the invite-only rooms.
3232+
3233+
32303234
As Spaces are just rooms under the hood, Space aliases may also be used.
32313235
items:
32323236
type: string

0 commit comments

Comments
 (0)