1
0
mirror of https://github.com/matrix-org/matrix-authentication-service.git synced 2025-08-06 06:02:40 +03:00

Add missing documentation for some configuration parameters

This commit is contained in:
Quentin Gliech
2024-04-30 13:53:24 +02:00
parent 603de2b620
commit e2cfa23401

View File

@@ -255,10 +255,18 @@ Policy settings
```yaml ```yaml
policy: policy:
data: data:
# Users which are allowed to ask for admin access. If possible, use the
# can_request_admin flag on users instead.
admin_users: admin_users:
- person1 - person1
- person2 - person2
# Client IDs which are allowed to ask for admin access with a
# client_credentials grant
admin_clients:
- 01H8PKNWKKRPCBW4YGH1RWV279
- 01HWQCPA5KF10FNCETY9402WGF
# Dynamic Client Registration # Dynamic Client Registration
client_registration: client_registration:
# don't require URIs to be on the same host. default: false # don't require URIs to be on the same host. default: false
@@ -268,7 +276,7 @@ policy:
# Registration using passwords # Registration using passwords
passwords: passwords:
# minimum length of a password. default: ? # minimum length of a password. default: 0
min_length: 8 min_length: 8
# require at least one lowercase character in a password. default: false # require at least one lowercase character in a password. default: false
require_lowercase: true require_lowercase: true
@@ -486,3 +494,29 @@ upstream_oauth2:
# - `never`: mark the email address as not verified # - `never`: mark the email address as not verified
#set_email_verification: import #set_email_verification: import
``` ```
## `experimental`
Settings that may change or be removed in future versions.
Some of those settings are in this section just because they don't have a stable place in the configuration yet.
```yaml
experimental:
# Time-to-live of OAuth 2.0 access tokens in seconds. Defaults to 300, 5 minutes.
#access_token_ttl: 300
# Time-to-live of compatibility access tokens in seconds, when refresh tokens are supported. Defaults to 300, 5 minutes.
#compat_token_ttl: 300
# Whether to enable self-service password registration. Defaults to `true` if password authentication is enabled.
#password_registration_enabled: false
# Whether users are allowed to change their email addresses. Defaults to `true`.
#email_change_allowed: false
# Whether users are allowed to change their display names. Defaults to `true`.
#displayname_change_allowed: false
# Whether users are allowed to change their passwords. Defaults to `true`.
#password_change_allowed: false
```