overmind
/
matrix-docker-ansible-deploy
镜像来自 https://github.com/spantaleev/matrix-docker-ansible-deploy
1
0
複製 0
程式碼 問題 0 版本發佈 0 Wiki 活動
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.
9608 提交
13 分支
36 MiB
 
 
目錄樹: ff031dfd96
分支列表 標籤
${ item.name }
建立分支 ${ searchTerm }
從 'ff031dfd96'
${ noResults }
matrix-docker-ansible-deploy/roles/custom/matrix-synapse/tasks/validate_config.yml

166 line
14 KiB
原始文件 Blame 歷史記錄 

  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] | length == 0"

  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': 'matrix_synapse_experimental_features_msc3861_issuer', when: "{{ matrix_synapse_experimental_features_msc3861_enabled }}"}

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

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

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

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

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

  41. 

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

  43. 

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

  45.   ansible.builtin.fail:

  46.     msg: >-

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

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

  49.   with_items:

  50.     - "matrix_synapse_workers_appservice_workers_count"

  51.     - "matrix_synapse_workers_user_dir_workers_count"

  52.     - "matrix_synapse_workers_background_workers_count"

  53.     - "matrix_synapse_workers_stream_writer_typing_stream_workers_count"

  54.     - "matrix_synapse_workers_stream_writer_to_device_stream_workers_count"

  55.     - "matrix_synapse_workers_stream_writer_account_data_stream_workers_count"

  56.     - "matrix_synapse_workers_stream_writer_receipts_stream_workers_count"

  57.     - "matrix_synapse_workers_stream_writer_presence_stream_workers_count"

  58. 

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

  60.   ansible.builtin.fail:

  61.     msg: >-

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

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

  64. 

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

  66.   ansible.builtin.fail:

  67.     msg: >-

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

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

  70.   when: "item.old in vars"

  71.   with_items:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  107. 

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

  109.   ansible.builtin.fail:

  110.     msg: >-

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

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

  113.   when: "item.old in matrix_synapse_configuration_extension"

  114.   with_items:

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

  116. 

  117. - when: matrix_synapse_container_image_customizations_templates_enabled | bool

  118.   block:

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

  120.       ansible.builtin.fail:

  121.         msg: >-

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

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

  124.       with_items:

  125.         - matrix_synapse_container_image_customizations_templates_git_repository_url

  126.         - matrix_synapse_container_image_customizations_templates_git_repository_branch

  127. 

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

  129.       ansible.builtin.fail:

  130.         msg: >-

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

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

  133.       with_items:

  134.         - matrix_synapse_container_image_customizations_templates_git_repository_keyscan_hostname

  135. 

  136. 

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

  138.   ansible.builtin.fail:

  139.     msg: >-

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

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

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

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

  144.   when:

  145.     - matrix_synapse_auto_accept_invites_enabled

  146.     - matrix_synapse_ext_synapse_auto_accept_invite_enabled

  147. 

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

  149.   ansible.builtin.fail:

  150.     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."

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

  152.   with_items:

  153.     - matrix_synapse_ext_password_provider_rest_auth_enabled

  154.     - matrix_synapse_ext_password_provider_shared_secret_auth_enabled

  155.     - matrix_synapse_ext_password_provider_ldap_enabled

  156. 

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

  158.   ansible.builtin.fail:

  159.     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."

  160.   when: matrix_synapse_experimental_features_msc3861_enabled and matrix_synapse_password_config_enabled

  161. 

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

  163.   ansible.builtin.fail:

  164.     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."

  165.   when: matrix_synapse_experimental_features_msc4108_enabled and not matrix_synapse_experimental_features_msc3861_enabled