matrix-docker-ansible-deploy/roles/custom/matrix-client-hydrogen/defaults/main.yml

# SPDX-FileCopyrightText: 2021 - 2022 Aaron Raimist
# SPDX-FileCopyrightText: 2021 - 2022 MDAD project contributors
# SPDX-FileCopyrightText: 2021 - 2025 Slavi Pantaleev
# SPDX-FileCopyrightText: 2022 - 2023 Nikita Chernyi
# SPDX-FileCopyrightText: 2022 Marko Weltzer
# SPDX-FileCopyrightText: 2022 Matthew Cengia
# SPDX-FileCopyrightText: 2023 Pierre 'McFly' Marty
# SPDX-FileCopyrightText: 2023 Samuel Meenzen
#
# SPDX-License-Identifier: AGPL-3.0-or-later

---
# Project source code URL: https://github.com/element-hq/hydrogen-web

hydrogen_enabled: true

hydrogen_container_image_self_build: false
hydrogen_container_image_self_build_repo: "https://github.com/element-hq/hydrogen-web.git"

# renovate: datasource=docker depName=ghcr.io/element-hq/hydrogen-web
hydrogen_version: v0.5.1
hydrogen_container_image: "{{ hydrogen_container_image_registry_prefix }}element-hq/hydrogen-web:{{ hydrogen_version }}"
hydrogen_container_image_registry_prefix_upstream_default: ghcr.io/
hydrogen_container_image_force_pull: "{{ hydrogen_container_image.endswith(':latest') }}"

hydrogen_base_path: "{{ matrix_base_data_path }}/client-hydrogen"
hydrogen_docker_src_files_path: "{{ hydrogen_base_path }}/docker-src"

# The base container network
hydrogen_container_network: ''

# 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 a reverse proxy, which runs in a different container network.
hydrogen_container_additional_networks: []

# Controls whether the container exposes its HTTP port (tcp/8080 in the container).
#
# Takes an "<ip>:<port>" or "<port>" value (e.g. "127.0.0.1:8768"), or empty string to not expose.
hydrogen_container_http_host_bind_port: ''

# hydrogen_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 `hydrogen_container_labels_additional_labels`.
hydrogen_container_labels_traefik_enabled: true
hydrogen_container_labels_traefik_docker_network: "{{ hydrogen_container_network }}"
hydrogen_container_labels_traefik_hostname: "{{ hydrogen_hostname }}"
# The path prefix must either be `/` or not end with a slash (e.g. `/hydrogen`).
hydrogen_container_labels_traefik_path_prefix: "{{ hydrogen_path_prefix }}"
hydrogen_container_labels_traefik_rule: "Host(`{{ hydrogen_container_labels_traefik_hostname }}`){% if hydrogen_container_labels_traefik_path_prefix != '/' %} && PathPrefix(`{{ hydrogen_container_labels_traefik_path_prefix }}`){% endif %}"
hydrogen_container_labels_traefik_priority: 0
hydrogen_container_labels_traefik_entrypoints: web-secure
hydrogen_container_labels_traefik_tls: "{{ hydrogen_container_labels_traefik_entrypoints != 'web' }}"
hydrogen_container_labels_traefik_tls_certResolver: default  # noqa var-naming

# Controls whether a compression middleware will be injected into the middlewares list.
# This compression middleware is supposed to be defined elsewhere (using labels or a File provider, etc.) and is merely referenced by this router.
hydrogen_container_labels_traefik_compression_middleware_enabled: false
hydrogen_container_labels_traefik_compression_middleware_name: ""

# Controls which additional headers to attach to all HTTP responses.
# To add your own headers, use `hydrogen_container_labels_traefik_additional_response_headers_custom`
hydrogen_container_labels_traefik_additional_response_headers: "{{ hydrogen_container_labels_traefik_additional_response_headers_auto | combine(hydrogen_container_labels_traefik_additional_response_headers_custom) }}"
hydrogen_container_labels_traefik_additional_response_headers_auto: |
  {{
    {}
    | combine ({'X-XSS-Protection': hydrogen_http_header_xss_protection} if hydrogen_http_header_xss_protection else {})
    | combine ({'X-Content-Type-Options': hydrogen_http_header_content_type_options} if hydrogen_http_header_content_type_options else {})
    | combine ({'Content-Security-Policy': hydrogen_http_header_content_security_policy} if hydrogen_http_header_content_security_policy else {})
    | combine ({'Permission-Policy': hydrogen_http_header_content_permission_policy} if hydrogen_http_header_content_permission_policy else {})
    | combine ({'Strict-Transport-Security': hydrogen_http_header_strict_transport_security} if hydrogen_http_header_strict_transport_security and hydrogen_container_labels_traefik_tls else {})
  }}
hydrogen_container_labels_traefik_additional_response_headers_custom: {}

# hydrogen_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:
# hydrogen_container_labels_additional_labels: |
#   my.label=1
#   another.label="here"
hydrogen_container_labels_additional_labels: ''

# A list of extra arguments to pass to the container
hydrogen_container_extra_arguments: []

# List of systemd services that hydrogen.service depends on
hydrogen_systemd_required_services_list: "{{ [devture_systemd_docker_base_docker_service_name] if devture_systemd_docker_base_docker_service_name else [] }}"

# 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
hydrogen_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
hydrogen_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
hydrogen_http_header_content_security_policy: frame-ancestors 'self'

# Specifies the value of the `Permission-Policy` header.
# See: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Permission-Policy
hydrogen_http_header_content_permission_policy: "{{ 'interest-cohort=()' if hydrogen_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
hydrogen_http_header_strict_transport_security: "max-age=31536000; includeSubDomains{{ '; preload' if hydrogen_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: `hydrogen_content_permission_policy`
hydrogen_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: `hydrogen_http_header_strict_transport_security`
hydrogen_hsts_preload_enabled: false

hydrogen_scheme: https

# The path at which Hydrogen is exposed.
# This value must either be `/` or not end with a slash (e.g. `/hydrogen`).
hydrogen_path_prefix: /

# Controls whether the self-check feature should validate SSL certificates.
hydrogen_self_check_validate_certificates: true

# Controls whether the access log is enabled.
hydrogen_access_log_enabled: true

# config.json
hydrogen_push:
  appId: io.element.hydrogen.web
  gatewayUrl: https://matrix.org
  applicationServerKey: "BC-gpSdVHEXhvHSHS0AzzWrQoukv2BE7KzpoPO_FfPacqOo3l1pdqz7rSgmB04pZCWaHPz7XRe6fjLaC-WPDopM"
hydrogen_default_hs_url: ""
hydrogen_bugReportEndpointUrl: "https://element.io/bugreports/submit"  # noqa var-naming

# Default Hydrogen configuration template which covers the generic use case.
# You can customize it by controlling the various variables inside it.
#
# For a more advanced customization, you can extend the default (see `hydrogen_configuration_extension_json`)
# or completely replace this variable with your own template.
#
# The side-effect of this lookup is that Ansible would even parse the JSON for us, returning a dict.
# This is unlike what it does when looking up YAML template files (no automatic parsing there).
hydrogen_configuration_default: "{{ lookup('template', 'templates/config.json.j2', convert_data=False) | from_json }}"

# Your custom JSON configuration for Hydrogen should go to `hydrogen_configuration_extension_json`.
# This configuration extends the default starting configuration (`hydrogen_configuration_default`).
#
# You can override individual variables from the default configuration, or introduce new ones.
#
# If you need something more special, you can take full control by
# completely redefining `hydrogen_configuration_default`.
#
# Example configuration extension follows:
#
# hydrogen_configuration_extension_json: |
#  {
#    "push": {
#      "appId": "io.element.hydrogen.web",
#      "gatewayUrl": "https://matrix.org",
#      "applicationServerKey": "BC-gpSdVHEXhvHSHS0AzzWrQoukv2BE7KzpoPO_FfPacqOo3l1pdqz7rSgmB04pZCWaHPz7XRe6fjLaC-WPDopM"
#    },
#    "defaultHomeServer": "matrix.org"
#  }
hydrogen_configuration_extension_json: '{}'

hydrogen_configuration_extension: "{{ hydrogen_configuration_extension_json | from_json if hydrogen_configuration_extension_json | from_json is mapping else {} }}"

# Holds the final Hydrogen configuration (a combination of the default and its extension).
# You most likely don't need to touch this variable. Instead, see `hydrogen_configuration_default`.
hydrogen_configuration: "{{ hydrogen_configuration_default | combine(hydrogen_configuration_extension, recursive=True) }}"