overmind
/
matrix-docker-ansible-deploy
kopia lustrzana https://github.com/spantaleev/matrix-docker-ansible-deploy
1
0
Forkuj 0
Kod Zgłoszenia 0 Wydania 0 Wiki Aktywność
Matrix Docker Ansible eploy
Nie możesz wybrać więcej, niż 25 tematów Tematy muszą się zaczynać od litery lub cyfry, mogą zawierać myślniki ('-') i mogą mieć do 35 znaków.
8758 Commity
13 Gałęzie
93 MiB
 
 
Drzewo: ab30390bd4
Gałęzie Tagi
${ item.name }
Utwórz gałąź ${ searchTerm }
z 'ab30390bd4'
${ noResults }
matrix-docker-ansible-deploy/roles/custom/matrix-base/tasks/validate_config.yml

104 wiersze
7.2 KiB
Czysty Wina Historia 

  1. # SPDX-FileCopyrightText: 2024 MDAD Team and contributors

  2. #

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

  4. 

  5. ---

  6. 

  7. - name: Fail if invalid homeserver implementation

  8.   ansible.builtin.fail:

  9.     msg: "You need to set a valid homeserver implementation in `matrix_homeserver_implementation`"

  10.   when: "matrix_homeserver_implementation not in ['synapse', 'dendrite', 'conduit']"

  11. 

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

  13.   ansible.builtin.fail:

  14.     msg: >-

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

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

  17.   when: "item.old in vars"

  18.   with_items:

  19.     - {'old': 'host_specific_hostname_identity', 'new': 'matrix_domain'}

  20.     - {'old': 'hostname_identity', 'new': 'matrix_domain'}

  21.     - {'old': 'hostname_matrix', 'new': 'matrix_server_fqn_matrix'}

  22.     - {'old': 'hostname_riot', 'new': 'matrix_server_fqn_element'}

  23.     - {'old': 'matrix_server_fqn_riot', 'new': 'matrix_server_fqn_element'}

  24.     - {'old': 'matrix_local_bin_path', 'new': '<there is no global bin path anymore - each role has its own>'}

  25.     - {'old': 'matrix_client_element_e2ee_default', 'new': 'matrix_static_files_file_matrix_client_property_io_element_e2ee_default'}

  26.     - {'old': 'matrix_client_element_e2ee_secure_backup_required', 'new': 'matrix_static_files_file_matrix_client_property_io_element_e2ee_secure_backup_required'}

  27.     - {'old': 'matrix_client_element_e2ee_secure_backup_setup_methods', 'new': 'matrix_static_files_file_matrix_client_property_io_element_e2ee_secure_backup_setup_methods'}

  28. 

  29. # We have a dedicated check for this variable, because we'd like to have a custom (friendlier) message.

  30. - name: Fail if matrix_homeserver_generic_secret_key is undefined

  31.   ansible.builtin.fail:

  32.     msg: |

  33.       The `matrix_homeserver_generic_secret_key` variable must be defined and have a non-null and non-empty value.

  34. 

  35.       If you're observing this error on a new installation, you should ensure that the `matrix_homeserver_generic_secret_key` is defined.

  36.       If you think you've defined it, but are still getting this error, then it's likely that you have a typo

  37.       in your domain name in `inventory/hosts` or in one of the directories leading up to your `inventory/host_vars/matrix.example.com/vars.yml` file.

  38. 

  39.       If you're observing this error on an existing homeserver installation, you can fix it easily and in a backward-compatible way by adding

  40.       `{% raw %}matrix_homeserver_generic_secret_key: "{{ matrix_synapse_macaroon_secret_key }}"{% endraw %}`

  41.       to your `vars.yml` file. Using another secret value for the new variable is also possible and shouldn't cause any trouble.

  42.   when: "matrix_homeserver_generic_secret_key is none or matrix_homeserver_generic_secret_key == ''"

  43. 

  44. - name: Fail if required variables are undefined

  45.   ansible.builtin.fail:

  46.     msg: "The `{{ item.var }}` variable must be defined and have a non-null and non-empty value"

  47.   with_items:

  48.     - {'var': matrix_domain, 'value': "{{ matrix_domain | default('') }}"}

  49.     - {'var': matrix_server_fqn_matrix, 'value': "{{ matrix_server_fqn_matrix | default('') }}"}

  50.     - {'var': matrix_server_fqn_element, 'value': "{{ matrix_server_fqn_element | default('') }}"}

  51.     - {'var': matrix_homeserver_container_client_api_endpoint, 'value': "{{ matrix_homeserver_container_client_api_endpoint | default('') }}"}

  52.     - {'var': matrix_homeserver_container_federation_api_endpoint, 'value': "{{ matrix_homeserver_container_federation_api_endpoint | default('') }}"}

  53.     - {'var': matrix_architecture, 'value': "{{ matrix_architecture | default('') }}"}

  54.   when: "item.value is none or item.value == ''"

  55. 

  56. - name: Fail if matrix_architecture is set incorrectly

  57.   ansible.builtin.fail:

  58.     msg: "Detected that variable matrix_architecture {{ matrix_architecture }} appears to be set incorrectly. See docs/alternative-architectures.md. Server appears to be {{ ansible_architecture }}."

  59.   when: matrix_architecture not in ['amd64', 'arm32', 'arm64']

  60. 

  61. - name: Fail if matrix_playbook_reverse_proxy_type is set incorrectly

  62.   ansible.builtin.fail:

  63.     msg: |

  64.       You have not explicitly specified the type of reverse-proxy you'd like to use (with a `matrix_playbook_reverse_proxy_type` variable in your configuration).

  65.       The playbook used to default to nginx (matrix-nginx-proxy), but things are changing with Traefik being the new default reverse-proxy.

  66.       Learn more here: https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/master/CHANGELOG.md#traefik-is-the-default-reverse-proxy-now

  67.   when: matrix_playbook_reverse_proxy_type == ''

  68. 

  69. - name: Fail if matrix_playbook_reverse_proxy_type is set incorrectly

  70.   ansible.builtin.fail:

  71.     msg: "Detected that variable matrix_playbook_reverse_proxy_type (current value: `{{ matrix_playbook_reverse_proxy_type }}`) appears to be set incorrectly. See roles/custom/matrix-base/defaults/main.yml for valid choices."

  72.   when: matrix_playbook_reverse_proxy_type not in ['playbook-managed-traefik', 'other-traefik-container', 'none']

  73. 

  74. - name: Fail if uppercase domain used

  75.   ansible.builtin.fail:

  76.     msg: "Detected that you're using an uppercase domain name - `{{ item }}`. This will cause trouble. Please use all-lowercase!"

  77.   with_items:

  78.     - "{{ matrix_domain }}"

  79.     - "{{ matrix_server_fqn_matrix }}"

  80.     - "{{ matrix_server_fqn_element }}"

  81.   when: "item != item | lower"

  82. 

  83. - name: Fail if encountering usage of removed role (mx-puppet-skype)

  84.   ansible.builtin.fail:

  85.     msg: >-

  86.       Your configuration seems to include a reference to `matrix_mx_puppet_skype_enabled`. Are you trying to install the mx-puppet-skype bridge?

  87.       The playbook no longer includes a role for installing mx-puppet-skype, because the mx-puppet-bridge is unmaintained and has been reported as broken for a long time.

  88.       To get rid of this error, remove all `matrix_mx_puppet_*` references from your configuration.

  89.       To clean up your server from mx-puppet-skype's presence, see this changelog entry: https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/master/CHANGELOG.md#mx-puppet-skype-removal.

  90.       If you still need bridging to Skype, consider switching to the go-skype bridge instead. See `docs/configuring-playbook-bridge-go-skype-bridge.md`.

  91.   when: "'matrix_mx_puppet_skype_enabled' in vars"

  92. 

  93. - name: Fail if mautrix-instagram and mautrix-meta-instagram are in conflict

  94.   ansible.builtin.fail:

  95.     msg: >-

  96.       Your configuration enables both the old mautrix-instagram bridge and the new mautrix-meta-instagram bridge.

  97.       By default, both bridges are configured to use the same bridge bot username (`@{{ matrix_mautrix_meta_instagram_appservice_username }}:{{ matrix_domain }}`) which is a conflict.

  98.       We recommend that you disable at least one of the bridges (preferrably the old mautrix-instagram bridge), or to resolve the conflict in another way.

  99.       To resolve the conflict without disabling a bridge, consider adjusting one of `matrix_mautrix_instagram_appservice_bot_username` or `matrix_mautrix_meta_instagram_appservice_username` - they both have a value of {{ matrix_mautrix_meta_instagram_appservice_username }} right now.

  100.   when:

  101.     - matrix_mautrix_instagram_enabled | bool

  102.     - matrix_mautrix_meta_instagram_enabled | bool

  103.     - matrix_mautrix_instagram_appservice_bot_username == matrix_mautrix_meta_instagram_appservice_username