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

# SPDX-FileCopyrightText: 2020 - 2021 Aaron Raimist
# SPDX-FileCopyrightText: 2020 - 2025 Slavi Pantaleev
# SPDX-FileCopyrightText: 2020 Dennis Ciba
# SPDX-FileCopyrightText: 2021 - 2025 MDAD project contributors
# SPDX-FileCopyrightText: 2021 Ahmad Haghighi
# SPDX-FileCopyrightText: 2022 - 2026 Nikita Chernyi
# SPDX-FileCopyrightText: 2022 Marko Weltzer
# SPDX-FileCopyrightText: 2023 Samuel Meenzen
#
# SPDX-License-Identifier: AGPL-3.0-or-later

---
# matrix-ketesa is Ketesa — a fully-featured, mobile-friendly admin interface for Matrix homeservers powered by Synapse.
# Project source code URL: https://github.com/etkecc/ketesa

matrix_ketesa_enabled: true

# A path on host where all related files will be saved
matrix_ketesa_base_path: "{{ matrix_base_data_path }}/ketesa"
matrix_ketesa_config_path: "{{ matrix_ketesa_base_path }}/config"
matrix_ketesa_container_src_files_path: "{{ matrix_ketesa_base_path }}/docker-src"

matrix_ketesa_container_uid: ''
matrix_ketesa_container_gid: ''

matrix_ketesa_container_image_self_build: false
matrix_ketesa_container_image_self_build_repo: "https://github.com/etkecc/ketesa.git"

# renovate: datasource=docker depName=ghcr.io/etkecc/ketesa
matrix_ketesa_version: v1.5.1
matrix_ketesa_container_image: "{{ matrix_ketesa_container_image_registry_prefix }}etkecc/ketesa:{{ matrix_ketesa_version }}"
matrix_ketesa_container_image_registry_prefix: "{{ 'localhost/' if matrix_ketesa_container_image_self_build else matrix_ketesa_container_image_registry_prefix_upstream }}"
matrix_ketesa_container_image_registry_prefix_upstream: "{{ matrix_ketesa_container_image_registry_prefix_upstream_default }}"
matrix_ketesa_container_image_registry_prefix_upstream_default: "ghcr.io/"

# The base container network
matrix_ketesa_container_network: matrix-ketesa

# 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.
matrix_ketesa_container_additional_networks: []

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

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

# Controls how long the pre-start cleanup should wait for stale container-name release
# before failing startup explicitly.
matrix_ketesa_container_cleanup_timeout_seconds: "{{ devture_systemd_docker_base_container_cleanup_timeout_seconds }}"

# Controls the delay between pre-start cleanup retries.
matrix_ketesa_container_cleanup_retry_delay_seconds: "{{ devture_systemd_docker_base_container_cleanup_retry_delay_seconds }}"

# Shell command used in the systemd pre-start phase to deterministically remove a stale
# container and wait until Docker releases its name.
matrix_ketesa_container_cleanup_command: |
  i=0;
  while [ "$i" -lt {{ matrix_ketesa_container_cleanup_timeout_seconds }} ]; do
  {{ devture_systemd_docker_base_host_command_docker }} stop -t {{ devture_systemd_docker_base_container_stop_grace_time_seconds }} matrix-ketesa >/dev/null 2>&1 || true;
  {{ devture_systemd_docker_base_host_command_docker }} rm -f matrix-ketesa >/dev/null 2>&1 || true;
  if {{ devture_systemd_docker_base_host_command_docker }} container inspect matrix-ketesa >/dev/null 2>&1; then
  i=$((i + 1));
  sleep {{ matrix_ketesa_container_cleanup_retry_delay_seconds }};
  continue;
  fi;
  if {{ devture_systemd_docker_base_host_command_docker }} info >/dev/null 2>&1; then
  exit 0;
  fi;
  echo "Failed to query Docker daemon while cleaning up matrix-ketesa" >&2;
  exit 1;
  done;
  echo "Failed to remove stale container matrix-ketesa after {{ matrix_ketesa_container_cleanup_timeout_seconds }} attempts" >&2;
  exit 1

# matrix_ketesa_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_ketesa_container_labels_additional_labels`.
matrix_ketesa_container_labels_traefik_enabled: true
matrix_ketesa_container_labels_traefik_docker_network: "{{ matrix_ketesa_container_network }}"
matrix_ketesa_container_labels_traefik_hostname: "{{ matrix_ketesa_hostname }}"
# The path prefix must either be `/` or not end with a slash (e.g. `/ketesa`).
matrix_ketesa_container_labels_traefik_path_prefix: "{{ matrix_ketesa_path_prefix }}"
matrix_ketesa_container_labels_traefik_rule: "Host(`{{ matrix_ketesa_container_labels_traefik_hostname }}`){% if matrix_ketesa_container_labels_traefik_path_prefix != '/' %} && PathPrefix(`{{ matrix_ketesa_container_labels_traefik_path_prefix }}`){% endif %}"
matrix_ketesa_container_labels_traefik_priority: 0
matrix_ketesa_container_labels_traefik_entrypoints: web-secure
matrix_ketesa_container_labels_traefik_tls: "{{ matrix_ketesa_container_labels_traefik_entrypoints != 'web' }}"
matrix_ketesa_container_labels_traefik_tls_certResolver: default  # noqa var-naming
# This setting is to define a list of IP addresses to allow access to Ketesa.
# Each IP address should be in CIDR format, e.g. xxx.xxx.xxx.xxx/xx.
# For more information, see: https://doc.traefik.io/traefik/middlewares/http/ipallowlist/
# If the list is empty, all IP addresses are allowed.
matrix_ketesa_container_labels_traefik_ipallowlist_sourcerange: []

# Controls which additional headers to attach to all HTTP responses.
# To add your own headers, use `matrix_ketesa_container_labels_traefik_additional_response_headers_custom`
matrix_ketesa_container_labels_traefik_additional_response_headers: "{{ matrix_ketesa_container_labels_traefik_additional_response_headers_auto | combine(matrix_ketesa_container_labels_traefik_additional_response_headers_custom) }}"
matrix_ketesa_container_labels_traefik_additional_response_headers_auto: |
  {{
    {}
    | combine ({'X-XSS-Protection': matrix_ketesa_http_header_xss_protection} if matrix_ketesa_http_header_xss_protection else {})
    | combine ({'X-Content-Type-Options': matrix_ketesa_http_header_content_type_options} if matrix_ketesa_http_header_content_type_options else {})
    | combine ({'Content-Security-Policy': matrix_ketesa_http_header_content_security_policy} if matrix_ketesa_http_header_content_security_policy else {})
    | combine ({'Permission-Policy': matrix_ketesa_http_header_content_permission_policy} if matrix_ketesa_http_header_content_permission_policy else {})
    | combine ({'Strict-Transport-Security': matrix_ketesa_http_header_strict_transport_security} if matrix_ketesa_http_header_strict_transport_security and matrix_ketesa_container_labels_traefik_tls else {})
  }}
matrix_ketesa_container_labels_traefik_additional_response_headers_custom: {}

# matrix_ketesa_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_ketesa_container_labels_additional_labels: |
#   my.label=1
#   another.label="here"
matrix_ketesa_container_labels_additional_labels: ''

# List of systemd services that matrix-ketesa.service depends on
matrix_ketesa_systemd_required_services_list: "{{ [devture_systemd_docker_base_docker_service_name] if devture_systemd_docker_base_docker_service_name else [] }}"

# List of systemd services that matrix-ketesa.service wants
matrix_ketesa_systemd_wanted_services_list: []

# 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_ketesa_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
matrix_ketesa_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_ketesa_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
matrix_ketesa_http_header_content_permission_policy: "{{ 'interest-cohort=()' if matrix_ketesa_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_ketesa_http_header_strict_transport_security: "max-age=31536000; includeSubDomains{{ '; preload' if matrix_ketesa_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_ketesa_content_permission_policy`
matrix_ketesa_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_ketesa_http_header_strict_transport_security`
matrix_ketesa_hsts_preload_enabled: false

# The hostname at which Ketesa is served.
matrix_ketesa_hostname: "{{ matrix_server_fqn_matrix }}"

# The path at which Ketesa is exposed.
# This value must either be `/` or not end with a slash (e.g. `/ketesa`).
matrix_ketesa_path_prefix: /synapse-admin

# Default Ketesa 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 `matrix_ketesa_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).
matrix_ketesa_configuration_default:
  restrictBaseUrl: "{{ matrix_ketesa_config_restrictBaseUrl }}"
  externalAuthProvider: "{{ matrix_ketesa_config_externalAuthProvider }}"
  wellKnownDiscovery: "{{ matrix_ketesa_config_wellKnownDiscovery }}"
  corsCredentials: "{{ matrix_ketesa_config_corsCredentials }}"
  asManagedUsers: "{{ matrix_ketesa_config_asManagedUsers }}"
  menu: "{{ matrix_ketesa_config_menu }}"

# Your custom JSON configuration for Ketesa should go to `matrix_ketesa_configuration_extension_json`.
# This configuration extends the default starting configuration (`matrix_ketesa_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 `matrix_ketesa_configuration_default`.
#
# Example configuration extension follows:
#
# matrix_ketesa_configuration_extension_json: |
#  {
#  "some_setting": true,
#  "another_setting": false
#  }
matrix_ketesa_configuration_extension_json: '{}'

# This is similar to `matrix_ketesa_configuration_extension_json`, but intended for use by playbook or group vars
matrix_ketesa_configuration_extension_json_auto: '{}'

matrix_ketesa_configuration_extension: "{{ matrix_ketesa_configuration_extension_json_auto | from_json | combine(matrix_ketesa_configuration_extension_json | from_json if matrix_ketesa_configuration_extension_json | from_json is mapping else {}, recursive=True) }}"

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

# Controls the restrictBaseUrl configuration setting, which, if defined,
# restricts the homeserver(s), so that the user can no longer define a homeserver manually during login.
matrix_ketesa_config_restrictBaseUrl: "{{ matrix_homeserver_url }}"  # noqa var-naming

# Controls the externalAuthProvider configuration setting, which, if defined,
# enables a special compatibility mode that works better for external auth providers like LDAP, MAS, etc.
matrix_ketesa_config_externalAuthProvider: false  # noqa var-naming

# Control automatic URL canonicalization via /.well-known/matrix/client
# Default: true (discovery enabled, per Matrix spec).
# Set to false when the /_synapse/admin API is hosted on a separate domain not advertised in well-known (e.g. a VPN-only admin endpoint).
# When disabled, MXID-based URL auto-fill uses the domain portion of the MXID directly without a well-known lookup.
matrix_ketesa_config_wellKnownDiscovery: true  # noqa var-naming

# Controls the corsCredentials configuration setting, which, if defined,
# allows including credentials (cookies, authorization headers, or TLS client certificates) in requests
# ref: https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API/Using_Fetch#including_credentials
matrix_ketesa_config_corsCredentials: "same-origin"  # noqa var-naming

# Controls the menu configuration setting, which, if defined, adds new menu items to the Ketesa UI.
# The format is a list of objects, where each object has the following keys:
# - `label` (string, required): The label of the menu item.
# - `i18n` (dict, optional): Dictionary of translations for the label. The keys should be BCP 47 language tags (e.g., en, fr, de) supported by Ketesa (see src/i18n).
# - `icon` (string, optional): The icon of the menu item, one of the https://github.com/etkecc/ketesa/blob/main/src/components/icons.ts
# - `url` (string, required): The URL of the menu item.
# Example:
# [
#   {
#     "label": "Contact support",
#     "i18n": {
#       "de": "Support kontaktieren",
#       "fr": "Contacter le support",
#       "zh": "联系支持"
#     },
#     "icon": "SupportAgent",
#     "url": "https://github.com/etkecc/ketesa/issues"
#   }
# ]
matrix_ketesa_config_menu: []

# Controls the asManagedUsers configuration setting (managed by playbook), which, if defined,
# restricts modifications of the specified users (e.g., bridge-managed).
# You should use JS regex syntax to match the user IDs.
# Example for mautrix-telegram: ["^@telegram_[a-zA-Z0-9]+:example\\.com$"]
# WARNING: you want to use matrix_ketesa_config_asManagedUsers_custom instead of this variable.
matrix_ketesa_config_asManagedUsers_auto: []  # noqa var-naming

# Controls the asManagedUsers configuration setting (managed per host), which, if defined,
# restricts modifications of the specified users (e.g., bridge-managed).
# You should use JS regex syntax to match the user IDs.
# Example for mautrix-telegram: ["^@telegram_[a-zA-Z0-9]+:example\\.com$"]
matrix_ketesa_config_asManagedUsers_custom: []  # noqa var-naming

# Controls the asManagedUsers configuration setting, which, if defined,
# restricts modifications of the specified users (e.g., bridge-managed).
# You should use JS regex syntax to match the user IDs.
# Example for mautrix-telegram: ["^@telegram_[a-zA-Z0-9]+:example\\.com$"]
# WARNING: you want to use matrix_ketesa_config_asManagedUsers_custom instead of this variable.
matrix_ketesa_config_asManagedUsers: "{{ matrix_ketesa_config_asManagedUsers_auto + matrix_ketesa_config_asManagedUsers_custom }}"  # noqa var-naming

# matrix_ketesa_restart_necessary controls whether the service
# will be restarted (when true) or merely started (when false) by the
# systemd service manager role (when conditional restart is enabled).
#
# This value is automatically computed during installation based on whether
# any configuration files, the systemd service file, or the container image changed.
# The default of `false` means "no restart needed" — appropriate when the role's
# installation tasks haven't run (e.g., due to --tags skipping them).
matrix_ketesa_restart_necessary: false