Initial work on matrix-homeserver-proxy role and eliminating matrix-nginx-proxy

This is still very far from usable.

Various bridges and bots are still talking to
`matrix-nginx-proxy` instead of the new `matrix-homeserver-proxy` role.
These services need to be reworked. While reworking them,
various cleanups are being done as well as adding Traefik-labels to
those that need them.

roles/custom/matrix-bridge-mautrix-facebook/defaults/main.yml

@@ -20,22 +20,69 @@ matrix_mautrix_facebook_docker_src_files_path: "{{ matrix_mautrix_facebook_base_
 
 matrix_mautrix_facebook_command_prefix: "!fb"
 
-# Whether or not the public-facing endpoints should be enabled (web-based login)
-matrix_mautrix_facebook_appservice_public_enabled: true
-
-# Mautrix Facebook public endpoint to log in to Facebook
-matrix_mautrix_facebook_public_endpoint: ''
-
 matrix_mautrix_facebook_homeserver_address: "{{ matrix_homeserver_container_url }}"
 matrix_mautrix_facebook_homeserver_domain: '{{ matrix_domain }}'
+
+# Whether or not the public-facing endpoints should be enabled (web-based login)
+matrix_mautrix_facebook_appservice_public_enabled: false
+# Mautrix Facebook public endpoint to log in to Facebook
+matrix_mautrix_facebook_appservice_public_prefix: ''
+matrix_mautrix_facebook_appservice_public_hostname: ''
+matrix_mautrix_facebook_appservice_public_external: "{{ ('https://' + matrix_mautrix_facebook_appservice_public_hostname + matrix_mautrix_facebook_appservice_public_prefix) if matrix_mautrix_facebook_appservice_public_enabled else '' }}"
+
 matrix_mautrix_facebook_appservice_address: 'http://matrix-mautrix-facebook:29319'
-matrix_mautrix_facebook_appservice_public_external: 'https://{{ matrix_server_fqn_matrix }}{{ matrix_mautrix_facebook_public_endpoint }}'
+
+matrix_mautrix_facebook_container_network: ""
+
+matrix_mautrix_facebook_container_additional_networks: "{{ matrix_mautrix_facebook_container_additional_networks_auto + matrix_mautrix_facebook_container_additional_networks_custom }}"
+matrix_mautrix_facebook_container_additional_networks_auto: []
+matrix_mautrix_facebook_container_additional_networks_custom: []
 
 # A list of extra arguments to pass to the container
 matrix_mautrix_facebook_container_extra_arguments: []
 
+# matrix_mautrix_facebook_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_mautrix_facebook_container_labels_additional_labels`.
+matrix_mautrix_facebook_container_labels_traefik_enabled: true
+matrix_mautrix_facebook_container_labels_traefik_docker_network: "{{ matrix_mautrix_facebook_container_network }}"
+matrix_mautrix_facebook_container_labels_traefik_entrypoints: web-secure
+matrix_mautrix_facebook_container_labels_traefik_tls_certResolver: default
+
+# Controls whether labels will be added that expose mautrix-facebook's public endpoint
+matrix_mautrix_facebook_container_labels_public_endpoint_enabled: "{{ matrix_mautrix_facebook_appservice_public_enabled }}"
+matrix_mautrix_facebook_container_labels_public_endpoint_traefik_rule: "Host(`{{ matrix_mautrix_facebook_appservice_public_hostname }}`) && PathPrefix(`{{ matrix_mautrix_facebook_appservice_public_prefix }}`)"
+matrix_mautrix_facebook_container_labels_public_endpoint_traefik_priority: 0
+matrix_mautrix_facebook_container_labels_public_endpoint_traefik_entrypoints: "{{ matrix_mautrix_facebook_container_labels_traefik_entrypoints }}"
+matrix_mautrix_facebook_container_labels_public_endpoint_traefik_tls: "{{ matrix_mautrix_facebook_container_labels_public_endpoint_traefik_entrypoints != 'web' }}"
+matrix_mautrix_facebook_container_labels_public_endpoint_traefik_tls_certResolver: "{{ matrix_mautrix_facebook_container_labels_traefik_tls_certResolver }}"  # noqa var-naming
+
+# Controls whether labels will be added that expose mautrix-facebook's metrics
+matrix_mautrix_facebook_container_labels_metrics_enabled: "{{ matrix_mautrix_facebook_metrics_enabled and matrix_mautrix_facebook_metrics_proxying_enabled }}"
+matrix_mautrix_facebook_container_labels_metrics_traefik_rule: "Host(`{{ matrix_mautrix_facebook_metrics_proxying_hostname }}`) && PathPrefix(`{{ matrix_mautrix_facebook_metrics_proxying_path_prefix }}`)"
+matrix_mautrix_facebook_container_labels_metrics_traefik_priority: 0
+matrix_mautrix_facebook_container_labels_metrics_traefik_entrypoints: "{{ matrix_mautrix_facebook_container_labels_traefik_entrypoints }}"
+matrix_mautrix_facebook_container_labels_metrics_traefik_tls: "{{ matrix_mautrix_facebook_container_labels_public_endpoint_traefik_entrypoints != 'web' }}"
+matrix_mautrix_facebook_container_labels_metrics_traefik_tls_certResolver: "{{ matrix_mautrix_facebook_container_labels_traefik_tls_certResolver }}"  # noqa var-naming
+matrix_mautrix_facebook_container_labels_metrics_middleware_basic_auth_enabled: false
+# See: https://doc.traefik.io/traefik/middlewares/http/basicauth/#users
+matrix_mautrix_facebook_container_labels_metrics_middleware_basic_auth_users: ''
+
+# matrix_mautrix_facebook_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_mautrix_facebook_container_labels_additional_labels: |
+#   my.label=1
+#   another.label="here"
+matrix_mautrix_facebook_container_labels_additional_labels: ''
+
 # List of systemd services that matrix-mautrix-facebook.service depends on.
-matrix_mautrix_facebook_systemd_required_services_list: ['docker.service']
+matrix_mautrix_facebook_systemd_required_services_list: "{{ matrix_mautrix_facebook_systemd_required_services_list_default + matrix_mautrix_facebook_systemd_required_services_list_auto + matrix_mautrix_facebook_systemd_required_services_list_custom }}"
+matrix_mautrix_facebook_systemd_required_services_list_default: ['docker.service']
+matrix_mautrix_facebook_systemd_required_services_list_auto: []
+matrix_mautrix_facebook_systemd_required_services_list_custom: []
 
 # List of systemd services that matrix-mautrix-facebook.service wants
 matrix_mautrix_facebook_systemd_wanted_services_list: []
@@ -52,10 +99,10 @@ matrix_mautrix_facebook_federate_rooms: true
 # If metrics need to be consumed by another (external) Prometheus server, consider exposing them via `matrix_mautrix_facebook_metrics_proxying_enabled`.
 matrix_mautrix_facebook_metrics_enabled: false
 
-# Controls whether metrics should be proxied (exposed) on `matrix.DOMAIN/metrics/mautrix-facebook`.
-# This will only work take effect if `matrix_nginx_proxy_proxy_matrix_metrics_enabled: true`.
-# See the `matrix-nginx-proxy` role for details about enabling `matrix_nginx_proxy_proxy_matrix_metrics_enabled`.
+# Controls whether metrics should be exposed on `matrix.DOMAIN/metrics/mautrix-facebook`.
 matrix_mautrix_facebook_metrics_proxying_enabled: false
+matrix_mautrix_facebook_metrics_proxying_hostname: ''
+matrix_mautrix_facebook_metrics_proxying_path_prefix: ''
 
 matrix_mautrix_facebook_bridge_permissions: |
   {{

roles/custom/matrix-bridge-mautrix-facebook/tasks/inject_into_nginx_proxy.yml

@@ -1,69 +0,0 @@
----
-
-- name: Fail if matrix-nginx-proxy role already executed
-  ansible.builtin.fail:
-    msg: >-
-      Trying to append Mautrix Facebook'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-mautrix-facebook role.
-  when: matrix_nginx_proxy_role_executed | default(False) | bool
-
-- name: Generate Mautrix Facebook proxying configuration for matrix-nginx-proxy
-  ansible.builtin.set_fact:
-    matrix_mautrix_facebook_matrix_nginx_proxy_configuration: |
-      location {{ matrix_mautrix_facebook_public_endpoint }} {
-      {% if matrix_nginx_proxy_enabled | default(False) %}
-          {# Use the embedded DNS resolver in Docker containers to discover the service #}
-          resolver 127.0.0.11 valid=5s;
-          set $backend "matrix-mautrix-facebook:29319";
-          proxy_pass http://$backend;
-      {% else %}
-          {# Generic configuration for use outside of our container setup #}
-          proxy_pass http://127.0.0.1:9008;
-      {% endif %}
-      }
-
-- name: Register Mautrix Facebook 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_mautrix_facebook_matrix_nginx_proxy_configuration]
-      }}
-
-- name: Warn about reverse-proxying if matrix-nginx-proxy not used
-  ansible.builtin.debug:
-    msg: >-
-      NOTE: You've enabled the Mautrix Facebook bridge but are not using the matrix-nginx-proxy
-      reverse proxy.
-      Please make sure that you're proxying the `{{ matrix_mautrix_facebook_public_endpoint }}`
-      URL endpoint to the matrix-mautrix-facebook container.
-      You can expose the container's port using the `matrix_mautrix_facebook_container_http_host_bind_port` variable.
-  when: "not matrix_nginx_proxy_enabled | default(False) | bool"
-
-- when: matrix_mautrix_facebook_metrics_proxying_enabled | bool
-  block:
-    - name: Generate mautrix-facebook metrics proxying configuration for matrix-nginx-proxy (matrix.DOMAIN/metrics/mautrix-facebook)
-      ansible.builtin.set_fact:
-        matrix_mautrix_facebook_nginx_metrics_configuration_block: |
-          location /metrics/mautrix-facebook {
-            {% if matrix_nginx_proxy_enabled | default(False) %}
-              {# Use the embedded DNS resolver in Docker containers to discover the service #}
-              resolver 127.0.0.11 valid=5s;
-              set $backend "matrix-mautrix-facebook:8000";
-              proxy_pass http://$backend/metrics;
-            {% else %}
-              return 404 "matrix-nginx-proxy is disabled and no host port was bound to the container, so metrics are unavailable";
-            {% endif %}
-          }
-
-    - name: Register mautrix-facebook metrics proxying configuration with matrix-nginx-proxy (matrix.DOMAIN/metrics/mautrix-facebook)
-      ansible.builtin.set_fact:
-        matrix_nginx_proxy_proxy_matrix_metrics_additional_system_location_configuration_blocks: |
-          {{
-            matrix_nginx_proxy_proxy_matrix_metrics_additional_system_location_configuration_blocks | default([])
-            +
-            [matrix_mautrix_facebook_nginx_metrics_configuration_block]
-          }}

roles/custom/matrix-bridge-mautrix-facebook/tasks/main.yml

@@ -1,14 +1,5 @@
 ---
 
-- tags:
-    - setup-all
-    - setup-nginx-proxy
-    - install-all
-    - install-nginx-proxy
-  block:
-    - when: matrix_mautrix_facebook_enabled | bool and matrix_mautrix_facebook_appservice_public_enabled | bool
-      ansible.builtin.include_tasks: "{{ role_path }}/tasks/inject_into_nginx_proxy.yml"
-
 - tags:
     - setup-all
     - setup-mautrix-facebook

roles/custom/matrix-bridge-mautrix-facebook/tasks/setup_install.yml

@@ -113,6 +113,16 @@
     owner: "{{ matrix_user_username }}"
     group: "{{ matrix_user_groupname }}"
 
+- name: Ensure mautrix-facebook support files installed
+  ansible.builtin.template:
+    src: "{{ role_path }}/templates/{{ item }}.j2"
+    dest: "{{ matrix_mautrix_facebook_base_path }}/{{ item }}"
+    mode: 0640
+    owner: "{{ matrix_user_username }}"
+    group: "{{ matrix_user_groupname }}"
+  with_items:
+    - labels
+
 - name: Ensure matrix-mautrix-facebook.service installed
   ansible.builtin.template:
     src: "{{ role_path }}/templates/systemd/matrix-mautrix-facebook.service.j2"

roles/custom/matrix-bridge-mautrix-facebook/tasks/validate_config.yml

@@ -1,14 +1,28 @@
 ---
 
+- name: (Deprecation) Catch and report renamed mautrix-facebook settings
+  ansible.builtin.fail:
+    msg: >-
+      Your configuration contains a variable, which now has a different name.
+      Please change your configuration to rename the variable (`{{ item.old }}` -> `{{ item.new }}`).
+  when: "item.old in vars"
+  with_items:
+    - {'old': 'matrix_mautrix_facebook_public_endpoint', 'new': 'matrix_mautrix_facebook_appservice_public_prefix'}
+
 - name: Fail if required mautrix-facebook settings not defined
   ansible.builtin.fail:
     msg: >-
       You need to define a required configuration setting (`{{ item.name }}`).
   when: "item.when | bool and vars[item.name] == ''"
   with_items:
-    - {'name': 'matrix_mautrix_facebook_public_endpoint', when: true}
+    - {'name': 'matrix_mautrix_facebook_appservice_public_hostname', when: "{{ matrix_mautrix_facebook_appservice_public_enabled }}"}
+    - {'name': 'matrix_mautrix_facebook_appservice_public_prefix', when: "{{ matrix_mautrix_facebook_appservice_public_enabled }}"}
+    - {'name': 'matrix_mautrix_facebook_metrics_proxying_hostname', when: "{{ matrix_mautrix_facebook_metrics_enabled }}"}
+    - {'name': 'matrix_mautrix_facebook_metrics_proxying_path_prefix', when: "{{ matrix_mautrix_facebook_metrics_enabled }}"}
     - {'name': 'matrix_mautrix_facebook_appservice_token', when: true}
     - {'name': 'matrix_mautrix_facebook_homeserver_token', when: true}
+    - {'name': 'matrix_mautrix_facebook_container_network', when: true}
+    - {'name': 'matrix_mautrix_facebook_homeserver_address', when: true}
     - {'name': 'matrix_mautrix_facebook_database_hostname', when: "{{ matrix_mautrix_facebook_database_engine == 'postgres' }}"}
 
 - when: "matrix_mautrix_facebook_database_engine == 'sqlite' and matrix_mautrix_facebook_docker_image.endswith(':da1b4ec596e334325a1589e70829dea46e73064b')"
@@ -23,3 +37,4 @@
               "NOTE: Your mautrix-facebook bridge is still on SQLite and on the last version that supported it, before support was dropped. Support has been subsequently re-added in v0.3.2, so we advise you to upgrade (by removing your `matrix_mautrix_facebook_docker_image` definition from vars.yml)"
             ]
           }}
+

roles/custom/matrix-bridge-mautrix-facebook/templates/config.yaml.j2

@@ -37,7 +37,7 @@ appservice:
         # Whether or not the public-facing endpoints should be enabled.
         enabled: {{ matrix_mautrix_facebook_appservice_public_enabled|to_json }}
         # The prefix to use in the public-facing endpoints.
-        prefix: {{ matrix_mautrix_facebook_public_endpoint|to_json }}
+        prefix: {{ matrix_mautrix_facebook_appservice_public_prefix|to_json }}
         # The base URL where the public-facing endpoints are available. The prefix is not added
         # implicitly.
         external: {{ matrix_mautrix_facebook_appservice_public_external|to_json }}

roles/custom/matrix-bridge-mautrix-facebook/templates/labels.j2

@@ -0,0 +1,45 @@
+{% if matrix_mautrix_facebook_container_labels_traefik_enabled %}
+traefik.enable=true
+
+{% if matrix_mautrix_facebook_container_labels_traefik_docker_network %}
+traefik.docker.network={{ matrix_mautrix_facebook_container_labels_traefik_docker_network }}
+{% endif %}
+
+{# Public endpoint #}
+{% if matrix_mautrix_facebook_container_labels_public_endpoint_enabled %}
+traefik.http.routers.matrix-mautrix-facebook-public-endpoint.rule={{ matrix_mautrix_facebook_container_labels_public_endpoint_traefik_rule }}
+{% if matrix_mautrix_facebook_container_labels_public_endpoint_traefik_priority | int > 0 %}
+traefik.http.routers.matrix-mautrix-facebook-public-endpoint.priority={{ matrix_mautrix_facebook_container_labels_public_endpoint_traefik_priority }}
+{% endif %}
+traefik.http.routers.matrix-mautrix-facebook-public-endpoint.service=matrix-mautrix-facebook-appservice
+traefik.http.routers.matrix-mautrix-facebook-public-endpoint.entrypoints={{ matrix_mautrix_facebook_container_labels_public_endpoint_traefik_entrypoints }}
+traefik.http.routers.matrix-mautrix-facebook-public-endpoint.tls={{ matrix_mautrix_facebook_container_labels_public_endpoint_traefik_tls | to_json }}
+{% if matrix_mautrix_facebook_container_labels_public_endpoint_traefik_tls %}
+traefik.http.routers.matrix-mautrix-facebook-public-endpoint.tls.certResolver={{ matrix_mautrix_facebook_container_labels_public_endpoint_traefik_tls_certResolver }}
+{% endif %}
+traefik.http.services.matrix-mautrix-facebook-appservice.loadbalancer.server.port=29319
+{% endif %}
+
+{# Metrics #}
+{% if matrix_mautrix_facebook_container_labels_metrics_enabled %}
+traefik.http.routers.matrix-mautrix-facebook-metrics.rule={{ matrix_mautrix_facebook_container_labels_metrics_traefik_rule }}
+{% if matrix_mautrix_facebook_container_labels_metrics_traefik_priority | int > 0 %}
+traefik.http.routers.matrix-mautrix-facebook-metrics.priority={{ matrix_mautrix_facebook_container_labels_metrics_traefik_priority }}
+{% endif %}
+traefik.http.routers.matrix-mautrix-facebook-metrics.service=matrix-mautrix-facebook-metrics
+traefik.http.routers.matrix-mautrix-facebook-metrics.entrypoints={{ matrix_mautrix_facebook_container_labels_metrics_traefik_entrypoints }}
+traefik.http.routers.matrix-mautrix-facebook-metrics.tls={{ matrix_mautrix_facebook_container_labels_metrics_traefik_tls | to_json }}
+{% if matrix_mautrix_facebook_container_labels_metrics_traefik_tls %}
+traefik.http.routers.matrix-mautrix-facebook-metrics.tls.certResolver={{ matrix_mautrix_facebook_container_labels_metrics_traefik_tls_certResolver }}
+{% endif %}
+{% if matrix_mautrix_facebook_container_labels_metrics_middleware_basic_auth_enabled %}
+traefik.http.routers.matrix-mautrix-facebook-metrics.middlewares=matrix-mautrix-facebook-metrics-basic-auth
+traefik.http.middlewares.matrix-mautrix-facebook-metrics-basic-auth.basicauth.users={{ matrix_mautrix_facebook_container_labels_metrics_middleware_basic_auth_users }}
+{% endif %}
+
+traefik.http.services.matrix-mautrix-facebook-metrics.loadbalancer.server.port=8000
+{% endif %}
+
+{% endif %}
+
+{{ matrix_mautrix_facebook_container_labels_additional_labels }}

roles/custom/matrix-bridge-mautrix-facebook/templates/systemd/matrix-mautrix-facebook.service.j2

@@ -19,22 +19,31 @@ 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-mautrix-facebook \
+ExecStartPre={{ devture_systemd_docker_base_host_command_docker }} create \
+			--rm \
+			--name=matrix-mautrix-facebook \
 			--log-driver=none \
 			--user={{ matrix_user_uid }}:{{ matrix_user_gid }} \
 			--cap-drop=ALL \
-			--network={{ matrix_docker_network }} \
+			--network={{ matrix_mautrix_facebook_container_network }} \
 			{% if matrix_mautrix_facebook_appservice_public_enabled and matrix_mautrix_facebook_container_http_host_bind_port %}
 			-p {{ matrix_mautrix_facebook_container_http_host_bind_port }}:29319 \
 			{% endif %}
-			-v {{ matrix_mautrix_facebook_config_path }}:/config:z \
-			-v {{ matrix_mautrix_facebook_data_path }}:/data:z \
+			--mount type=bind,src={{ matrix_mautrix_facebook_config_path }},dst=/config \
+			--mount type=bind,src={{ matrix_mautrix_facebook_data_path }},dst=/data \
+			--label-file={{ matrix_mautrix_facebook_base_path }}/labels \
 			{% for arg in matrix_mautrix_facebook_container_extra_arguments %}
 			{{ arg }} \
 			{% endfor %}
 			{{ matrix_mautrix_facebook_docker_image }} \
 			python3 -m mautrix_facebook -c /config/config.yaml --no-update
 
+{% for network in matrix_mautrix_facebook_container_additional_networks %}
+ExecStartPre={{ devture_systemd_docker_base_host_command_docker }} network connect {{ network }} matrix-mautrix-facebook
+{% endfor %}
+
+ExecStart={{ devture_systemd_docker_base_host_command_docker }} start --attach matrix-mautrix-facebook
+
 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-mautrix-facebook 2>/dev/null || true'
 ExecStop=-{{ devture_systemd_docker_base_host_command_sh }} -c '{{ devture_systemd_docker_base_host_command_docker }} rm matrix-mautrix-facebook 2>/dev/null || true'
 Restart=always