overmind
/
matrix-docker-ansible-deploy
mirror of https://github.com/spantaleev/matrix-docker-ansible-deploy
1
0
Fork 0
Code Issues 0 Releases 0 Wiki Activity
Matrix Docker Ansible eploy
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
7734 Commits
13 Branches
36 MiB
 
 
Tree: 09d9db5617
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '09d9db5617'
${ noResults }
matrix-docker-ansible-deploy/roles/custom/matrix-synapse/tasks/validate_config.yml

136 lines
11 KiB
Raw Blame History 

  1. ---

  2. 

  3. - name: Fail if required Synapse settings not defined

  4.   ansible.builtin.fail:

  5.     msg: >-

  6.       You need to define a required configuration setting (`{{ item.name }}`).

  7.   when: "item.when | bool and vars[item.name] == ''"

  8.   with_items:

  9.     - {'name': 'matrix_synapse_username', when: true}

  10.     - {'name': 'matrix_synapse_uid', when: true}

  11.     - {'name': 'matrix_synapse_gid', when: true}

  12.     - {'name': 'matrix_synapse_container_network', when: true}

  13.     - {'name': 'matrix_synapse_macaroon_secret_key', when: true}

  14.     - {'name': 'matrix_synapse_database_host', when: true}

  15.     - {'name': 'matrix_synapse_database_user', when: true}

  16.     - {'name': 'matrix_synapse_database_password', when: true}

  17.     - {'name': 'matrix_synapse_database_database', when: true}

  18. 

  19.     - {'name': 'matrix_synapse_container_labels_public_client_root_traefik_hostname', when: "{{ matrix_synapse_container_labels_public_client_root_enabled }}"}

  20.     - {'name': 'matrix_synapse_container_labels_public_client_root_redirection_url', when: "{{ matrix_synapse_container_labels_public_client_root_redirection_enabled }}"}

  21. 

  22.     - {'name': 'matrix_synapse_container_labels_public_client_api_traefik_hostname', when: "{{ matrix_synapse_container_labels_public_client_api_enabled }}"}

  23. 

  24.     - {'name': 'matrix_synapse_container_labels_internal_client_api_traefik_entrypoints', when: "{{ matrix_synapse_container_labels_internal_client_api_enabled }}"}

  25. 

  26.     - {'name': 'matrix_synapse_container_labels_public_client_synapse_client_api_traefik_hostname', when: "{{ matrix_synapse_container_labels_public_client_synapse_client_api_enabled }}"}

  27.     - {'name': 'matrix_synapse_container_labels_public_client_synapse_admin_api_traefik_hostname', when: "{{ matrix_synapse_container_labels_public_client_synapse_admin_api_enabled }}"}

  28. 

  29.     - {'name': 'matrix_synapse_container_labels_public_federation_api_traefik_hostname', when: "{{ matrix_synapse_container_labels_public_federation_api_enabled }}"}

  30.     - {'name': 'matrix_synapse_container_labels_public_federation_api_traefik_entrypoints', when: "{{ matrix_synapse_container_labels_public_federation_api_enabled }}"}

  31. 

  32.     - {'name': 'matrix_synapse_metrics_proxying_hostname', when: "{{ matrix_synapse_metrics_proxying_enabled }}"}

  33.     - {'name': 'matrix_synapse_metrics_proxying_path_prefix', when: "{{ matrix_synapse_metrics_proxying_enabled }}"}

  34. 

  35. - name: Fail if asking for more than 1 instance of single-instance workers

  36.   ansible.builtin.fail:

  37.     msg: >-

  38.       `{{ item }}` cannot be more than 1. This is a single-instance worker.

  39.   when: "vars[item] | int > 1"

  40.   with_items:

  41.     - "matrix_synapse_workers_appservice_workers_count"

  42.     - "matrix_synapse_workers_user_dir_workers_count"

  43.     - "matrix_synapse_workers_background_workers_count"

  44.     - "matrix_synapse_workers_stream_writer_typing_stream_workers_count"

  45.     - "matrix_synapse_workers_stream_writer_to_device_stream_workers_count"

  46.     - "matrix_synapse_workers_stream_writer_account_data_stream_workers_count"

  47.     - "matrix_synapse_workers_stream_writer_receipts_stream_workers_count"

  48.     - "matrix_synapse_workers_stream_writer_presence_stream_workers_count"

  49. 

  50. - name: Fail when mixing generic workers with new specialized workers

  51.   ansible.builtin.fail:

  52.     msg: >-

  53.       Generic workers should not be mixed with the new specialized worker types (room workers, sync workers, client readers, and federation readers)

  54.   when: matrix_synapse_workers_generic_workers_count | int > 0 and ((matrix_synapse_workers_room_workers_count | int + matrix_synapse_workers_sync_workers_count | int + matrix_synapse_workers_client_reader_workers_count | int + matrix_synapse_workers_federation_reader_workers_count | int) > 0)

  55. 

  56. - name: (Deprecation) Catch and report renamed settings

  57.   ansible.builtin.fail:

  58.     msg: >-

  59.       Your configuration contains a variable, which now has a different name.

  60.       Please change your configuration to rename the variable (`{{ item.old }}` -> `{{ item.new }}`).

  61.   when: "item.old in vars"

  62.   with_items:

  63.     - {'old': 'matrix_synapse_email_riot_base_url', 'new': '<superseded by client_base_url>'}

  64.     - {'old': 'matrix_synapse_container_expose_api_port', 'new': '<superseded by matrix_synapse_container_federation_api_plain_host_bind_port>'}

  65.     - {'old': 'matrix_synapse_no_tls', 'new': '<removed>'}

  66.     - {'old': 'matrix_enable_room_list_search', 'new': 'matrix_synapse_enable_room_list_search'}

  67.     - {'old': 'matrix_alias_creation_rules', 'new': 'matrix_synapse_alias_creation_rules'}

  68.     - {'old': 'matrix_room_list_publication_rules', 'new': 'matrix_synapse_room_list_publication_rules'}

  69.     - {'old': 'matrix_synapse_rc_messages_per_second', 'new': '<per_second subkey of matrix_synapse_rc_message>'}

  70.     - {'old': 'matrix_synapse_rc_message_burst_count', 'new': '<burst_count subkey of matrix_synapse_rc_message>'}

  71.     - {'old': 'matrix_synapse_federation_rc_window_size', 'new': '<window_size subkey of matrix_synapse_rc_federation>'}

  72.     - {'old': 'matrix_synapse_federation_rc_sleep_limit', 'new': '<sleep_limit subkey of matrix_synapse_rc_federation>'}

  73.     - {'old': 'matrix_synapse_federation_rc_sleep_delay', 'new': '<sleep_delay subkey of matrix_synapse_rc_federation>'}

  74.     - {'old': 'matrix_synapse_federation_rc_reject_limit', 'new': '<reject_limit subkey of matrix_synapse_rc_federation>'}

  75.     - {'old': 'matrix_synapse_federation_rc_concurrent', 'new': '<concurrent subkey of matrix_synapse_rc_federation>'}

  76.     - {'old': 'matrix_synapse_container_expose_client_api_port', 'new': '<superseded by matrix_synapse_container_client_api_host_bind_port>'}

  77.     - {'old': 'matrix_synapse_container_expose_federation_api_port', 'new': '<superseded by matrix_synapse_container_federation_api_plain_host_bind_port>'}

  78.     - {'old': 'matrix_synapse_container_expose_metrics_port', 'new': '<superseded by matrix_synapse_container_metrics_api_host_bind_port>'}

  79.     - {'old': 'matrix_synapse_cache_factor', 'new': 'matrix_synapse_caches_global_factor'}

  80.     - {'old': 'matrix_synapse_trusted_third_party_id_servers', 'new': '<deprecated in Synapse v0.99.4 and removed in Synapse v1.19.0>'}

  81.     - {'old': 'matrix_synapse_use_presence', 'new': 'matrix_synapse_presence_enabled'}

  82.     - {'old': 'matrix_synapse_version_arm64', 'new': '<superseded by matrix_synapse_version - see https://github.com/matrix-org/synapse/pull/11810>'}

  83.     - {'old': 'matrix_synapse_enable_group_creation', 'new': '<removed in Synapse v1.61.0 - use the new Spaces feature instead>'}

  84.     - {'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>'}

  85.     - {'old': 'matrix_synapse_workers_frontend_proxy_workers_count', 'new': '<removed in favor of generic workers - see https://github.com/matrix-org/synapse/pull/13645>'}

  86.     - {'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>'}

  87.     - {'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>'}

  88.     - {'old': 'matrix_synapse_ext_s3_storage_provider_path', 'new': 'matrix_synapse_ext_s3_storage_provider_base_path'}

  89.     - {'old': 'matrix_synapse_send_federation', 'new': '<unnecessary - Synapse relies on federation_sender_instances now>'}

  90.     - {'old': 'matrix_synapse_start_pushers', 'new': '<unnecessary - Synapse relies on pusher_instances now>'}

  91.     - {'old': 'matrix_synapse_spam_checker', 'new': '<superseded by matrix_synapse_modules>'}

  92.     - {'old': 'matrix_synapse_caches_autotuning_max_cache_memory_usage', 'new': 'matrix_synapse_cache_autotuning_max_cache_memory_usage'}

  93.     - {'old': 'matrix_synapse_caches_autotuning_target_cache_memory_usage', 'new': 'matrix_synapse_cache_autotuning_target_cache_memory_usage'}

  94.     - {'old': 'matrix_synapse_caches_autotuning_min_cache_ttl', 'new': 'matrix_synapse_cache_autotuning_min_cache_ttl'}

  95.     - {'old': 'matrix_synapse_memtotal_kb', 'new': '<superseded by matrix_synapse_cache_size_calculations_memtotal_bytes>'}

  96. 

  97. - name: (Deprecation) Catch and report renamed settings in matrix_synapse_configuration_extension_yaml

  98.   ansible.builtin.fail:

  99.     msg: >-

  100.       Your matrix_synapse_configuration_extension_yaml configuration contains a variable, which now has a different name.

  101.       Please change your configuration to rename the variable (`{{ item.old }}` -> `{{ item.new }}`).

  102.   when: "item.old in matrix_synapse_configuration_extension"

  103.   with_items:

  104.     - {'old': 'federation_ip_range_blacklist', 'new': 'ip_range_blacklist'}

  105. 

  106. - when: matrix_synapse_container_image_customizations_templates_enabled | bool

  107.   block:

  108.     - name: Fail if required `matrix_synapse_container_image_customizations_templates_*` settings not defined

  109.       ansible.builtin.fail:

  110.         msg: >-

  111.           You need to define a required configuration setting (`{{ item }}`) when enabling `matrix_synapse_container_image_customizations_templates_enabled`.

  112.       when: "vars[item] == ''"

  113.       with_items:

  114.         - matrix_synapse_container_image_customizations_templates_git_repository_url

  115.         - matrix_synapse_container_image_customizations_templates_git_repository_branch

  116. 

  117.     - name: Fail if required `matrix_synapse_container_image_customizations_templates_git_repository_keyscan_*` settings not defined

  118.       ansible.builtin.fail:

  119.         msg: >-

  120.           You need to define a required configuration setting (`{{ item }}`) when enabling `matrix_synapse_container_image_customizations_templates_git_repository_keyscan`.

  121.       when: "matrix_synapse_container_image_customizations_templates_git_repository_keyscan_enabled | bool and vars[item] == ''"

  122.       with_items:

  123.         - matrix_synapse_container_image_customizations_templates_git_repository_keyscan_hostname

  124. 

  125. 

  126. - name: Fail when auto-accept-invite enabled as a native feature and a module at the same time

  127.   ansible.builtin.fail:

  128.     msg: >-

  129.       Your configuration enables the auto-accept invites feature both as a native Synapse feature (`matrix_synapse_auto_accept_invites_enabled`) and a 3rd party module (`matrix_synapse_ext_synapse_auto_accept_invite_enabled`).

  130.       This is unnecessary, since they both do the same and the native feature is built on top of the 3rd party module anyway.

  131.       Enabling both at the same time will lead to issues.

  132.       We recommend leaving `matrix_synapse_auto_accept_invites_enabled` in your configuration and removing `matrix_synapse_ext_synapse_auto_accept_invite_enabled`.

  133.   when:

  134.     - matrix_synapse_auto_accept_invites_enabled

  135.     - matrix_synapse_ext_synapse_auto_accept_invite_enabled