5
0
mirror of https://github.com/spantaleev/matrix-docker-ansible-deploy.git synced 2026-07-17 15:26:41 +00:00

Rename matrix_appservice_irc_* variables to matrix_bridge_appservice_irc_*

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:47:01 +03:00
parent dc16f09e78
commit 98269653b2
11 changed files with 277 additions and 277 deletions
@@ -12,15 +12,15 @@
- install-all
- install-appservice-irc
block:
- when: matrix_appservice_irc_enabled | bool
- when: matrix_bridge_appservice_irc_enabled | bool
ansible.builtin.include_tasks: "{{ role_path }}/tasks/validate_config.yml"
- when: matrix_appservice_irc_enabled | bool
- when: matrix_bridge_appservice_irc_enabled | bool
ansible.builtin.include_tasks: "{{ role_path }}/tasks/setup_install.yml"
- tags:
- setup-all
- setup-appservice-irc
block:
- when: not matrix_appservice_irc_enabled | bool
- when: not matrix_bridge_appservice_irc_enabled | bool
ansible.builtin.include_tasks: "{{ role_path }}/tasks/setup_uninstall.yml"
@@ -38,13 +38,13 @@
- name: Check existence of matrix-appservice-irc service
ansible.builtin.stat:
path: "{{ devture_systemd_docker_base_systemd_path }}/matrix-appservice-irc.service"
register: matrix_appservice_irc_service_stat
register: matrix_bridge_appservice_irc_service_stat
- name: Ensure matrix-appservice-irc is stopped
ansible.builtin.service:
name: matrix-appservice-irc
state: stopped
when: "matrix_appservice_irc_service_stat.stat.exists"
when: "matrix_bridge_appservice_irc_service_stat.stat.exists"
- name: Import appservice-irc NeDB database into Postgres
ansible.builtin.command:
@@ -53,25 +53,25 @@
--rm
--user={{ matrix_user_uid }}:{{ matrix_user_gid }}
--cap-drop=ALL
{% if matrix_appservice_irc_database_container_network %}
--network={{ matrix_appservice_irc_database_container_network }}
{% if matrix_bridge_appservice_irc_database_container_network %}
--network={{ matrix_bridge_appservice_irc_database_container_network }}
{% endif %}
--mount type=bind,src={{ matrix_appservice_irc_data_path }},dst=/data
--mount type=bind,src={{ matrix_bridge_appservice_irc_data_path }},dst=/data
--entrypoint=/bin/sh
{{ matrix_appservice_irc_container_image }}
{{ matrix_bridge_appservice_irc_container_image }}
-c
'/usr/local/bin/node /app/lib/scripts/migrate-db-to-pgres.js --dbdir /data --privateKey /data/passkey.pem --connectionString {{ matrix_appservice_irc_database_connection_string }}'
register: matrix_appservice_irc_import_nedb_to_postgres_result
changed_when: matrix_appservice_irc_import_nedb_to_postgres_result.rc == 0
'/usr/local/bin/node /app/lib/scripts/migrate-db-to-pgres.js --dbdir /data --privateKey /data/passkey.pem --connectionString {{ matrix_bridge_appservice_irc_database_connection_string }}'
register: matrix_bridge_appservice_irc_import_nedb_to_postgres_result
changed_when: matrix_bridge_appservice_irc_import_nedb_to_postgres_result.rc == 0
- name: Archive NeDB database files
ansible.builtin.command:
cmd: "mv {{ matrix_appservice_irc_data_path }}/{{ item }} {{ matrix_appservice_irc_data_path }}/{{ item }}.backup"
cmd: "mv {{ matrix_bridge_appservice_irc_data_path }}/{{ item }} {{ matrix_bridge_appservice_irc_data_path }}/{{ item }}.backup"
with_items:
- rooms.db
- users.db
register: matrix_appservice_irc_import_nedb_to_postgres_move_result
changed_when: matrix_appservice_irc_import_nedb_to_postgres_move_result.rc == 0
register: matrix_bridge_appservice_irc_import_nedb_to_postgres_move_result
changed_when: matrix_bridge_appservice_irc_import_nedb_to_postgres_move_result.rc == 0
- name: Inject result
ansible.builtin.set_fact:
@@ -80,6 +80,6 @@
devture_playbook_runtime_messages_list | default([])
+
[
"Note: Your appservice-irc database files have been imported into Postgres. The original database files have been moved from `" + matrix_appservice_irc_data_path + "/*.db` to `" + matrix_appservice_irc_data_path + "/*.db.backup`. When you've confirmed that the import went well and everything works, you should be able to safely delete these files."
"Note: Your appservice-irc database files have been imported into Postgres. The original database files have been moved from `" + matrix_bridge_appservice_irc_data_path + "/*.db` to `" + matrix_bridge_appservice_irc_data_path + "/*.db.backup`. When you've confirmed that the import went well and everything works, you should be able to safely delete these files."
]
}}
@@ -26,18 +26,18 @@
owner: "{{ matrix_user_name }}"
group: "{{ matrix_group_name }}"
with_items:
- {path: "{{ matrix_appservice_irc_base_path }}", when: true}
- {path: "{{ matrix_appservice_irc_config_path }}", when: true}
- {path: "{{ matrix_appservice_irc_data_path }}", when: true}
- {path: "{{ matrix_appservice_irc_container_src_files_path }}", when: "{{ matrix_appservice_irc_container_image_self_build }}"}
- {path: "{{ matrix_bridge_appservice_irc_base_path }}", when: true}
- {path: "{{ matrix_bridge_appservice_irc_config_path }}", when: true}
- {path: "{{ matrix_bridge_appservice_irc_data_path }}", when: true}
- {path: "{{ matrix_bridge_appservice_irc_container_src_files_path }}", when: "{{ matrix_bridge_appservice_irc_container_image_self_build }}"}
when: item.when | bool
- name: Check if an old passkey file already exists
ansible.builtin.stat:
path: "{{ matrix_appservice_irc_base_path }}/passkey.pem"
register: matrix_appservice_irc_stat_passkey
path: "{{ matrix_bridge_appservice_irc_base_path }}/passkey.pem"
register: matrix_bridge_appservice_irc_stat_passkey
- when: "matrix_appservice_irc_stat_passkey.stat.exists"
- when: "matrix_bridge_appservice_irc_stat_passkey.stat.exists"
block:
- name: (Data relocation) Ensure matrix-appservice-irc.service is stopped
ansible.builtin.service:
@@ -48,104 +48,104 @@
- name: (Data relocation) Move AppService IRC passkey.pem file to ./data directory
ansible.builtin.command:
cmd: "mv {{ matrix_appservice_irc_base_path }}/passkey.pem {{ matrix_appservice_irc_data_path }}/passkey.pem"
register: matrix_appservice_irc_move_passkey_result
changed_when: matrix_appservice_irc_move_passkey_result.rc == 0
cmd: "mv {{ matrix_bridge_appservice_irc_base_path }}/passkey.pem {{ matrix_bridge_appservice_irc_data_path }}/passkey.pem"
register: matrix_bridge_appservice_irc_move_passkey_result
changed_when: matrix_bridge_appservice_irc_move_passkey_result.rc == 0
- name: (Data relocation) Move AppService IRC database files to ./data directory
ansible.builtin.command:
cmd: "mv {{ matrix_appservice_irc_base_path }}/{{ item }} {{ matrix_appservice_irc_data_path }}/{{ item }}"
register: matrix_appservice_irc_move_dbs_result
changed_when: matrix_appservice_irc_move_dbs_result.rc == 0
cmd: "mv {{ matrix_bridge_appservice_irc_base_path }}/{{ item }} {{ matrix_bridge_appservice_irc_data_path }}/{{ item }}"
register: matrix_bridge_appservice_irc_move_dbs_result
changed_when: matrix_bridge_appservice_irc_move_dbs_result.rc == 0
with_items:
- rooms.db
- users.db
failed_when: false
- ansible.builtin.set_fact:
matrix_appservice_irc_migration_requires_restart: false
matrix_bridge_appservice_irc_migration_requires_restart: false
- when: "matrix_appservice_irc_database_engine == 'postgres'"
- when: "matrix_bridge_appservice_irc_database_engine == 'postgres'"
block:
- name: Check if a nedb database already exists
ansible.builtin.stat:
path: "{{ matrix_appservice_irc_data_path }}/users.db"
register: matrix_appservice_irc_nedb_database_path_local_stat_result
path: "{{ matrix_bridge_appservice_irc_data_path }}/users.db"
register: matrix_bridge_appservice_irc_nedb_database_path_local_stat_result
- when: "matrix_appservice_irc_nedb_database_path_local_stat_result.stat.exists | bool"
- when: "matrix_bridge_appservice_irc_nedb_database_path_local_stat_result.stat.exists | bool"
block:
- ansible.builtin.include_tasks: "{{ role_path }}/tasks/migrate_nedb_to_postgres.yml"
- ansible.builtin.set_fact:
matrix_appservice_irc_migration_requires_restart: true
matrix_bridge_appservice_irc_migration_requires_restart: true
- name: Ensure Appservice IRC image is pulled
community.docker.docker_image_pull:
name: "{{ matrix_appservice_irc_container_image }}"
name: "{{ matrix_bridge_appservice_irc_container_image }}"
pull: always
when: "matrix_appservice_irc_enabled | bool and not matrix_appservice_irc_container_image_self_build | bool"
register: matrix_appservice_irc_container_image_pull_result
when: "matrix_bridge_appservice_irc_enabled | bool and not matrix_bridge_appservice_irc_container_image_self_build | bool"
register: matrix_bridge_appservice_irc_container_image_pull_result
retries: "{{ devture_playbook_help_container_retries_count }}"
delay: "{{ devture_playbook_help_container_retries_delay }}"
until: matrix_appservice_irc_container_image_pull_result is not failed
until: matrix_bridge_appservice_irc_container_image_pull_result is not failed
- name: Ensure matrix-appservice-irc repository is present when self-building
ansible.builtin.git:
repo: "{{ matrix_appservice_irc_container_repo }}"
version: "{{ matrix_appservice_irc_container_repo_version }}"
dest: "{{ matrix_appservice_irc_container_src_files_path }}"
repo: "{{ matrix_bridge_appservice_irc_container_repo }}"
version: "{{ matrix_bridge_appservice_irc_container_repo_version }}"
dest: "{{ matrix_bridge_appservice_irc_container_src_files_path }}"
force: "yes"
become: true
become_user: "{{ matrix_user_name }}"
register: matrix_appservice_irc_git_pull_results
when: "matrix_appservice_irc_enabled | bool and matrix_appservice_irc_container_image_self_build | bool"
register: matrix_bridge_appservice_irc_git_pull_results
when: "matrix_bridge_appservice_irc_enabled | bool and matrix_bridge_appservice_irc_container_image_self_build | bool"
- name: Ensure matrix-appservice-irc Docker image is built
community.docker.docker_image_build:
name: "{{ matrix_appservice_irc_container_image }}"
name: "{{ matrix_bridge_appservice_irc_container_image }}"
dockerfile: Dockerfile
path: "{{ matrix_appservice_irc_container_src_files_path }}"
path: "{{ matrix_bridge_appservice_irc_container_src_files_path }}"
pull: true
rebuild: "{{ 'always' if matrix_appservice_irc_git_pull_results.changed | bool else 'never' }}"
when: "matrix_appservice_irc_enabled | bool and matrix_appservice_irc_container_image_self_build | bool and matrix_appservice_irc_git_pull_results.changed"
register: matrix_appservice_irc_container_image_build_result
rebuild: "{{ 'always' if matrix_bridge_appservice_irc_git_pull_results.changed | bool else 'never' }}"
when: "matrix_bridge_appservice_irc_enabled | bool and matrix_bridge_appservice_irc_container_image_self_build | bool and matrix_bridge_appservice_irc_git_pull_results.changed"
register: matrix_bridge_appservice_irc_container_image_build_result
- name: Ensure Matrix Appservice IRC config installed
ansible.builtin.copy:
content: "{{ matrix_appservice_irc_configuration | to_nice_yaml(indent=2, width=999999) }}"
dest: "{{ matrix_appservice_irc_config_path }}/config.yaml"
content: "{{ matrix_bridge_appservice_irc_configuration | to_nice_yaml(indent=2, width=999999) }}"
dest: "{{ matrix_bridge_appservice_irc_config_path }}/config.yaml"
mode: '0644'
owner: "{{ matrix_user_name }}"
group: "{{ matrix_group_name }}"
register: matrix_appservice_irc_config_result
register: matrix_bridge_appservice_irc_config_result
- name: Ensure Matrix Appservice IRC labels file installed
ansible.builtin.template:
src: "{{ role_path }}/templates/labels.j2"
dest: "{{ matrix_appservice_irc_base_path }}/labels"
dest: "{{ matrix_bridge_appservice_irc_base_path }}/labels"
mode: '0644'
owner: "{{ matrix_user_name }}"
group: "{{ matrix_group_name }}"
register: matrix_appservice_irc_labels_result
register: matrix_bridge_appservice_irc_labels_result
- name: Generate Appservice IRC passkey if it doesn't exist
ansible.builtin.shell:
cmd: "{{ matrix_host_command_openssl }} genpkey -out {{ matrix_appservice_irc_data_path }}/passkey.pem -outform PEM -algorithm RSA -pkeyopt rsa_keygen_bits:2048"
creates: "{{ matrix_appservice_irc_data_path }}/passkey.pem"
cmd: "{{ matrix_host_command_openssl }} genpkey -out {{ matrix_bridge_appservice_irc_data_path }}/passkey.pem -outform PEM -algorithm RSA -pkeyopt rsa_keygen_bits:2048"
creates: "{{ matrix_bridge_appservice_irc_data_path }}/passkey.pem"
become: true
become_user: "{{ matrix_user_name }}"
- name: Check if an authenticated media signing key exists
ansible.builtin.stat:
path: "{{ matrix_appservice_irc_data_path }}/auth-media.jwk"
register: matrix_appservice_irc_stat_auth_media_key
path: "{{ matrix_bridge_appservice_irc_data_path }}/auth-media.jwk"
register: matrix_bridge_appservice_irc_stat_auth_media_key
- when: not matrix_appservice_irc_stat_auth_media_key.stat.exists
- when: not matrix_bridge_appservice_irc_stat_auth_media_key.stat.exists
block:
- name: Generate IRC appservice signing key for authenticated media
community.docker.docker_container:
name: "create-auth-media-jwk-key"
image: "{{ matrix_appservice_irc_container_image }}"
image: "{{ matrix_bridge_appservice_irc_container_image }}"
cleanup: true
network_mode: none
entrypoint: "/usr/local/bin/node"
@@ -160,12 +160,12 @@
}
main().then(() => process.exit(0)).catch(err => { throw err });"
detach: false
register: matrix_appservice_irc_jwk_result
register: matrix_bridge_appservice_irc_jwk_result
- name: Write auth media signing key to file
ansible.builtin.copy:
content: "{{ matrix_appservice_irc_jwk_result.container.Output }}"
dest: "{{ matrix_appservice_irc_data_path }}/auth-media.jwk"
content: "{{ matrix_bridge_appservice_irc_jwk_result.container.Output }}"
dest: "{{ matrix_bridge_appservice_irc_data_path }}/auth-media.jwk"
mode: "0644"
owner: "{{ matrix_user_name }}"
group: "{{ matrix_group_name }}"
@@ -174,7 +174,7 @@
# Fix it.
- name: (Migration) Ensure Appservice IRC passkey permissions are okay
ansible.builtin.file:
path: "{{ matrix_appservice_irc_data_path }}/passkey.pem"
path: "{{ matrix_bridge_appservice_irc_data_path }}/passkey.pem"
mode: '0644'
owner: "{{ matrix_user_name }}"
group: "{{ matrix_group_name }}"
@@ -203,10 +203,10 @@
{{ devture_systemd_docker_base_host_command_docker }} run --rm --name matrix-appservice-irc-gen
--user={{ matrix_user_uid }}:{{ matrix_user_gid }}
--cap-drop=ALL
--mount type=bind,src={{ matrix_appservice_irc_config_path }},dst=/config
--mount type=bind,src={{ matrix_appservice_irc_data_path }},dst=/data
--mount type=bind,src={{ matrix_bridge_appservice_irc_config_path }},dst=/config
--mount type=bind,src={{ matrix_bridge_appservice_irc_data_path }},dst=/data
--entrypoint=/bin/bash
{{ matrix_appservice_irc_container_image }}
{{ matrix_bridge_appservice_irc_container_image }}
-c
'node app.js
-r
@@ -218,37 +218,37 @@
- name: Read Appservice IRC registration-template.yaml
ansible.builtin.slurp:
src: "{{ matrix_appservice_irc_config_path }}/registration-template.yaml"
register: matrix_appservice_irc_registration_template_slurp
src: "{{ matrix_bridge_appservice_irc_config_path }}/registration-template.yaml"
register: matrix_bridge_appservice_irc_registration_template_slurp
- name: Remove unnecessary Appservice IRC registration-template.yaml
ansible.builtin.file:
path: "{{ matrix_appservice_irc_config_path }}/registration-template.yaml"
path: "{{ matrix_bridge_appservice_irc_config_path }}/registration-template.yaml"
state: absent
changed_when: false
- name: Parse registration-template.yaml
ansible.builtin.set_fact:
matrix_appservice_irc_registration_template: "{{ matrix_appservice_irc_registration_template_slurp['content'] | b64decode | from_yaml }}"
matrix_bridge_appservice_irc_registration_template: "{{ matrix_bridge_appservice_irc_registration_template_slurp['content'] | b64decode | from_yaml }}"
- name: Combine registration-template.yaml and own registration override config
ansible.builtin.set_fact:
matrix_appservice_irc_registration: "{{ matrix_appservice_irc_registration_template | combine(matrix_appservice_irc_registration_override, recursive=True) }}"
matrix_bridge_appservice_irc_registration: "{{ matrix_bridge_appservice_irc_registration_template | combine(matrix_bridge_appservice_irc_registration_override, recursive=True) }}"
- name: Ensure Appservice IRC registration.yaml installed
ansible.builtin.copy:
content: "{{ matrix_appservice_irc_registration | to_nice_yaml(indent=2, width=999999) }}"
dest: "{{ matrix_appservice_irc_config_path }}/registration.yaml"
content: "{{ matrix_bridge_appservice_irc_registration | to_nice_yaml(indent=2, width=999999) }}"
dest: "{{ matrix_bridge_appservice_irc_config_path }}/registration.yaml"
mode: '0644'
owner: "{{ matrix_user_name }}"
group: "{{ matrix_group_name }}"
register: matrix_appservice_irc_registration_result
register: matrix_bridge_appservice_irc_registration_result
- name: Ensure matrix-appservice-irc container network is created
when: matrix_appservice_irc_container_network != 'host'
when: matrix_bridge_appservice_irc_container_network != 'host'
community.general.docker_network:
enable_ipv6: "{{ devture_systemd_docker_base_ipv6_enabled }}"
name: "{{ matrix_appservice_irc_container_network }}"
name: "{{ matrix_bridge_appservice_irc_container_network }}"
driver: bridge
driver_options: "{{ devture_systemd_docker_base_container_networks_driver_options }}"
@@ -257,19 +257,19 @@
src: "{{ role_path }}/templates/systemd/matrix-appservice-irc.service.j2"
dest: "{{ devture_systemd_docker_base_systemd_path }}/matrix-appservice-irc.service"
mode: '0644'
register: matrix_appservice_irc_systemd_service_result
register: matrix_bridge_appservice_irc_systemd_service_result
- name: Determine whether matrix-appservice-irc needs a restart
ansible.builtin.set_fact:
matrix_appservice_irc_restart_necessary: >-
matrix_bridge_appservice_irc_restart_necessary: >-
{{
matrix_appservice_irc_migration_requires_restart | default(false)
or matrix_appservice_irc_config_result.changed | default(false)
or matrix_appservice_irc_labels_result.changed | default(false)
or matrix_appservice_irc_registration_result.changed | default(false)
or matrix_appservice_irc_systemd_service_result.changed | default(false)
or matrix_appservice_irc_container_image_pull_result.changed | default(false)
or matrix_appservice_irc_container_image_build_result.changed | default(false)
matrix_bridge_appservice_irc_migration_requires_restart | default(false)
or matrix_bridge_appservice_irc_config_result.changed | default(false)
or matrix_bridge_appservice_irc_labels_result.changed | default(false)
or matrix_bridge_appservice_irc_registration_result.changed | default(false)
or matrix_bridge_appservice_irc_systemd_service_result.changed | default(false)
or matrix_bridge_appservice_irc_container_image_pull_result.changed | default(false)
or matrix_bridge_appservice_irc_container_image_build_result.changed | default(false)
}}
- name: Ensure matrix-appservice-irc.service restarted, if necessary
@@ -277,4 +277,4 @@
name: "matrix-appservice-irc.service"
state: restarted
daemon_reload: true
when: "matrix_appservice_irc_migration_requires_restart | bool"
when: "matrix_bridge_appservice_irc_migration_requires_restart | bool"
@@ -9,9 +9,9 @@
- name: Check existence of matrix-appservice-irc service
ansible.builtin.stat:
path: "{{ devture_systemd_docker_base_systemd_path }}/matrix-appservice-irc.service"
register: matrix_appservice_irc_service_stat
register: matrix_bridge_appservice_irc_service_stat
- when: matrix_appservice_irc_service_stat.stat.exists | bool
- when: matrix_bridge_appservice_irc_service_stat.stat.exists | bool
block:
- name: Ensure matrix-appservice-irc is stopped
ansible.builtin.service:
@@ -13,20 +13,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_appservice_irc_container_expose_client_server_api_port', 'new': '<superseded by matrix_appservice_irc_container_http_host_bind_port>'}
- {'old': 'matrix_appservice_irc_container_self_build', 'new': 'matrix_appservice_irc_container_image_self_build'}
- {'old': 'matrix_appservice_irc_docker_image_name_prefix', 'new': 'matrix_appservice_irc_container_image_registry_prefix'}
- {'old': 'matrix_appservice_irc_homeserver_media_url', 'new': '<removed; media proxying now uses matrix_appservice_irc_ircService_mediaProxy_publicUrl>'}
- {'old': 'matrix_appservice_irc_docker_image', 'new': 'matrix_appservice_irc_container_image'}
- {'old': 'matrix_appservice_irc_docker_image_force_pull', 'new': 'matrix_appservice_irc_container_image_force_pull'}
- {'old': 'matrix_appservice_irc_docker_image_registry_prefix', 'new': 'matrix_appservice_irc_container_image_registry_prefix'}
- {'old': 'matrix_appservice_irc_docker_image_registry_prefix_upstream', 'new': 'matrix_appservice_irc_container_image_registry_prefix_upstream'}
- {'old': 'matrix_appservice_irc_docker_image_registry_prefix_upstream_default', 'new': 'matrix_appservice_irc_container_image_registry_prefix_upstream_default'}
- {'old': 'matrix_appservice_irc_docker_image_tag', 'new': 'matrix_appservice_irc_container_image_tag'}
- {'old': 'matrix_appservice_irc_docker_repo', 'new': 'matrix_appservice_irc_container_repo'}
- {'old': 'matrix_appservice_irc_docker_repo_version', 'new': 'matrix_appservice_irc_container_repo_version'}
- {'old': 'matrix_appservice_irc_docker_src_files_path', 'new': 'matrix_appservice_irc_container_src_files_path'}
- {'old': 'matrix_appservice_irc_container_image_force_pull', 'new': '<removed> (the new community.docker.docker_image_pull module handles this natively)'}
- {'old': 'matrix_bridge_appservice_irc_container_expose_client_server_api_port', 'new': '<superseded by matrix_bridge_appservice_irc_container_http_host_bind_port>'}
- {'old': 'matrix_bridge_appservice_irc_container_self_build', 'new': 'matrix_bridge_appservice_irc_container_image_self_build'}
- {'old': 'matrix_bridge_appservice_irc_docker_image_name_prefix', 'new': 'matrix_bridge_appservice_irc_container_image_registry_prefix'}
- {'old': 'matrix_bridge_appservice_irc_homeserver_media_url', 'new': '<removed; media proxying now uses matrix_bridge_appservice_irc_ircService_mediaProxy_publicUrl>'}
- {'old': 'matrix_bridge_appservice_irc_docker_image', 'new': 'matrix_bridge_appservice_irc_container_image'}
- {'old': 'matrix_bridge_appservice_irc_docker_image_force_pull', 'new': 'matrix_bridge_appservice_irc_container_image_force_pull'}
- {'old': 'matrix_bridge_appservice_irc_docker_image_registry_prefix', 'new': 'matrix_bridge_appservice_irc_container_image_registry_prefix'}
- {'old': 'matrix_bridge_appservice_irc_docker_image_registry_prefix_upstream', 'new': 'matrix_bridge_appservice_irc_container_image_registry_prefix_upstream'}
- {'old': 'matrix_bridge_appservice_irc_docker_image_registry_prefix_upstream_default', 'new': 'matrix_bridge_appservice_irc_container_image_registry_prefix_upstream_default'}
- {'old': 'matrix_bridge_appservice_irc_docker_image_tag', 'new': 'matrix_bridge_appservice_irc_container_image_tag'}
- {'old': 'matrix_bridge_appservice_irc_docker_repo', 'new': 'matrix_bridge_appservice_irc_container_repo'}
- {'old': 'matrix_bridge_appservice_irc_docker_repo_version', 'new': 'matrix_bridge_appservice_irc_container_repo_version'}
- {'old': 'matrix_bridge_appservice_irc_docker_src_files_path', 'new': 'matrix_bridge_appservice_irc_container_src_files_path'}
- {'old': 'matrix_bridge_appservice_irc_container_image_force_pull', 'new': '<removed> (the new community.docker.docker_image_pull module handles this natively)'}
- name: Fail if required appservice-irc settings not defined
ansible.builtin.fail:
@@ -34,16 +34,16 @@
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_appservice_irc_appservice_token', when: true}
- {'name': 'matrix_appservice_irc_homeserver_url', when: true}
- {'name': 'matrix_appservice_irc_homeserver_token', when: true}
- {'name': 'matrix_appservice_irc_database_hostname', when: "{{ matrix_appservice_irc_database_engine == 'postgres' }}"}
- {'name': 'matrix_appservice_irc_container_network', when: true}
- {'name': 'matrix_bridge_appservice_irc_appservice_token', when: true}
- {'name': 'matrix_bridge_appservice_irc_homeserver_url', when: true}
- {'name': 'matrix_bridge_appservice_irc_homeserver_token', when: true}
- {'name': 'matrix_bridge_appservice_irc_database_hostname', when: "{{ matrix_bridge_appservice_irc_database_engine == 'postgres' }}"}
- {'name': 'matrix_bridge_appservice_irc_container_network', when: true}
# Our base configuration (`matrix_appservice_irc_configuration_yaml`) is not enough to
# Our base configuration (`matrix_bridge_appservice_irc_configuration_yaml`) is not enough to
# let the playbook run without errors.
#
# Unless the final configuration (`matrix_appservice_irc_configuration`) contains an `ircService` definition,
# Unless the final configuration (`matrix_bridge_appservice_irc_configuration`) contains an `ircService` definition,
# we'd fail generating the registration.yaml file with a non-helpful error.
#
# This is a safety check to ensure we fail earlier and in a nicer way.
@@ -52,30 +52,30 @@
ansible.builtin.fail:
msg: >-
Your Appservice IRC configuration is incomplete (lacking an `ircService.servers` configuration).
You need to define one or more servers by either using `matrix_appservice_irc_ircService_servers`
or by extending the base configuration with additional configuration in `matrix_appservice_irc_configuration_extension_yaml`.
Overriding the whole bridge's configuration (`matrix_appservice_irc_configuration`) is yet another possibility.
when: "matrix_appservice_irc_configuration.ircService.servers | length == 0"
You need to define one or more servers by either using `matrix_bridge_appservice_irc_ircService_servers`
or by extending the base configuration with additional configuration in `matrix_bridge_appservice_irc_configuration_extension_yaml`.
Overriding the whole bridge's configuration (`matrix_bridge_appservice_irc_configuration`) is yet another possibility.
when: "matrix_bridge_appservice_irc_configuration.ircService.servers | length == 0"
- name: Fail if matrix_appservice_irc_ircService_mediaProxy_publicUrl_pathPrefix does not start with a slash
- name: Fail if matrix_bridge_appservice_irc_ircService_mediaProxy_publicUrl_pathPrefix does not start with a slash
ansible.builtin.fail:
msg: >-
matrix_appservice_irc_ircService_mediaProxy_publicUrl_pathPrefix (`{{ matrix_appservice_irc_ircService_mediaProxy_publicUrl_pathPrefix }}`) must start with a slash (e.g. `/` or `/irc/`).
when: "matrix_appservice_irc_ircService_mediaProxy_publicUrl_pathPrefix[0] != '/'"
matrix_bridge_appservice_irc_ircService_mediaProxy_publicUrl_pathPrefix (`{{ matrix_bridge_appservice_irc_ircService_mediaProxy_publicUrl_pathPrefix }}`) must start with a slash (e.g. `/` or `/irc/`).
when: "matrix_bridge_appservice_irc_ircService_mediaProxy_publicUrl_pathPrefix[0] != '/'"
- name: Fail if matrix_appservice_irc_ircService_mediaProxy_publicUrl_pathPrefix does not end with a slash
- name: Fail if matrix_bridge_appservice_irc_ircService_mediaProxy_publicUrl_pathPrefix does not end with a slash
ansible.builtin.fail:
msg: >-
matrix_appservice_irc_ircService_mediaProxy_publicUrl_pathPrefix (`{{ matrix_appservice_irc_ircService_mediaProxy_publicUrl_pathPrefix }}`) must end with a slash (e.g. `/` or `/irc/`).
when: "matrix_appservice_irc_ircService_mediaProxy_publicUrl_pathPrefix[-1] != '/'"
matrix_bridge_appservice_irc_ircService_mediaProxy_publicUrl_pathPrefix (`{{ matrix_bridge_appservice_irc_ircService_mediaProxy_publicUrl_pathPrefix }}`) must end with a slash (e.g. `/` or `/irc/`).
when: "matrix_bridge_appservice_irc_ircService_mediaProxy_publicUrl_pathPrefix[-1] != '/'"
- when: matrix_appservice_irc_container_labels_traefik_enabled | bool
- when: matrix_bridge_appservice_irc_container_labels_traefik_enabled | bool
block:
# We ensure it doesn't end with a slash, because we handle both (slash and no-slash).
# Knowing that the path_prefix does not end with a slash ensures we know how to set these routes up
# without having to do "does it end with a slash" checks elsewhere.
- name: Fail if matrix_appservice_irc_container_labels_media_proxy_traefik_path_prefix ends with a slash
- name: Fail if matrix_bridge_appservice_irc_container_labels_media_proxy_traefik_path_prefix ends with a slash
ansible.builtin.fail:
msg: >-
matrix_appservice_irc_container_labels_media_proxy_traefik_path_prefix (`{{ matrix_appservice_irc_container_labels_media_proxy_traefik_path_prefix }}`) must either be `/` or not end with a slash (e.g. `/irc`).
when: "matrix_appservice_irc_container_labels_media_proxy_traefik_path_prefix != '/' and matrix_appservice_irc_container_labels_media_proxy_traefik_path_prefix[-1] == '/'"
matrix_bridge_appservice_irc_container_labels_media_proxy_traefik_path_prefix (`{{ matrix_bridge_appservice_irc_container_labels_media_proxy_traefik_path_prefix }}`) must either be `/` or not end with a slash (e.g. `/irc`).
when: "matrix_bridge_appservice_irc_container_labels_media_proxy_traefik_path_prefix != '/' and matrix_bridge_appservice_irc_container_labels_media_proxy_traefik_path_prefix[-1] == '/'"