Fix indention in generated config file (#7300)

Also adjust sample_config.yaml

Signed-off-by: Lars Franke <frcl@mailbox.org>

changelog.d/7300.misc

@@ -0,0 +1 @@
+Fix sample SAML Service Provider configuration. Contributed by @frcl.

docs/sample_config.yaml

@@ -1339,32 +1339,32 @@ saml2_config:
   #    remote:
   #      - url: https://our_idp/metadata.xml
   #
-  #    # By default, the user has to go to our login page first. If you'd like
+  #  # By default, the user has to go to our login page first. If you'd like
-  #    # to allow IdP-initiated login, set 'allow_unsolicited: true' in a
+  #  # to allow IdP-initiated login, set 'allow_unsolicited: true' in a
-  #    # 'service.sp' section:
+  #  # 'service.sp' section:
-  #    #
+  #  #
-  #    #service:
+  #  #service:
-  #    #  sp:
+  #  #  sp:
-  #    #    allow_unsolicited: true
+  #  #    allow_unsolicited: true
   #
-  #    # The examples below are just used to generate our metadata xml, and you
+  #  # The examples below are just used to generate our metadata xml, and you
-  #    # may well not need them, depending on your setup. Alternatively you
+  #  # may well not need them, depending on your setup. Alternatively you
-  #    # may need a whole lot more detail - see the pysaml2 docs!
+  #  # may need a whole lot more detail - see the pysaml2 docs!
   #
-  #    description: ["My awesome SP", "en"]
+  #  description: ["My awesome SP", "en"]
-  #    name: ["Test SP", "en"]
+  #  name: ["Test SP", "en"]
   #
-  #    organization:
+  #  organization:
-  #      name: Example com
+  #    name: Example com
-  #      display_name:
+  #    display_name:
-  #        - ["Example co", "en"]
+  #      - ["Example co", "en"]
-  #      url: "http://example.com"
+  #    url: "http://example.com"
   #
-  #    contact_person:
+  #  contact_person:
-  #      - given_name: Bob
+  #    - given_name: Bob
-  #        sur_name: "the Sysadmin"
+  #      sur_name: "the Sysadmin"
-  #        email_address": ["admin@example.com"]
+  #      email_address": ["admin@example.com"]
-  #        contact_type": technical
+  #      contact_type": technical
 
   # Instead of putting the config inline as above, you can specify a
   # separate pysaml2 configuration file:

synapse/config/saml2_config.py

@@ -248,32 +248,32 @@ class SAML2Config(Config):
           #    remote:
           #      - url: https://our_idp/metadata.xml
           #
-          #    # By default, the user has to go to our login page first. If you'd like
+          #  # By default, the user has to go to our login page first. If you'd like
-          #    # to allow IdP-initiated login, set 'allow_unsolicited: true' in a
+          #  # to allow IdP-initiated login, set 'allow_unsolicited: true' in a
-          #    # 'service.sp' section:
+          #  # 'service.sp' section:
-          #    #
+          #  #
-          #    #service:
+          #  #service:
-          #    #  sp:
+          #  #  sp:
-          #    #    allow_unsolicited: true
+          #  #    allow_unsolicited: true
           #
-          #    # The examples below are just used to generate our metadata xml, and you
+          #  # The examples below are just used to generate our metadata xml, and you
-          #    # may well not need them, depending on your setup. Alternatively you
+          #  # may well not need them, depending on your setup. Alternatively you
-          #    # may need a whole lot more detail - see the pysaml2 docs!
+          #  # may need a whole lot more detail - see the pysaml2 docs!
           #
-          #    description: ["My awesome SP", "en"]
+          #  description: ["My awesome SP", "en"]
-          #    name: ["Test SP", "en"]
+          #  name: ["Test SP", "en"]
           #
-          #    organization:
+          #  organization:
-          #      name: Example com
+          #    name: Example com
-          #      display_name:
+          #    display_name:
-          #        - ["Example co", "en"]
+          #      - ["Example co", "en"]
-          #      url: "http://example.com"
+          #    url: "http://example.com"
           #
-          #    contact_person:
+          #  contact_person:
-          #      - given_name: Bob
+          #    - given_name: Bob
-          #        sur_name: "the Sysadmin"
+          #      sur_name: "the Sysadmin"
-          #        email_address": ["admin@example.com"]
+          #      email_address": ["admin@example.com"]
-          #        contact_type": technical
+          #      contact_type": technical
 
           # Instead of putting the config inline as above, you can specify a
           # separate pysaml2 configuration file: