Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Commit

Permalink
Mention captchas; discourage open registration
Browse files Browse the repository at this point in the history
  • Loading branch information
David Robertson committed Aug 17, 2022
1 parent 2ce408e commit 77f6b88
Showing 1 changed file with 13 additions and 5 deletions.
18 changes: 13 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -133,12 +133,20 @@ Registering a new user from a client
------------------------------------

By default, registration of new users via Matrix clients is disabled. To enable
it, specify ``enable_registration: true`` in ``homeserver.yaml``. (It is then
recommended to also `set up a CAPTCHA
<https://matrix-org.github.io/synapse/latest/CAPTCHA_SETUP.html>`_.)
it:

Once ``enable_registration`` is set to ``true``, it is possible to register a
user via a Matrix client.
1. In the
`registration config section <https://matrix-org.github.io/synapse/latest/usage/configuration/config_documentation.html#registration>`_
set ``enable_registration: true`` in ``homeserver.yaml``.

2. Then **either**:
a. set up a `CAPTCHA <https://matrix-org.github.io/synapse/latest/CAPTCHA_SETUP.html>`_, or
b. set ``enable_registration_without_verification: true`` in ``homeserver.yaml``.

We **strongly** recommend using a CAPTCHA, particularly if your homeserver is exposed to
the public internet. Without it, anyone can freely register accounts on your homeserver.
This can be exploited by attackers to create spambots targetting the rest of the Matrix
federation.

Your new user name will be formed partly from the ``server_name``, and partly
from a localpart you specify when you create the account. Your name will take
Expand Down

0 comments on commit 77f6b88

Please sign in to comment.