From e4cdecb3107727d17c34b253d65cd56e2acd526b Mon Sep 17 00:00:00 2001 From: dykstranet Date: Wed, 3 Feb 2021 23:21:30 +0800 Subject: [PATCH] config: Add detail to auto_join_rooms comment (#9291) config: Add detail to auto_join_rooms comment Signed-off-by: Gary Dykstra --- changelog.d/9291.doc | 1 + docs/sample_config.yaml | 2 ++ synapse/config/registration.py | 2 ++ 3 files changed, 5 insertions(+) create mode 100644 changelog.d/9291.doc diff --git a/changelog.d/9291.doc b/changelog.d/9291.doc new file mode 100644 index 000000000..422acd389 --- /dev/null +++ b/changelog.d/9291.doc @@ -0,0 +1 @@ +Add note to `auto_join_rooms` config option explaining existing rooms must be publicly joinable. diff --git a/docs/sample_config.yaml b/docs/sample_config.yaml index 0e323846f..601a8338e 100644 --- a/docs/sample_config.yaml +++ b/docs/sample_config.yaml @@ -1328,6 +1328,8 @@ account_threepid_delegates: # 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. This behaviour can be customised with the settings below. +# If the room already exists, make certain it is a publicly joinable +# room. The join rule of the room must be set to 'public'. # #auto_join_rooms: # - "#example:example.com" diff --git a/synapse/config/registration.py b/synapse/config/registration.py index ac48913a0..afb3e0b2a 100644 --- a/synapse/config/registration.py +++ b/synapse/config/registration.py @@ -378,6 +378,8 @@ class RegistrationConfig(Config): # 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. This behaviour can be customised with the settings below. + # If the room already exists, make certain it is a publicly joinable + # room. The join rule of the room must be set to 'public'. # #auto_join_rooms: # - "#example:example.com"