diff options
| author | Andrew Morgan <1342360+anoadragon453@users.noreply.github.com> | 2020-04-08 00:46:50 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-04-08 00:46:50 +0100 |
| commit | 29b7e22b939c473649c8619fdfbecec0cee6b029 (patch) | |
| tree | b60495f1d65f7b0820bd02a40caae2f30e69012d /docs/sample_config.yaml | |
| parent | bg update to clear out duplicate outbound_device_list_pokes (#7193) (diff) | |
| download | synapse-29b7e22b939c473649c8619fdfbecec0cee6b029.tar.xz | |
Add documentation to password_providers config option (#7238)
Diffstat (limited to 'docs/sample_config.yaml')
| -rw-r--r-- | docs/sample_config.yaml | 14 |
1 files changed, 13 insertions, 1 deletions
diff --git a/docs/sample_config.yaml b/docs/sample_config.yaml index be742969cc..3417813750 100644 --- a/docs/sample_config.yaml +++ b/docs/sample_config.yaml @@ -1657,7 +1657,19 @@ email: #template_dir: "res/templates" -#password_providers: +# Password providers allow homeserver administrators to integrate +# their Synapse installation with existing authentication methods +# ex. LDAP, external tokens, etc. +# +# For more information and known implementations, please see +# https://github.com/matrix-org/synapse/blob/master/docs/password_auth_providers.md +# +# Note: instances wishing to use SAML or CAS authentication should +# instead use the `saml2_config` or `cas_config` options, +# respectively. +# +password_providers: +# # Example config for an LDAP auth provider # - module: "ldap_auth_provider.LdapAuthProvider" # config: # enabled: true |