summary refs log tree commit diff
path: root/synapse/config/oidc_config.py
diff options
context:
space:
mode:
authorPatrick Cloke <clokep@users.noreply.github.com>2020-10-30 10:01:59 -0400
committerGitHub <noreply@github.com>2020-10-30 10:01:59 -0400
commit8f1aefa694bb860dd1485ec95054c699b1667e96 (patch)
treeb3a6f47aa67d22ef28e9902cf302a27be35447cc /synapse/config/oidc_config.py
parentImplement and use an @lru_cache decorator (#8595) (diff)
downloadsynapse-8f1aefa694bb860dd1485ec95054c699b1667e96.tar.xz
Improve the sample config for SSO (OIDC, SAML, and CAS). (#8635)
Diffstat (limited to 'synapse/config/oidc_config.py')
-rw-r--r--synapse/config/oidc_config.py7
1 files changed, 3 insertions, 4 deletions
diff --git a/synapse/config/oidc_config.py b/synapse/config/oidc_config.py
index 7597fbc864..69d188341c 100644
--- a/synapse/config/oidc_config.py
+++ b/synapse/config/oidc_config.py
@@ -87,11 +87,10 @@ class OIDCConfig(Config):
 
     def generate_config_section(self, config_dir_path, server_name, **kwargs):
         return """\
-        # OpenID Connect integration. The following settings can be used to make Synapse
-        # use an OpenID Connect Provider for authentication, instead of its internal
-        # password database.
+        # Enable OpenID Connect (OIDC) / OAuth 2.0 for registration and login.
         #
-        # See https://github.com/matrix-org/synapse/blob/master/docs/openid.md.
+        # See https://github.com/matrix-org/synapse/blob/master/docs/openid.md
+        # for some example configurations.
         #
         oidc_config:
           # Uncomment the following to enable authorization against an OpenID Connect