summary refs log tree commit diff
path: root/docs/usage/configuration/config_documentation.md
diff options
context:
space:
mode:
authorMaximilian Bosch <maximilian@mbosch.me>2023-08-21 21:32:17 +0200
committerGitHub <noreply@github.com>2023-08-21 19:32:17 +0000
commitd6ae4041a4c014a8c234f1afccc80867bf5b7df0 (patch)
treecf6c959146ed4bf2cef7d6a6b56e8e719099c27b /docs/usage/configuration/config_documentation.md
parentImplements a task scheduler for resumable potentially long running tasks (#15... (diff)
downloadsynapse-d6ae4041a4c014a8c234f1afccc80867bf5b7df0.tar.xz
Add `client_secret_path` as alternative for `client_secret` for OIDC config (#16030)
Diffstat (limited to 'docs/usage/configuration/config_documentation.md')
-rw-r--r--docs/usage/configuration/config_documentation.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/usage/configuration/config_documentation.md b/docs/usage/configuration/config_documentation.md
index 6601bba9f2..743c51d76a 100644
--- a/docs/usage/configuration/config_documentation.md
+++ b/docs/usage/configuration/config_documentation.md
@@ -3204,6 +3204,14 @@ Options for each entry include:
 
 * `client_secret`: oauth2 client secret to use. May be omitted if
   `client_secret_jwt_key` is given, or if `client_auth_method` is 'none'.
+  Must be omitted if `client_secret_path` is specified.
+
+* `client_secret_path`: path to the oauth2 client secret to use. With that
+   it's not necessary to leak secrets into the config file itself.
+   Mutually exclusive with `client_secret`. Can be omitted if
+   `client_secret_jwt_key` is specified.
+
+   *Added in Synapse 1.91.0.*
 
 * `client_secret_jwt_key`: Alternative to client_secret: details of a key used
    to create a JSON Web Token to be used as an OAuth2 client secret. If