diff --git a/docs/configuring-playbook-bridge-heisenbridge.md b/docs/configuring-playbook-bridge-heisenbridge.md index 552a90635..746e03d57 100644 --- a/docs/configuring-playbook-bridge-heisenbridge.md +++ b/docs/configuring-playbook-bridge-heisenbridge.md @@ -25,26 +25,26 @@ If you wish to adjust it, see the section [below](#adjusting-the-heisenbridge-ur To enable Heisenbridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file: ```yaml -matrix_heisenbridge_enabled: true +matrix_bridge_heisenbridge_enabled: true # Setting the owner is optional as the first local user to DM `@heisenbridge:example.com` will be made the owner. # If you are not using a local user you must set it as otherwise you can't DM it at all. -matrix_heisenbridge_owner: "@alice:{{ matrix_domain }}" +matrix_bridge_heisenbridge_owner: "@alice:{{ matrix_domain }}" # Uncomment to enable identd on host port 113/TCP (optional) -# matrix_heisenbridge_identd_enabled: true +# matrix_bridge_heisenbridge_identd_enabled: true ``` ### Adjusting the Heisenbridge URL (optional) -By tweaking the `matrix_heisenbridge_hostname` and `matrix_heisenbridge_path_prefix` variables, you can easily make the service available at a **different hostname and/or path** than the default one. +By tweaking the `matrix_bridge_heisenbridge_hostname` and `matrix_bridge_heisenbridge_path_prefix` variables, you can easily make the service available at a **different hostname and/or path** than the default one. Example additional configuration for your `vars.yml` file: ```yaml # Change the default hostname and path prefix -matrix_heisenbridge_hostname: heisenbridge.example.com -matrix_heisenbridge_path_prefix: / +matrix_bridge_heisenbridge_hostname: heisenbridge.example.com +matrix_bridge_heisenbridge_path_prefix: / ``` If you've changed the default hostname, you may need to create a CNAME record for the Heisenbridge domain (`heisenbridge.example.com`), which targets `matrix.example.com`. diff --git a/group_vars/matrix_servers b/group_vars/matrix_servers index 081eb4e9b..ca83fb45b 100755 --- a/group_vars/matrix_servers +++ b/group_vars/matrix_servers @@ -106,7 +106,7 @@ matrix_homeserver_container_extra_arguments_auto: | + (['--mount type=bind,src=' + matrix_wechat_config_path + '/registration.yaml,dst=/matrix-wechat-registration.yaml,ro'] if matrix_wechat_enabled else []) + - (['--mount type=bind,src=' + matrix_heisenbridge_base_path + '/registration.yaml,dst=/heisenbridge-registration.yaml,ro'] if matrix_heisenbridge_enabled else []) + (['--mount type=bind,src=' + matrix_bridge_heisenbridge_base_path + '/registration.yaml,dst=/heisenbridge-registration.yaml,ro'] if matrix_bridge_heisenbridge_enabled else []) + (['--mount type=bind,src=' + matrix_hookshot_base_path + '/registration.yml,dst=/hookshot-registration.yml,ro'] if matrix_hookshot_enabled else []) + @@ -165,7 +165,7 @@ matrix_homeserver_app_service_config_files_auto: | + (['/matrix-wechat-registration.yaml'] if matrix_wechat_enabled else []) + - (['/heisenbridge-registration.yaml'] if matrix_heisenbridge_enabled else []) + (['/heisenbridge-registration.yaml'] if matrix_bridge_heisenbridge_enabled else []) + (['/hookshot-registration.yml'] if matrix_hookshot_enabled else []) + @@ -394,9 +394,9 @@ devture_systemd_service_manager_services_list_auto: | ([{ 'name': 'matrix-heisenbridge.service', 'priority': 2000, - 'restart_necessary': (matrix_heisenbridge_restart_necessary | bool), + 'restart_necessary': (matrix_bridge_heisenbridge_restart_necessary | bool), 'groups': ['matrix', 'bridges', 'heisenbridge'], - }] if matrix_heisenbridge_enabled else []) + }] if matrix_bridge_heisenbridge_enabled else []) + ([{ 'name': 'matrix-hookshot.service', @@ -2521,38 +2521,38 @@ matrix_sms_bridge_homeserver_token: "{{ (matrix_homeserver_generic_secret_key + ###################################################################### # We don't enable bridges by default. -matrix_heisenbridge_enabled: false +matrix_bridge_heisenbridge_enabled: false -matrix_heisenbridge_scheme: "{{ 'https' if matrix_playbook_ssl_enabled else 'http' }}" +matrix_bridge_heisenbridge_scheme: "{{ 'https' if matrix_playbook_ssl_enabled else 'http' }}" -matrix_heisenbridge_systemd_required_services_list_auto: | +matrix_bridge_heisenbridge_systemd_required_services_list_auto: | {{ matrix_addons_homeserver_systemd_services_list }} -matrix_heisenbridge_container_image_registry_prefix_upstream: "{{ matrix_container_global_registry_prefix_override if matrix_container_global_registry_prefix_override else matrix_heisenbridge_container_image_registry_prefix_upstream_default }}" +matrix_bridge_heisenbridge_container_image_registry_prefix_upstream: "{{ matrix_container_global_registry_prefix_override if matrix_container_global_registry_prefix_override else matrix_bridge_heisenbridge_container_image_registry_prefix_upstream_default }}" -matrix_heisenbridge_container_network: "{{ matrix_addons_container_network }}" +matrix_bridge_heisenbridge_container_network: "{{ matrix_addons_container_network }}" -matrix_heisenbridge_container_additional_networks_auto: |- +matrix_bridge_heisenbridge_container_additional_networks_auto: |- {{ ( ([] if matrix_addons_homeserver_container_network == '' else [matrix_addons_homeserver_container_network]) + - [matrix_playbook_reverse_proxyable_services_additional_network] if (matrix_heisenbridge_container_labels_traefik_enabled and matrix_playbook_reverse_proxyable_services_additional_network) else [] + [matrix_playbook_reverse_proxyable_services_additional_network] if (matrix_bridge_heisenbridge_container_labels_traefik_enabled and matrix_playbook_reverse_proxyable_services_additional_network) else [] ) | unique }} -matrix_heisenbridge_container_labels_traefik_enabled: "{{ matrix_playbook_reverse_proxy_type in ['playbook-managed-traefik', 'other-traefik-container'] }}" -matrix_heisenbridge_container_labels_traefik_docker_network: "{{ matrix_playbook_reverse_proxyable_services_additional_network }}" -matrix_heisenbridge_container_labels_traefik_entrypoints: "{{ traefik_entrypoint_primary }}" -matrix_heisenbridge_container_labels_traefik_tls_certResolver: "{{ traefik_certResolver_primary }}" +matrix_bridge_heisenbridge_container_labels_traefik_enabled: "{{ matrix_playbook_reverse_proxy_type in ['playbook-managed-traefik', 'other-traefik-container'] }}" +matrix_bridge_heisenbridge_container_labels_traefik_docker_network: "{{ matrix_playbook_reverse_proxyable_services_additional_network }}" +matrix_bridge_heisenbridge_container_labels_traefik_entrypoints: "{{ traefik_entrypoint_primary }}" +matrix_bridge_heisenbridge_container_labels_traefik_tls_certResolver: "{{ traefik_certResolver_primary }}" -matrix_heisenbridge_appservice_token: "{{ (matrix_homeserver_generic_secret_key + ':heisen.as.tok') | hash('sha512') | to_uuid }}" +matrix_bridge_heisenbridge_appservice_token: "{{ (matrix_homeserver_generic_secret_key + ':heisen.as.tok') | hash('sha512') | to_uuid }}" -matrix_heisenbridge_homeserver_token: "{{ (matrix_homeserver_generic_secret_key + ':heisen.hs.tok') | hash('sha512') | to_uuid }}" +matrix_bridge_heisenbridge_homeserver_token: "{{ (matrix_homeserver_generic_secret_key + ':heisen.hs.tok') | hash('sha512') | to_uuid }}" -matrix_heisenbridge_homeserver_url: "{{ matrix_addons_homeserver_client_api_url }}" +matrix_bridge_heisenbridge_homeserver_url: "{{ matrix_addons_homeserver_client_api_url }}" ###################################################################### # @@ -5110,7 +5110,7 @@ matrix_ketesa_config_asManagedUsers_auto: | ([ '^@heisenbridge:'+(matrix_domain | regex_escape)+'$', '^@hbirc_[a-zA-Z0-9]+:'+(matrix_domain | regex_escape)+'$', - ] if matrix_heisenbridge_enabled else []) + ] if matrix_bridge_heisenbridge_enabled else []) + ([ '^@hookshot:'+(matrix_domain | regex_escape)+'$', diff --git a/roles/custom/matrix-bridge-heisenbridge/defaults/main.yml b/roles/custom/matrix-bridge-heisenbridge/defaults/main.yml index 5f3586dff..73306c13e 100644 --- a/roles/custom/matrix-bridge-heisenbridge/defaults/main.yml +++ b/roles/custom/matrix-bridge-heisenbridge/defaults/main.yml @@ -12,105 +12,105 @@ # Heisenbridge is a bouncer-style Matrix IRC bridge # Project source code URL: https://github.com/hifi/heisenbridge -matrix_heisenbridge_enabled: true +matrix_bridge_heisenbridge_enabled: true -matrix_heisenbridge_scheme: https -matrix_heisenbridge_hostname: "{{ matrix_server_fqn_matrix }}" -matrix_heisenbridge_path_prefix: "/heisenbridge" +matrix_bridge_heisenbridge_scheme: https +matrix_bridge_heisenbridge_hostname: "{{ matrix_server_fqn_matrix }}" +matrix_bridge_heisenbridge_path_prefix: "/heisenbridge" # renovate: datasource=docker depName=hif1/heisenbridge -matrix_heisenbridge_version: 1.15.4 -matrix_heisenbridge_container_image: "{{ matrix_heisenbridge_container_image_registry_prefix }}hif1/heisenbridge:{{ matrix_heisenbridge_version }}" -matrix_heisenbridge_container_image_registry_prefix: "{{ matrix_heisenbridge_container_image_registry_prefix_upstream }}" -matrix_heisenbridge_container_image_registry_prefix_upstream: "{{ matrix_heisenbridge_container_image_registry_prefix_upstream_default }}" -matrix_heisenbridge_container_image_registry_prefix_upstream_default: "docker.io/" +matrix_bridge_heisenbridge_version: 1.15.4 +matrix_bridge_heisenbridge_container_image: "{{ matrix_bridge_heisenbridge_container_image_registry_prefix }}hif1/heisenbridge:{{ matrix_bridge_heisenbridge_version }}" +matrix_bridge_heisenbridge_container_image_registry_prefix: "{{ matrix_bridge_heisenbridge_container_image_registry_prefix_upstream }}" +matrix_bridge_heisenbridge_container_image_registry_prefix_upstream: "{{ matrix_bridge_heisenbridge_container_image_registry_prefix_upstream_default }}" +matrix_bridge_heisenbridge_container_image_registry_prefix_upstream_default: "docker.io/" # Set this to your Matrix ID if you want to enforce the owner, otherwise first _local_ user becomes one -matrix_heisenbridge_owner: "" +matrix_bridge_heisenbridge_owner: "" # Enabling identd will bind to host port 113/TCP -matrix_heisenbridge_identd_enabled: false +matrix_bridge_heisenbridge_identd_enabled: false -matrix_heisenbridge_base_path: "{{ matrix_base_data_path }}/heisenbridge" +matrix_bridge_heisenbridge_base_path: "{{ matrix_base_data_path }}/heisenbridge" -matrix_heisenbridge_container_network: "" +matrix_bridge_heisenbridge_container_network: "" -matrix_heisenbridge_container_additional_networks: "{{ matrix_heisenbridge_container_additional_networks_auto + matrix_heisenbridge_container_additional_networks_custom }}" -matrix_heisenbridge_container_additional_networks_auto: [] -matrix_heisenbridge_container_additional_networks_custom: [] +matrix_bridge_heisenbridge_container_additional_networks: "{{ matrix_bridge_heisenbridge_container_additional_networks_auto + matrix_bridge_heisenbridge_container_additional_networks_custom }}" +matrix_bridge_heisenbridge_container_additional_networks_auto: [] +matrix_bridge_heisenbridge_container_additional_networks_custom: [] # Controls how long to wait for the container to stop gracefully before killing it. # We use a small value here, because this container does not seem to handle the SIGTERM signal. -matrix_heisenbridge_container_stop_grace_time_seconds: 1 +matrix_bridge_heisenbridge_container_stop_grace_time_seconds: 1 -# matrix_heisenbridge_container_labels_traefik_enabled controls whether labels to assist a Traefik reverse-proxy will be attached to the container. +# matrix_bridge_heisenbridge_container_labels_traefik_enabled controls whether labels to assist a Traefik reverse-proxy will be attached to the container. # See `../templates/labels.j2` for details. # -# To inject your own other container labels, see `matrix_heisenbridge_container_labels_additional_labels`. -matrix_heisenbridge_container_labels_traefik_enabled: true -matrix_heisenbridge_container_labels_traefik_docker_network: "{{ matrix_heisenbridge_container_network }}" -matrix_heisenbridge_container_labels_traefik_hostname: "{{ matrix_heisenbridge_hostname }}" -matrix_heisenbridge_container_labels_traefik_path_prefix: "{{ matrix_heisenbridge_path_prefix }}" -matrix_heisenbridge_container_labels_traefik_entrypoints: web-secure -matrix_heisenbridge_container_labels_traefik_tls_certResolver: default # noqa var-naming +# To inject your own other container labels, see `matrix_bridge_heisenbridge_container_labels_additional_labels`. +matrix_bridge_heisenbridge_container_labels_traefik_enabled: true +matrix_bridge_heisenbridge_container_labels_traefik_docker_network: "{{ matrix_bridge_heisenbridge_container_network }}" +matrix_bridge_heisenbridge_container_labels_traefik_hostname: "{{ matrix_bridge_heisenbridge_hostname }}" +matrix_bridge_heisenbridge_container_labels_traefik_path_prefix: "{{ matrix_bridge_heisenbridge_path_prefix }}" +matrix_bridge_heisenbridge_container_labels_traefik_entrypoints: web-secure +matrix_bridge_heisenbridge_container_labels_traefik_tls_certResolver: default # noqa var-naming # Controls if the media router is enabled -matrix_heisenbridge_container_labels_traefik_media_enabled: true -matrix_heisenbridge_container_labels_traefik_media_hostname: "{{ matrix_heisenbridge_container_labels_traefik_hostname }}" +matrix_bridge_heisenbridge_container_labels_traefik_media_enabled: true +matrix_bridge_heisenbridge_container_labels_traefik_media_hostname: "{{ matrix_bridge_heisenbridge_container_labels_traefik_hostname }}" # The path prefix must either be `/` or not end with a slash (e.g. `/heisenbridge`). -matrix_heisenbridge_container_labels_traefik_media_path_prefix: "{{ '' if matrix_heisenbridge_container_labels_traefik_path_prefix == '/' else (matrix_heisenbridge_container_labels_traefik_path_prefix) }}/_heisenbridge/media" -matrix_heisenbridge_container_labels_traefik_media_rule: "Host(`{{ matrix_heisenbridge_container_labels_traefik_media_hostname }}`){% if matrix_heisenbridge_container_labels_traefik_media_path_prefix != '/' %} && PathPrefix(`{{ matrix_heisenbridge_container_labels_traefik_media_path_prefix }}`){% endif %}" -matrix_heisenbridge_container_labels_traefik_media_priority: 0 -matrix_heisenbridge_container_labels_traefik_media_entrypoints: "{{ matrix_heisenbridge_container_labels_traefik_entrypoints }}" -matrix_heisenbridge_container_labels_traefik_media_tls: "{{ matrix_heisenbridge_container_labels_traefik_media_entrypoints != 'web' }}" -matrix_heisenbridge_container_labels_traefik_media_tls_certResolver: "{{ matrix_heisenbridge_container_labels_traefik_tls_certResolver }}" # noqa var-naming +matrix_bridge_heisenbridge_container_labels_traefik_media_path_prefix: "{{ '' if matrix_bridge_heisenbridge_container_labels_traefik_path_prefix == '/' else (matrix_bridge_heisenbridge_container_labels_traefik_path_prefix) }}/_heisenbridge/media" +matrix_bridge_heisenbridge_container_labels_traefik_media_rule: "Host(`{{ matrix_bridge_heisenbridge_container_labels_traefik_media_hostname }}`){% if matrix_bridge_heisenbridge_container_labels_traefik_media_path_prefix != '/' %} && PathPrefix(`{{ matrix_bridge_heisenbridge_container_labels_traefik_media_path_prefix }}`){% endif %}" +matrix_bridge_heisenbridge_container_labels_traefik_media_priority: 0 +matrix_bridge_heisenbridge_container_labels_traefik_media_entrypoints: "{{ matrix_bridge_heisenbridge_container_labels_traefik_entrypoints }}" +matrix_bridge_heisenbridge_container_labels_traefik_media_tls: "{{ matrix_bridge_heisenbridge_container_labels_traefik_media_entrypoints != 'web' }}" +matrix_bridge_heisenbridge_container_labels_traefik_media_tls_certResolver: "{{ matrix_bridge_heisenbridge_container_labels_traefik_tls_certResolver }}" # noqa var-naming -# matrix_heisenbridge_container_labels_additional_labels contains a multiline string with additional labels to add to the container label file. +# matrix_bridge_heisenbridge_container_labels_additional_labels contains a multiline string with additional labels to add to the container label file. # See `../templates/labels.j2` for details. # # Example: -# matrix_heisenbridge_container_labels_additional_labels: | +# matrix_bridge_heisenbridge_container_labels_additional_labels: | # my.label=1 # another.label="here" -matrix_heisenbridge_container_labels_additional_labels: '' +matrix_bridge_heisenbridge_container_labels_additional_labels: '' # A list of extra arguments to pass to the container -matrix_heisenbridge_container_extra_arguments: [] +matrix_bridge_heisenbridge_container_extra_arguments: [] # List of systemd services that service depends on. -matrix_heisenbridge_systemd_required_services_list: "{{ matrix_heisenbridge_systemd_required_services_list_default + matrix_heisenbridge_systemd_required_services_list_auto + matrix_heisenbridge_systemd_required_services_list_custom }}" -matrix_heisenbridge_systemd_required_services_list_default: "{{ [devture_systemd_docker_base_docker_service_name] if devture_systemd_docker_base_docker_service_name else [] }}" -matrix_heisenbridge_systemd_required_services_list_auto: [] -matrix_heisenbridge_systemd_required_services_list_custom: [] +matrix_bridge_heisenbridge_systemd_required_services_list: "{{ matrix_bridge_heisenbridge_systemd_required_services_list_default + matrix_bridge_heisenbridge_systemd_required_services_list_auto + matrix_bridge_heisenbridge_systemd_required_services_list_custom }}" +matrix_bridge_heisenbridge_systemd_required_services_list_default: "{{ [devture_systemd_docker_base_docker_service_name] if devture_systemd_docker_base_docker_service_name else [] }}" +matrix_bridge_heisenbridge_systemd_required_services_list_auto: [] +matrix_bridge_heisenbridge_systemd_required_services_list_custom: [] # List of systemd services that service wants -matrix_heisenbridge_systemd_wanted_services_list: [] +matrix_bridge_heisenbridge_systemd_wanted_services_list: [] -matrix_heisenbridge_homeserver_url: "" +matrix_bridge_heisenbridge_homeserver_url: "" -matrix_heisenbridge_appservice_token: '' -matrix_heisenbridge_homeserver_token: '' +matrix_bridge_heisenbridge_appservice_token: '' +matrix_bridge_heisenbridge_homeserver_token: '' -matrix_heisenbridge_config_media_url: "{{ matrix_heisenbridge_scheme }}://{{ matrix_heisenbridge_hostname }}" -# This matches the hardcoded `DEFAULT_MEDIA_PATH` in Heisenbridge, but uses `matrix_heisenbridge_path_prefix` as the path prefix. +matrix_bridge_heisenbridge_config_media_url: "{{ matrix_bridge_heisenbridge_scheme }}://{{ matrix_bridge_heisenbridge_hostname }}" +# This matches the hardcoded `DEFAULT_MEDIA_PATH` in Heisenbridge, but uses `matrix_bridge_heisenbridge_path_prefix` as the path prefix. # See: https://github.com/hifi/heisenbridge/blob/7e18a5818f4a8c86cc62e474eee1631d16cb2602/heisenbridge/__main__.py#L66 -matrix_heisenbridge_config_media_path: "{{ matrix_heisenbridge_container_labels_traefik_media_path_prefix }}/{server}/{media_id}/{checksum}{filename}" -matrix_heisenbridge_config_media_key: "{{ matrix_heisenbridge_homeserver_token }}" -matrix_heisenbridge_config_displayname: "Heisenbridge" +matrix_bridge_heisenbridge_config_media_path: "{{ matrix_bridge_heisenbridge_container_labels_traefik_media_path_prefix }}/{server}/{media_id}/{checksum}{filename}" +matrix_bridge_heisenbridge_config_media_key: "{{ matrix_bridge_heisenbridge_homeserver_token }}" +matrix_bridge_heisenbridge_config_displayname: "Heisenbridge" -matrix_heisenbridge_registration_yaml_heisenbridge: - media_url: "{{ matrix_heisenbridge_config_media_url }}" - media_path: "{{ matrix_heisenbridge_config_media_path }}" - media_key: "{{ matrix_heisenbridge_config_media_key }}" - displayname: "{{ matrix_heisenbridge_config_displayname }}" +matrix_bridge_heisenbridge_registration_yaml_heisenbridge: + media_url: "{{ matrix_bridge_heisenbridge_config_media_url }}" + media_path: "{{ matrix_bridge_heisenbridge_config_media_path }}" + media_key: "{{ matrix_bridge_heisenbridge_config_media_key }}" + displayname: "{{ matrix_bridge_heisenbridge_config_displayname }}" # Default registration file consumed by both the homeserver and Heisenbridge. # Besides registration information, it contains configuration (see the Heisenbridge key). -matrix_heisenbridge_registration_yaml: +matrix_bridge_heisenbridge_registration_yaml: id: heisenbridge url: http://matrix-heisenbridge:9898 - as_token: "{{ matrix_heisenbridge_appservice_token }}" - hs_token: "{{ matrix_heisenbridge_homeserver_token }}" + as_token: "{{ matrix_bridge_heisenbridge_appservice_token }}" + hs_token: "{{ matrix_bridge_heisenbridge_homeserver_token }}" rate_limited: false sender_localpart: heisenbridge namespaces: @@ -119,11 +119,11 @@ matrix_heisenbridge_registration_yaml: exclusive: true aliases: [] rooms: [] - heisenbridge: "{{ matrix_heisenbridge_registration_yaml_heisenbridge }}" + heisenbridge: "{{ matrix_bridge_heisenbridge_registration_yaml_heisenbridge }}" -matrix_heisenbridge_registration: "{{ matrix_heisenbridge_registration_yaml | from_yaml }}" +matrix_bridge_heisenbridge_registration: "{{ matrix_bridge_heisenbridge_registration_yaml | from_yaml }}" -# matrix_heisenbridge_restart_necessary controls whether the service +# matrix_bridge_heisenbridge_restart_necessary controls whether the service # will be restarted (when true) or merely started (when false) by the # systemd service manager role (when conditional restart is enabled). # @@ -131,4 +131,4 @@ matrix_heisenbridge_registration: "{{ matrix_heisenbridge_registration_yaml | fr # any configuration files, the systemd service file, or the container image changed. # The default of `false` means "no restart needed" — appropriate when the role's # installation tasks haven't run (e.g., due to --tags skipping them). -matrix_heisenbridge_restart_necessary: false +matrix_bridge_heisenbridge_restart_necessary: false diff --git a/roles/custom/matrix-bridge-heisenbridge/tasks/main.yml b/roles/custom/matrix-bridge-heisenbridge/tasks/main.yml index 7de077071..1d9ee6500 100644 --- a/roles/custom/matrix-bridge-heisenbridge/tasks/main.yml +++ b/roles/custom/matrix-bridge-heisenbridge/tasks/main.yml @@ -12,15 +12,15 @@ - install-all - install-heisenbridge block: - - when: matrix_heisenbridge_enabled | bool + - when: matrix_bridge_heisenbridge_enabled | bool ansible.builtin.include_tasks: "{{ role_path }}/tasks/validate_config.yml" - - when: matrix_heisenbridge_enabled | bool + - when: matrix_bridge_heisenbridge_enabled | bool ansible.builtin.include_tasks: "{{ role_path }}/tasks/setup_install.yml" - tags: - setup-all - setup-heisenbridge block: - - when: not matrix_heisenbridge_enabled | bool + - when: not matrix_bridge_heisenbridge_enabled | bool ansible.builtin.include_tasks: "{{ role_path }}/tasks/setup_uninstall.yml" diff --git a/roles/custom/matrix-bridge-heisenbridge/tasks/setup_install.yml b/roles/custom/matrix-bridge-heisenbridge/tasks/setup_install.yml index 9241bfaa0..da44002e7 100644 --- a/roles/custom/matrix-bridge-heisenbridge/tasks/setup_install.yml +++ b/roles/custom/matrix-bridge-heisenbridge/tasks/setup_install.yml @@ -12,12 +12,12 @@ - name: Ensure Heisenbridge image is pulled community.docker.docker_image_pull: - name: "{{ matrix_heisenbridge_container_image }}" + name: "{{ matrix_bridge_heisenbridge_container_image }}" pull: always - register: matrix_heisenbridge_container_image_pull_result + register: matrix_bridge_heisenbridge_container_image_pull_result retries: "{{ devture_playbook_help_container_retries_count }}" delay: "{{ devture_playbook_help_container_retries_delay }}" - until: matrix_heisenbridge_container_image_pull_result is not failed + until: matrix_bridge_heisenbridge_container_image_pull_result is not failed - name: Ensure Heisenbridge paths exist ansible.builtin.file: @@ -27,33 +27,33 @@ owner: "{{ matrix_user_name }}" group: "{{ matrix_group_name }}" with_items: - - "{{ matrix_heisenbridge_base_path }}" + - "{{ matrix_bridge_heisenbridge_base_path }}" - name: Ensure Heisenbridge registration.yaml installed if provided ansible.builtin.copy: - content: "{{ matrix_heisenbridge_registration | to_nice_yaml(indent=2, width=999999) }}" - dest: "{{ matrix_heisenbridge_base_path }}/registration.yaml" + content: "{{ matrix_bridge_heisenbridge_registration | to_nice_yaml(indent=2, width=999999) }}" + dest: "{{ matrix_bridge_heisenbridge_base_path }}/registration.yaml" mode: '0644' owner: "{{ matrix_user_name }}" group: "{{ matrix_group_name }}" - register: matrix_heisenbridge_registration_result + register: matrix_bridge_heisenbridge_registration_result - name: Ensure Heisenbridge support files installed ansible.builtin.template: src: "{{ role_path }}/templates/{{ item }}.j2" - dest: "{{ matrix_heisenbridge_base_path }}/{{ item }}" + dest: "{{ matrix_bridge_heisenbridge_base_path }}/{{ item }}" mode: '0640' owner: "{{ matrix_user_name }}" group: "{{ matrix_group_name }}" with_items: - labels - register: matrix_heisenbridge_support_files_result + register: matrix_bridge_heisenbridge_support_files_result - name: Ensure Heisenbridge container network is created - when: matrix_heisenbridge_container_network != 'host' + when: matrix_bridge_heisenbridge_container_network != 'host' community.general.docker_network: enable_ipv6: "{{ devture_systemd_docker_base_ipv6_enabled }}" - name: "{{ matrix_heisenbridge_container_network }}" + name: "{{ matrix_bridge_heisenbridge_container_network }}" driver: bridge driver_options: "{{ devture_systemd_docker_base_container_networks_driver_options }}" @@ -62,14 +62,14 @@ src: "{{ role_path }}/templates/systemd/matrix-heisenbridge.service.j2" dest: "{{ devture_systemd_docker_base_systemd_path }}/matrix-heisenbridge.service" mode: '0644' - register: matrix_heisenbridge_systemd_service_result + register: matrix_bridge_heisenbridge_systemd_service_result - name: Determine whether matrix-heisenbridge needs a restart ansible.builtin.set_fact: - matrix_heisenbridge_restart_necessary: >- + matrix_bridge_heisenbridge_restart_necessary: >- {{ - matrix_heisenbridge_registration_result.changed | default(false) - or matrix_heisenbridge_support_files_result.changed | default(false) - or matrix_heisenbridge_systemd_service_result.changed | default(false) - or matrix_heisenbridge_container_image_pull_result.changed | default(false) + matrix_bridge_heisenbridge_registration_result.changed | default(false) + or matrix_bridge_heisenbridge_support_files_result.changed | default(false) + or matrix_bridge_heisenbridge_systemd_service_result.changed | default(false) + or matrix_bridge_heisenbridge_container_image_pull_result.changed | default(false) }} diff --git a/roles/custom/matrix-bridge-heisenbridge/tasks/setup_uninstall.yml b/roles/custom/matrix-bridge-heisenbridge/tasks/setup_uninstall.yml index ba42105de..ae4025153 100644 --- a/roles/custom/matrix-bridge-heisenbridge/tasks/setup_uninstall.yml +++ b/roles/custom/matrix-bridge-heisenbridge/tasks/setup_uninstall.yml @@ -10,9 +10,9 @@ - name: Check existence of matrix-heisenbridge service ansible.builtin.stat: path: "{{ devture_systemd_docker_base_systemd_path }}/matrix-heisenbridge.service" - register: matrix_heisenbridge_service_stat + register: matrix_bridge_heisenbridge_service_stat -- when: matrix_heisenbridge_service_stat.stat.exists | bool +- when: matrix_bridge_heisenbridge_service_stat.stat.exists | bool block: - name: Ensure matrix-heisenbridge is stopped ansible.builtin.service: diff --git a/roles/custom/matrix-bridge-heisenbridge/tasks/validate_config.yml b/roles/custom/matrix-bridge-heisenbridge/tasks/validate_config.yml index b31cbf83a..b39ec8486 100644 --- a/roles/custom/matrix-bridge-heisenbridge/tasks/validate_config.yml +++ b/roles/custom/matrix-bridge-heisenbridge/tasks/validate_config.yml @@ -12,12 +12,12 @@ 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_heisenbridge_docker_image', 'new': 'matrix_heisenbridge_container_image'} - - {'old': 'matrix_heisenbridge_docker_image_force_pull', 'new': 'matrix_heisenbridge_container_image_force_pull'} - - {'old': 'matrix_heisenbridge_docker_image_registry_prefix', 'new': 'matrix_heisenbridge_container_image_registry_prefix'} - - {'old': 'matrix_heisenbridge_docker_image_registry_prefix_upstream', 'new': 'matrix_heisenbridge_container_image_registry_prefix_upstream'} - - {'old': 'matrix_heisenbridge_docker_image_registry_prefix_upstream_default', 'new': 'matrix_heisenbridge_container_image_registry_prefix_upstream_default'} - - {'old': 'matrix_heisenbridge_container_image_force_pull', 'new': ' (the new community.docker.docker_image_pull module handles this natively)'} + - {'old': 'matrix_bridge_heisenbridge_docker_image', 'new': 'matrix_bridge_heisenbridge_container_image'} + - {'old': 'matrix_bridge_heisenbridge_docker_image_force_pull', 'new': 'matrix_bridge_heisenbridge_container_image_force_pull'} + - {'old': 'matrix_bridge_heisenbridge_docker_image_registry_prefix', 'new': 'matrix_bridge_heisenbridge_container_image_registry_prefix'} + - {'old': 'matrix_bridge_heisenbridge_docker_image_registry_prefix_upstream', 'new': 'matrix_bridge_heisenbridge_container_image_registry_prefix_upstream'} + - {'old': 'matrix_bridge_heisenbridge_docker_image_registry_prefix_upstream_default', 'new': 'matrix_bridge_heisenbridge_container_image_registry_prefix_upstream_default'} + - {'old': 'matrix_bridge_heisenbridge_container_image_force_pull', 'new': ' (the new community.docker.docker_image_pull module handles this natively)'} - name: Fail if required Heisenbridge settings not defined @@ -26,5 +26,5 @@ 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_heisenbridge_container_network', when: true} - - {'name': 'matrix_heisenbridge_homeserver_url', when: true} + - {'name': 'matrix_bridge_heisenbridge_container_network', when: true} + - {'name': 'matrix_bridge_heisenbridge_homeserver_url', when: true} diff --git a/roles/custom/matrix-bridge-heisenbridge/templates/labels.j2 b/roles/custom/matrix-bridge-heisenbridge/templates/labels.j2 index fa2cb1ee1..bf435a907 100644 --- a/roles/custom/matrix-bridge-heisenbridge/templates/labels.j2 +++ b/roles/custom/matrix-bridge-heisenbridge/templates/labels.j2 @@ -4,33 +4,33 @@ SPDX-FileCopyrightText: 2024 Slavi Pantaleev SPDX-License-Identifier: AGPL-3.0-or-later #} -{% if matrix_heisenbridge_container_labels_traefik_enabled %} +{% if matrix_bridge_heisenbridge_container_labels_traefik_enabled %} traefik.enable=true -{% if matrix_heisenbridge_container_labels_traefik_docker_network %} -traefik.docker.network={{ matrix_heisenbridge_container_labels_traefik_docker_network }} +{% if matrix_bridge_heisenbridge_container_labels_traefik_docker_network %} +traefik.docker.network={{ matrix_bridge_heisenbridge_container_labels_traefik_docker_network }} {% endif %} traefik.http.services.matrix-heisenbridge.loadbalancer.server.port=9898 {% set middlewares = [] %} -{% if matrix_heisenbridge_container_labels_traefik_path_prefix != '/' %} -traefik.http.middlewares.matrix-heisenbridge-strip-prefix.stripprefix.prefixes={{ matrix_heisenbridge_container_labels_traefik_path_prefix }} +{% if matrix_bridge_heisenbridge_container_labels_traefik_path_prefix != '/' %} +traefik.http.middlewares.matrix-heisenbridge-strip-prefix.stripprefix.prefixes={{ matrix_bridge_heisenbridge_container_labels_traefik_path_prefix }} {% set middlewares = middlewares + ['matrix-heisenbridge-strip-prefix'] %} {% endif %} -{% if matrix_heisenbridge_container_labels_traefik_media_enabled %} +{% if matrix_bridge_heisenbridge_container_labels_traefik_media_enabled %} ########################################################################## # # # Media # # # ########################################################################## -traefik.http.routers.matrix-heisenbridge-media.rule={{ matrix_heisenbridge_container_labels_traefik_media_rule }} +traefik.http.routers.matrix-heisenbridge-media.rule={{ matrix_bridge_heisenbridge_container_labels_traefik_media_rule }} -{% if matrix_heisenbridge_container_labels_traefik_media_priority | int > 0 %} -traefik.http.routers.matrix-heisenbridge-media.priority={{ matrix_heisenbridge_container_labels_traefik_media_priority }} +{% if matrix_bridge_heisenbridge_container_labels_traefik_media_priority | int > 0 %} +traefik.http.routers.matrix-heisenbridge-media.priority={{ matrix_bridge_heisenbridge_container_labels_traefik_media_priority }} {% endif %} {% if middlewares | length > 0 %} @@ -38,11 +38,11 @@ traefik.http.routers.matrix-heisenbridge-media.middlewares={{ middlewares | join {% endif %} traefik.http.routers.matrix-heisenbridge-media.service=matrix-heisenbridge -traefik.http.routers.matrix-heisenbridge-media.entrypoints={{ matrix_heisenbridge_container_labels_traefik_entrypoints }} +traefik.http.routers.matrix-heisenbridge-media.entrypoints={{ matrix_bridge_heisenbridge_container_labels_traefik_entrypoints }} -traefik.http.routers.matrix-heisenbridge-media.tls={{ matrix_heisenbridge_container_labels_traefik_media_tls | to_json }} -{% if matrix_heisenbridge_container_labels_traefik_media_entrypoints %} -traefik.http.routers.matrix-heisenbridge-media.tls.certResolver={{ matrix_heisenbridge_container_labels_traefik_media_tls_certResolver }} +traefik.http.routers.matrix-heisenbridge-media.tls={{ matrix_bridge_heisenbridge_container_labels_traefik_media_tls | to_json }} +{% if matrix_bridge_heisenbridge_container_labels_traefik_media_entrypoints %} +traefik.http.routers.matrix-heisenbridge-media.tls.certResolver={{ matrix_bridge_heisenbridge_container_labels_traefik_media_tls_certResolver }} {% endif %} ########################################################################## @@ -55,4 +55,4 @@ traefik.http.routers.matrix-heisenbridge-media.tls.certResolver={{ matrix_heisen {% endif %} -{{ matrix_heisenbridge_container_labels_additional_labels }} +{{ matrix_bridge_heisenbridge_container_labels_additional_labels }} diff --git a/roles/custom/matrix-bridge-heisenbridge/templates/systemd/matrix-heisenbridge.service.j2 b/roles/custom/matrix-bridge-heisenbridge/templates/systemd/matrix-heisenbridge.service.j2 index 64c9f6231..e164cc6b9 100644 --- a/roles/custom/matrix-bridge-heisenbridge/templates/systemd/matrix-heisenbridge.service.j2 +++ b/roles/custom/matrix-bridge-heisenbridge/templates/systemd/matrix-heisenbridge.service.j2 @@ -1,11 +1,11 @@ #jinja2: lstrip_blocks: True [Unit] Description=a bouncer-style Matrix IRC bridge -{% for service in matrix_heisenbridge_systemd_required_services_list %} +{% for service in matrix_bridge_heisenbridge_systemd_required_services_list %} Requires={{ service }} After={{ service }} {% endfor %} -{% for service in matrix_heisenbridge_systemd_wanted_services_list %} +{% for service in matrix_bridge_heisenbridge_systemd_wanted_services_list %} Wants={{ service }} {% endfor %} DefaultDependencies=no @@ -13,7 +13,7 @@ DefaultDependencies=no [Service] Type=simple Environment="HOME={{ devture_systemd_docker_base_systemd_unit_home_path }}" -ExecStartPre=-{{ devture_systemd_docker_base_host_command_docker }} stop -t {{ matrix_heisenbridge_container_stop_grace_time_seconds }} matrix-heisenbridge +ExecStartPre=-{{ devture_systemd_docker_base_host_command_docker }} stop -t {{ matrix_bridge_heisenbridge_container_stop_grace_time_seconds }} matrix-heisenbridge ExecStartPre=-{{ devture_systemd_docker_base_host_command_docker }} rm matrix-heisenbridge ExecStartPre={{ devture_systemd_docker_base_host_command_docker }} create \ @@ -22,37 +22,37 @@ ExecStartPre={{ devture_systemd_docker_base_host_command_docker }} create \ --log-driver=none \ --user={{ matrix_user_uid }}:{{ matrix_user_gid }} \ --cap-drop=ALL \ - --network={{ matrix_heisenbridge_container_network }} \ - {% if matrix_heisenbridge_identd_enabled %} + --network={{ matrix_bridge_heisenbridge_container_network }} \ + {% if matrix_bridge_heisenbridge_identd_enabled %} -p 113:13113 \ {% endif %} - --mount type=bind,src={{ matrix_heisenbridge_base_path }},dst=/config \ - --label-file={{ matrix_heisenbridge_base_path }}/labels \ - {% for arg in matrix_heisenbridge_container_extra_arguments %} + --mount type=bind,src={{ matrix_bridge_heisenbridge_base_path }},dst=/config \ + --label-file={{ matrix_bridge_heisenbridge_base_path }}/labels \ + {% for arg in matrix_bridge_heisenbridge_container_extra_arguments %} {{ arg }} \ {% endfor %} - {{ matrix_heisenbridge_container_image }} \ - {% if matrix_heisenbridge_identd_enabled %} + {{ matrix_bridge_heisenbridge_container_image }} \ + {% if matrix_bridge_heisenbridge_identd_enabled %} --identd \ --identd-port 13113 \ {% endif %} - {% if matrix_heisenbridge_owner %} - -o {{ matrix_heisenbridge_owner }} \ + {% if matrix_bridge_heisenbridge_owner %} + -o {{ matrix_bridge_heisenbridge_owner }} \ {% endif %} --config /config/registration.yaml \ --listen-address 0.0.0.0 \ --listen-port 9898 \ - {{ matrix_heisenbridge_homeserver_url }} + {{ matrix_bridge_heisenbridge_homeserver_url }} -{% if matrix_heisenbridge_container_network != 'host' %} -{% for network in matrix_heisenbridge_container_additional_networks %} +{% if matrix_bridge_heisenbridge_container_network != 'host' %} +{% for network in matrix_bridge_heisenbridge_container_additional_networks %} ExecStartPre={{ devture_systemd_docker_base_host_command_docker }} network connect {{ network }} matrix-heisenbridge {% endfor %} {% endif %} ExecStart={{ devture_systemd_docker_base_host_command_docker }} start --attach matrix-heisenbridge -ExecStop=-{{ devture_systemd_docker_base_host_command_docker }} stop -t {{ matrix_heisenbridge_container_stop_grace_time_seconds }} matrix-heisenbridge +ExecStop=-{{ devture_systemd_docker_base_host_command_docker }} stop -t {{ matrix_bridge_heisenbridge_container_stop_grace_time_seconds }} matrix-heisenbridge ExecStop=-{{ devture_systemd_docker_base_host_command_docker }} rm matrix-heisenbridge Restart=always RestartSec=30