From bc15db3316c2102d3e52f4491405467f08dd9f11 Mon Sep 17 00:00:00 2001 From: Slavi Pantaleev Date: Fri, 23 Nov 2018 11:00:08 +0200 Subject: [PATCH] Fix a few minor things for consistency Trying to: - stay closer to naming in Synapse (autojoin -> auto_join) - not create new variable namespaces (`matrix_homeserver_`), when existing ones (`matrix_synapse_`) are more suitable - allow `null` (`~`) values for `matrix_riot_web_welcome_user_id` - render things like `auto_join_rooms` in `homeserver.yaml` more prettily - fix breakage in `config.json` where `matrix_riot_web_roomdir_servers` was rendered as YAML and not as JSON - simplify code (especially in riot-web's `config.json`), which used `if` statements that could have been omitted - avoid changing comments in `homeserver.yaml` which are not ours, so that we can keep closer to the configuration file generated by upstream --- roles/matrix-server/defaults/main.yml | 13 ++++++------- .../matrix-server/templates/riot-web/config.json.j2 | 8 ++------ .../templates/synapse/homeserver.yaml.j2 | 10 ++++++---- 3 files changed, 14 insertions(+), 17 deletions(-) diff --git a/roles/matrix-server/defaults/main.yml b/roles/matrix-server/defaults/main.yml index 6d1d5888..080470d8 100644 --- a/roles/matrix-server/defaults/main.yml +++ b/roles/matrix-server/defaults/main.yml @@ -84,9 +84,12 @@ matrix_synapse_report_stats: false # disabling this will decrease server load significantly. matrix_synapse_use_presence: true -# Set autojoin room(s) -# Users who register on this homeserver will automatically be joined to these rooms -matrix_synapse_autojoin_rooms: [] +# Controls whether people with access to the homeserver can register by themselves. +matrix_synapse_enable_registration: false + +# Users who register on this homeserver will automatically be joined to these rooms. +# Rooms are to be specified using addresses (e.g. `#address:example.com`) +matrix_synapse_auto_join_rooms: [] # Controls password-peppering for Matrix Synapse. Not to be changed after initial setup. matrix_synapse_password_config_pepper: "" @@ -146,9 +149,6 @@ matrix_synapse_ext_password_provider_shared_secret_auth_download_url: "https://r matrix_synapse_ext_password_provider_shared_secret_auth_shared_secret: "" -# Enable registration to new users. -matrix_homeserver_enable_registration: false - # The defaults below cause a postgres server to be configured (running within a container). # Using an external server is possible by tweaking all of the parameters below. matrix_postgres_use_external: false @@ -271,7 +271,6 @@ matrix_riot_web_integrations_widgets_urls: "https://scalar.vector.im/api" matrix_riot_web_integrations_jitsi_widget_url: "https://scalar.vector.im/api/widgets/jitsi.html" # Riot public room directory server(s) matrix_riot_web_roomdir_servers: ['matrix.org'] -# Uncomment to enable default riot user bot matrix_riot_web_welcome_user_id: "@riot-bot:matrix.org" diff --git a/roles/matrix-server/templates/riot-web/config.json.j2 b/roles/matrix-server/templates/riot-web/config.json.j2 index 7218271f..6a979912 100644 --- a/roles/matrix-server/templates/riot-web/config.json.j2 +++ b/roles/matrix-server/templates/riot-web/config.json.j2 @@ -11,11 +11,7 @@ "bug_report_endpoint_url": "https://riot.im/bugreports/submit", "enableLabs": true, "roomDirectory": { - "servers": {{ matrix_riot_web_roomdir_servers|to_nice_yaml }} -{% if matrix_riot_web_welcome_user_id %} + "servers": {{ matrix_riot_web_roomdir_servers|to_json }} }, - "welcomeUserId": "{{ matrix_riot_web_welcome_user_id }}" -{% else %} - } -{% endif %} + "welcomeUserId": {{ matrix_riot_web_welcome_user_id|to_json }} } diff --git a/roles/matrix-server/templates/synapse/homeserver.yaml.j2 b/roles/matrix-server/templates/synapse/homeserver.yaml.j2 index 49fa2c96..bc2622f8 100644 --- a/roles/matrix-server/templates/synapse/homeserver.yaml.j2 +++ b/roles/matrix-server/templates/synapse/homeserver.yaml.j2 @@ -432,7 +432,7 @@ turn_allow_guests: False ## Registration ## # Enable registration for new users. -enable_registration: {{ matrix_homeserver_enable_registration|capitalize }} +enable_registration: {{ matrix_synapse_enable_registration }} # The user must provide all of the below types of 3PID when registering. # @@ -474,11 +474,13 @@ trusted_third_party_id_servers: - {{ server }} {% endfor %} -# Users who register on this homeserver will automatically be joined to these rooms -{% if matrix_synapse_autojoin_rooms|length >0 %} +# Users who register on this homeserver will automatically be joined +# to these rooms #auto_join_rooms: # - "#example:example.com" -auto_join_rooms: {{ matrix_synapse_autojoin_rooms|to_yaml }} +{% if matrix_synapse_auto_join_rooms|length > 0 %} +auto_join_rooms: +{{ matrix_synapse_auto_join_rooms|to_nice_yaml }} {% endif %} ## Metrics ###