2019-01-17 00:05:48 +08:00
---
- name : Fail if required Synapse settings not defined
2022-07-18 15:39:08 +08:00
ansible.builtin.fail :
2019-05-21 09:46:49 +08:00
msg : >-
2019-01-17 00:05:48 +08:00
You need to define a required configuration setting (`{{ item }}`) for using Synapse.
when : "vars[item] == ''"
with_items :
2019-02-05 17:07:08 +08:00
- "matrix_synapse_macaroon_secret_key"
2021-01-22 18:23:00 +08:00
- "matrix_synapse_database_host"
- "matrix_synapse_database_user"
- "matrix_synapse_database_password"
- "matrix_synapse_database_database"
2019-02-05 17:07:08 +08:00
2021-02-15 17:25:35 +08:00
- name : Fail if asking for more than 1 instance of single-instance workers
2022-07-18 15:39:08 +08:00
ansible.builtin.fail :
2021-02-15 17:25:35 +08:00
msg : >-
`{{ item }}` cannot be more than 1. This is a single-instance worker.
2022-09-18 17:21:09 +08:00
when : "vars[item] | int > 1"
2021-02-15 17:25:35 +08:00
with_items :
2022-09-15 15:00:57 +08:00
- "matrix_synapse_workers_appservice_workers_count"
- "matrix_synapse_workers_user_dir_workers_count"
2022-09-15 15:32:51 +08:00
- "matrix_synapse_workers_background_workers_count"
2022-09-15 12:05:25 +08:00
- "matrix_synapse_workers_stream_writer_typing_stream_workers_count"
- "matrix_synapse_workers_stream_writer_to_device_stream_workers_count"
- "matrix_synapse_workers_stream_writer_account_data_stream_workers_count"
- "matrix_synapse_workers_stream_writer_receipts_stream_workers_count"
- "matrix_synapse_workers_stream_writer_presence_stream_workers_count"
2021-02-15 17:25:35 +08:00
2019-02-05 17:07:08 +08:00
- name : (Deprecation) Catch and report renamed settings
2022-07-18 15:39:08 +08:00
ansible.builtin.fail :
2019-02-28 17:51:09 +08:00
msg : >-
2019-02-05 17:07:08 +08:00
Your configuration contains a variable, which now has a different name.
Please change your configuration to rename the variable (`{{ item.old }}` -> `{{ item.new }}`).
when : "item.old in vars"
with_items :
2020-01-23 21:47:53 +08:00
- {'old': 'matrix_synapse_email_riot_base_url', 'new' : '<superseded by client_base_url>' }
2019-05-25 06:41:04 +08:00
- {'old': 'matrix_synapse_container_expose_api_port', 'new' : '<superseded by matrix_synapse_container_federation_api_plain_host_bind_port>' }
2019-02-15 00:40:55 +08:00
- {'old': 'matrix_synapse_no_tls', 'new' : '<removed>' }
2019-05-21 11:09:38 +08:00
- {'old': 'matrix_enable_room_list_search', 'new' : 'matrix_synapse_enable_room_list_search' }
- {'old': 'matrix_alias_creation_rules', 'new' : 'matrix_synapse_alias_creation_rules' }
- {'old': 'matrix_room_list_publication_rules', 'new' : 'matrix_synapse_room_list_publication_rules' }
2019-05-23 08:23:04 +08:00
- {'old': 'matrix_synapse_rc_messages_per_second', 'new' : '<per_second subkey of matrix_synapse_rc_message>' }
- {'old': 'matrix_synapse_rc_message_burst_count', 'new' : '<burst_count subkey of matrix_synapse_rc_message>' }
- {'old': 'matrix_synapse_federation_rc_window_size', 'new' : '<window_size subkey of matrix_synapse_rc_federation>' }
- {'old': 'matrix_synapse_federation_rc_sleep_limit', 'new' : '<sleep_limit subkey of matrix_synapse_rc_federation>' }
- {'old': 'matrix_synapse_federation_rc_sleep_delay', 'new' : '<sleep_delay subkey of matrix_synapse_rc_federation>' }
- {'old': 'matrix_synapse_federation_rc_reject_limit', 'new' : '<reject_limit subkey of matrix_synapse_rc_federation>' }
- {'old': 'matrix_synapse_federation_rc_concurrent', 'new' : '<concurrent subkey of matrix_synapse_rc_federation>' }
2019-05-25 06:41:04 +08:00
- {'old': 'matrix_synapse_container_expose_client_api_port', 'new' : '<superseded by matrix_synapse_container_client_api_host_bind_port>' }
- {'old': 'matrix_synapse_container_expose_federation_api_port', 'new' : '<superseded by matrix_synapse_container_federation_api_plain_host_bind_port>' }
- {'old': 'matrix_synapse_container_expose_metrics_port', 'new' : '<superseded by matrix_synapse_container_metrics_api_host_bind_port>' }
2020-05-28 20:23:05 +08:00
- {'old': 'matrix_synapse_cache_factor', 'new' : 'matrix_synapse_caches_global_factor' }
2020-08-17 22:02:40 +08:00
- {'old': 'matrix_synapse_trusted_third_party_id_servers', 'new' : '<deprecated in Synapse v0.99.4 and removed in Synapse v1.19.0>' }
2021-04-22 19:22:07 +08:00
- {'old': 'matrix_synapse_use_presence', 'new' : 'matrix_synapse_presence_enabled' }
2022-02-08 21:13:41 +08:00
- {'old': 'matrix_synapse_version_arm64', 'new' : '<superseded by matrix_synapse_version - see https://github.com/matrix-org/synapse/pull/11810>' }
2022-06-17 20:25:49 +08:00
- {'old': 'matrix_synapse_enable_group_creation', 'new' : '<removed in Synapse v1.61.0 - use the new Spaces feature instead>' }
2022-08-30 23:50:44 +08:00
- {'old': 'matrix_synapse_account_threepid_delegates_email', 'new' : '<removed in Synapse v1.66.0 - make sure to configure email settings for Synapse - see https://matrix-org.github.io/synapse/v1.66/upgrade.html#delegation-of-email-validation-no-longer-supported>' }
2022-09-13 20:45:08 +08:00
- {'old': 'matrix_synapse_workers_frontend_proxy_workers_count', 'new' : '<removed in favor of generic workers - see https://github.com/matrix-org/synapse/pull/13645>' }
- {'old': 'matrix_synapse_workers_frontend_proxy_workers_port_range_start', 'new' : '<removed in favor of generic workers - see https://github.com/matrix-org/synapse/pull/13645>' }
- {'old': 'matrix_synapse_workers_frontend_proxy_workers_metrics_range_start', 'new' : '<removed in favor of generic workers - see https://github.com/matrix-org/synapse/pull/13645>' }
2021-01-13 19:47:51 +08:00
- name : (Deprecation) Catch and report renamed settings in matrix_synapse_configuration_extension_yaml
2022-07-18 15:39:08 +08:00
ansible.builtin.fail :
2021-01-13 19:47:51 +08:00
msg : >-
Your matrix_synapse_configuration_extension_yaml configuration contains a variable, which now has a different name.
Please change your configuration to rename the variable (`{{ item.old }}` -> `{{ item.new }}`).
when : "item.old in matrix_synapse_configuration_extension"
with_items :
- {'old': 'federation_ip_range_blacklist', 'new' : 'ip_range_blacklist' }
