diff options
Diffstat (limited to 'develop/usage')
| -rw-r--r-- | develop/usage/configuration/config_documentation.html | 28 |
1 files changed, 12 insertions, 16 deletions
diff --git a/develop/usage/configuration/config_documentation.html b/develop/usage/configuration/config_documentation.html index a2abcd329c..28c6384a95 100644 --- a/develop/usage/configuration/config_documentation.html +++ b/develop/usage/configuration/config_documentation.html @@ -1914,24 +1914,20 @@ This setting is ignored unless <code>public_baseurl</code> is also explicitly se </code></pre> <hr /> <h3 id="account_threepid_delegates"><a class="header" href="#account_threepid_delegates"><code>account_threepid_delegates</code></a></h3> -<p>Handle threepid (email/phone etc) registration and password resets through a set of -<em>trusted</em> identity servers. Note that this allows the configured identity server to -reset passwords for accounts!</p> -<p>Be aware that if <code>email</code> is not set, and SMTP options have not been -configured in the email config block, registration and user password resets via -email will be globally disabled.</p> -<p>Additionally, if <code>msisdn</code> is not set, registration and password resets via msisdn -will be disabled regardless, and users will not be able to associate an msisdn -identifier to their account. This is due to Synapse currently not supporting -any method of sending SMS messages on its own.</p> -<p>To enable using an identity server for operations regarding a particular third-party -identifier type, set the value to the URL of that identity server as shown in the -examples below.</p> -<p>Servers handling the these requests must answer the <code>/requestToken</code> endpoints defined -by the Matrix Identity Service API <a href="https://matrix.org/docs/spec/identity_service/latest">specification</a>.</p> +<p>Delegate verification of phone numbers to an identity server.</p> +<p>When a user wishes to add a phone number to their account, we need to verify that they +actually own that phone number, which requires sending them a text message (SMS). +Currently Synapse does not support sending those texts itself and instead delegates the +task to an identity server. The base URI for the identity server to be used is +specified by the <code>account_threepid_delegates.msisdn</code> option.</p> +<p>If this is left unspecified, Synapse will not allow users to add phone numbers to +their account.</p> +<p>(Servers handling the these requests must answer the <code>/requestToken</code> endpoints defined +by the Matrix Identity Service API +<a href="https://matrix.org/docs/spec/identity_service/latest">specification</a>.)</p> +<p><em>Updated in Synapse 1.64.0</em>: No longer accepts an <code>email</code> option.</p> <p>Example configuration:</p> <pre><code class="language-yaml">account_threepid_delegates: - email: https://example.com # Delegate email sending to example.com msisdn: http://localhost:8090 # Delegate SMS sending to this local process </code></pre> <hr /> |