Clarify what registration_shared_secret allows for (#2885) (#4844)

* Clarify what registration_shared_secret allows for (#2885)

Signed-off-by: Aaron Raimist <aaron@raim.ist>

* Add changelog

Signed-off-by: Aaron Raimist <aaron@raim.ist>
This commit is contained in:
Aaron Raimist 2019-03-11 13:21:52 -05:00 committed by Richard van der Hoff
parent 290552fd83
commit 8ea1b41a0e
4 changed files with 7 additions and 6 deletions

View file

@ -402,8 +402,8 @@ This process uses a setting `registration_shared_secret` in
`homeserver.yaml`, which is shared between Synapse itself and the `homeserver.yaml`, which is shared between Synapse itself and the
`register_new_matrix_user` script. It doesn't matter what it is (a random `register_new_matrix_user` script. It doesn't matter what it is (a random
value is generated by `--generate-config`), but it should be kept secret, as value is generated by `--generate-config`), but it should be kept secret, as
anyone with knowledge of it can register users on your server even if anyone with knowledge of it can register users, including admin accounts,
`enable_registration` is `false`. on your server even if `enable_registration` is `false`.
## Setting up a TURN server ## Setting up a TURN server

1
changelog.d/4844.misc Normal file
View file

@ -0,0 +1 @@
Clarify what registration_shared_secret allows for.

View file

@ -624,8 +624,8 @@ enable_registration: False
# - medium: msisdn # - medium: msisdn
# pattern: '\+44' # pattern: '\+44'
# If set, allows registration by anyone who also has the shared # If set, allows registration of standard or admin accounts by anyone who
# secret, even if registration is otherwise disabled. # has the shared secret, even if registration is otherwise disabled.
# #
# registration_shared_secret: <PRIVATE STRING> # registration_shared_secret: <PRIVATE STRING>

View file

@ -92,8 +92,8 @@ class RegistrationConfig(Config):
# - medium: msisdn # - medium: msisdn
# pattern: '\\+44' # pattern: '\\+44'
# If set, allows registration by anyone who also has the shared # If set, allows registration of standard or admin accounts by anyone who
# secret, even if registration is otherwise disabled. # has the shared secret, even if registration is otherwise disabled.
# #
%(registration_shared_secret)s %(registration_shared_secret)s