5
0
mirror of https://github.com/spantaleev/matrix-docker-ansible-deploy.git synced 2026-07-19 08:09:36 +00:00

Rename matrix_mautrix_whatsapp_* variables to matrix_bridge_mautrix_whatsapp_*

Part of adopting a uniform naming policy for bridge variables,
where the variable prefix matches the role directory name.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This commit is contained in:
Slavi Pantaleev
2026-07-16 14:56:55 +03:00
parent 54020894b4
commit 4d6b68a5da
10 changed files with 320 additions and 320 deletions
@@ -13,15 +13,15 @@
- install-all
- install-mautrix-whatsapp
block:
- when: matrix_mautrix_whatsapp_enabled | bool
- when: matrix_bridge_mautrix_whatsapp_enabled | bool
ansible.builtin.include_tasks: "{{ role_path }}/tasks/validate_config.yml"
- when: matrix_mautrix_whatsapp_enabled | bool
- when: matrix_bridge_mautrix_whatsapp_enabled | bool
ansible.builtin.include_tasks: "{{ role_path }}/tasks/setup_install.yml"
- tags:
- setup-all
- setup-mautrix-whatsapp
block:
- when: not matrix_mautrix_whatsapp_enabled | bool
- when: not matrix_bridge_mautrix_whatsapp_enabled | bool
ansible.builtin.include_tasks: "{{ role_path }}/tasks/setup_uninstall.yml"
@@ -18,32 +18,32 @@
---
- ansible.builtin.set_fact:
matrix_mautrix_whatsapp_migration_requires_restart: false
matrix_bridge_mautrix_whatsapp_migration_requires_restart: false
- when: "matrix_mautrix_whatsapp_database_engine == 'postgres'"
- when: "matrix_bridge_mautrix_whatsapp_database_engine == 'postgres'"
block:
- name: Check if an SQLite database already exists
ansible.builtin.stat:
path: "{{ matrix_mautrix_whatsapp_sqlite_database_path_local }}"
register: matrix_mautrix_whatsapp_sqlite_database_path_local_stat_result
path: "{{ matrix_bridge_mautrix_whatsapp_sqlite_database_path_local }}"
register: matrix_bridge_mautrix_whatsapp_sqlite_database_path_local_stat_result
- when: "matrix_mautrix_whatsapp_sqlite_database_path_local_stat_result.stat.exists | bool"
- when: "matrix_bridge_mautrix_whatsapp_sqlite_database_path_local_stat_result.stat.exists | bool"
block:
- ansible.builtin.include_role:
name: galaxy/postgres
tasks_from: migrate_db_to_postgres
vars:
postgres_db_migration_request:
src: "{{ matrix_mautrix_whatsapp_sqlite_database_path_local }}"
dst: "{{ matrix_mautrix_whatsapp_database_connection_string }}"
src: "{{ matrix_bridge_mautrix_whatsapp_sqlite_database_path_local }}"
dst: "{{ matrix_bridge_mautrix_whatsapp_database_connection_string }}"
caller: "{{ role_path | basename }}"
engine_variable_name: 'matrix_mautrix_whatsapp_database_engine'
engine_variable_name: 'matrix_bridge_mautrix_whatsapp_database_engine'
engine_old: 'sqlite'
systemd_services_to_stop: ['matrix-mautrix-whatsapp.service']
pgloader_options: ['--with "quote identifiers"']
- ansible.builtin.set_fact:
matrix_mautrix_whatsapp_migration_requires_restart: true
matrix_bridge_mautrix_whatsapp_migration_requires_restart: true
- name: Ensure Mautrix Whatsapp paths exists
ansible.builtin.file:
@@ -53,52 +53,52 @@
owner: "{{ matrix_user_name }}"
group: "{{ matrix_group_name }}"
with_items:
- {path: "{{ matrix_mautrix_whatsapp_base_path }}", when: true}
- {path: "{{ matrix_mautrix_whatsapp_config_path }}", when: true}
- {path: "{{ matrix_mautrix_whatsapp_data_path }}", when: true}
- {path: "{{ matrix_mautrix_whatsapp_container_src_files_path }}", when: "{{ matrix_mautrix_whatsapp_container_image_self_build }}"}
- {path: "{{ matrix_bridge_mautrix_whatsapp_base_path }}", when: true}
- {path: "{{ matrix_bridge_mautrix_whatsapp_config_path }}", when: true}
- {path: "{{ matrix_bridge_mautrix_whatsapp_data_path }}", when: true}
- {path: "{{ matrix_bridge_mautrix_whatsapp_container_src_files_path }}", when: "{{ matrix_bridge_mautrix_whatsapp_container_image_self_build }}"}
when: item.when | bool
- name: Ensure Mautrix Whatsapp image is pulled
community.docker.docker_image_pull:
name: "{{ matrix_mautrix_whatsapp_container_image }}"
name: "{{ matrix_bridge_mautrix_whatsapp_container_image }}"
pull: always
when: not matrix_mautrix_whatsapp_container_image_self_build
register: matrix_mautrix_whatsapp_container_image_pull_result
when: not matrix_bridge_mautrix_whatsapp_container_image_self_build
register: matrix_bridge_mautrix_whatsapp_container_image_pull_result
retries: "{{ devture_playbook_help_container_retries_count }}"
delay: "{{ devture_playbook_help_container_retries_delay }}"
until: matrix_mautrix_whatsapp_container_image_pull_result is not failed
until: matrix_bridge_mautrix_whatsapp_container_image_pull_result is not failed
- name: Ensure Mautrix Whatsapp repository is present on self-build
ansible.builtin.git:
repo: "{{ matrix_mautrix_whatsapp_container_image_self_build_repo }}"
dest: "{{ matrix_mautrix_whatsapp_container_src_files_path }}"
version: "{{ matrix_mautrix_whatsapp_container_image_self_build_branch }}"
repo: "{{ matrix_bridge_mautrix_whatsapp_container_image_self_build_repo }}"
dest: "{{ matrix_bridge_mautrix_whatsapp_container_src_files_path }}"
version: "{{ matrix_bridge_mautrix_whatsapp_container_image_self_build_branch }}"
force: "yes"
become: true
become_user: "{{ matrix_user_name }}"
register: matrix_mautrix_whatsapp_git_pull_results
when: "matrix_mautrix_whatsapp_container_image_self_build | bool"
register: matrix_bridge_mautrix_whatsapp_git_pull_results
when: "matrix_bridge_mautrix_whatsapp_container_image_self_build | bool"
- name: Ensure Mautrix Whatsapp Docker image is built
community.docker.docker_image_build:
name: "{{ matrix_mautrix_whatsapp_container_image }}"
name: "{{ matrix_bridge_mautrix_whatsapp_container_image }}"
dockerfile: Dockerfile
path: "{{ matrix_mautrix_whatsapp_container_src_files_path }}"
path: "{{ matrix_bridge_mautrix_whatsapp_container_src_files_path }}"
pull: true
rebuild: "{{ 'always' if matrix_mautrix_whatsapp_git_pull_results.changed | bool else 'never' }}"
when: "matrix_mautrix_whatsapp_container_image_self_build | bool"
register: matrix_mautrix_whatsapp_container_image_build_result
rebuild: "{{ 'always' if matrix_bridge_mautrix_whatsapp_git_pull_results.changed | bool else 'never' }}"
when: "matrix_bridge_mautrix_whatsapp_container_image_self_build | bool"
register: matrix_bridge_mautrix_whatsapp_container_image_build_result
- name: Check if an old database file exists
ansible.builtin.stat:
path: "{{ matrix_mautrix_whatsapp_base_path }}/mautrix-whatsapp.db"
register: matrix_mautrix_whatsapp_stat_database
path: "{{ matrix_bridge_mautrix_whatsapp_base_path }}/mautrix-whatsapp.db"
register: matrix_bridge_mautrix_whatsapp_stat_database
- name: Check if an old Matrix state file exists
ansible.builtin.stat:
path: "{{ matrix_mautrix_whatsapp_base_path }}/mx-state.json"
register: matrix_mautrix_whatsapp_stat_mx_state
path: "{{ matrix_bridge_mautrix_whatsapp_base_path }}/mx-state.json"
register: matrix_bridge_mautrix_whatsapp_stat_mx_state
- name: (Data relocation) Ensure matrix-mautrix-whatsapp.service is stopped
ansible.builtin.service:
@@ -107,56 +107,56 @@
enabled: false
daemon_reload: true
failed_when: false
when: "matrix_mautrix_whatsapp_stat_database.stat.exists"
when: "matrix_bridge_mautrix_whatsapp_stat_database.stat.exists"
- name: (Data relocation) Move mautrix-whatsapp database file to ./data directory
ansible.builtin.command:
cmd: "mv {{ matrix_mautrix_whatsapp_base_path }}/mautrix-whatsapp.db {{ matrix_mautrix_whatsapp_data_path }}/mautrix-whatsapp.db"
creates: "{{ matrix_mautrix_whatsapp_data_path }}/mautrix-whatsapp.db"
removes: "{{ matrix_mautrix_whatsapp_base_path }}/mautrix-whatsapp.db"
when: "matrix_mautrix_whatsapp_stat_database.stat.exists"
cmd: "mv {{ matrix_bridge_mautrix_whatsapp_base_path }}/mautrix-whatsapp.db {{ matrix_bridge_mautrix_whatsapp_data_path }}/mautrix-whatsapp.db"
creates: "{{ matrix_bridge_mautrix_whatsapp_data_path }}/mautrix-whatsapp.db"
removes: "{{ matrix_bridge_mautrix_whatsapp_base_path }}/mautrix-whatsapp.db"
when: "matrix_bridge_mautrix_whatsapp_stat_database.stat.exists"
- name: (Data relocation) Move mautrix-whatsapp mx-state file to ./data directory
ansible.builtin.command:
cmd: "mv {{ matrix_mautrix_whatsapp_base_path }}/mx-state.json {{ matrix_mautrix_whatsapp_data_path }}/mx-state.json"
creates: "{{ matrix_mautrix_whatsapp_data_path }}/mx-state.json"
removes: "{{ matrix_mautrix_whatsapp_base_path }}/mx-state.json"
when: "matrix_mautrix_whatsapp_stat_mx_state.stat.exists"
cmd: "mv {{ matrix_bridge_mautrix_whatsapp_base_path }}/mx-state.json {{ matrix_bridge_mautrix_whatsapp_data_path }}/mx-state.json"
creates: "{{ matrix_bridge_mautrix_whatsapp_data_path }}/mx-state.json"
removes: "{{ matrix_bridge_mautrix_whatsapp_base_path }}/mx-state.json"
when: "matrix_bridge_mautrix_whatsapp_stat_mx_state.stat.exists"
- name: Ensure mautrix-whatsapp config.yaml installed
ansible.builtin.copy:
content: "{{ matrix_mautrix_whatsapp_configuration | to_nice_yaml(indent=2, width=999999) }}"
dest: "{{ matrix_mautrix_whatsapp_config_path }}/config.yaml"
content: "{{ matrix_bridge_mautrix_whatsapp_configuration | to_nice_yaml(indent=2, width=999999) }}"
dest: "{{ matrix_bridge_mautrix_whatsapp_config_path }}/config.yaml"
mode: '0644'
owner: "{{ matrix_user_name }}"
group: "{{ matrix_group_name }}"
register: matrix_mautrix_whatsapp_config_result
register: matrix_bridge_mautrix_whatsapp_config_result
- name: Ensure mautrix-whatsapp registration.yaml installed
ansible.builtin.copy:
content: "{{ matrix_mautrix_whatsapp_registration | to_nice_yaml(indent=2, width=999999) }}"
dest: "{{ matrix_mautrix_whatsapp_config_path }}/registration.yaml"
content: "{{ matrix_bridge_mautrix_whatsapp_registration | to_nice_yaml(indent=2, width=999999) }}"
dest: "{{ matrix_bridge_mautrix_whatsapp_config_path }}/registration.yaml"
mode: '0644'
owner: "{{ matrix_user_name }}"
group: "{{ matrix_group_name }}"
register: matrix_mautrix_whatsapp_registration_result
register: matrix_bridge_mautrix_whatsapp_registration_result
- name: Ensure mautrix-whatsapp support files installed
ansible.builtin.template:
src: "{{ role_path }}/templates/{{ item }}.j2"
dest: "{{ matrix_mautrix_whatsapp_base_path }}/{{ item }}"
dest: "{{ matrix_bridge_mautrix_whatsapp_base_path }}/{{ item }}"
mode: '0640'
owner: "{{ matrix_user_name }}"
group: "{{ matrix_group_name }}"
with_items:
- labels
register: matrix_mautrix_whatsapp_support_files_result
register: matrix_bridge_mautrix_whatsapp_support_files_result
- name: Ensure matrix-mautrix-whatsapp container network is created
when: matrix_mautrix_whatsapp_container_network != 'host'
when: matrix_bridge_mautrix_whatsapp_container_network != 'host'
community.general.docker_network:
enable_ipv6: "{{ devture_systemd_docker_base_ipv6_enabled }}"
name: "{{ matrix_mautrix_whatsapp_container_network }}"
name: "{{ matrix_bridge_mautrix_whatsapp_container_network }}"
driver: bridge
driver_options: "{{ devture_systemd_docker_base_container_networks_driver_options }}"
@@ -165,19 +165,19 @@
src: "{{ role_path }}/templates/systemd/matrix-mautrix-whatsapp.service.j2"
dest: "{{ devture_systemd_docker_base_systemd_path }}/matrix-mautrix-whatsapp.service"
mode: '0644'
register: matrix_mautrix_whatsapp_systemd_service_result
register: matrix_bridge_mautrix_whatsapp_systemd_service_result
- name: Determine whether matrix-mautrix-whatsapp needs a restart
ansible.builtin.set_fact:
matrix_mautrix_whatsapp_restart_necessary: >-
matrix_bridge_mautrix_whatsapp_restart_necessary: >-
{{
matrix_mautrix_whatsapp_migration_requires_restart | default(false)
or matrix_mautrix_whatsapp_config_result.changed | default(false)
or matrix_mautrix_whatsapp_registration_result.changed | default(false)
or matrix_mautrix_whatsapp_support_files_result.changed | default(false)
or matrix_mautrix_whatsapp_systemd_service_result.changed | default(false)
or matrix_mautrix_whatsapp_container_image_pull_result.changed | default(false)
or matrix_mautrix_whatsapp_container_image_build_result.changed | default(false)
matrix_bridge_mautrix_whatsapp_migration_requires_restart | default(false)
or matrix_bridge_mautrix_whatsapp_config_result.changed | default(false)
or matrix_bridge_mautrix_whatsapp_registration_result.changed | default(false)
or matrix_bridge_mautrix_whatsapp_support_files_result.changed | default(false)
or matrix_bridge_mautrix_whatsapp_systemd_service_result.changed | default(false)
or matrix_bridge_mautrix_whatsapp_container_image_pull_result.changed | default(false)
or matrix_bridge_mautrix_whatsapp_container_image_build_result.changed | default(false)
}}
- name: Ensure matrix-mautrix-whatsapp.service restarted, if necessary
@@ -185,4 +185,4 @@
name: "matrix-mautrix-whatsapp.service"
state: restarted
daemon_reload: true
when: "matrix_mautrix_whatsapp_migration_requires_restart | bool"
when: "matrix_bridge_mautrix_whatsapp_migration_requires_restart | bool"
@@ -9,9 +9,9 @@
- name: Check existence of matrix-mautrix-whatsapp service
ansible.builtin.stat:
path: "{{ devture_systemd_docker_base_systemd_path }}/matrix-mautrix-whatsapp.service"
register: matrix_mautrix_whatsapp_service_stat
register: matrix_bridge_mautrix_whatsapp_service_stat
- when: matrix_mautrix_whatsapp_service_stat.stat.exists | bool
- when: matrix_bridge_mautrix_whatsapp_service_stat.stat.exists | bool
block:
- name: Ensure matrix-mautrix-whatsapp is stopped
ansible.builtin.service:
@@ -15,20 +15,20 @@
Please rename the variable (`{{ item.old }}` -> `{{ item.new }}`) on your configuration file (vars.yml).
when: "lookup('ansible.builtin.varnames', ('^' + item.old + '$'), wantlist=True) | length > 0"
with_items:
- {'old': 'matrix_mautrix_whatsapp_log_level', 'new': 'matrix_mautrix_whatsapp_logging_level'}
- {'old': 'matrix_mautrix_whatsapp_login_shared_secret', 'new': '<removed>'}
- {'old': 'matrix_mautrix_whatsapp_bridge_login_shared_secret_map', 'new': '<superseded by matrix_mautrix_whatsapp_double_puppet_secrets>'}
- {'old': 'matrix_mautrix_whatsapp_bridge_double_puppet_server_map', 'new': '<removed>'}
- {'old': 'matrix_mautrix_whatsapp_bridge_allow_user_invite', 'new': '<removed>'}
- {'old': 'matrix_mautrix_whatsapp_bridge_mute_bridging', 'new': '<removed>'}
- {'old': 'matrix_mautrix_whatsapp_docker_image_name_prefix', 'new': 'matrix_mautrix_whatsapp_container_image_registry_prefix'}
- {'old': 'matrix_mautrix_whatsapp_docker_image', 'new': 'matrix_mautrix_whatsapp_container_image'}
- {'old': 'matrix_mautrix_whatsapp_docker_image_force_pull', 'new': 'matrix_mautrix_whatsapp_container_image_force_pull'}
- {'old': 'matrix_mautrix_whatsapp_docker_image_registry_prefix', 'new': 'matrix_mautrix_whatsapp_container_image_registry_prefix'}
- {'old': 'matrix_mautrix_whatsapp_docker_image_registry_prefix_upstream', 'new': 'matrix_mautrix_whatsapp_container_image_registry_prefix_upstream'}
- {'old': 'matrix_mautrix_whatsapp_docker_image_registry_prefix_upstream_default', 'new': 'matrix_mautrix_whatsapp_container_image_registry_prefix_upstream_default'}
- {'old': 'matrix_mautrix_whatsapp_docker_src_files_path', 'new': 'matrix_mautrix_whatsapp_container_src_files_path'}
- {'old': 'matrix_mautrix_whatsapp_container_image_force_pull', 'new': '<removed> (the new community.docker.docker_image_pull module handles this natively)'}
- {'old': 'matrix_bridge_mautrix_whatsapp_log_level', 'new': 'matrix_bridge_mautrix_whatsapp_logging_level'}
- {'old': 'matrix_bridge_mautrix_whatsapp_login_shared_secret', 'new': '<removed>'}
- {'old': 'matrix_bridge_mautrix_whatsapp_bridge_login_shared_secret_map', 'new': '<superseded by matrix_bridge_mautrix_whatsapp_double_puppet_secrets>'}
- {'old': 'matrix_bridge_mautrix_whatsapp_bridge_double_puppet_server_map', 'new': '<removed>'}
- {'old': 'matrix_bridge_mautrix_whatsapp_bridge_allow_user_invite', 'new': '<removed>'}
- {'old': 'matrix_bridge_mautrix_whatsapp_bridge_mute_bridging', 'new': '<removed>'}
- {'old': 'matrix_bridge_mautrix_whatsapp_docker_image_name_prefix', 'new': 'matrix_bridge_mautrix_whatsapp_container_image_registry_prefix'}
- {'old': 'matrix_bridge_mautrix_whatsapp_docker_image', 'new': 'matrix_bridge_mautrix_whatsapp_container_image'}
- {'old': 'matrix_bridge_mautrix_whatsapp_docker_image_force_pull', 'new': 'matrix_bridge_mautrix_whatsapp_container_image_force_pull'}
- {'old': 'matrix_bridge_mautrix_whatsapp_docker_image_registry_prefix', 'new': 'matrix_bridge_mautrix_whatsapp_container_image_registry_prefix'}
- {'old': 'matrix_bridge_mautrix_whatsapp_docker_image_registry_prefix_upstream', 'new': 'matrix_bridge_mautrix_whatsapp_container_image_registry_prefix_upstream'}
- {'old': 'matrix_bridge_mautrix_whatsapp_docker_image_registry_prefix_upstream_default', 'new': 'matrix_bridge_mautrix_whatsapp_container_image_registry_prefix_upstream_default'}
- {'old': 'matrix_bridge_mautrix_whatsapp_docker_src_files_path', 'new': 'matrix_bridge_mautrix_whatsapp_container_src_files_path'}
- {'old': 'matrix_bridge_mautrix_whatsapp_container_image_force_pull', 'new': '<removed> (the new community.docker.docker_image_pull module handles this natively)'}
- name: Fail if required mautrix-whatsapp settings not defined
ansible.builtin.fail:
@@ -36,7 +36,7 @@
You need to define a required configuration setting (`{{ item.name }}`).
when: "item.when | bool and lookup('vars', item.name, default='') | string | length == 0"
with_items:
- {'name': 'matrix_mautrix_whatsapp_appservice_token', when: true}
- {'name': 'matrix_mautrix_whatsapp_homeserver_address', when: true}
- {'name': 'matrix_mautrix_whatsapp_homeserver_token', when: true}
- {'name': 'matrix_mautrix_whatsapp_database_hostname', when: "{{ matrix_mautrix_whatsapp_database_engine == 'postgres' }}"}
- {'name': 'matrix_bridge_mautrix_whatsapp_appservice_token', when: true}
- {'name': 'matrix_bridge_mautrix_whatsapp_homeserver_address', when: true}
- {'name': 'matrix_bridge_mautrix_whatsapp_homeserver_token', when: true}
- {'name': 'matrix_bridge_mautrix_whatsapp_database_hostname', when: "{{ matrix_bridge_mautrix_whatsapp_database_engine == 'postgres' }}"}