Mirrors
/
synapse-old
mirror of https://github.com/matrix-org/synapse.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Document that the 'auto_join_rooms' option works with Spaces (#13931)

This commit is contained in:
Andrew Morgan 2022-09-28 15:13:19 +01:00 committed by GitHub
parent 220b21936e
commit 25c0e69392
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
changelog.d/13931.doc Normal file
View File

@ -0,0 +1 @@
Clarify that the `auto_join_rooms` config option can also be used with Space aliases.

7
docs/usage/configuration/config_documentation.md
View File

@ -2229,6 +2229,9 @@ 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 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. relating to auto-joining rooms below.
As Spaces are just rooms under the hood, Space aliases may also be
used.
Example configuration: Example configuration:
```yaml ```yaml
auto_join_rooms: auto_join_rooms:
@ -2240,7 +2243,7 @@ auto_join_rooms:
Where `auto_join_rooms` are specified, setting this flag ensures that Where `auto_join_rooms` are specified, setting this flag ensures that
the rooms exist by creating them when the first user on the the rooms exist by creating them when the first user on the
homeserver registers. homeserver registers. This option will not create Spaces.
By default the auto-created rooms are publicly joinable from any federated By default the auto-created rooms are publicly joinable from any federated
server. Use the `autocreate_auto_join_rooms_federated` and server. Use the `autocreate_auto_join_rooms_federated` and
@ -2258,7 +2261,7 @@ autocreate_auto_join_rooms: false
--- ---
### `autocreate_auto_join_rooms_federated` ### `autocreate_auto_join_rooms_federated`
Whether the rooms listen in `auto_join_rooms` that are auto-created are available Whether the rooms listed in `auto_join_rooms` that are auto-created are available
via federation. Only has an effect if `autocreate_auto_join_rooms` is true. via federation. Only has an effect if `autocreate_auto_join_rooms` is true.
Note that whether a room is federated cannot be modified after Note that whether a room is federated cannot be modified after