diff options
author | Erik Johnston <erik@matrix.org> | 2019-04-05 14:10:16 +0100 |
---|---|---|
committer | Erik Johnston <erik@matrix.org> | 2019-04-05 14:10:16 +0100 |
commit | 9bf49abc07882766972e28a76c5a068de0ebd0a9 (patch) | |
tree | 64fab2db39db7846b8968bde53ecd8159c2c9d0d /docs | |
parent | Prevent exception when hs or shadow_hs missing (#5012) (diff) | |
parent | 0.99.3 (diff) | |
download | synapse-9bf49abc07882766972e28a76c5a068de0ebd0a9.tar.xz |
Merge branch 'master' of github.com:matrix-org/synapse into dinsic
Diffstat (limited to 'docs')
-rw-r--r-- | docs/ACME.md | 2 | ||||
-rw-r--r-- | docs/password_auth_providers.rst | 14 | ||||
-rw-r--r-- | docs/reverse_proxy.rst | 14 |
3 files changed, 20 insertions, 10 deletions
diff --git a/docs/ACME.md b/docs/ACME.md index 46136a9f2c..9eb18a9cf5 100644 --- a/docs/ACME.md +++ b/docs/ACME.md @@ -67,7 +67,7 @@ For nginx users, add the following line to your existing `server` block: ``` location /.well-known/acme-challenge { - proxy_pass http://localhost:8009/; + proxy_pass http://localhost:8009; } ``` diff --git a/docs/password_auth_providers.rst b/docs/password_auth_providers.rst index d8a7b61cdc..6149ba7458 100644 --- a/docs/password_auth_providers.rst +++ b/docs/password_auth_providers.rst @@ -75,6 +75,20 @@ Password auth provider classes may optionally provide the following methods. result from the ``/login`` call (including ``access_token``, ``device_id``, etc.) +``someprovider.check_3pid_auth``\(*medium*, *address*, *password*) + + This method, if implemented, is called when a user attempts to register or + log in with a third party identifier, such as email. It is passed the + medium (ex. "email"), an address (ex. "jdoe@example.com") and the user's + password. + + The method should return a Twisted ``Deferred`` object, which resolves to + a ``str`` containing the user's (canonical) User ID if authentication was + successful, and ``None`` if not. + + As with ``check_auth``, the ``Deferred`` may alternatively resolve to a + ``(user_id, callback)`` tuple. + ``someprovider.check_password``\(*user_id*, *password*) This method provides a simpler interface than ``get_supported_login_types`` diff --git a/docs/reverse_proxy.rst b/docs/reverse_proxy.rst index 8e26c50f1b..cc81ceb84b 100644 --- a/docs/reverse_proxy.rst +++ b/docs/reverse_proxy.rst @@ -69,20 +69,16 @@ Let's assume that we expect clients to connect to our server at SSLEngine on ServerName matrix.example.com; - <Location /_matrix> - ProxyPass http://127.0.0.1:8008/_matrix nocanon - ProxyPassReverse http://127.0.0.1:8008/_matrix - </Location> + ProxyPass /_matrix http://127.0.0.1:8008/_matrix nocanon + ProxyPassReverse /_matrix http://127.0.0.1:8008/_matrix </VirtualHost> <VirtualHost *:8448> SSLEngine on ServerName example.com; - - <Location /_matrix> - ProxyPass http://127.0.0.1:8008/_matrix nocanon - ProxyPassReverse http://127.0.0.1:8008/_matrix - </Location> + + ProxyPass /_matrix http://127.0.0.1:8008/_matrix nocanon + ProxyPassReverse /_matrix http://127.0.0.1:8008/_matrix </VirtualHost> * HAProxy:: |