Skip to content

Commit

Permalink
Update config_documentation - Change example of msisdn in allowed_loc…
Browse files Browse the repository at this point in the history
…al_3pids (#17476)

Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
  • Loading branch information
Bitzo and anoadragon453 committed Jul 25, 2024
1 parent 729026e commit 69ac4b6
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 2 deletions.
1 change: 1 addition & 0 deletions changelog.d/17476.doc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Update the [`allowed_local_3pids`](https://element-hq.github.io/synapse/v1.112/usage/configuration/config_documentation.html#allowed_local_3pids) config option's msisdn address to a working example.
7 changes: 5 additions & 2 deletions docs/usage/configuration/config_documentation.md
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 @@ -2411,6 +2411,9 @@ 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.
`pattern` is a [Perl-like regular expression](https://docs.python.org/3/library/re.html#module-re).

More information about 3PIDs, allowed `medium` types and their `address` syntax can be found [in the Matrix spec](https://spec.matrix.org/latest/appendices/#3pid-types).

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

0 comments on commit 69ac4b6

Please sign in to comment.