# SPDX-FileCopyrightText: 2023 - 2024 Nikita Chernyi # SPDX-FileCopyrightText: 2023 - 2025 Slavi Pantaleev # SPDX-FileCopyrightText: 2024 Sergio Durigan Junior # SPDX-FileCopyrightText: 2025 MASH project contributors # SPDX-FileCopyrightText: 2025 Suguru Hirahara # # SPDX-License-Identifier: AGPL-3.0-or-later --- # Project source code URL: https://app.radicle.xyz/nodes/seed.radicle.garden/rad%3Az3Re1EQbd186vUQDwHByYiLadsVWY matrixto_enabled: true matrixto_identifier: matrixto matrixto_base_path: "/{{ matrixto_identifier }}" matrixto_version: 1.2.17-1 matrixto_uid: "" matrixto_gid: "" matrixto_scheme: https # The hostname at which Matrix.to is served. matrixto_hostname: "" # The path at which Matrix.to is exposed. # This value must either be `/` or not end with a slash (e.g. `/matrixto`). # # Hosting Matrix.to under a subpath does not seem to be possible due to Matrix.to's # technical limitations. matrixto_path_prefix: / matrixto_container_image: "{{ matrixto_container_image_registry_prefix }}shirahara/matrixto:{{ matrixto_container_image_tag }}" matrixto_container_image_tag: "{{ matrixto_version }}" matrixto_container_image_registry_prefix: "{{ matrixto_container_image_registry_prefix_upstream }}" matrixto_container_image_registry_prefix_upstream: "{{ matrixto_container_image_registry_prefix_upstream_default }}" matrixto_container_image_registry_prefix_upstream_default: "" matrixto_container_image_force_pull: "{{ matrixto_container_image.endswith(':latest') }}" matrixto_container_image_self_build: true matrixto_container_image_self_build_name: "shirahara/matrixto:{{ matrixto_container_image_self_build_repo_version }}" matrixto_container_image_self_build_repo: "https://seed.radicle.garden/z3Re1EQbd186vUQDwHByYiLadsVWY.git" matrixto_container_image_self_build_repo_version: "{{ matrixto_version if matrixto_version != 'latest' else 'main' }}" matrixto_container_image_self_build_src_files_path: "{{ matrixto_base_path }}/docker-src" # Controls whether the container exposes its HTTP port (tcp/8080 in the container). # # Takes an ":" or "" value (e.g. "127.0.0.1:2586"), or empty string to not expose. matrixto_container_http_host_bind_port: "" # The base container network. It will be auto-created by this role if it doesn't exist already. matrixto_container_network: "{{ matrixto_identifier }}" # The port number in the container matrixto_container_http_port: 5000 # 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. matrixto_container_additional_networks: "{{ matrixto_container_additional_networks_auto + matrixto_container_additional_networks_custom }}" matrixto_container_additional_networks_auto: [] matrixto_container_additional_networks_custom: [] # A list of additional "volumes" to mount in the container. # This list gets populated dynamically at runtime. You can provide a different default value, # if you wish to mount your own files into the container. # Contains definition objects like this: `{"type": "bind", "src": "/outside", "dst": "/inside", "options": "readonly"}. # See the `--mount` documentation for the `docker run` command. matrixto_container_additional_volumes: "{{ matrixto_container_additional_volumes_auto + matrixto_container_additional_volumes_custom }}" matrixto_container_additional_volumes_auto: [] matrixto_container_additional_volumes_custom: [] # matrixto_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 `matrixto_container_labels_additional_labels`. matrixto_container_labels_traefik_enabled: true matrixto_container_labels_traefik_docker_network: "{{ matrixto_container_network }}" matrixto_container_labels_traefik_hostname: "{{ matrixto_hostname }}" # The path prefix must either be `/` or not end with a slash (e.g. `/matrixto`). matrixto_container_labels_traefik_path_prefix: "{{ matrixto_path_prefix }}" matrixto_container_labels_traefik_rule: "Host(`{{ matrixto_container_labels_traefik_hostname }}`){% if matrixto_container_labels_traefik_path_prefix != '/' %} && PathPrefix(`{{ matrixto_container_labels_traefik_path_prefix }}`){% endif %}" matrixto_container_labels_traefik_priority: 0 matrixto_container_labels_traefik_entrypoints: web-secure matrixto_container_labels_traefik_tls: "{{ matrixto_container_labels_traefik_entrypoints != 'web' }}" matrixto_container_labels_traefik_tls_certResolver: default # noqa var-naming # Controls which additional headers to attach to all HTTP requests. # To add your own custom request headers, use `matrixto_container_labels_traefik_additional_request_headers_custom` matrixto_container_labels_traefik_additional_request_headers: "{{ matrixto_container_labels_traefik_additional_request_headers_auto | combine(matrixto_container_labels_traefik_additional_request_headers_custom) }}" matrixto_container_labels_traefik_additional_request_headers_auto: {} matrixto_container_labels_traefik_additional_request_headers_custom: {} # Controls which additional headers to attach to all HTTP responses. # To add your own custom response headers, use `matrixto_container_labels_traefik_additional_response_headers_custom` matrixto_container_labels_traefik_additional_response_headers: "{{ matrixto_container_labels_traefik_additional_response_headers_auto | combine(matrixto_container_labels_traefik_additional_response_headers_custom) }}" matrixto_container_labels_traefik_additional_response_headers_auto: | {{ {} | combine ({'X-XSS-Protection': matrixto_http_header_xss_protection} if matrixto_http_header_xss_protection else {}) | combine ({'X-Content-Type-Options': matrixto_http_header_content_type_options} if matrixto_http_header_content_type_options else {}) | combine ({'Content-Security-Policy': matrixto_http_header_content_security_policy} if matrixto_http_header_content_security_policy else {}) | combine ({'Permissions-Policy': matrixto_http_header_permissions_policy} if matrixto_http_header_permissions_policy else {}) | combine ({'Strict-Transport-Security': matrixto_http_header_strict_transport_security} if matrixto_http_header_strict_transport_security and matrixto_container_labels_traefik_tls else {}) }} matrixto_container_labels_traefik_additional_response_headers_custom: {} # matrixto_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: # matrixto_container_labels_additional_labels: | # my.label=1 # another.label="here" matrixto_container_labels_additional_labels: "" # A list of extra arguments to pass to the container (`docker run` command) matrixto_container_extra_arguments: [] # 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 matrixto_http_header_xss_protection: "1; mode=block" # 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 matrixto_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 matrixto_http_header_content_security_policy: frame-ancestors 'self' # Specifies the value of the `Permissions-Policy` header. # See: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Permissions-Policy matrixto_http_header_permissions_policy: "{{ 'interest-cohort=()' if matrixto_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 matrixto_http_header_strict_transport_security: "max-age=31536000; includeSubDomains{{ '; preload' if matrixto_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: `matrixto_http_header_permissions_policy` matrixto_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: `matrixto_http_header_strict_transport_security` matrixto_hsts_preload_enabled: false # List of systemd services that the Matrix.to systemd service depends on matrixto_systemd_required_services_list: "{{ matrixto_systemd_required_services_list_default + matrixto_systemd_required_services_list_auto + matrixto_systemd_required_services_list_custom }}" matrixto_systemd_required_services_list_default: "{{ [devture_systemd_docker_base_docker_service_name] if devture_systemd_docker_base_docker_service_name else [] }}" matrixto_systemd_required_services_list_auto: [] matrixto_systemd_required_services_list_custom: [] # List of systemd services that the Matrix.to systemd service wants matrixto_systemd_wanted_services_list: "{{ matrixto_systemd_wanted_services_list_default + matrixto_systemd_wanted_services_list_auto + matrixto_systemd_wanted_services_list_custom }}" matrixto_systemd_wanted_services_list_default: [] matrixto_systemd_wanted_services_list_auto: [] matrixto_systemd_wanted_services_list_custom: [] # Additional environment variables. matrixto_environment_variables_additional_variables: ""