Skip to content

Commit 69ac4b6

Browse files
Bitzoanoadragon453
andauthored
Update config_documentation - Change example of msisdn in allowed_local_3pids (#17476)
Co-authored-by: Andrew Morgan <[email protected]>
1 parent 729026e commit 69ac4b6

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed

changelog.d/17476.doc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
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.

docs/usage/configuration/config_documentation.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2386,7 +2386,7 @@ enable_registration_without_verification: true
23862386
---
23872387
### `registrations_require_3pid`
23882388

2389-
If this is set, users must provide all of the specified types of 3PID when registering an account.
2389+
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.
23902390

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

@@ -2411,6 +2411,9 @@ disable_msisdn_registration: true
24112411

24122412
Mandate that users are only allowed to associate certain formats of
24132413
3PIDs with accounts on this server, as specified by the `medium` and `pattern` sub-options.
2414+
`pattern` is a [Perl-like regular expression](https://docs.python.org/3/library/re.html#module-re).
2415+
2416+
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).
24142417

24152418
Example configuration:
24162419
```yaml
@@ -2420,7 +2423,7 @@ allowed_local_3pids:
24202423
- medium: email
24212424
pattern: '^[^@]+@vector\.im$'
24222425
- medium: msisdn
2423-
pattern: '\+44'
2426+
pattern: '^44\d{10}$'
24242427
```
24252428
---
24262429
### `enable_3pid_lookup`

0 commit comments

Comments
 (0)