Move matrix-bridge-mx-puppet-twitter to its own container network and add native Traefik support

group_vars/matrix_servers

@@ -1791,19 +1791,37 @@ matrix_mx_puppet_slack_database_password: "{{ '%s' | format(matrix_homeserver_ge
 # We don't enable bridges by default.
 matrix_mx_puppet_twitter_enabled: false
 
+matrix_mx_puppet_twitter_hostname: "{{ matrix_server_fqn_matrix }}"
+
+matrix_mx_puppet_twitter_systemd_required_services_list_auto: |
+  {{
+    matrix_addons_homeserver_systemd_services_list
+    +
+    ([devture_postgres_identifier ~ '.service'] if (devture_postgres_enabled and matrix_mx_puppet_twitter_database_hostname == devture_postgres_connection_hostname) else [])
+  }}
+
 matrix_mx_puppet_twitter_container_image_self_build: "{{ matrix_architecture != 'amd64' }}"
 
-matrix_mx_puppet_twitter_systemd_required_services_list: |
+matrix_mx_puppet_twitter_container_http_host_bind_port: "{{ (matrix_playbook_service_host_bind_interface_prefix ~ '' ~ matrix_mx_puppet_twitter_appservice_port) if matrix_playbook_service_host_bind_interface_prefix else '' }}"
+
+matrix_mx_puppet_twitter_container_network: "{{ matrix_addons_container_network }}"
+
+matrix_mx_puppet_twitter_container_additional_networks_auto: |-
   {{
-    ['docker.service']
+    (
-    +
+      ([] if matrix_addons_homeserver_container_network == '' else [matrix_addons_homeserver_container_network])
-    ['matrix-' + matrix_homeserver_implementation + '.service']
+      +
-    +
+      ([devture_postgres_container_network] if (devture_postgres_enabled and matrix_mx_puppet_twitter_database_hostname == devture_postgres_connection_hostname and matrix_mx_puppet_twitter_container_network != devture_postgres_container_network) else [])
-    ([devture_postgres_identifier ~ '.service'] if devture_postgres_enabled else [])
+      +
-    +
+      ([matrix_playbook_reverse_proxyable_services_additional_network] if (matrix_playbook_reverse_proxyable_services_additional_network and matrix_mx_puppet_twitter_container_labels_traefik_enabled) else [])
-    (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else [])
+    ) | unique
   }}
 
+matrix_mx_puppet_twitter_container_labels_traefik_enabled: "{{ matrix_playbook_reverse_proxy_type in ['playbook-managed-traefik', 'other-traefik-container'] }}"
+matrix_mx_puppet_twitter_container_labels_traefik_docker_network: "{{ matrix_playbook_reverse_proxyable_services_additional_network }}"
+matrix_mx_puppet_twitter_container_labels_traefik_entrypoints: "{{ devture_traefik_entrypoint_primary }}"
+matrix_mx_puppet_twitter_container_labels_traefik_tls_certResolver: "{{ devture_traefik_certResolver_primary }}"
+
 matrix_mx_puppet_twitter_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxtwt.as.tok', rounds=655555) | to_uuid }}"
 
 matrix_mx_puppet_twitter_homeserver_address: "{{ matrix_addons_homeserver_client_api_url }}"
@@ -1811,7 +1829,7 @@ matrix_mx_puppet_twitter_homeserver_token: "{{ '%s' | format(matrix_homeserver_g
 
 matrix_mx_puppet_twitter_login_shared_secret: "{{ matrix_synapse_ext_password_provider_shared_secret_auth_shared_secret if matrix_synapse_ext_password_provider_shared_secret_auth_enabled else '' }}"
 
-matrix_mx_puppet_twitter_container_http_host_bind_port: "{{ (matrix_playbook_service_host_bind_interface_prefix ~ '' ~ matrix_mx_puppet_twitter_appservice_port) if matrix_playbook_service_host_bind_interface_prefix else '' }}"
+matrix_mx_puppet_twitter_presence_enabled: "{{ matrix_homeserver_implementation != 'synapse' or matrix_synapse_presence_enabled }}"
 
 # Postgres is the default, except if not using internal Postgres server
 matrix_mx_puppet_twitter_database_engine: "{{ 'postgres' if devture_postgres_enabled else 'sqlite' }}"

roles/custom/matrix-bridge-mx-puppet-twitter/defaults/main.yml

@@ -5,6 +5,10 @@
 
 matrix_mx_puppet_twitter_enabled: true
 
+matrix_mx_puppet_twitter_scheme: https
+matrix_mx_puppet_twitter_hostname: ''
+matrix_mx_puppet_twitter_path_prefix: /twitter/webhook
+
 matrix_mx_puppet_twitter_container_image_self_build: false
 matrix_mx_puppet_twitter_container_image_self_build_repo: "https://github.com/Sorunome/mx-puppet-twitter.git"
 
@@ -35,8 +39,8 @@ matrix_mx_puppet_twitter_consumer_secret: ''
 matrix_mx_puppet_twitter_access_token: ''
 matrix_mx_puppet_twitter_access_token_secret: ''
 matrix_mx_puppet_twitter_environment: ''
-matrix_mx_puppet_twitter_webhook_path: '/twitter/webhook'
+matrix_mx_puppet_twitter_server_path: "{{ matrix_mx_puppet_twitter_path_prefix }}"
-matrix_mx_puppet_twitter_webhook_url: 'https://{{ matrix_server_fqn_matrix }}{{ matrix_mx_puppet_twitter_webhook_path }}'
+matrix_mx_puppet_twitter_server_url: 'https://{{ matrix_server_fqn_matrix }}{{ matrix_mx_puppet_twitter_server_path }}'
 
 # "@user:server.com" to allow specific user
 # "@.*:yourserver.com" to allow users on a specific homeserver
@@ -49,11 +53,48 @@ matrix_mx_puppet_twitter_provisioning_whitelist:
 # "@.*:yourserver.com" disallow users on a specific homeserver
 matrix_mx_puppet_twitter_provisioning_blacklist: []
 
+matrix_mx_puppet_twitter_container_network: ""
+
+matrix_mx_puppet_twitter_container_additional_networks: "{{ matrix_mx_puppet_twitter_container_additional_networks_auto + matrix_mx_puppet_twitter_container_additional_networks_custom }}"
+matrix_mx_puppet_twitter_container_additional_networks_auto: []
+matrix_mx_puppet_twitter_container_additional_networks_custom: []
+
+# matrix_mx_puppet_twitter_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_mx_puppet_twitter_container_labels_additional_labels`.
+matrix_mx_puppet_twitter_container_labels_traefik_enabled: true
+matrix_mx_puppet_twitter_container_labels_traefik_docker_network: "{{ matrix_mx_puppet_twitter_container_network }}"
+matrix_mx_puppet_twitter_container_labels_traefik_entrypoints: web-secure
+matrix_mx_puppet_twitter_container_labels_traefik_tls_certResolver: default  # noqa var-naming
+
+# Controls whether labels will be added that expose mx-puppet-twitter's public endpoint
+matrix_mx_puppet_twitter_container_labels_public_endpoint_enabled: true
+matrix_mx_puppet_twitter_container_labels_public_endpoint_hostname: "{{ matrix_mx_puppet_twitter_hostname }}"
+matrix_mx_puppet_twitter_container_labels_public_endpoint_path_prefix: "{{ matrix_mx_puppet_twitter_path_prefix }}"
+matrix_mx_puppet_twitter_container_labels_public_endpoint_traefik_rule: "Host(`{{ matrix_mx_puppet_twitter_container_labels_public_endpoint_hostname }}`) && PathPrefix(`{{ matrix_mx_puppet_twitter_container_labels_public_endpoint_path_prefix }}`)"
+matrix_mx_puppet_twitter_container_labels_public_endpoint_traefik_priority: 0
+matrix_mx_puppet_twitter_container_labels_public_endpoint_traefik_entrypoints: "{{ matrix_mx_puppet_twitter_container_labels_traefik_entrypoints }}"
+matrix_mx_puppet_twitter_container_labels_public_endpoint_traefik_tls: "{{ matrix_mx_puppet_twitter_container_labels_public_endpoint_traefik_entrypoints != 'web' }}"
+matrix_mx_puppet_twitter_container_labels_public_endpoint_traefik_tls_certResolver: "{{ matrix_mx_puppet_twitter_container_labels_traefik_tls_certResolver }}"  # noqa var-naming
+
+# matrix_mx_puppet_twitter_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_mx_puppet_twitter_container_labels_additional_labels: |
+#   my.label=1
+#   another.label="here"
+matrix_mx_puppet_twitter_container_labels_additional_labels: ''
+
 # A list of extra arguments to pass to the container
 matrix_mx_puppet_twitter_container_extra_arguments: []
 
 # List of systemd services that mx-puppet-twitter.service depends on.
-matrix_mx_puppet_twitter_systemd_required_services_list: ['docker.service']
+matrix_mx_puppet_twitter_systemd_required_services_list: "{{ matrix_mx_puppet_twitter_systemd_required_services_list_default + matrix_mx_puppet_twitter_systemd_required_services_list_auto + matrix_mx_puppet_twitter_systemd_required_services_list_custom }}"
+matrix_mx_puppet_twitter_systemd_required_services_list_default: ['docker.service']
+matrix_mx_puppet_twitter_systemd_required_services_list_auto: []
+matrix_mx_puppet_twitter_systemd_required_services_list_custom: []
 
 # List of systemd services that mx-puppet-twitter.service wants
 matrix_mx_puppet_twitter_systemd_wanted_services_list: []
@@ -64,6 +105,9 @@ matrix_mx_puppet_twitter_homeserver_token: ''
 # Can be set to enable automatic double-puppeting via Shared Secret Auth (https://github.com/devture/matrix-synapse-shared-secret-auth).
 matrix_mx_puppet_twitter_login_shared_secret: ''
 
+matrix_mx_puppet_twitter_presence_enabled: true
+matrix_mx_puppet_twitter_presence_interval: 5000
+
 # Database configuration
 matrix_mx_puppet_twitter_database_engine: sqlite
 

roles/custom/matrix-bridge-mx-puppet-twitter/tasks/inject_into_nginx_proxy.yml

@@ -1,44 +0,0 @@
----
-
-- name: Fail if matrix-nginx-proxy role already executed
-  ansible.builtin.fail:
-    msg: >-
-      Trying to append Twitter 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-mx-puppet-twitter role.
-  when: matrix_nginx_proxy_role_executed | default(False) | bool
-
-- name: Generate Matrix MX Puppet Twitter proxying configuration for matrix-nginx-proxy
-  ansible.builtin.set_fact:
-    matrix_mx_puppet_twitter_matrix_nginx_proxy_configuration: |
-      location {{ matrix_mx_puppet_twitter_webhook_path }} {
-      {% 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_mx_puppet_twitter_appservice_address }}";
-          proxy_pass $backend;
-      {% else %}
-          {# Generic configuration for use outside of our container setup #}
-          proxy_pass http://127.0.0.1:{{ matrix_mx_puppet_twitter_appservice_port }};
-      {% endif %}
-      }
-
-- name: Register Twitter 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_mx_puppet_twitter_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 Twitter bridge but are not using the matrix-nginx-proxy
-      reverse proxy.
-      Please make sure that you're proxying the `{{ matrix_mx_puppet_twitter_redirect_path }}`
-      URL endpoint to the matrix-mx-puppet-twitter container.
-      You can expose the container's port using the `matrix_mx_puppet_twitter_container_http_host_bind_port` variable.
-  when: "not matrix_nginx_proxy_enabled | default(False) | bool"

roles/custom/matrix-bridge-mx-puppet-twitter/tasks/main.yml

@@ -1,14 +1,5 @@
 ---
 
-- tags:
-    - setup-all
-    - setup-nginx-proxy
-    - install-all
-    - install-nginx-proxy
-  block:
-    - when: matrix_mx_puppet_twitter_enabled | bool
-      ansible.builtin.include_tasks: "{{ role_path }}/tasks/inject_into_nginx_proxy.yml"
-
 - tags:
     - setup-all
     - setup-mx-puppet-twitter

roles/custom/matrix-bridge-mx-puppet-twitter/tasks/setup_install.yml

@@ -113,6 +113,21 @@
     owner: "{{ matrix_user_username }}"
     group: "{{ matrix_user_groupname }}"
 
+- name: Ensure mx-puppet-twitter support files installed
+  ansible.builtin.template:
+    src: "{{ role_path }}/templates/{{ item }}.j2"
+    dest: "{{ matrix_mx_puppet_twitter_base_path }}/{{ item }}"
+    mode: 0640
+    owner: "{{ matrix_user_username }}"
+    group: "{{ matrix_user_groupname }}"
+  with_items:
+    - labels
+
+- name: Ensure mx-puppet-twitter container network is created
+  community.general.docker_network:
+    name: "{{ matrix_mx_puppet_twitter_container_network }}"
+    driver: bridge
+
 - name: Ensure matrix-mx-puppet-twitter.service installed
   ansible.builtin.template:
     src: "{{ role_path }}/templates/systemd/matrix-mx-puppet-twitter.service.j2"

roles/custom/matrix-bridge-mx-puppet-twitter/tasks/validate_config.yml

@@ -6,7 +6,20 @@
       You need to define a required configuration setting (`{{ item.name }}`).
   when: "item.when | bool and vars[item.name] == ''"
   with_items:
+    - {'name': 'matrix_mx_puppet_twitter_hostname', when: true}
+    - {'name': 'matrix_mx_puppet_twitter_path_prefix', when: true}
     - {'name': 'matrix_mx_puppet_twitter_appservice_token', when: true}
     - {'name': 'matrix_mx_puppet_twitter_homeserver_address', when: true}
     - {'name': 'matrix_mx_puppet_twitter_homeserver_token', when: true}
     - {'name': 'matrix_mx_puppet_twitter_database_hostname', when: "{{ matrix_mx_puppet_twitter_database_engine == 'postgres' }}"}
+    - {'name': 'matrix_mx_puppet_twitter_container_network', when: true}
+
+- name: (Deprecation) Catch and report renamed mx-puppet-twitter 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_mx_puppet_twitter_webhook_path', 'new': '<matrix_mx_puppet_twitter_server_path, but setting matrix_mx_puppet_twitter_path_prefix is better'}
+    - {'old': 'matrix_mx_puppet_twitter_webhook_url', 'new': 'matrix_mx_puppet_twitter_server_url, but controlling matrix_mx_puppet_twitter_scheme/matrix_mx_puppet_twitter_hostname/matrix_mx_puppet_twitter_path_prefix is better'}

roles/custom/matrix-bridge-mx-puppet-twitter/templates/config.yaml.j2

@@ -15,20 +15,20 @@ bridge:
   {% endif %}
 
 twitter:
-  consumerKey: "{{ matrix_mx_puppet_twitter_consumer_key }}"
+  consumerKey: {{ matrix_mx_puppet_twitter_consumer_keyl | to_json }}
-  consumerSecret: "{{ matrix_mx_puppet_twitter_consumer_secret }}"
+  consumerSecret: {{ matrix_mx_puppet_twitter_consumer_secretl | to_json }}
-  accessToken: "{{ matrix_mx_puppet_twitter_access_token }}"
+  accessToken: {{ matrix_mx_puppet_twitter_access_tokenl | to_json }}
-  accessTokenSecret: "{{ matrix_mx_puppet_twitter_access_token_secret }}"
+  accessTokenSecret: {{ matrix_mx_puppet_twitter_access_token_secretl | to_json }}
-  environment: "{{ matrix_mx_puppet_twitter_environment }}"
+  environment: {{ matrix_mx_puppet_twitter_environmentl | to_json }}
   server:
-    url: "{{ matrix_mx_puppet_twitter_webhook_url }}"
+    url: {{ matrix_mx_puppet_twitter_server_url | to_json }}
-    path: "{{ matrix_mx_puppet_twitter_webhook_path }}"
+    path: {{ matrix_mx_puppet_twitter_server_path | to_json }}
 
 presence:
   # Bridge Twitter online/offline status
-  enabled: true
+  enabled: {{ matrix_mx_puppet_twitter_presence_enabled | to_json }}
   # How often to send status to the homeserver in milliseconds
-  interval: 5000
+  interval: {{ matrix_mx_puppet_twitter_presence_interval | to_json }}
 
 provisioning:
   # Regex of Matrix IDs allowed to use the puppet bridge

roles/custom/matrix-bridge-mx-puppet-twitter/templates/labels.j2

@@ -0,0 +1,26 @@
+{% if matrix_mx_puppet_twitter_container_labels_traefik_enabled %}
+traefik.enable=true
+
+{% if matrix_mx_puppet_twitter_container_labels_traefik_docker_network %}
+traefik.docker.network={{ matrix_mx_puppet_twitter_container_labels_traefik_docker_network }}
+{% endif %}
+
+{# Public endpoint #}
+{% if matrix_mx_puppet_twitter_container_labels_public_endpoint_enabled %}
+traefik.http.routers.matrix-mx-puppet-twitter-public.rule={{ matrix_mx_puppet_twitter_container_labels_public_endpoint_traefik_rule }}
+{% if matrix_mx_puppet_twitter_container_labels_public_endpoint_traefik_priority | int > 0 %}
+traefik.http.routers.matrix-mx-puppet-twitter-public.priority={{ matrix_mx_puppet_twitter_container_labels_public_endpoint_traefik_priority }}
+{% endif %}
+traefik.http.routers.matrix-mx-puppet-twitter-public.service=martix-mx-puppet-twitter
+traefik.http.routers.matrix-mx-puppet-twitter-public.entrypoints={{ matrix_mx_puppet_twitter_container_labels_public_endpoint_traefik_entrypoints }}
+traefik.http.routers.matrix-mx-puppet-twitter-public.tls={{ matrix_mx_puppet_twitter_container_labels_public_endpoint_traefik_tls | to_json }}
+{% if matrix_mx_puppet_twitter_container_labels_public_endpoint_traefik_tls %}
+traefik.http.routers.matrix-mx-puppet-twitter-public.tls.certResolver={{ matrix_mx_puppet_twitter_container_labels_public_endpoint_traefik_tls_certResolver }}
+{% endif %}
+traefik.http.services.martix-mx-puppet-twitter.loadbalancer.server.port={{ matrix_mx_puppet_twitter_appservice_port }}
+{% endif %}
+
+
+{% endif %}
+
+{{ matrix_mx_puppet_twitter_container_labels_additional_labels }}