overmind
/
matrix-docker-ansible-deploy
огледало од https://github.com/spantaleev/matrix-docker-ansible-deploy
1
0
Креирај огранак 0
Код Дискусије 0 Издања 0 Вики 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.
10883 Комити
13 Гране
36 MiB
 
 
Дрво: e5b48f22db
Гране Ознаке
${ item.name }
Create branch ${ searchTerm }
from 'e5b48f22db'
${ noResults }
matrix-docker-ansible-deploy/roles/custom/matrix-synapse/tasks/validate_config.yml

192 lines
17 KiB
Датотека Blame Историја 

  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 lookup('vars', item.name, default='') | 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_matrix_authentication_service_endpoint', when: "{{ matrix_synapse_matrix_authentication_service_enabled }}"}

  43.     - {'name': 'matrix_synapse_matrix_authentication_service_secret', when: "{{ matrix_synapse_matrix_authentication_service_enabled }}"}

  44. 

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

  46. 

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

  48.   ansible.builtin.fail:

  49.     msg: >-

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

  51.   when: "lookup('vars', item, default='') | int > 1"

  52.   with_items:

  53.     - "matrix_synapse_workers_appservice_workers_count"

  54.     - "matrix_synapse_workers_user_dir_workers_count"

  55.     - "matrix_synapse_workers_background_workers_count"

  56.     - "matrix_synapse_workers_stream_writer_typing_stream_workers_count"

  57.     - "matrix_synapse_workers_stream_writer_to_device_stream_workers_count"

  58.     - "matrix_synapse_workers_stream_writer_account_data_stream_workers_count"

  59.     - "matrix_synapse_workers_stream_writer_receipts_stream_workers_count"

  60.     - "matrix_synapse_workers_stream_writer_presence_stream_workers_count"

  61. 

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

  63.   ansible.builtin.fail:

  64.     msg: >-

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

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

  67. 

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

  69.   ansible.builtin.fail:

  70.     msg: >-

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

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

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

  74.   with_items:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  111. 

  112.     - {'old': 'matrix_synapse_experimental_features_msc3202_device_masquerading_enabled', 'new': '<removed - this feature is enabled by default now'}

  113. 

  114.     - {'old': 'matrix_synapse_experimental_features_msc3861_enabled', 'new': 'matrix_synapse_matrix_authentication_service_enabled'}

  115.     - {'old': 'matrix_synapse_experimental_features_msc3861_issuer', 'new': '<superseded by matrix_synapse_matrix_authentication_service_endpoint>'}

  116.     - {'old': 'matrix_synapse_experimental_features_msc3861_client_id', 'new': '<removed>'}

  117.     - {'old': 'matrix_synapse_experimental_features_msc3861_client_auth_method', 'new': '<removed>'}

  118.     - {'old': 'matrix_synapse_experimental_features_msc3861_client_secret', 'new': '<removed>'}

  119.     - {'old': 'matrix_synapse_experimental_features_msc3861_admin_token', 'new': '<removed>'}

  120.     - {'old': 'matrix_synapse_experimental_features_msc3861_account_management_url', 'new': '<removed>'}

  121. 

  122.     - {'old': 'matrix_synapse_experimental_features_msc4133_enabled', 'new': '<removed - this feature is enabled by default now>'}

  123. 

  124.     - {'old': 'matrix_synapse_container_image_customizations_s3_storage_provider_installation_old_boto_workaround_enabled', 'new': '<removed; see https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/4637>'}

  125. 

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

  127.   ansible.builtin.fail:

  128.     msg: >-

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

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

  131.   when: "item.old in matrix_synapse_configuration_extension"

  132.   with_items:

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

  134. 

  135. - when: matrix_synapse_container_image_customizations_templates_enabled | bool

  136.   block:

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

  138.       ansible.builtin.fail:

  139.         msg: >-

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

  141.       when: "lookup('vars', item, default='') == ''"

  142.       with_items:

  143.         - matrix_synapse_container_image_customizations_templates_git_repository_url

  144.         - matrix_synapse_container_image_customizations_templates_git_repository_branch

  145. 

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

  147.       ansible.builtin.fail:

  148.         msg: >-

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

  150.       when: "matrix_synapse_container_image_customizations_templates_git_repository_keyscan_enabled | bool and lookup('vars', item, default='') == ''"

  151.       with_items:

  152.         - matrix_synapse_container_image_customizations_templates_git_repository_keyscan_hostname

  153. 

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

  155.   ansible.builtin.fail:

  156.     msg: "When Synapse is delegating authentication to Matrix Authentication Service (`matrix_synapse_matrix_authentication_service_enabled: true`), 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."

  157.   when: matrix_synapse_matrix_authentication_service_enabled and lookup('vars', item, default='') | bool

  158.   with_items:

  159.     - matrix_synapse_ext_password_provider_rest_auth_enabled

  160.     - matrix_synapse_ext_password_provider_shared_secret_auth_enabled

  161.     - matrix_synapse_ext_password_provider_ldap_enabled

  162. 

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

  164.   ansible.builtin.fail:

  165.     msg: "When Synapse is delegating authentication to Matrix Authentication Service (`matrix_synapse_matrix_authentication_service_enabled: true`), 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."

  166.   when: matrix_synapse_matrix_authentication_service_enabled and matrix_synapse_password_config_enabled

  167. 

  168. - name: Fail if registration is enabled for Synapse when auth is delegated to Matrix Authentication Service

  169.   ansible.builtin.fail:

  170.     msg: "When Synapse is delegating authentication to Matrix Authentication Service (`matrix_synapse_matrix_authentication_service_enabled: true`), it doesn't make sense to enable registration (`matrix_synapse_enable_registration: true`), because it is not Synapse that is handling authentication. Synapse will refuse to start otherwise."

  171.   when: matrix_synapse_matrix_authentication_service_enabled and matrix_synapse_enable_registration

  172. 

  173. - name: Fail if registration CAPTCHA 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 (`matrix_synapse_matrix_authentication_service_enabled: true`), it doesn't make sense to enable registration CAPTCHA (`matrix_synapse_enable_registration_captcha: true`), because it is not Synapse that is handling authentication. Synapse will refuse to start otherwise."

  176.   when: matrix_synapse_matrix_authentication_service_enabled and matrix_synapse_enable_registration_captcha

  177. 

  178. - name: Fail if OpenID Connect is enabled for Synapse when auth is delegated to Matrix Authentication Service

  179.   ansible.builtin.fail:

  180.     msg: "When Synapse is delegating authentication to Matrix Authentication Service (`matrix_synapse_matrix_authentication_service_enabled: true`), it doesn't make sense to enable OpenID Connect (`matrix_synapse_oidc_enabled: true`), because it is not Synapse that is handling authentication. Synapse will refuse to start otherwise."

  181.   when: matrix_synapse_matrix_authentication_service_enabled and matrix_synapse_oidc_enabled

  182. 

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

  184.   ansible.builtin.fail:

  185.     msg: "When Synapse is delegating authentication to Matrix Authentication Service (`matrix_synapse_matrix_authentication_service_enabled: true`), it doesn't make sense to enable CAS config (`matrix_synapse_cas_config_enabled: true`), because it is not Synapse that is handling authentication. Synapse will refuse to start otherwise."

  186.   when: matrix_synapse_matrix_authentication_service_enabled and matrix_synapse_cas_config_enabled

  187. 

  188. - name: Fail if QR code login (MSC4108) is enabled while Matrix Authentication Service is not

  189.   ansible.builtin.fail:

  190.     msg: "When Synapse QR code login is enabled (MSC4108 via `matrix_synapse_experimental_features_msc4108_enabled`), Matrix Authentication Service integration (`matrix_synapse_matrix_authentication_service_enabled`) must also be enabled."

  191.   when: matrix_synapse_experimental_features_msc4108_enabled and not matrix_synapse_matrix_authentication_service_enabled