overmind
/
matrix-docker-ansible-deploy
mirror da https://github.com/spantaleev/matrix-docker-ansible-deploy
1
0
Forka 0
Codice Problemi 0 Rilasci 0 Wiki Attività
Matrix Docker Ansible eploy
Non puoi selezionare più di 25 argomenti Gli argomenti devono iniziare con una lettera o un numero, possono includere trattini ('-') e possono essere lunghi fino a 35 caratteri.
10260 Commit
13 Rami (Branch)
509 MiB
 
 
Albero (Tree): cbbf20004c
Rami (Branch) Tag
${ item.name }
Crea branch ${ searchTerm }
da 'cbbf20004c'
${ noResults }
matrix-docker-ansible-deploy/roles/custom/matrix-synapse/tasks/validate_config.yml

182 righe
15 KiB
Originale Blame Cronologia 

  1. # SPDX-FileCopyrightText: 2019 - 2024 Slavi Pantaleev

  2. # SPDX-FileCopyrightText: 2024 Charles Wright

  3. # SPDX-FileCopyrightText: 2024 MDAD project contributors

  4. #

  5. # SPDX-License-Identifier: AGPL-3.0-or-later

  6. 

  7. ---

  8. 

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

  10.   ansible.builtin.fail:

  11.     msg: >-

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

  13.   when: "item.when | bool and vars[item.name] | string | length == 0"

  14.   with_items:

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

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

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

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

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

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

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

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

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

  24. 

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

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

  27. 

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

  29. 

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

  31.     - {'name': 'matrix_synapse_container_labels_internal_client_synapse_admin_api_traefik_entrypoints', when: "{{ matrix_synapse_container_labels_internal_client_synapse_admin_api_enabled }}"}

  32. 

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

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

  35. 

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

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

  38. 

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

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

  41. 

  42.     - {'name': 'matrix_synapse_experimental_features_msc3861_issuer', when: "{{ matrix_synapse_experimental_features_msc3861_enabled }}"}

  43.     - {'name': 'matrix_synapse_experimental_features_msc3861_client_id', when: "{{ matrix_synapse_experimental_features_msc3861_enabled }}"}

  44.     - {'name': 'matrix_synapse_experimental_features_msc3861_client_auth_method', when: "{{ matrix_synapse_experimental_features_msc3861_enabled }}"}

  45.     - {'name': 'matrix_synapse_experimental_features_msc3861_client_secret', when: "{{ matrix_synapse_experimental_features_msc3861_enabled }}"}

  46.     - {'name': 'matrix_synapse_experimental_features_msc3861_admin_token', when: "{{ matrix_synapse_experimental_features_msc3861_enabled }}"}

  47.     - {'name': 'matrix_synapse_experimental_features_msc3861_account_management_url', when: "{{ matrix_synapse_experimental_features_msc3861_enabled }}"}

  48. 

  49.     - {'name': 'matrix_synapse_container_labels_traefik_compression_middleware_name', when: "{{ matrix_synapse_container_labels_traefik_compression_middleware_enabled }}"}

  50. 

  51. # If only MSC 4108 is enabled, Synapse fails with: "MSC4108 requires MSC3861 to be enabled"

  52. - name: Fail if Synapse experimental feature QR code login (MSC4108) is enabled while Next-Gen Auth (MSC3861) is not

  53.   ansible.builtin.fail:

  54.     msg: >-

  55.       QR code login (MSC4108) requires Next-Gen Auth (MSC3861) to be enabled or Synapse will fail to start.

  56.       Enable `matrix_synapse_experimental_features_msc3861_enabled` when using `matrix_synapse_experimental_features_msc4108_enabled`.

  57.   when: "matrix_synapse_experimental_features_msc4108_enabled and not matrix_synapse_experimental_features_msc3861_enabled"

  58. 

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

  60.   ansible.builtin.fail:

  61.     msg: >-

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

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

  64.   with_items:

  65.     - "matrix_synapse_workers_appservice_workers_count"

  66.     - "matrix_synapse_workers_user_dir_workers_count"

  67.     - "matrix_synapse_workers_background_workers_count"

  68.     - "matrix_synapse_workers_stream_writer_typing_stream_workers_count"

  69.     - "matrix_synapse_workers_stream_writer_to_device_stream_workers_count"

  70.     - "matrix_synapse_workers_stream_writer_account_data_stream_workers_count"

  71.     - "matrix_synapse_workers_stream_writer_receipts_stream_workers_count"

  72.     - "matrix_synapse_workers_stream_writer_presence_stream_workers_count"

  73. 

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

  75.   ansible.builtin.fail:

  76.     msg: >-

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

  78.   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)

  79. 

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

  81.   ansible.builtin.fail:

  82.     msg: >-

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

  84.       Please rename the variable (`{{ item.old }}` -> `{{ item.new }}`) on your configuration file (vars.yml).

  85.   when: "lookup('ansible.builtin.varnames', ('^' + item.old + '$'), wantlist=True) | length > 0"

  86.   with_items:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  120.     - {'old': 'matrix_synapse_docker_image_name_prefix', 'new': 'matrix_synapse_docker_image_registry_prefix'}

  121.     - {'old': 'matrix_s3_goofys_docker_image_name_prefix', 'new': 'matrix_s3_goofys_docker_image_registry_prefix'}

  122.     - {'old': 'matrix_synapse_rust_synapse_compress_state_docker_image_name_prefix', 'new': 'matrix_synapse_rust_synapse_compress_state_docker_image_registry_prefix'}

  123. 

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

  125.   ansible.builtin.fail:

  126.     msg: >-

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

  128.       Please rename the variable (`{{ item.old }}` -> `{{ item.new }}`) on your configuration file (vars.yml).

  129.   when: "item.old in matrix_synapse_configuration_extension"

  130.   with_items:

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

  132. 

  133. - when: matrix_synapse_container_image_customizations_templates_enabled | bool

  134.   block:

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

  136.       ansible.builtin.fail:

  137.         msg: >-

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

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

  140.       with_items:

  141.         - matrix_synapse_container_image_customizations_templates_git_repository_url

  142.         - matrix_synapse_container_image_customizations_templates_git_repository_branch

  143. 

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

  145.       ansible.builtin.fail:

  146.         msg: >-

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

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

  149.       with_items:

  150.         - matrix_synapse_container_image_customizations_templates_git_repository_keyscan_hostname

  151. 

  152. 

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

  154.   ansible.builtin.fail:

  155.     msg: >-

  156.       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`).

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

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

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

  160.   when:

  161.     - matrix_synapse_auto_accept_invites_enabled

  162.     - matrix_synapse_ext_synapse_auto_accept_invite_enabled

  163. 

  164. - name: Fail if known Synapse password provider modules are enabled when auth is delegated to Matrix Authentication Service

  165.   ansible.builtin.fail:

  166.     msg: "When Synapse is delegating authentication to Matrix Authentication Service, it does not make sense to enable password provider modules, because it is not Synapse that is handling authentication. Please disable {{ item }} before enabling Matrix Authentication Service integration for Synapse. Synapse will refuse to start otherwise."

  167.   when: matrix_synapse_experimental_features_msc3861_enabled and vars[item] | bool

  168.   with_items:

  169.     - matrix_synapse_ext_password_provider_rest_auth_enabled

  170.     - matrix_synapse_ext_password_provider_shared_secret_auth_enabled

  171.     - matrix_synapse_ext_password_provider_ldap_enabled

  172. 

  173. - name: Fail if password config is enabled for Synapse when auth is delegated to Matrix Authentication Service

  174.   ansible.builtin.fail:

  175.     msg: "When Synapse is delegating authentication to Matrix Authentication Service, it doesn't make sense to enable the password config (`matrix_synapse_password_config_enabled: true`), because it is not Synapse that is handling authentication. Please remove your `matrix_synapse_password_config_enabled: true` setting before enabling Matrix Authentication Service integration for Synapse. Synapse will refuse to start otherwise."

  176.   when: matrix_synapse_experimental_features_msc3861_enabled and matrix_synapse_password_config_enabled

  177. 

  178. - name: Fail if QR code login (MSC4108) is enabled while Next-Gen Auth (MSC3861) is not

  179.   ansible.builtin.fail:

  180.     msg: "When Synapse QR code login is enabled (MSC4108 via `matrix_synapse_experimental_features_msc4108_enabled`), Next-Gen auth (MSC3861 via `matrix_synapse_experimental_features_msc3861_enabled`) must also be enabled."

  181.   when: matrix_synapse_experimental_features_msc4108_enabled and not matrix_synapse_experimental_features_msc3861_enabled