Fix some DETECTED VIOLATIONS in the config file (#7550)

consistency ftw

changelog.d/7550.misc

@@ -0,0 +1 @@
+Fix some indentation inconsistencies in the sample config.

docs/sample_config.yaml

@@ -322,21 +322,26 @@ listeners:
 # Used by phonehome stats to group together related servers.
 #server_context: context
 
-# Resource-constrained homeserver Settings
+# Resource-constrained homeserver settings
 #
-# If limit_remote_rooms.enabled is True, the room complexity will be
+# When this is enabled, the room "complexity" will be checked before a user
-# checked before a user joins a new remote room. If it is above
+# joins a new remote room. If it is above the complexity limit, the server will
-# limit_remote_rooms.complexity, it will disallow joining or
+# disallow joining, or will instantly leave.
-# instantly leave.
 #
-# limit_remote_rooms.complexity_error can be set to customise the text
+# Room complexity is an arbitrary measure based on factors such as the number of
-# displayed to the user when a room above the complexity threshold has
+# users in the room.
-# its join cancelled.
+#
+limit_remote_rooms:
+  # Uncomment to enable room complexity checking.
   #
-# Uncomment the below lines to enable:
-#limit_remote_rooms:
   #enabled: true
-#  complexity: 1.0
+
+  # the limit above which rooms cannot be joined. The default is 1.0.
+  #
+  #complexity: 0.5
+
+  # override the error which is returned when the room is too complex.
+  #
   #complexity_error: "This room is too complex."
 
 # Whether to require a user to be in the room to add an alias to it.
@@ -942,25 +947,28 @@ url_preview_accept_language:
 
 
 ## Captcha ##
-# See docs/CAPTCHA_SETUP for full details of configuring this.
+# See docs/CAPTCHA_SETUP.md for full details of configuring this.
 
-# This homeserver's ReCAPTCHA public key.
+# This homeserver's ReCAPTCHA public key. Must be specified if
+# enable_registration_captcha is enabled.
 #
 #recaptcha_public_key: "YOUR_PUBLIC_KEY"
 
-# This homeserver's ReCAPTCHA private key.
+# This homeserver's ReCAPTCHA private key. Must be specified if
+# enable_registration_captcha is enabled.
 #
 #recaptcha_private_key: "YOUR_PRIVATE_KEY"
 
-# Enables ReCaptcha checks when registering, preventing signup
+# Uncomment to enable ReCaptcha checks when registering, preventing signup
 # unless a captcha is answered. Requires a valid ReCaptcha
-# public/private key.
+# public/private key. Defaults to 'false'.
 #
-#enable_registration_captcha: false
+#enable_registration_captcha: true
 
 # The API endpoint to use for verifying m.login.recaptcha responses.
+# Defaults to "https://www.recaptcha.net/recaptcha/api/siteverify".
 #
-#recaptcha_siteverify_api: "https://www.recaptcha.net/recaptcha/api/siteverify"
+#recaptcha_siteverify_api: "https://my.recaptcha.site"
 
 
 ## TURN ##
@@ -1237,6 +1245,7 @@ metrics_flags:
     #known_servers: true
 
 # Whether or not to report anonymized homeserver usage statistics.
+#
 #report_stats: true|false
 
 # The endpoint to report the anonymized homeserver usage statistics to.

synapse/config/captcha.py

@@ -32,23 +32,26 @@ class CaptchaConfig(Config):
     def generate_config_section(self, **kwargs):
         return """\
         ## Captcha ##
-        # See docs/CAPTCHA_SETUP for full details of configuring this.
+        # See docs/CAPTCHA_SETUP.md for full details of configuring this.
 
-        # This homeserver's ReCAPTCHA public key.
+        # This homeserver's ReCAPTCHA public key. Must be specified if
+        # enable_registration_captcha is enabled.
         #
         #recaptcha_public_key: "YOUR_PUBLIC_KEY"
 
-        # This homeserver's ReCAPTCHA private key.
+        # This homeserver's ReCAPTCHA private key. Must be specified if
+        # enable_registration_captcha is enabled.
         #
         #recaptcha_private_key: "YOUR_PRIVATE_KEY"
 
-        # Enables ReCaptcha checks when registering, preventing signup
+        # Uncomment to enable ReCaptcha checks when registering, preventing signup
         # unless a captcha is answered. Requires a valid ReCaptcha
-        # public/private key.
+        # public/private key. Defaults to 'false'.
         #
-        #enable_registration_captcha: false
+        #enable_registration_captcha: true
 
         # The API endpoint to use for verifying m.login.recaptcha responses.
+        # Defaults to "https://www.recaptcha.net/recaptcha/api/siteverify".
         #
-        #recaptcha_siteverify_api: "https://www.recaptcha.net/recaptcha/api/siteverify"
+        #recaptcha_siteverify_api: "https://my.recaptcha.site"
         """

synapse/config/metrics.py

@@ -93,6 +93,7 @@ class MetricsConfig(Config):
             #known_servers: true
 
         # Whether or not to report anonymized homeserver usage statistics.
+        #
         """
 
         if report_stats is None:

synapse/config/registration.py

@@ -148,9 +148,7 @@ class RegistrationConfig(Config):
                 random_string_with_symbols(50),
             )
         else:
-            registration_shared_secret = (
+            registration_shared_secret = "#registration_shared_secret: <PRIVATE STRING>"
-                "# registration_shared_secret: <PRIVATE STRING>"
-            )
 
         return (
             """\

synapse/config/server.py

@@ -434,7 +434,7 @@ class ServerConfig(Config):
             )
 
         self.limit_remote_rooms = LimitRemoteRoomsConfig(
-            **config.get("limit_remote_rooms", {})
+            **(config.get("limit_remote_rooms") or {})
         )
 
         bind_port = config.get("bind_port")
@@ -895,21 +895,26 @@ class ServerConfig(Config):
         # Used by phonehome stats to group together related servers.
         #server_context: context
 
-        # Resource-constrained homeserver Settings
+        # Resource-constrained homeserver settings
         #
-        # If limit_remote_rooms.enabled is True, the room complexity will be
+        # When this is enabled, the room "complexity" will be checked before a user
-        # checked before a user joins a new remote room. If it is above
+        # joins a new remote room. If it is above the complexity limit, the server will
-        # limit_remote_rooms.complexity, it will disallow joining or
+        # disallow joining, or will instantly leave.
-        # instantly leave.
         #
-        # limit_remote_rooms.complexity_error can be set to customise the text
+        # Room complexity is an arbitrary measure based on factors such as the number of
-        # displayed to the user when a room above the complexity threshold has
+        # users in the room.
-        # its join cancelled.
+        #
+        limit_remote_rooms:
+          # Uncomment to enable room complexity checking.
           #
-        # Uncomment the below lines to enable:
-        #limit_remote_rooms:
           #enabled: true
-        #  complexity: 1.0
+
+          # the limit above which rooms cannot be joined. The default is 1.0.
+          #
+          #complexity: 0.5
+
+          # override the error which is returned when the room is too complex.
+          #
           #complexity_error: "This room is too complex."
 
         # Whether to require a user to be in the room to add an alias to it.