config: Add detail to auto_join_rooms comment

Signed-off-by: Gary Dykstra <gary@dykstranet.com>
matrix-org · Feb 2, 2021 · 35a481f · 35a481f
1 parent 846b9d3
commit 35a481f
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 0 deletions.
diff --git a/changelog.d/9291.doc b/changelog.d/9291.doc
@@ -0,0 +1 @@
+Add configuration detail to auto_join_rooms comment.
diff --git a/docs/sample_config.yaml b/docs/sample_config.yaml
@@ -1320,6 +1320,9 @@ 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, i.e. 'Security & Privacy' settings for the room allow 'Anyone
+# who knows the room's link, including guests' to access the room.
 #
 #auto_join_rooms:
 #  - "#example:example.com"

diff --git a/synapse/config/registration.py b/synapse/config/registration.py
@@ -378,6 +378,9 @@ 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, i.e. 'Security & Privacy' settings for the room allow 'Anyone
+        # who knows the room's link, including guests' to access the room.
         #
         #auto_join_rooms:
         #  - "#example:example.com"
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Add configuration detail to auto_join_rooms comment.