Skip to content
This repository has been archived by the owner on Sep 10, 2024. It is now read-only.

Commit

Permalink
Document the new account-management options
Browse files Browse the repository at this point in the history
  • Loading branch information
sandhose committed Aug 1, 2024
1 parent 8b3451d commit b261ac0
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 0 deletions.
36 changes: 36 additions & 0 deletions docs/reference/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -259,6 +259,42 @@ passwords:
algorithm: argon2id
```

## `account`

Configuration related to account management

```yaml
account:
# Whether users are allowed to change their email addresses.
#
# Defaults to `true`.
email_change_allowed: true

# Whether users are allowed to change their display names
#
# Defaults to `true`.
# This should be in sync with the policy in the homeserver configuration.
displayname_change_allowed: true

# Whether to enable self-service password registration
#
# Defaults to `false`.
# This has no effect if password login is disabled.
password_registration_enabled: false

# Whether users are allowed to change their passwords
#
# Defaults to `true`.
# This has no effect if password login is disabled.
password_change_allowed: true

# Whether email-based password recovery is enabled
#
# Defaults to `false`.
# This has no effect if password login is disabled.
password_recovery_enabled: false
```
## `captcha`

Settings related to CAPTCHA protection
Expand Down
1 change: 1 addition & 0 deletions docs/setup/running.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ A few configuration sections might still require some tweaking, including:
- [`telemetry`](../reference/configuration.md#telemetry): to setup metrics, tracing and Sentry crash reporting
- [`email`](../reference/configuration.md#email): to setup email sending
- [`password`](../reference/configuration.md#password): to enable/disable password authentication
- [`account`](../reference/configuration.md#account): to configure what account management features are enabled
- [`upstream_oauth`](../reference/configuration.md#upstream-oauth): to configure upstream OAuth providers


Expand Down

0 comments on commit b261ac0

Please sign in to comment.