Make SAML2 optional and add some references/comments

1 files changed, 14 insertions, 0 deletions

diff --git a/synapse/config/saml2.py b/synapse/config/saml2.py
index d18d076a89..be5176db52 100644
--- a/synapse/config/saml2.py
+++ b/synapse/config/saml2.py
@@ -16,6 +16,19 @@
 from ._base import Config
 
 
+#
+# SAML2 Configuration
+# Synapse uses pysaml2 libraries for providing SAML2 support
+#
+# config_path:      Path to the sp_conf.py configuration file
+# idp_redirect_url: Identity provider URL which will redirect
+#                   the user back to /login/saml2 with proper info.
+#
+# sp_conf.py file is something like:
+# https://github.com/rohe/pysaml2/blob/master/example/sp-repoze/sp_conf.py.example
+#
+# More information: https://pythonhosted.org/pysaml2/howto/config.html
+#
 class SAML2Config(Config):
     def read_config(self, config):
         self.saml2_config = config["saml2_config"]
@@ -23,6 +36,7 @@ class SAML2Config(Config):
     def default_config(self, config_dir_path, server_name):
         return """
         saml2_config:
+            enabled: false
             config_path: "%s/sp_conf.py"
             idp_redirect_url: "http://%s/idp"
         """ % (config_dir_path, server_name)