config: Add detail to auto_join_rooms comment (#9291)

config: Add detail to auto_join_rooms comment Signed-off-by: Gary Dykstra <gary@dykstranet.com>
matrix-org · Feb 17, 2021 · 644dab4 · 644dab4
1 parent bfc9694
commit 644dab4
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 0 deletions.
diff --git a/changelog.d/9291.doc 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
@@ -1326,6 +1326,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
@@ -391,6 +391,8 @@ def generate_config_section(self, generate_secrets=False, **kwargs):
         # 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"
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Add note to `auto_join_rooms` config option explaining existing rooms must be publicly joinable.