summary refs log tree commit diff
path: root/docs/sample_config.yaml
diff options
context:
space:
mode:
authorRichard van der Hoff <richard@matrix.org>2019-06-27 00:41:04 +0100
committerRichard van der Hoff <richard@matrix.org>2019-06-27 00:41:04 +0100
commitdde41183417fedf28f47af1fed310790de11c661 (patch)
tree6db544cbdd4034b8ac2f5966d49b777a19d3d6f2 /docs/sample_config.yaml
parentcleanups (diff)
downloadsynapse-dde41183417fedf28f47af1fed310790de11c661.tar.xz
update sample config
Diffstat (limited to '')
-rw-r--r--docs/sample_config.yaml19
1 files changed, 13 insertions, 6 deletions
diff --git a/docs/sample_config.yaml b/docs/sample_config.yaml
index 8d52d17792..5558b3e2bd 100644
--- a/docs/sample_config.yaml
+++ b/docs/sample_config.yaml
@@ -988,6 +988,12 @@ signing_key_path: "CONFDIR/SERVERNAME.signing.key"
 # so it is not normally necessary to specify them unless you need to
 # override them.
 #
+# Once SAML support is enabled, a metadata file will be exposed at
+# https://<server>:<port>/_matrix/saml2/metadata.xml, which you may be able to
+# use to configure your SAML IdP with. Alternatively, you can manually configure
+# the IdP to use an ACS location of
+# https://<server>:<port>/_matrix/saml2/authn_response.
+#
 #saml2_config:
 #  sp_config:
 #    # point this to the IdP's metadata. You can use either a local file or
@@ -998,13 +1004,14 @@ signing_key_path: "CONFDIR/SERVERNAME.signing.key"
 #        - url: https://our_idp/metadata.xml
 #
 #    # 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 an 'sp'
-#    # section:
-#    #
-#    #sp:
-#    #  allow_unsolicited: True
+#    # allow IdP-initiated login, set 'allow_unsolicited: True' in a
+#    # 'service.sp' section:
 #    #
-#    # The rest of sp_config is just used to generate our metadata xml, and you
+#    #service:
+#    #  sp:
+#    #    allow_unsolicited: True
+#
+#    # The examples below are just used to generate our metadata xml, and you
 #    # may well not need it, depending on your setup. Alternatively you
 #    # may need a whole lot more detail - see the pysaml2 docs!
 #