diff options
| author | Patrick Cloke <clokep@users.noreply.github.com> | 2020-07-06 08:31:51 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-07-06 08:31:51 -0400 |
| commit | 2a266f451132da3888ef8cd62dc966735a38a7ff (patch) | |
| tree | 3f39e2b820e1ecdcfc36f86b461bdbeba496bed9 /docs/sample_config.yaml | |
| parent | Convert the appservice handler to async/await. (#7775) (diff) | |
| download | synapse-2a266f451132da3888ef8cd62dc966735a38a7ff.tar.xz | |
Add documentation for JWT login type and improve sample config. (#7776)
Diffstat (limited to 'docs/sample_config.yaml')
| -rw-r--r-- | docs/sample_config.yaml | 35 |
1 files changed, 31 insertions, 4 deletions
diff --git a/docs/sample_config.yaml b/docs/sample_config.yaml index 2d27b0b34d..164a104045 100644 --- a/docs/sample_config.yaml +++ b/docs/sample_config.yaml @@ -1804,12 +1804,39 @@ sso: #template_dir: "res/templates" -# The JWT needs to contain a globally unique "sub" (subject) claim. +# JSON web token integration. The following settings can be used to make +# Synapse JSON web tokens for authentication, instead of its internal +# password database. +# +# Each JSON Web Token needs to contain a "sub" (subject) claim, which is +# used as the localpart of the mxid. +# +# Note that this is a non-standard login type and client support is +# expected to be non-existant. +# +# See https://github.com/matrix-org/synapse/blob/master/docs/jwt.md. # #jwt_config: -# enabled: true -# secret: "a secret" -# algorithm: "HS256" + # Uncomment the following to enable authorization using JSON web + # tokens. Defaults to false. + # + #enabled: true + + # This is either the private shared secret or the public key used to + # decode the contents of the JSON web token. + # + # Required if 'enabled' is true. + # + #secret: "provided-by-your-issuer" + + # The algorithm used to sign the JSON web token. + # + # Supported algorithms are listed at + # https://pyjwt.readthedocs.io/en/latest/algorithms.html + # + # Required if 'enabled' is true. + # + #algorithm: "provided-by-your-issuer" password_config: |