Skip to content

Update config_documentation - Change example of msisdn in allowed_local_3pids #17476

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jul 25, 2024
Merged

Update config_documentation - Change example of msisdn in allowed_local_3pids #17476

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
24d1105
Update config_documentation.md
Bitzo Jul 24, 2024
ef6fb6b
Create changelog
Bitzo Jul 24, 2024
4e66cff
link 3pid spec to config doc
Bitzo Jul 25, 2024
8e8b554
Merge branch 'develop' into config_3pid_doc
Bitzo Jul 25, 2024
cdb9289
small wording changes, document `pattern` syntax
anoadragon453 Jul 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelog.d/17476.doc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Change the example configuration of msisdn in allowed_local_3pids, which is a bit misleading that regex pattern has leading '+'.
6 changes: 4 additions & 2 deletions docs/usage/configuration/config_documentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2386,7 +2386,7 @@ enable_registration_without_verification: true
---
### `registrations_require_3pid`

If this is set, users must provide all of the specified types of 3PID when registering an account.
If this is set, users must provide all of the specified types of [3PID](https://spec.matrix.org/latest/appendices/#3pid-types) when registering an account.

Note that [`enable_registration`](#enable_registration) must also be set to allow account registration.

Expand All @@ -2412,6 +2412,8 @@ disable_msisdn_registration: true
Mandate that users are only allowed to associate certain formats of
3PIDs with accounts on this server, as specified by the `medium` and `pattern` sub-options.

You can get more information about 3PID and the expected types of `medium` [here](https://spec.matrix.org/latest/appendices/#3pid-types).

Example configuration:
```yaml
allowed_local_3pids:
Expand All @@ -2420,7 +2422,7 @@ allowed_local_3pids:
- medium: email
pattern: '^[^@]+@vector\.im$'
- medium: msisdn
pattern: '\+44'
pattern: '^44\d{10}$'
```
---
### `enable_3pid_lookup`
Expand Down