summary refs log tree commit diff
path: root/develop/usage
diff options
context:
space:
mode:
authorDMRobertson <DMRobertson@users.noreply.github.com>2022-07-12 18:19:38 +0000
committerDMRobertson <DMRobertson@users.noreply.github.com>2022-07-12 18:19:38 +0000
commitb498de323ca8fbffa4a59116f8b2a218dc9b6deb (patch)
tree4bf9b515c1195dc812e0e1293edfc6504471dd51 /develop/usage
parentdeploy: 6f30eb5b8e3d88d1b44cc7f9d7e548b30081d7e6 (diff)
downloadsynapse-b498de323ca8fbffa4a59116f8b2a218dc9b6deb.tar.xz
deploy: fa71bb18b527d1a3e2629b48640ea67fff2f8c59
Diffstat (limited to 'develop/usage')
-rw-r--r--develop/usage/configuration/config_documentation.html28
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 />