diff --git a/group_vars/matrix_servers b/group_vars/matrix_servers index 3c65ea048..78a790c45 100755 --- a/group_vars/matrix_servers +++ b/group_vars/matrix_servers @@ -553,6 +553,13 @@ matrix_appservice_discord_database_password: "{{ '%s' | format(matrix_homeserver # We don't enable bridges by default. matrix_appservice_webhooks_enabled: false +matrix_appservice_webhooks_hostname: "{{ matrix_server_fqn_matrix }}" + +matrix_appservice_webhooks_systemd_required_services_list_auto: | + {{ + matrix_addons_homeserver_systemd_services_list + }} + matrix_appservice_webhooks_container_image_self_build: "{{ matrix_architecture != 'amd64' }}" # Normally, matrix-nginx-proxy is enabled and nginx can reach matrix-appservice-webhooks over the container network. @@ -560,6 +567,22 @@ matrix_appservice_webhooks_container_image_self_build: "{{ matrix_architecture ! # matrix-appservice-webhooks' client-server port to the local host. matrix_appservice_webhooks_container_http_host_bind_port: "{{ (matrix_playbook_service_host_bind_interface_prefix ~ matrix_appservice_webhooks_matrix_port) if matrix_playbook_service_host_bind_interface_prefix else '' }}" +matrix_appservice_webhooks_container_network: "{{ matrix_addons_container_network }}" + +matrix_appservice_webhooks_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_playbook_reverse_proxyable_services_additional_network and matrix_appservice_webhooks_container_labels_traefik_enabled) else []) + ) | unique + }} + +matrix_appservice_webhooks_container_labels_traefik_enabled: "{{ matrix_playbook_reverse_proxy_type in ['playbook-managed-traefik', 'other-traefik-container'] }}" +matrix_appservice_webhooks_container_labels_traefik_docker_network: "{{ matrix_playbook_reverse_proxyable_services_additional_network }}" +matrix_appservice_webhooks_container_labels_traefik_entrypoints: "{{ devture_traefik_entrypoint_primary }}" +matrix_appservice_webhooks_container_labels_traefik_tls_certResolver: "{{ devture_traefik_certResolver_primary }}" + matrix_appservice_webhooks_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'webhook.as.token', rounds=655555) | to_uuid }}" matrix_appservice_webhooks_homeserver_url: "{{ matrix_homeserver_container_url }}" @@ -567,15 +590,6 @@ matrix_appservice_webhooks_homeserver_token: "{{ '%s' | format(matrix_homeserver matrix_appservice_webhooks_id_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'webhook.id.token', rounds=655555) | to_uuid }}" -matrix_appservice_webhooks_systemd_required_services_list: | - {{ - ['docker.service'] - + - ['matrix-' + matrix_homeserver_implementation + '.service'] - + - (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else []) - }} - ###################################################################### # # /matrix-appservice-webhooks diff --git a/roles/custom/matrix-bridge-appservice-webhooks/defaults/main.yml b/roles/custom/matrix-bridge-appservice-webhooks/defaults/main.yml index f181f0958..22bbd45c3 100644 --- a/roles/custom/matrix-bridge-appservice-webhooks/defaults/main.yml +++ b/roles/custom/matrix-bridge-appservice-webhooks/defaults/main.yml @@ -4,6 +4,10 @@ matrix_appservice_webhooks_enabled: true +matrix_appservice_webhooks_scheme: https +matrix_appservice_webhooks_hostname: '' +matrix_appservice_webhooks_path_prefix: /appservice-webhooks + matrix_appservice_webhooks_container_image_self_build: false matrix_appservice_webhooks_container_image_self_build_repo: "https://github.com/redoonetworks/matrix-appservice-webhooks" matrix_appservice_webhooks_container_image_self_build_repo_version: "{{ 'master' if matrix_appservice_webhooks_version == 'latest' else matrix_appservice_webhooks_version }}" @@ -20,8 +24,8 @@ matrix_appservice_webhooks_data_path: "{{ matrix_appservice_webhooks_base_path } matrix_appservice_webhooks_docker_src_files_path: "{{ matrix_appservice_webhooks_base_path }}/docker-src" # If nginx-proxy is disabled, the bridge itself expects its endpoint to be on its own domain (e.g. "localhost:6789") -matrix_appservice_webhooks_public_endpoint: /appservice-webhooks -matrix_appservice_webhooks_inbound_uri_prefix: "{{ matrix_homeserver_url }}{{ matrix_appservice_webhooks_public_endpoint }}" +matrix_appservice_webhooks_public_endpoint: "{{ matrix_appservice_webhooks_path_prefix }}" +matrix_appservice_webhooks_inbound_uri_prefix: "{{ matrix_appservice_webhooks_scheme }}://{{ matrix_appservice_webhooks_hostname }}{{ matrix_appservice_webhooks_public_endpoint }}" matrix_appservice_webhooks_bot_name: 'webhookbot' matrix_appservice_webhooks_user_prefix: '_webhook_' @@ -34,20 +38,57 @@ matrix_appservice_webhooks_matrix_port: 6789 # Takes an ":" or "" value (e.g. "127.0.0.1:9999"), or empty string to not expose. matrix_appservice_webhooks_container_http_host_bind_port: '' -matrix_appservice_webhooks_homeserver_media_url: "{{ matrix_server_fqn_matrix }}" -matrix_appservice_webhooks_homeserver_url: "" -matrix_appservice_webhooks_homeserver_domain: "{{ matrix_domain }}" -matrix_appservice_webhooks_appservice_url: 'http://matrix-appservice-webhooks' +matrix_appservice_webhooks_container_network: "" + +matrix_appservice_webhooks_container_additional_networks: "{{ matrix_appservice_webhooks_container_additional_networks_auto + matrix_appservice_webhooks_container_additional_networks_custom }}" +matrix_appservice_webhooks_container_additional_networks_auto: [] +matrix_appservice_webhooks_container_additional_networks_custom: [] + +# matrix_appservice_webhooks_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_appservice_webhooks_container_labels_additional_labels`. +matrix_appservice_webhooks_container_labels_traefik_enabled: true +matrix_appservice_webhooks_container_labels_traefik_docker_network: "{{ matrix_appservice_webhooks_container_network }}" +matrix_appservice_webhooks_container_labels_traefik_entrypoints: web-secure +matrix_appservice_webhooks_container_labels_traefik_tls_certResolver: default # noqa var-naming + +# Controls whether labels will be added that expose matrix-appservice-webhook's public endpoints +matrix_appservice_webhooks_container_labels_public_endpoint_enabled: true +matrix_appservice_webhooks_container_labels_public_endpoint_hostname: "{{ matrix_appservice_webhooks_hostname }}" +matrix_appservice_webhooks_container_labels_public_endpoint_prefix: "{{ matrix_appservice_webhooks_path_prefix }}" +matrix_appservice_webhooks_container_labels_public_endpoint_traefik_rule: "Host(`{{ matrix_appservice_webhooks_container_labels_public_endpoint_hostname }}`) && PathPrefix(`{{ matrix_appservice_webhooks_path_prefix }}`)" +matrix_appservice_webhooks_container_labels_public_endpoint_traefik_priority: 0 +matrix_appservice_webhooks_container_labels_public_endpoint_traefik_entrypoints: "{{ matrix_appservice_webhooks_container_labels_traefik_entrypoints }}" +matrix_appservice_webhooks_container_labels_public_endpoint_traefik_tls: "{{ matrix_appservice_webhooks_container_labels_public_endpoint_traefik_entrypoints != 'web' }}" +matrix_appservice_webhooks_container_labels_public_endpoint_traefik_tls_certResolver: "{{ matrix_appservice_webhooks_container_labels_traefik_tls_certResolver }}" # noqa var-naming + +# matrix_appservice_webhooks_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_appservice_webhooks_container_labels_additional_labels: | +# my.label=1 +# another.label="here" +matrix_appservice_webhooks_container_labels_additional_labels: '' # A list of extra arguments to pass to the container matrix_appservice_webhooks_container_extra_arguments: [] # List of systemd services that matrix-appservice-webhooks.service depends on. -matrix_appservice_webhooks_systemd_required_services_list: ['docker.service', 'matrix-synapse.service'] +matrix_appservice_webhooks_systemd_required_services_list: "{{ matrix_appservice_webhooks_systemd_required_services_list_default + matrix_appservice_webhooks_systemd_required_services_list_auto + matrix_appservice_webhooks_systemd_required_services_list_custom }}" +matrix_appservice_webhooks_systemd_required_services_list_default: ['docker.service'] +matrix_appservice_webhooks_systemd_required_services_list_auto: [] +matrix_appservice_webhooks_systemd_required_services_list_custom: [] # List of systemd services that matrix-appservice-webhooks.service wants matrix_appservice_webhooks_systemd_wanted_services_list: [] +matrix_appservice_webhooks_homeserver_media_url: "{{ matrix_server_fqn_matrix }}" +matrix_appservice_webhooks_homeserver_url: "" +matrix_appservice_webhooks_homeserver_domain: "{{ matrix_domain }}" +matrix_appservice_webhooks_appservice_url: 'http://matrix-appservice-webhooks' + matrix_appservice_webhooks_appservice_token: '' matrix_appservice_webhooks_homeserver_token: '' matrix_appservice_webhooks_id_token: '' diff --git a/roles/custom/matrix-bridge-appservice-webhooks/tasks/inject_into_nginx_proxy.yml b/roles/custom/matrix-bridge-appservice-webhooks/tasks/inject_into_nginx_proxy.yml deleted file mode 100644 index 2e4ad18e4..000000000 --- a/roles/custom/matrix-bridge-appservice-webhooks/tasks/inject_into_nginx_proxy.yml +++ /dev/null @@ -1,46 +0,0 @@ ---- - -- name: Fail if matrix-nginx-proxy role already executed - ansible.builtin.fail: - msg: >- - Trying to append webhooks Appservice's reverse-proxying configuration to matrix-nginx-proxy, - but it's pointless since the matrix-nginx-proxy role had already executed. - To fix this, please change the order of roles in your playbook, - so that the matrix-nginx-proxy role would run after the matrix-bridge-appservice-webhooks role. - when: matrix_nginx_proxy_role_executed | default(False) | bool - -- name: Generate Matrix Appservice webhooks proxying configuration for matrix-nginx-proxy - ansible.builtin.set_fact: - matrix_appservice_webhooks_matrix_nginx_proxy_configuration: | - {% if matrix_nginx_proxy_enabled | default(False) %} - {# Use the embedded DNS resolver in Docker containers to discover the service #} - location ~ ^{{ matrix_appservice_webhooks_public_endpoint }}/(.*)$ { - resolver 127.0.0.11 valid=5s; - set $backend "matrix-appservice-webhooks:{{ matrix_appservice_webhooks_matrix_port }}"; - proxy_pass http://$backend/$1; - } - {% else %} - {# Generic configuration for use outside of our container setup #} - location {{ matrix_appservice_webhooks_public_endpoint }}/ { - proxy_pass http://127.0.0.1:{{ matrix_appservice_webhooks_matrix_port }}/; - } - {% endif %} - -- name: Register webhooks Appservice proxying configuration with matrix-nginx-proxy - ansible.builtin.set_fact: - matrix_nginx_proxy_proxy_matrix_additional_server_configuration_blocks: | - {{ - matrix_nginx_proxy_proxy_matrix_additional_server_configuration_blocks | default([]) - + - [matrix_appservice_webhooks_matrix_nginx_proxy_configuration] - }} - -- name: Warn about reverse-proxying if matrix-nginx-proxy not used - ansible.builtin.debug: - msg: >- - NOTE: You've enabled the Matrix webhooks bridge but are not using the matrix-nginx-proxy - reverse proxy. - Please make sure that you're proxying the `{{ matrix_appservice_webhooks_public_endpoint }}` - URL endpoint to the matrix-appservice-webhooks container. - You can expose the container's port using the `matrix_appservice_webhooks_container_http_host_bind_port` variable. - when: "matrix_appservice_webhooks_enabled | bool and not matrix_nginx_proxy_enabled | default(False) | bool" diff --git a/roles/custom/matrix-bridge-appservice-webhooks/tasks/main.yml b/roles/custom/matrix-bridge-appservice-webhooks/tasks/main.yml index a40d66ddc..b8d8c8cd4 100644 --- a/roles/custom/matrix-bridge-appservice-webhooks/tasks/main.yml +++ b/roles/custom/matrix-bridge-appservice-webhooks/tasks/main.yml @@ -1,14 +1,5 @@ --- -- tags: - - setup-all - - setup-nginx-proxy - - install-all - - install-nginx-proxy - block: - - when: matrix_appservice_webhooks_enabled | bool - ansible.builtin.include_tasks: "{{ role_path }}/tasks/inject_into_nginx_proxy.yml" - - tags: - setup-all - setup-appservice-webhooks diff --git a/roles/custom/matrix-bridge-appservice-webhooks/tasks/setup_install.yml b/roles/custom/matrix-bridge-appservice-webhooks/tasks/setup_install.yml index 194ef0176..bb538e22b 100644 --- a/roles/custom/matrix-bridge-appservice-webhooks/tasks/setup_install.yml +++ b/roles/custom/matrix-bridge-appservice-webhooks/tasks/setup_install.yml @@ -1,6 +1,6 @@ --- -- name: Ensure AppService webhooks paths exist +- name: Ensure matrix-appservice-webhooks paths exist ansible.builtin.file: path: "{{ item.path }}" state: directory @@ -14,7 +14,7 @@ - {path: "{{ matrix_appservice_webhooks_docker_src_files_path }}", when: "{{ matrix_appservice_webhooks_container_image_self_build }}"} when: "item.when | bool" -- name: Ensure Appservice webhooks image is pulled +- name: Ensure matrix-appservice-webhooks container image is pulled community.docker.docker_image: name: "{{ matrix_appservice_webhooks_docker_image }}" source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}" @@ -28,7 +28,7 @@ - when: "matrix_appservice_webhooks_container_image_self_build | bool" block: - - name: Ensure Appservice webhooks repository is present on self-build + - name: Ensure matrix-appservice-webhooks repository is present on self-build ansible.builtin.git: repo: "{{ matrix_appservice_webhooks_container_image_self_build_repo }}" dest: "{{ matrix_appservice_webhooks_docker_src_files_path }}" @@ -38,7 +38,7 @@ become_user: "{{ matrix_user_username }}" register: matrix_appservice_webhooks_git_pull_results - - name: Ensure Appservice webhooks Docker image is built + - name: Ensure matrix-appservice-webhooks container image is built community.docker.docker_image: name: "{{ matrix_appservice_webhooks_docker_image }}" source: build @@ -49,7 +49,7 @@ path: "{{ matrix_appservice_webhooks_docker_src_files_path }}" pull: true -- name: Ensure Matrix Appservice webhooks config is installed +- name: Ensure matrix-appservice-webhooks config is installed ansible.builtin.copy: content: "{{ matrix_appservice_webhooks_configuration | to_nice_yaml(indent=2, width=999999) }}" dest: "{{ matrix_appservice_webhooks_config_path }}/config.yaml" @@ -57,7 +57,7 @@ owner: "{{ matrix_user_username }}" group: "{{ matrix_user_groupname }}" -- name: Ensure Matrix Appservice webhooks schema.yml template exists +- name: Ensure matrix-appservice-webhooks schema.yml template exists ansible.builtin.template: src: "{{ role_path }}/templates/schema.yml.j2" dest: "{{ matrix_appservice_webhooks_config_path }}/schema.yml" @@ -65,7 +65,7 @@ owner: "{{ matrix_user_username }}" group: "{{ matrix_user_groupname }}" -- name: Ensure Matrix Appservice webhooks database.json template exists +- name: Ensure matrix-appservice-webhooks database.json template exists ansible.builtin.template: src: "{{ role_path }}/templates/database.json.j2" dest: "{{ matrix_appservice_webhooks_data_path }}/database.json" @@ -81,6 +81,21 @@ owner: "{{ matrix_user_username }}" group: "{{ matrix_user_groupname }}" +- name: Ensure matrix-appservice-webhooks container network is created + community.general.docker_network: + name: "{{ matrix_appservice_webhooks_container_network }}" + driver: bridge + +- name: Ensure matrix-appservice-webhooks support files installed + ansible.builtin.template: + src: "{{ role_path }}/templates/{{ item }}.j2" + dest: "{{ matrix_appservice_webhooks_base_path }}/{{ item }}" + mode: 0640 + owner: "{{ matrix_user_username }}" + group: "{{ matrix_user_groupname }}" + with_items: + - labels + - name: Ensure matrix-appservice-webhooks.service installed ansible.builtin.template: src: "{{ role_path }}/templates/systemd/matrix-appservice-webhooks.service.j2" diff --git a/roles/custom/matrix-bridge-appservice-webhooks/tasks/validate_config.yml b/roles/custom/matrix-bridge-appservice-webhooks/tasks/validate_config.yml index d7f45c6f8..fa8a75fc2 100644 --- a/roles/custom/matrix-bridge-appservice-webhooks/tasks/validate_config.yml +++ b/roles/custom/matrix-bridge-appservice-webhooks/tasks/validate_config.yml @@ -1,13 +1,16 @@ --- -- name: Fail if required settings not defined +- name: Fail if required matrix-appservice-webhooks settings not defined ansible.builtin.fail: msg: >- You need to define a required configuration setting (`{{ item }}`). when: "vars[item] == ''" with_items: - - "matrix_appservice_webhooks_appservice_token" - - "matrix_appservice_webhooks_homeserver_url" - - "matrix_appservice_webhooks_homeserver_token" - - "matrix_appservice_webhooks_id_token" - - "matrix_appservice_webhooks_api_secret" + - matrix_appservice_webhooks_appservice_token + - matrix_appservice_webhooks_homeserver_url + - matrix_appservice_webhooks_homeserver_token + - matrix_appservice_webhooks_id_token + - matrix_appservice_webhooks_api_secret + - matrix_appservice_webhooks_container_network + - matrix_appservice_webhooks_hostname + - matrix_appservice_webhooks_path_prefix diff --git a/roles/custom/matrix-bridge-appservice-webhooks/templates/labels.j2 b/roles/custom/matrix-bridge-appservice-webhooks/templates/labels.j2 new file mode 100644 index 000000000..ba7b29e35 --- /dev/null +++ b/roles/custom/matrix-bridge-appservice-webhooks/templates/labels.j2 @@ -0,0 +1,36 @@ +{% if matrix_appservice_webhooks_container_labels_traefik_enabled %} +traefik.enable=true + +{% if matrix_appservice_webhooks_container_labels_traefik_docker_network %} +traefik.docker.network={{ matrix_appservice_webhooks_container_labels_traefik_docker_network }} +{% endif %} + +{# + Start of public +#} +{% if matrix_appservice_webhooks_container_labels_public_endpoint_enabled %} +traefik.http.middlewares.matrix-appservice-webhooks-public-strip-prefix.stripprefix.prefixes={{ matrix_appservice_webhooks_container_labels_public_endpoint_prefix }} + +traefik.http.routers.matrix-appservice-webhooks-public-endpoint.rule={{ matrix_appservice_webhooks_container_labels_public_endpoint_traefik_rule }} +traefik.http.routers.matrix-appservice-webhooks-public-endpoint.middlewares=matrix-appservice-webhooks-public-strip-prefix + +{% if matrix_appservice_webhooks_container_labels_public_endpoint_traefik_priority | int > 0 %} +traefik.http.routers.matrix-appservice-webhooks-public-endpoint.priority={{ matrix_appservice_webhooks_container_labels_public_endpoint_traefik_priority }} +{% endif %} + +traefik.http.routers.matrix-appservice-webhooks-public-endpoint.service=matrix-appservice-webhooks +traefik.http.routers.matrix-appservice-webhooks-public-endpoint.entrypoints={{ matrix_appservice_webhooks_container_labels_public_endpoint_traefik_entrypoints }} + +traefik.http.routers.matrix-appservice-webhooks-public-endpoint.tls={{ matrix_appservice_webhooks_container_labels_public_endpoint_traefik_tls | to_json }} +{% if matrix_appservice_webhooks_container_labels_public_endpoint_traefik_tls %} +traefik.http.routers.matrix-appservice-webhooks-public-endpoint.tls.certResolver={{ matrix_appservice_webhooks_container_labels_public_endpoint_traefik_tls_certResolver }} +{% endif %} +traefik.http.services.matrix-appservice-webhooks.loadbalancer.server.port={{ matrix_appservice_webhooks_matrix_port }} +{% endif %} +{# + /End of public +#} + +{% endif %} + +{{ matrix_appservice_webhooks_container_labels_additional_labels }} diff --git a/roles/custom/matrix-bridge-appservice-webhooks/templates/systemd/matrix-appservice-webhooks.service.j2 b/roles/custom/matrix-bridge-appservice-webhooks/templates/systemd/matrix-appservice-webhooks.service.j2 index 091442c95..74a0df47b 100644 --- a/roles/custom/matrix-bridge-appservice-webhooks/templates/systemd/matrix-appservice-webhooks.service.j2 +++ b/roles/custom/matrix-bridge-appservice-webhooks/templates/systemd/matrix-appservice-webhooks.service.j2 @@ -19,7 +19,9 @@ ExecStartPre=-{{ devture_systemd_docker_base_host_command_sh }} -c '{{ devture_s # Intentional delay, so that the homeserver (we likely depend on) can manage to start. ExecStartPre={{ matrix_host_command_sleep }} 5 -ExecStart={{ devture_systemd_docker_base_host_command_docker }} run --rm --name matrix-appservice-webhooks \ +ExecStartPre={{ devture_systemd_docker_base_host_command_docker }} create \ + --rm \ + --name=matrix-appservice-webhooks \ --log-driver=none \ --user={{ matrix_user_uid }}:{{ matrix_user_gid }} \ --cap-drop=ALL \ @@ -27,14 +29,21 @@ ExecStart={{ devture_systemd_docker_base_host_command_docker }} run --rm --name {% if matrix_appservice_webhooks_container_http_host_bind_port %} -p {{ matrix_appservice_webhooks_container_http_host_bind_port }}:{{matrix_appservice_webhooks_matrix_port}} \ {% endif %} - -v {{ matrix_appservice_webhooks_config_path }}:/config:z \ - -v {{ matrix_appservice_webhooks_data_path }}:/data:z \ + --mount type=bind,src={{ matrix_appservice_webhooks_config_path }},dst=/config \ + --mount type=bind,src={{ matrix_appservice_webhooks_data_path }},dst=/data \ + --label-file={{ matrix_appservice_slack_base_path }}/labels \ {% for arg in matrix_appservice_webhooks_container_extra_arguments %} {{ arg }} \ {% endfor %} {{ matrix_appservice_webhooks_docker_image }} \ node index.js -p {{ matrix_appservice_webhooks_matrix_port }} -c /config/config.yaml -f /config/webhooks-registration.yaml +{% for network in matrix_appservice_webhooks_container_additional_networks %} +ExecStartPre={{ devture_systemd_docker_base_host_command_docker }} network connect {{ network }} matrix-appservice-webhooks +{% endfor %} + +ExecStart={{ devture_systemd_docker_base_host_command_docker }} start --attach matrix-appservice-webhooks + ExecStop=-{{ devture_systemd_docker_base_host_command_sh }} -c '{{ devture_systemd_docker_base_host_command_docker }} stop --time={{ devture_systemd_docker_base_container_stop_grace_time_seconds }} matrix-appservice-webhooks 2>/dev/null || true' ExecStop=-{{ devture_systemd_docker_base_host_command_sh }} -c '{{ devture_systemd_docker_base_host_command_docker }} rm matrix-appservice-webhooks 2>/dev/null || true' Restart=always