Add native Traefik support to Dimension

roles/custom/matrix-dimension/defaults/main.yml

@@ -3,6 +3,15 @@
 
 matrix_dimension_enabled: false
 
+matrix_dimension_scheme: https
+
+# The hostname at which Dimension is served.
+matrix_dimension_hostname: ''
+
+# The path at which Dimension is exposed.
+# This value must either be `/` or not end with a slash (e.g. `/dimension`).
+matrix_dimension_path_prefix: /
+
 # You are required to specify an access token for Dimension to work.
 # For information on how to acquire an access token, visit https://t2bot.io/docs/access_tokens
 matrix_dimension_access_token: ""
@@ -35,21 +44,129 @@ matrix_dimension_systemd_wanted_services_list: []
 matrix_dimension_user_uid: '1000'
 matrix_dimension_user_gid: '1000'
 
+# The base container network. It will be auto-created by this role if it doesn't exist already.
+matrix_dimension_container_network: matrix-dimension
+
+# A list of additional container networks that the container would be connected to.
+# The role does not create these networks, so make sure they already exist.
+# Use this to expose this container to another reverse proxy, which runs in a different container network.
+matrix_dimension_container_additional_networks: []
+
 # Controls whether the matrix-dimension container exposes its HTTP port (tcp/8184 in the container).
 #
 # Takes an "<ip>:<port>" or "<port>" value (e.g. "127.0.0.1:8184"), or empty string to not expose.
 matrix_dimension_container_http_host_bind_port: ''
 
+
+# matrix_dimension_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_dimension_container_labels_additional_labels`.
+matrix_dimension_container_labels_traefik_enabled: true
+matrix_dimension_container_labels_traefik_docker_network: "{{ matrix_dimension_container_network }}"
+matrix_dimension_container_labels_traefik_hostname: "{{ matrix_dimension_hostname }}"
+# The path prefix must either be `/` or not end with a slash (e.g. `/dimension`).
+matrix_dimension_container_labels_traefik_path_prefix: "{{ matrix_dimension_path_prefix }}"
+matrix_dimension_container_labels_traefik_rule: "Host(`{{ matrix_dimension_container_labels_traefik_hostname }}`){% if matrix_dimension_container_labels_traefik_path_prefix != '/' %} && PathPrefix(`{{ matrix_dimension_container_labels_traefik_path_prefix }}`){% endif %}"
+matrix_dimension_container_labels_traefik_priority: 0
+matrix_dimension_container_labels_traefik_entrypoints: web-secure
+matrix_dimension_container_labels_traefik_tls: "{{ matrix_dimension_container_labels_traefik_entrypoints != 'web' }}"
+matrix_dimension_container_labels_traefik_tls_certResolver: default  # noqa var-naming
+
+# Controls which additional headers to attach to all HTTP responses.
+# To add your own headers, use `matrix_dimension_container_labels_traefik_additional_response_headers_custom`
+matrix_dimension_container_labels_traefik_additional_response_headers: "{{ matrix_dimension_container_labels_traefik_additional_response_headers_auto | combine(matrix_dimension_container_labels_traefik_additional_response_headers_custom) }}"
+matrix_dimension_container_labels_traefik_additional_response_headers_auto: |
+  {{
+    {}
+    | combine ({'X-XSS-Protection': matrix_dimension_http_header_xss_protection} if matrix_dimension_http_header_xss_protection else {})
+    | combine ({'X-Frame-Options': matrix_dimension_http_header_frame_options} if matrix_dimension_http_header_frame_options else {})
+    | combine ({'X-Content-Type-Options': matrix_dimension_http_header_content_type_options} if matrix_dimension_http_header_content_type_options else {})
+    | combine ({'Content-Security-Policy': matrix_dimension_http_header_content_security_policy} if matrix_dimension_http_header_content_security_policy else {})
+    | combine ({'Permission-Policy': matrix_dimension_http_header_content_permission_policy} if matrix_dimension_http_header_content_permission_policy else {})
+    | combine ({'Strict-Transport-Security': matrix_dimension_http_header_strict_transport_security} if matrix_dimension_http_header_strict_transport_security and matrix_dimension_container_labels_traefik_tls else {})
+  }}
+matrix_dimension_container_labels_traefik_additional_response_headers_custom: {}
+
+# matrix_dimension_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_dimension_container_labels_additional_labels: |
+#   my.label=1
+#   another.label="here"
+matrix_dimension_container_labels_additional_labels: ''
+
+
 # A list of extra arguments to pass to the container
 matrix_dimension_container_extra_arguments: []
 
-matrix_dimension_integrations_ui_url: "https://{{ matrix_server_fqn_dimension }}/element"
-matrix_dimension_integrations_rest_url: "https://{{ matrix_server_fqn_dimension }}/api/v1/scalar"
-matrix_dimension_integrations_widgets_urls: ["https://{{ matrix_server_fqn_dimension }}/widgets"]
-matrix_dimension_integrations_jitsi_widget_url: "https://{{ matrix_server_fqn_dimension }}/widgets/jitsi"
+# Public facing base URL of the Dimension service.
+# It should not end with a slash.
+matrix_dimension_base_url: "{{ matrix_dimension_scheme }}://{{ matrix_dimension_hostname }}{{ '' if matrix_dimension_path_prefix == '/' else matrix_dimension_path_prefix }}"
 
-matrix_dimension_homeserver_federationUrl: ""  # noqa var-naming
+matrix_dimension_integrations_ui_url: "{{ matrix_dimension_base_url }}/element"
+matrix_dimension_integrations_rest_url: "{{ matrix_dimension_base_url }}/api/v1/scalar"
+matrix_dimension_integrations_widgets_urls: ["{{ matrix_dimension_base_url }}/widgets"]
+matrix_dimension_integrations_jitsi_widget_url: "{{ matrix_dimension_base_url }}/widgets/jitsi"
 
+matrix_dimension_homeserver_clientServerUrl: ''  # noqa var-naming
+matrix_dimension_homeserver_federationUrl: ''  # noqa var-naming
+matrix_dimension_homeserver_mediaUrl: ''  # noqa var-naming
+
+# Controls the dimension.publicUrl configuration option
+matrix_dimension_dimension_publicUrl: "{{ matrix_dimension_base_url }}"  # noqa var-naming
+
+# Specifies the value of the `X-XSS-Protection` header
+# Stops pages from loading when they detect reflected cross-site scripting (XSS) attacks.
+#
+# Learn more about it is here:
+# - https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection
+# - https://portswigger.net/web-security/cross-site-scripting/reflected
+matrix_dimension_http_header_xss_protection: "1; mode=block"
+
+# Specifies the value of the `X-Frame-Options` header which controls whether framing can happen.
+# See: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options
+matrix_dimension_http_header_frame_options: ''
+
+# Specifies the value of the `X-Content-Type-Options` header.
+# See: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Content-Type-Options
+matrix_dimension_http_header_content_type_options: nosniff
+
+# Specifies the value of the `Content-Security-Policy` header.
+# See: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy
+matrix_dimension_http_header_content_security_policy: ''
+
+# Specifies the value of the `Permission-Policy` header.
+# See: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Permission-Policy
+matrix_dimension_http_header_content_permission_policy: "{{ 'interest-cohort=()' if matrix_dimension_floc_optout_enabled else '' }}"
+
+# Specifies the value of the `Strict-Transport-Security` header.
+# See: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security
+matrix_dimension_http_header_strict_transport_security: "max-age=31536000; includeSubDomains{{ '; preload' if matrix_dimension_hsts_preload_enabled else '' }}"
+
+# Controls whether to send a "Permissions-Policy interest-cohort=();" header along with all responses
+#
+# Learn more about what it is here:
+# - https://www.eff.org/deeplinks/2021/03/googles-floc-terrible-idea
+# - https://paramdeo.com/blog/opting-your-website-out-of-googles-floc-network
+# - https://amifloced.org/
+#
+# Of course, a better solution is to just stop using browsers (like Chrome), which participate in such tracking practices.
+# See: `matrix_dimension_content_permission_policy`
+matrix_dimension_floc_optout_enabled: true
+
+# Controls if HSTS preloading is enabled
+#
+# In its strongest and recommended form, the [HSTS policy](https://www.chromium.org/hsts) includes all subdomains, and
+# indicates a willingness to be "preloaded" into browsers:
+# `Strict-Transport-Security: max-age=31536000; includeSubDomains; preload`
+# For more information visit:
+# - https://en.wikipedia.org/wiki/HTTP_Strict_Transport_Security
+# - https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security
+# - https://hstspreload.org/#opt-in
+# See: `matrix_dimension_http_header_strict_transport_security`
+matrix_dimension_hsts_preload_enabled: false
 
 # Database-related configuration fields.
 #

roles/custom/matrix-dimension/tasks/setup_install.yml

@@ -85,6 +85,14 @@
     owner: "{{ matrix_user_username }}"
     group: "{{ matrix_dimension_user_gid }}"
 
+- name: Ensure Dimension labels installed
+  ansible.builtin.template:
+    src: "{{ role_path }}/templates/labels.j2"
+    dest: "{{ matrix_dimension_base_path }}/labels"
+    mode: 0640
+    owner: "{{ matrix_user_username }}"
+    group: "{{ matrix_user_groupname }}"
+
 - name: Ensure Dimension image is pulled
   community.docker.docker_image:
     name: "{{ matrix_dimension_docker_image }}"
@@ -120,6 +128,11 @@
       pull: true
   when: "matrix_dimension_container_image_self_build | bool"
 
+- name: Ensure Dimension container network is created
+  community.general.docker_network:
+    name: "{{ matrix_dimension_container_network }}"
+    driver: bridge
+
 - name: Ensure matrix-dimension.service installed
   ansible.builtin.template:
     src: "{{ role_path }}/templates/systemd/matrix-dimension.service.j2"

roles/custom/matrix-dimension/tasks/validate_config.yml

@@ -6,7 +6,12 @@
       You need to define a required configuration setting (`{{ item.name }}`).
   when: "item.when | bool and vars[item.name] == ''"
   with_items:
+    - {'name': 'matrix_dimension_hostname', when: true}
+    - {'name': 'matrix_dimension_container_network', when: true}
     - {'name': 'matrix_dimension_access_token', when: true}
+    - {'name': 'matrix_dimension_homeserver_clientServerUrl', when: true}
+    - {'name': 'matrix_dimension_homeserver_federationUrl', when: true}
+    - {'name': 'matrix_dimension_homeserver_mediaUrl', when: true}
     - {'name': 'matrix_dimension_database_hostname', when: "{{ matrix_dimension_database_engine == 'postgres' }}"}
 
 - name: (Deprecation) Catch and report renamed Dimension variables
@@ -17,3 +22,31 @@
   when: "item.old in vars"
   with_items:
     - {'old': 'matrix_dimension_container_expose_port', 'new': '<superseded by matrix_dimension_container_http_host_bind_port>'}
+
+- when: matrix_dimension_container_labels_traefik_enabled | bool
+  block:
+    - name: Fail if required Dimension Traefik settings not defined
+      ansible.builtin.fail:
+        msg: >-
+          You need to define a required configuration setting (`{{ item }}`).
+      when: "vars[item] == ''"
+      with_items:
+        - matrix_dimension_container_labels_traefik_hostname
+        - matrix_dimension_container_labels_traefik_path_prefix
+
+    # We ensure it doesn't end with a slash, because we handle both (slash and no-slash).
+    # Knowing that `matrix_dimension_container_labels_traefik_path_prefix` does not end with a slash
+    # ensures we know how to set these routes up without having to do "does it end with a slash" checks elsewhere.
+    - name: Fail if matrix_dimension_container_labels_traefik_path_prefix ends with a slash
+      ansible.builtin.fail:
+        msg: >-
+          matrix_dimension_container_labels_traefik_path_prefix (`{{ matrix_dimension_container_labels_traefik_path_prefix }}`) must either be `/` or not end with a slash (e.g. `/dimension`).
+      when: "matrix_dimension_container_labels_traefik_path_prefix != '/' and matrix_dimension_container_labels_traefik_path_prefix[-1] == '/'"
+
+    - name: Fail if matrix_dimension_container_labels_traefik_path_prefix is not /
+      ansible.builtin.fail:
+        msg: >-
+          matrix_dimension_container_labels_traefik_path_prefix (`{{ matrix_dimension_container_labels_traefik_path_prefix }}`) must currently be set to `/`.
+          Other values are not supported.
+          See: https://github.com/turt2live/matrix-dimension/issues/510
+      when: "matrix_dimension_container_labels_traefik_path_prefix != '/' and matrix_dimension_container_labels_traefik_path_prefix[-1] == '/'"

roles/custom/matrix-dimension/templates/config.yaml.j2

@@ -9,30 +9,30 @@ web:
 homeserver:
   # The domain name of the homeserver. This is used in many places, such as with go-neb
   # setups, to identify the homeserver.
-  name: "{{ matrix_domain }}"
+  name: {{ matrix_domain | to_json }}
 
   # The URL that Dimension, go-neb, and other services provisioned by Dimension should
   # use to access the homeserver with.
-  clientServerUrl: "{{ matrix_homeserver_container_url }}"
+  clientServerUrl: {{ matrix_dimension_homeserver_clientServerUrl | to_json }}
 
   # The URL that Dimension should use when trying to communicate with federated APIs on
   # the homeserver. If not supplied or left empty Dimension will try to resolve the address
   # through the normal federation process.
-  federationUrl: "{{ matrix_dimension_homeserver_federationUrl }}"
+  federationUrl: {{ matrix_dimension_homeserver_federationUrl | to_json }}
 
   # The URL that Dimension will redirect media requests to for downloading media such as
   # stickers. If not supplied or left empty Dimension will use the clientServerUrl.
-  mediaUrl: "https://{{ matrix_server_fqn_matrix }}"
+  mediaUrl: {{ matrix_dimension_homeserver_mediaUrl | to_json }}
 
   # The access token Dimension should use for miscellaneous access to the homeserver. This
   # should be for a user on the configured homeserver: any user will do, however it is
   # recommended to use a dedicated user (such as @dimension:t2bot.io). For information on
   # how to acquire an access token, visit https://t2bot.io/docs/access_tokens
-  accessToken: "{{ matrix_dimension_access_token }}"
+  accessToken: {{ matrix_dimension_access_token | to_json }}
 
 # These users can modify the integrations this Dimension supports.
 # To access the admin interface, open Dimension in Element and click the settings icon.
-admins: {{ matrix_dimension_admins|to_json }}
+admins: {{ matrix_dimension_admins | to_json }}
 
 # IPs and CIDR ranges listed here will be blocked from being widgets.
 # Note: Widgets may still be embedded with restricted content, although not through Dimension directly.
@@ -72,4 +72,4 @@ goneb:
 dimension:
   # This is where Dimension is accessible from clients. Be sure to set this
   # to your own Dimension instance.
-  publicUrl: "https://{{ matrix_server_fqn_dimension }}"
+  publicUrl: {{ matrix_dimension_dimension_publicUrl | to_json }}

roles/custom/matrix-dimension/templates/labels.j2

@@ -0,0 +1,45 @@
+{% if matrix_dimension_container_labels_traefik_enabled %}
+traefik.enable=true
+
+{% if matrix_dimension_container_labels_traefik_docker_network %}
+traefik.docker.network={{ matrix_dimension_container_labels_traefik_docker_network }}
+{% endif %}
+
+{% set middlewares = [] %}
+
+{% if matrix_dimension_container_labels_traefik_path_prefix != '/' %}
+traefik.http.middlewares.matrix-dimension-slashless-redirect.redirectregex.regex=({{ matrix_dimension_container_labels_traefik_path_prefix | quote }})$
+traefik.http.middlewares.matrix-dimension-slashless-redirect.redirectregex.replacement=${1}/
+{% set middlewares = middlewares + ['matrix-dimension-slashless-redirect'] %}
+{% endif %}
+
+{% if matrix_dimension_container_labels_traefik_path_prefix != '/' %}
+traefik.http.middlewares.matrix-dimension-strip-prefix.stripprefix.prefixes={{ matrix_dimension_container_labels_traefik_path_prefix }}
+{% set middlewares = middlewares + ['matrix-dimension-strip-prefix'] %}
+{% endif %}
+
+{% if matrix_dimension_container_labels_traefik_additional_response_headers.keys() | length > 0 %}
+{% for name, value in matrix_dimension_container_labels_traefik_additional_response_headers.items() %}
+traefik.http.middlewares.matrix-dimension-add-headers.headers.customresponseheaders.{{ name }}={{ value }}
+{% endfor %}
+{% set middlewares = middlewares + ['matrix-dimension-add-headers'] %}
+{% endif %}
+
+traefik.http.routers.matrix-dimension.rule={{ matrix_dimension_container_labels_traefik_rule }}
+{% if matrix_dimension_container_labels_traefik_priority | int > 0 %}
+traefik.http.routers.matrix-dimension.priority={{ matrix_dimension_container_labels_traefik_priority }}
+{% endif %}
+traefik.http.routers.matrix-dimension.service=matrix-dimension
+{% if middlewares | length > 0 %}
+traefik.http.routers.matrix-dimension.middlewares={{ middlewares | join(',') }}
+{% endif %}
+traefik.http.routers.matrix-dimension.entrypoints={{ matrix_dimension_container_labels_traefik_entrypoints }}
+traefik.http.routers.matrix-dimension.tls={{ matrix_dimension_container_labels_traefik_tls | to_json }}
+{% if matrix_dimension_container_labels_traefik_tls %}
+traefik.http.routers.matrix-dimension.tls.certResolver={{ matrix_dimension_container_labels_traefik_tls_certResolver }}
+{% endif %}
+
+traefik.http.services.matrix-dimension.loadbalancer.server.port=8184
+{% endif %}
+
+{{ matrix_dimension_container_labels_additional_labels }}

roles/custom/matrix-dimension/templates/systemd/matrix-dimension.service.j2

@@ -21,25 +21,35 @@ ExecStartPre=-{{ devture_systemd_docker_base_host_command_sh }} -c '{{ devture_s
 ExecStartPre=-{{ matrix_host_command_chown }} {{ matrix_dimension_user_uid }}:{{ matrix_dimension_user_gid }} {{ matrix_dimension_sqlite_database_path_local }}
 {% endif %}
 
-ExecStart={{ devture_systemd_docker_base_host_command_docker }} run --rm --name matrix-dimension \
+ExecStartPre={{ devture_systemd_docker_base_host_command_docker }} create \
+			--rm \
+			--name=matrix-dimension \
 			--log-driver=none \
 			--user={{ matrix_dimension_user_uid }}:{{ matrix_dimension_user_gid }} \
 			--cap-drop=ALL \
-			--network={{ matrix_docker_network }} \
+			--network={{ matrix_dimension_container_network }} \
 			{% if matrix_dimension_widgets_allow_self_signed_ssl_certificates %}
 			-e NODE_TLS_REJECT_UNAUTHORIZED=0 \
 			{% endif %}
 			{% if matrix_dimension_container_http_host_bind_port %}
 			-p {{ matrix_dimension_container_http_host_bind_port }}:8184 \
 			{% endif %}
+			--label-file={{ matrix_dimension_base_path }}/labels \
 			--mount type=bind,src={{ matrix_dimension_base_path }},dst=/data \
 			{% for arg in matrix_dimension_container_extra_arguments %}
 			{{ arg }} \
 			{% endfor %}
 			{{ matrix_dimension_docker_image }}
 
+{% for network in matrix_dimension_container_additional_networks %}
+ExecStartPre={{ devture_systemd_docker_base_host_command_docker }} network connect {{ network }} matrix-dimension
+{% endfor %}
+
+ExecStart={{ devture_systemd_docker_base_host_command_docker }} start --attach matrix-dimension
+
 ExecStop=-{{ devture_systemd_docker_base_host_command_sh }} -c '{{ devture_systemd_docker_base_host_command_docker }} kill matrix-dimension 2>/dev/null || true'
 ExecStop=-{{ devture_systemd_docker_base_host_command_sh }} -c '{{ devture_systemd_docker_base_host_command_docker }} rm matrix-dimension 2>/dev/null || true'
+
 Restart=always
 RestartSec=30
 SyslogIdentifier=matrix-dimension