summary refs log tree commit diff
path: root/docs
diff options
context:
space:
mode:
authorreivilibre <oliverw@matrix.org>2022-05-27 10:44:51 +0100
committerGitHub <noreply@github.com>2022-05-27 09:44:51 +0000
commit7b88f5a107ce9751365f9f2393521ef3d62afde8 (patch)
treeb93a748112b6ea0c0dc038f9755f0ee0683de67f /docs
parentImprove URL previews by not including the content of media tags in the genera... (diff)
downloadsynapse-7b88f5a107ce9751365f9f2393521ef3d62afde8.tar.xz
Add an option allowing users to use their password to reauthenticate even though password authentication is disabled. (#12883)
Diffstat (limited to 'docs')
-rw-r--r--docs/sample_config.yaml4
-rw-r--r--docs/usage/configuration/config_documentation.md3
2 files changed, 6 insertions, 1 deletions
diff --git a/docs/sample_config.yaml b/docs/sample_config.yaml
index ee98d193cb..e0abcd3b03 100644
--- a/docs/sample_config.yaml
+++ b/docs/sample_config.yaml
@@ -2216,7 +2216,9 @@ sso:
 
 
 password_config:
-   # Uncomment to disable password login
+   # Uncomment to disable password login.
+   # Set to `only_for_reauth` to permit reauthentication for users that
+   # have passwords and are already logged in.
    #
    #enabled: false
 
diff --git a/docs/usage/configuration/config_documentation.md b/docs/usage/configuration/config_documentation.md
index 0f5bda32b9..295cece7e8 100644
--- a/docs/usage/configuration/config_documentation.md
+++ b/docs/usage/configuration/config_documentation.md
@@ -2930,6 +2930,9 @@ Use this setting to enable password-based logins.
 
 This setting has the following sub-options:
 * `enabled`: Defaults to true.
+   Set to false to disable password authentication.
+   Set to `only_for_reauth` to allow users with existing passwords to use them
+   to log in and reauthenticate, whilst preventing new users from setting passwords.
 * `localdb_enabled`: Set to false to disable authentication against the local password
    database. This is ignored if `enabled` is false, and is only useful
    if you have other `password_providers`. Defaults to true.