2022-02-05 21:32:54 +01:00
---
2022-07-16 22:59:21 +02:00
# Project source code URL: https://github.com/ajbura/cinny
2022-02-05 21:32:54 +01:00
2022-01-05 17:33:21 +01:00
matrix_client_cinny_enabled : true
matrix_client_cinny_container_image_self_build : false
matrix_client_cinny_container_image_self_build_repo : "https://github.com/ajbura/cinny.git"
2023-10-06 14:14:03 +02:00
# renovate: datasource=docker depName=ajbura/cinny
2024-11-12 13:35:47 +01:00
matrix_client_cinny_version : v4.2.3
2022-01-05 17:33:21 +01:00
matrix_client_cinny_docker_image : "{{ matrix_client_cinny_docker_image_name_prefix }}ajbura/cinny:{{ matrix_client_cinny_version }}"
2022-01-06 10:04:35 +01:00
matrix_client_cinny_docker_image_name_prefix : "{{ 'localhost/' if matrix_client_cinny_container_image_self_build else matrix_container_global_registry_prefix }}"
2022-01-05 17:33:21 +01:00
matrix_client_cinny_docker_image_force_pull : "{{ matrix_client_cinny_docker_image.endswith(':latest') }}"
matrix_client_cinny_data_path : "{{ matrix_base_data_path }}/client-cinny"
matrix_client_cinny_docker_src_files_path : "{{ matrix_client_cinny_data_path }}/docker-src"
2023-02-14 10:29:53 +01:00
# The base container network
2024-01-05 06:17:11 +01:00
matrix_client_cinny_container_network : ''
2023-02-14 10:29:53 +01:00
# 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_client_cinny_container_additional_networks : [ ]
2022-01-05 17:33:21 +01:00
# 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.
matrix_client_cinny_container_http_host_bind_port : ''
2023-02-14 10:29:53 +01:00
# matrix_client_cinny_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_client_cinny_container_labels_additional_labels`.
matrix_client_cinny_container_labels_traefik_enabled : true
matrix_client_cinny_container_labels_traefik_docker_network : "{{ matrix_client_cinny_container_network }}"
matrix_client_cinny_container_labels_traefik_hostname : "{{ matrix_client_cinny_hostname }}"
# The path prefix must either be `/` or not end with a slash (e.g. `/cinny`).
matrix_client_cinny_container_labels_traefik_path_prefix : "{{ matrix_client_cinny_path_prefix }}"
matrix_client_cinny_container_labels_traefik_rule : "Host(`{{ matrix_client_cinny_container_labels_traefik_hostname }}`){% if matrix_client_cinny_container_labels_traefik_path_prefix != '/' %} && PathPrefix(`{{ matrix_client_cinny_container_labels_traefik_path_prefix }}`){% endif %}"
matrix_client_cinny_container_labels_traefik_priority : 0
matrix_client_cinny_container_labels_traefik_entrypoints : web-secure
matrix_client_cinny_container_labels_traefik_tls : "{{ matrix_client_cinny_container_labels_traefik_entrypoints != 'web' }}"
matrix_client_cinny_container_labels_traefik_tls_certResolver : default # noqa var-naming
2024-11-14 14:53:58 +01:00
# 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.
matrix_client_cinny_container_labels_traefik_compression_middleware_enabled : false
matrix_client_cinny_container_labels_traefik_compression_middleware_name : ""
2023-02-14 10:29:53 +01:00
# Controls which additional headers to attach to all HTTP responses.
# To add your own headers, use `matrix_client_cinny_container_labels_traefik_additional_response_headers_custom`
matrix_client_cinny_container_labels_traefik_additional_response_headers : "{{ matrix_client_cinny_container_labels_traefik_additional_response_headers_auto | combine(matrix_client_cinny_container_labels_traefik_additional_response_headers_custom) }}"
matrix_client_cinny_container_labels_traefik_additional_response_headers_auto : |
{{
{}
| combine ({'X-XSS-Protection': matrix_client_cinny_http_header_xss_protection} if matrix_client_cinny_http_header_xss_protection else {})
| combine ({'X-Frame-Options': matrix_client_cinny_http_header_frame_options} if matrix_client_cinny_http_header_frame_options else {})
| combine ({'X-Content-Type-Options': matrix_client_cinny_http_header_content_type_options} if matrix_client_cinny_http_header_content_type_options else {})
| combine ({'Content-Security-Policy': matrix_client_cinny_http_header_content_security_policy} if matrix_client_cinny_http_header_content_security_policy else {})
| combine ({'Permission-Policy': matrix_client_cinny_http_header_content_permission_policy} if matrix_client_cinny_http_header_content_permission_policy else {})
| combine ({'Strict-Transport-Security': matrix_client_cinny_http_header_strict_transport_security} if matrix_client_cinny_http_header_strict_transport_security and matrix_client_cinny_container_labels_traefik_tls else {})
}}
matrix_client_cinny_container_labels_traefik_additional_response_headers_custom : {}
# matrix_client_cinny_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_client_cinny_container_labels_additional_labels: |
# my.label=1
# another.label="here"
matrix_client_cinny_container_labels_additional_labels : ''
2022-01-05 17:33:21 +01:00
# A list of extra arguments to pass to the container
matrix_client_cinny_container_extra_arguments : [ ]
# List of systemd services that matrix-client-cinny.service depends on
2024-06-04 12:14:34 +02:00
matrix_client_cinny_systemd_required_services_list : "{{ [devture_systemd_docker_base_docker_service_name] if devture_systemd_docker_base_docker_service_name else [] }}"
2022-01-05 17:33:21 +01:00
2023-02-14 10:29:53 +01:00
# 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_client_cinny_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_client_cinny_http_header_frame_options : SAMEORIGIN
# 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_client_cinny_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_client_cinny_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
2023-02-20 15:50:39 +01:00
matrix_client_cinny_http_header_content_permission_policy : "{{ 'interest-cohort=()' if matrix_client_cinny_floc_optout_enabled else '' }}"
2023-02-14 10:29:53 +01:00
# Specifies the value of the `Strict-Transport-Security` header.
# See: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security
2023-02-20 15:50:39 +01:00
matrix_client_cinny_http_header_strict_transport_security : "max-age=31536000; includeSubDomains{{ '; preload' if matrix_client_cinny_hsts_preload_enabled else '' }}"
2023-02-14 10:29:53 +01:00
# 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_client_cinny_content_permission_policy`
matrix_client_cinny_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_client_cinny_http_header_strict_transport_security`
matrix_client_cinny_hsts_preload_enabled : false
2024-05-25 15:14:26 +02:00
matrix_client_cinny_scheme : https
2023-02-14 10:29:53 +01:00
# The hostname at which Cinny is served.
# Only works with with Traefik reverse-proxying.
matrix_client_cinny_hostname : "{{ matrix_server_fqn_cinny }}"
# The path at which Cinny is exposed.
# This value must either be `/` or not end with a slash (e.g. `/cinny`).
matrix_client_cinny_path_prefix : /
2022-01-05 17:33:21 +01:00
# Controls whether the self-check feature should validate SSL certificates.
matrix_client_cinny_self_check_validate_certificates : true
2024-12-21 12:44:09 +01:00
# Default homeserver URL to use in the `config.json` file.
# See `matrix_client_cinny_config_homeserverList`.
2022-01-05 17:33:21 +01:00
matrix_client_cinny_default_hs_url : ""
2024-12-21 12:44:09 +01:00
# Controls the `homeserverList` value in the `config.json` file.
matrix_client_cinny_config_homeserverList : "{{ [matrix_client_cinny_default_hs_url] }}" # noqa var-naming
2024-10-10 20:40:17 +02:00
# Default Cinny configuration template which covers the generic use case.
2022-01-05 17:33:21 +01:00
# You can customize it by controlling the various variables inside it.
#
# For a more advanced customization, you can extend the default (see `matrix_client_cinny_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_client_cinny_configuration_default : "{{ lookup('template', 'templates/config.json.j2') }}"
2024-10-10 20:40:17 +02:00
# Your custom JSON configuration for Cinny should go to `matrix_client_cinny_configuration_extension_json`.
2022-01-05 17:33:21 +01:00
# This configuration extends the default starting configuration (`matrix_client_cinny_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_client_cinny_configuration_default`.
matrix_client_cinny_configuration_extension_json : '{}'
2022-07-18 11:28:39 +02:00
matrix_client_cinny_configuration_extension : "{{ matrix_client_cinny_configuration_extension_json | from_json if matrix_client_cinny_configuration_extension_json | from_json is mapping else {} }}"
2022-01-05 17:33:21 +01:00
2024-10-10 20:40:17 +02:00
# Holds the final Cinny configuration (a combination of the default and its extension).
2022-01-05 17:33:21 +01:00
# You most likely don't need to touch this variable. Instead, see `matrix_client_cinny_configuration_default`.
2022-07-18 11:28:39 +02:00
matrix_client_cinny_configuration : "{{ matrix_client_cinny_configuration_default | combine(matrix_client_cinny_configuration_extension, recursive=True) }}"