2022-02-05 22:32:54 +02:00
---
2019-05-14 16:47:22 +02:00
# Synapse is a Matrix homeserver
2024-01-17 07:58:01 +02:00
# Project source code URL: https://github.com/element-hq/synapse
2019-05-14 16:47:22 +02:00
matrix_synapse_enabled : true
2020-03-15 10:10:41 +02:00
2024-01-17 08:40:23 +02:00
# Specifies which Github organization and repository name Synapse lives at.
#
# This influences:
# - the Github Container Image registry that container images are pulled from (see `matrix_synapse_docker_image_name`)
# - the git repository to code is pulled from when self-building is used (see `matrix_synapse_container_image_self_build_repo`)
# - potentially other roles which need to reference the Synapse git repository
#
# A popular alternative value may be: `matrix-org/synapse`.
# However, do note that the last Synapse version available there is v1.98.0.
matrix_synapse_github_org_and_repo : element-hq/synapse
2024-01-17 07:58:01 +02:00
# renovate: datasource=docker depName=ghcr.io/element-hq/synapse
2024-05-28 14:12:34 +02:00
matrix_synapse_version : v1.108.0
2023-03-01 11:07:25 +02:00
2023-02-17 17:16:50 +02:00
matrix_synapse_username : ''
matrix_synapse_uid : ''
matrix_synapse_gid : ''
2020-03-15 10:15:27 +02:00
matrix_synapse_container_image_self_build : false
2024-01-17 08:40:23 +02:00
matrix_synapse_container_image_self_build_repo : "https://github.com/{{ matrix_synapse_github_org_and_repo }}.git"
2019-05-14 16:47:22 +02:00
2022-10-14 15:33:19 +02:00
# matrix_synapse_container_image_customizations_enabled controls whether a customized Synapse image will be built.
#
# We toggle this variable to `true` when certain features which require a custom build are enabled.
# Feel free to toggle this to `true` yourself and specify build steps in `matrix_synapse_container_image_customizations_dockerfile_body_custom`.
#
# See:
2022-11-03 09:11:29 +02:00
# - `roles/custom/matrix-synapse/templates/synapse/customizations/Dockerfile.j2`
2022-10-14 15:33:19 +02:00
# - `matrix_synapse_container_image_customizations_dockerfile_body_custom`
# - `matrix_synapse_docker_image_customized`
# - `matrix_synapse_docker_image_final`
2023-02-17 19:37:34 +02:00
matrix_synapse_container_image_customizations_enabled : |-
{{
matrix_synapse_container_image_customizations_s3_storage_provider_installation_enabled
or
matrix_synapse_container_image_customizations_templates_enabled
2024-02-21 18:04:14 +02:00
or
matrix_synapse_container_image_customizations_auto_accept_invite_installation_enabled
2023-02-17 19:37:34 +02:00
}}
2022-10-14 15:33:19 +02:00
2022-10-14 16:41:41 +02:00
# Controls whether custom build steps will be added to the Dockerfile for installing s3-storage-provider.
# The version that will be installed is specified in `matrix_synapse_ext_synapse_s3_storage_provider_version`.
matrix_synapse_container_image_customizations_s3_storage_provider_installation_enabled : "{{ matrix_synapse_ext_synapse_s3_storage_provider_enabled }}"
2024-02-21 18:04:14 +02:00
# Controls whether custom build steps will be added to the Dockerfile for installing auto-accept-invite module.
# The version that will be installed is specified in `matrix_synapse_ext_synapse_auto_accept_invite_version`.
matrix_synapse_container_image_customizations_auto_accept_invite_installation_enabled : "{{ matrix_synapse_ext_synapse_auto_accept_invite_enabled }}"
2023-02-17 19:37:34 +02:00
# Controls whether custom build steps will be added to the Dockerfile for customizing the email templates used by Synapse.
#
# Example usage:
#
# ```yml
# matrix_synapse_container_image_customizations_templates_enabled: true
# # The templates are expected to be in a `templates/` subdirectory in
# matrix_synapse_container_image_customizations_templates_in_container_template_files_relative_path: templates/
# matrix_synapse_container_image_customizations_templates_git_repository_url: git@github.com:organization/repository.git
# matrix_synapse_container_image_customizations_templates_git_repository_branch: main
# matrix_synapse_container_image_customizations_templates_git_repository_keyscan_enabled: true
# matrix_synapse_container_image_customizations_templates_git_repository_keyscan_hostname: github.com
# ```
#
2024-01-17 07:58:01 +02:00
# See: https://github.com/element-hq/synapse/blob/develop/docs/templates.md
2023-02-17 19:37:34 +02:00
matrix_synapse_container_image_customizations_templates_enabled : false
matrix_synapse_container_image_customizations_templates_in_container_base_path : /custom-templates
matrix_synapse_container_image_customizations_templates_in_container_template_files_relative_path : ''
matrix_synapse_container_image_customizations_templates_in_container_full_path : "{{ matrix_synapse_container_image_customizations_templates_in_container_base_path }}/{{ matrix_synapse_container_image_customizations_templates_in_container_template_files_relative_path }}"
matrix_synapse_container_image_customizations_templates_git_repository_url : ''
matrix_synapse_container_image_customizations_templates_git_repository_branch : main
matrix_synapse_container_image_customizations_templates_git_repository_keyscan_enabled : false
matrix_synapse_container_image_customizations_templates_git_repository_keyscan_hostname : ''
2022-10-14 15:33:19 +02:00
# matrix_synapse_container_image_customizations_dockerfile_body contains your custom Dockerfile steps
# for building your customized Synapse image based on the original (upstream) image (`matrix_synapse_docker_image`).
# A `FROM ...` clause is included automatically so you don't have to.
#
# Example:
# matrix_synapse_container_image_customizations_dockerfile_body_custom: |
# RUN echo 'This is a custom step for building the customized Docker image for Synapse.'
# RUN echo 'You can override matrix_synapse_container_image_customizations_dockerfile_body_custom to add your own steps.'
# RUN echo 'You do NOT need to include a FROM clause yourself.'
matrix_synapse_container_image_customizations_dockerfile_body_custom : ''
2023-05-15 18:39:53 +02:00
matrix_synapse_docker_image : "{{ matrix_synapse_docker_image_name_prefix }}{{ matrix_synapse_docker_image_name }}:{{ matrix_synapse_docker_image_tag }}"
2023-03-28 15:10:55 +02:00
matrix_synapse_docker_image_name_prefix : "{{ 'localhost/' if matrix_synapse_container_image_self_build else matrix_synapse_docker_image_registry_prefix }}"
2024-01-17 08:40:23 +02:00
matrix_synapse_docker_image_name : "{{ matrix_synapse_github_org_and_repo }}"
2022-02-08 15:13:41 +02:00
matrix_synapse_docker_image_tag : "{{ matrix_synapse_version }}"
2019-06-10 13:23:51 +02:00
matrix_synapse_docker_image_force_pull : "{{ matrix_synapse_docker_image.endswith(':latest') }}"
2023-03-28 15:24:11 +02:00
matrix_synapse_docker_image_registry_prefix : ghcr.io/
2019-01-12 17:53:00 +02:00
2022-10-14 15:33:19 +02:00
# matrix_synapse_docker_image_customized is the name of the locally built Synapse image
# which adds various customizations on top of the original (upstream) Synapse image.
# This image will be based on the upstream `matrix_synapse_docker_image` image, only if `matrix_synapse_container_image_customizations_enabled: true`.
matrix_synapse_docker_image_customized : "localhost/matrixdotorg/synapse:{{ matrix_synapse_docker_image_tag }}-customized"
2023-02-17 19:37:34 +02:00
# Controls whether the customized image (`matrix_synapse_docker_image_customized`) is to be force-built without layer caching enabled.
# This is useful if you've enabled customizations (e.g. `matrix_synapse_container_image_customizations_templates_enabled`),
# which clone some branch of some repository, and you'd like for each Ansible run to pull new revisions from that branch.
matrix_synapse_docker_image_customized_build_nocache : false
# Controls whether the customized image (`matrix_synapse_docker_image_customized`) is to be built, even if it already exists.
# Related to: matrix_synapse_docker_image_customized_build_nocache
matrix_synapse_docker_image_customized_force_source : "{{ matrix_synapse_docker_image_customized_build_nocache }}"
2022-10-14 15:33:19 +02:00
# matrix_synapse_docker_image_final holds the name of the Synapse image to run depending on whether or not customizations are enabled.
matrix_synapse_docker_image_final : "{{ matrix_synapse_docker_image_customized if matrix_synapse_container_image_customizations_enabled else matrix_synapse_docker_image }} "
2019-01-12 17:53:00 +02:00
matrix_synapse_base_path : "{{ matrix_base_data_path }}/synapse"
2022-11-27 09:28:29 +02:00
2020-03-08 01:28:14 +02:00
matrix_synapse_docker_src_files_path : "{{ matrix_synapse_base_path }}/docker-src"
2022-10-14 15:33:19 +02:00
matrix_synapse_customized_docker_src_files_path : "{{ matrix_synapse_base_path }}/customized-docker-src"
2019-01-12 17:53:00 +02:00
matrix_synapse_config_dir_path : "{{ matrix_synapse_base_path }}/config"
matrix_synapse_storage_path : "{{ matrix_synapse_base_path }}/storage"
matrix_synapse_media_store_path : "{{ matrix_synapse_storage_path }}/media-store"
2022-11-27 09:26:18 +02:00
matrix_synapse_bin_path : "{{ matrix_synapse_base_path }}/bin"
2022-11-27 09:28:29 +02:00
matrix_synapse_ext_path : "{{ matrix_synapse_base_path }}/ext"
matrix_synapse_ext_s3_storage_provider_base_path : "{{ matrix_synapse_base_path }}/ext/s3-storage-provider"
2022-11-27 09:34:46 +02:00
matrix_synapse_ext_s3_storage_provider_bin_path : "{{ matrix_synapse_ext_s3_storage_provider_base_path }}/bin"
2022-12-04 08:14:20 +02:00
matrix_synapse_ext_s3_storage_provider_data_path : "{{ matrix_synapse_ext_s3_storage_provider_base_path }}/data"
2019-01-12 17:53:00 +02:00
2021-11-15 22:43:05 +02:00
matrix_synapse_container_client_api_port : 8008
2021-11-15 14:56:11 +02:00
matrix_synapse_container_federation_api_tls_port : 8448
2021-11-15 14:49:03 +02:00
2021-11-15 14:56:11 +02:00
matrix_synapse_container_federation_api_plain_port : 8048
2021-11-14 23:32:25 +02:00
2023-02-17 16:13:38 +02:00
# The base container network. It will be auto-created by this role if it doesn't exist already.
2024-01-05 16:46:30 +02:00
matrix_synapse_container_network : ''
2023-02-17 16:13:38 +02: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 another reverse proxy, which runs in a different container network.
2024-01-26 12:55:01 +02:00
matrix_synapse_container_additional_networks : "{{ matrix_synapse_container_additional_networks_auto + matrix_synapse_container_additional_networks_custom }}"
matrix_synapse_container_additional_networks_auto : [ ]
matrix_synapse_container_additional_networks_custom : [ ]
2023-02-17 16:13:38 +02:00
2021-11-15 22:43:05 +02:00
# Controls whether the matrix-synapse container exposes the Client/Server API port (tcp/{{ matrix_synapse_container_client_api_port }} in the container).
2019-05-25 00:41:04 +02:00
#
# Takes an "<ip>:<port>" or "<port>" value (e.g. "127.0.0.1:8008"), or empty string to not expose.
matrix_synapse_container_client_api_host_bind_port : ''
# Controls whether the matrix-synapse container exposes the plain (unencrypted) Server/Server (Federation) API port (tcp/8048 in the container).
#
# Takes effect only if federation is enabled (matrix_synapse_federation_enabled).
#
# Takes an "<ip>:<port>" or "<port>" value (e.g. "127.0.0.1:8048"), or empty string to not expose.
matrix_synapse_container_federation_api_plain_host_bind_port : ''
# Controls whether the matrix-synapse container exposes the tls (encrypted) Server/Server (Federation) API port (tcp/8448 in the container).
#
# Takes effect only if federation is enabled (matrix_synapse_federation_enabled)
# and TLS support is enabled (matrix_synapse_tls_federation_listener_enabled).
#
# Takes an "<ip>:<port>" or "<port>" value (e.g. "8448"), or empty string to not expose.
matrix_synapse_container_federation_api_tls_host_bind_port : ''
# Controls whether the matrix-synapse container exposes the metrics port (tcp/9100 in the container).
#
# Takes effect only if metrics are enabled (matrix_synapse_metrics_enabled).
#
# Takes an "<ip>:<port>" or "<port>" value (e.g. "127.0.0.1:9100"), or empty string to not expose.
matrix_synapse_container_metrics_api_host_bind_port : ''
2019-01-30 20:31:50 +02:00
2019-12-05 08:07:15 +02:00
# Controls whether the matrix-synapse container exposes the manhole port (tcp/9000 in the container).
#
# Takes effect only if the manhole is enabled (matrix_synapse_manhole_enabled).
#
# Takes an "<ip>:<port>" or "<port>" value (e.g. "127.0.0.1:9100"), or empty string to not expose.
matrix_synapse_container_manhole_api_host_bind_port : ''
2024-01-12 12:15:40 +02:00
# matrix_synapse_container_labels_traefik_enabled controls whether labels to assist a Traefik reverse-proxy will be attached to the main Synapse worker.
2024-01-04 19:00:23 +02:00
# See `../templates/labels.j2` for details.
#
# To inject your own other container labels, see `matrix_synapse_container_labels_additional_labels`.
matrix_synapse_container_labels_traefik_enabled : true
matrix_synapse_container_labels_traefik_docker_network : "{{ matrix_synapse_container_network }}"
matrix_synapse_container_labels_traefik_entrypoints : web-secure
matrix_synapse_container_labels_traefik_tls_certResolver : default # noqa var-naming
matrix_synapse_container_labels_traefik_hostname : ''
2024-01-12 12:15:40 +02:00
# Controls whether Matrix-related labels will be added.
#
# When set to false, variables like the following take no effect:
2024-01-14 10:23:55 +02:00
# - `matrix_synapse_container_labels_public_client_api_enabled`
# - `matrix_synapse_container_labels_public_client_synapse_client_api_enabled`
# - `matrix_synapse_container_labels_public_client_synapse_admin_api_enabled`
# - `matrix_synapse_container_labels_public_federation_api_enabled`
2024-01-12 12:15:40 +02:00
#
# When workers are enabled, we do not capture these requests, because we can't route them appropriately.
matrix_synapse_container_labels_matrix_related_labels_enabled : "{{ not matrix_synapse_workers_enabled }}"
2024-01-14 10:23:55 +02:00
# Controls whether labels will be added for handling the root (/) path on a public Traefik entrypoint.
matrix_synapse_container_labels_public_client_root_enabled : true
matrix_synapse_container_labels_public_client_root_traefik_hostname : "{{ matrix_synapse_container_labels_traefik_hostname }}"
matrix_synapse_container_labels_public_client_root_traefik_rule : "Host(`{{ matrix_synapse_container_labels_public_client_root_traefik_hostname }}`) && Path(`/`)"
matrix_synapse_container_labels_public_client_root_traefik_priority : 0
matrix_synapse_container_labels_public_client_root_traefik_entrypoints : "{{ matrix_synapse_container_labels_traefik_entrypoints }}"
matrix_synapse_container_labels_public_client_root_traefik_tls : "{{ matrix_synapse_container_labels_public_client_root_traefik_entrypoints != 'web' }}"
matrix_synapse_container_labels_public_client_root_traefik_tls_certResolver : "{{ matrix_synapse_container_labels_traefik_tls_certResolver }}" # noqa var-naming
matrix_synapse_container_labels_public_client_root_redirection_enabled : false
matrix_synapse_container_labels_public_client_root_redirection_url : ""
# Controls whether labels will be added that expose the Client-Server API on a public Traefik entrypoint.
2024-01-12 12:15:40 +02:00
# Regardless of whether this is enabled, it may or may not take effect due to the value of other variables.
# See `matrix_synapse_container_labels_traefik_enabled` or `matrix_synapse_container_labels_matrix_related_labels_enabled`
2024-01-14 10:23:55 +02:00
matrix_synapse_container_labels_public_client_api_enabled : true
matrix_synapse_container_labels_public_client_api_traefik_hostname : "{{ matrix_synapse_container_labels_traefik_hostname }}"
matrix_synapse_container_labels_public_client_api_traefik_path_prefix : /_matrix
matrix_synapse_container_labels_public_client_api_traefik_rule : "Host(`{{ matrix_synapse_container_labels_public_client_api_traefik_hostname }}`) && PathPrefix(`{{ matrix_synapse_container_labels_public_client_api_traefik_path_prefix }}`)"
matrix_synapse_container_labels_public_client_api_traefik_priority : 0
matrix_synapse_container_labels_public_client_api_traefik_entrypoints : "{{ matrix_synapse_container_labels_traefik_entrypoints }}"
matrix_synapse_container_labels_public_client_api_traefik_tls : "{{ matrix_synapse_container_labels_public_client_api_traefik_entrypoints != 'web' }}"
matrix_synapse_container_labels_public_client_api_traefik_tls_certResolver : "{{ matrix_synapse_container_labels_traefik_tls_certResolver }}" # noqa var-naming
# Controls whether labels will be added that expose the Client-Server API on the internal Traefik entrypoint.
# This is similar to `matrix_synapse_container_labels_public_client_api_enabled`, but the entrypoint and intent is different.
# Regardless of whether this is enabled, it may or may not take effect due to the value of other variables.
# See `matrix_synapse_container_labels_traefik_enabled` or `matrix_synapse_container_labels_matrix_related_labels_enabled`
matrix_synapse_container_labels_internal_client_api_enabled : false
2024-01-14 10:37:21 +02:00
matrix_synapse_container_labels_internal_client_api_traefik_path_prefix : "{{ matrix_synapse_container_labels_public_client_api_traefik_path_prefix }}"
2024-01-14 10:23:55 +02:00
matrix_synapse_container_labels_internal_client_api_traefik_rule : "PathPrefix(`{{ matrix_synapse_container_labels_internal_client_api_traefik_path_prefix }}`)"
matrix_synapse_container_labels_internal_client_api_traefik_priority : "{{ matrix_synapse_container_labels_public_client_api_traefik_priority }}"
matrix_synapse_container_labels_internal_client_api_traefik_entrypoints : ""
2024-01-04 19:00:23 +02:00
# Controls whether labels will be added that expose the /_synapse/client paths
2024-01-12 12:15:40 +02:00
# When workers are enabled, we do not capture these requests, because they may be load-balanaced to some specific worker.
# Regardless of whether this is enabled, it may or may not take effect due to the value of other variables.
# See `matrix_synapse_container_labels_traefik_enabled` or `matrix_synapse_container_labels_matrix_related_labels_enabled`
2024-01-14 10:23:55 +02:00
matrix_synapse_container_labels_public_client_synapse_client_api_enabled : true
matrix_synapse_container_labels_public_client_synapse_client_api_traefik_hostname : "{{ matrix_synapse_container_labels_traefik_hostname }}"
matrix_synapse_container_labels_public_client_synapse_client_api_traefik_path_prefix : /_synapse/client
matrix_synapse_container_labels_public_client_synapse_client_api_traefik_rule : "Host(`{{ matrix_synapse_container_labels_public_client_synapse_client_api_traefik_hostname }}`) && PathPrefix(`{{ matrix_synapse_container_labels_public_client_synapse_client_api_traefik_path_prefix }}`)"
matrix_synapse_container_labels_public_client_synapse_client_api_traefik_priority : 0
matrix_synapse_container_labels_public_client_synapse_client_api_traefik_entrypoints : "{{ matrix_synapse_container_labels_traefik_entrypoints }}"
matrix_synapse_container_labels_public_client_synapse_client_api_traefik_tls : "{{ matrix_synapse_container_labels_public_client_synapse_client_api_traefik_entrypoints != 'web' }}"
matrix_synapse_container_labels_public_client_synapse_client_api_traefik_tls_certResolver : "{{ matrix_synapse_container_labels_traefik_tls_certResolver }}" # noqa var-naming
2024-01-04 19:00:23 +02:00
# Controls whether labels will be added that expose the /_synapse/admin paths
2024-01-17 07:58:01 +02:00
# Following these recommendations (https://github.com/element-hq/synapse/blob/master/docs/reverse_proxy.md), by default, we don't.
2024-01-12 12:15:40 +02:00
# Regardless of whether this is enabled, it may or may not take effect due to the value of other variables.
# See `matrix_synapse_container_labels_traefik_enabled` or `matrix_synapse_container_labels_matrix_related_labels_enabled`
2024-01-14 10:23:55 +02:00
matrix_synapse_container_labels_public_client_synapse_admin_api_enabled : false
matrix_synapse_container_labels_public_client_synapse_admin_api_traefik_hostname : "{{ matrix_synapse_container_labels_traefik_hostname }}"
matrix_synapse_container_labels_public_client_synapse_admin_api_traefik_path_prefix : /_synapse/admin
matrix_synapse_container_labels_public_client_synapse_admin_api_traefik_rule : "Host(`{{ matrix_synapse_container_labels_public_client_synapse_admin_api_traefik_hostname }}`) && PathPrefix(`{{ matrix_synapse_container_labels_public_client_synapse_admin_api_traefik_path_prefix }}`)"
matrix_synapse_container_labels_public_client_synapse_admin_api_traefik_priority : 0
matrix_synapse_container_labels_public_client_synapse_admin_api_traefik_entrypoints : "{{ matrix_synapse_container_labels_traefik_entrypoints }}"
matrix_synapse_container_labels_public_client_synapse_admin_api_traefik_tls : "{{ matrix_synapse_container_labels_public_client_synapse_admin_api_traefik_entrypoints != 'web' }}"
matrix_synapse_container_labels_public_client_synapse_admin_api_traefik_tls_certResolver : "{{ matrix_synapse_container_labels_traefik_tls_certResolver }}" # noqa var-naming
2024-01-04 19:00:23 +02:00
# Controls whether labels will be added that expose the Server-Server API (Federation API).
2024-01-12 12:15:40 +02:00
# Regardless of whether this is enabled, it may or may not take effect due to the value of other variables.
# See `matrix_synapse_container_labels_traefik_enabled` or `matrix_synapse_container_labels_matrix_related_labels_enabled`
2024-02-08 12:42:59 +02:00
matrix_synapse_container_labels_public_federation_api_enabled : "{{ matrix_synapse_federation_port_enabled }}"
2024-01-14 10:23:55 +02:00
matrix_synapse_container_labels_public_federation_api_traefik_hostname : "{{ matrix_synapse_container_labels_traefik_hostname }}"
matrix_synapse_container_labels_public_federation_api_traefik_path_prefix : /_matrix
matrix_synapse_container_labels_public_federation_api_traefik_rule : "Host(`{{ matrix_synapse_container_labels_public_federation_api_traefik_hostname }}`) && PathPrefix(`{{ matrix_synapse_container_labels_public_federation_api_traefik_path_prefix }}`)"
matrix_synapse_container_labels_public_federation_api_traefik_priority : 0
matrix_synapse_container_labels_public_federation_api_traefik_entrypoints : ''
2024-01-15 09:39:36 +02:00
# TLS is force-enabled here, because the spec (https://spec.matrix.org/v1.9/server-server-api/#tls) says that the federation API must use HTTPS.
matrix_synapse_container_labels_public_federation_api_traefik_tls : true
2024-01-14 10:23:55 +02:00
matrix_synapse_container_labels_public_federation_api_traefik_tls_certResolver : "{{ matrix_synapse_container_labels_traefik_tls_certResolver }}" # noqa var-naming
2024-01-04 19:00:23 +02:00
2024-01-12 12:15:40 +02:00
# Controls whether labels will be added that expose metrics (see `matrix_synapse_metrics_proxying_enabled`) for the main Synapse process
2024-01-14 10:23:55 +02:00
matrix_synapse_container_labels_public_metrics_enabled : "{{ matrix_synapse_metrics_enabled and matrix_synapse_metrics_proxying_enabled }}"
matrix_synapse_container_labels_public_metrics_traefik_path : "{{ matrix_synapse_metrics_proxying_path_prefix }}/main-process"
matrix_synapse_container_labels_public_metrics_traefik_rule : "Host(`{{ matrix_synapse_metrics_proxying_hostname }}`) && Path(`{{ matrix_synapse_container_labels_public_metrics_traefik_path }}`)"
matrix_synapse_container_labels_public_metrics_traefik_priority : 0
matrix_synapse_container_labels_public_metrics_traefik_entrypoints : "{{ matrix_synapse_container_labels_traefik_entrypoints }}"
matrix_synapse_container_labels_public_metrics_traefik_tls : "{{ matrix_synapse_container_labels_public_metrics_traefik_entrypoints != 'web' }}"
matrix_synapse_container_labels_public_metrics_traefik_tls_certResolver : "{{ matrix_synapse_container_labels_traefik_tls_certResolver }}" # noqa var-naming
matrix_synapse_container_labels_public_metrics_middleware_basic_auth_enabled : false
2024-01-12 09:52:08 +02:00
# See: https://doc.traefik.io/traefik/middlewares/http/basicauth/#users
2024-01-14 10:23:55 +02:00
matrix_synapse_container_labels_public_metrics_middleware_basic_auth_users : ''
2024-01-12 09:52:08 +02:00
2024-01-04 19:00:23 +02:00
# matrix_synapse_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_synapse_container_labels_additional_labels: |
# my.label=1
# another.label="here"
matrix_synapse_container_labels_additional_labels : ''
2019-04-30 16:35:18 +02:00
# A list of extra arguments to pass to the container
2022-08-24 07:38:12 +02:00
# Also see `matrix_synapse_container_arguments`
2019-04-30 16:35:18 +02:00
matrix_synapse_container_extra_arguments : [ ]
2022-11-22 21:36:49 +02:00
# matrix_synapse_container_extra_arguments_auto is a list of extra arguments to pass to the container.
# This list is managed by the playbook. You're not meant to override this variable.
2022-08-24 07:38:12 +02:00
# If you'd like to inject your own arguments, see `matrix_synapse_container_extra_arguments`.
2022-11-22 21:36:49 +02:00
matrix_synapse_container_extra_arguments_auto : [ ]
2022-08-24 07:38:12 +02:00
# matrix_synapse_container_arguments holds the final list of extra arguments to pass to the container.
# You're not meant to override this variable.
# If you'd like to inject your own arguments, see `matrix_synapse_container_extra_arguments`.
2022-11-22 21:36:49 +02:00
matrix_synapse_container_arguments : "{{ matrix_synapse_container_extra_arguments + matrix_synapse_container_extra_arguments_auto }}"
2022-08-24 07:38:12 +02:00
2024-01-24 21:14:34 +02:00
# matrix_synapse_container_master_extra_arguments contains arguments specific to the master process whereas
2024-01-25 07:39:25 +02:00
# matrix_synapse_container_arguments contains arguments the apply to all Synapse containers (master and worker).
2024-01-24 21:14:34 +02:00
matrix_synapse_container_master_extra_arguments : [ ]
2019-01-16 18:05:48 +02:00
# List of systemd services that matrix-synapse.service depends on
2024-01-04 19:00:23 +02:00
matrix_synapse_systemd_required_services_list : "{{ matrix_synapse_systemd_required_services_list_default + matrix_synapse_systemd_required_services_list_auto + matrix_synapse_systemd_required_services_list_custom }}"
matrix_synapse_systemd_required_services_list_default : [ 'docker.service' ]
matrix_synapse_systemd_required_services_list_auto : [ ]
matrix_synapse_systemd_required_services_list_custom : [ ]
2019-01-16 18:05:48 +02:00
# List of systemd services that matrix-synapse.service wants
2024-01-04 19:00:23 +02:00
matrix_synapse_systemd_wanted_services_list : "{{ matrix_synapse_systemd_wanted_services_list_default + matrix_synapse_systemd_wanted_services_list_auto + matrix_synapse_systemd_wanted_services_list_custom }}"
matrix_synapse_systemd_wanted_services_list_default : [ ]
matrix_synapse_systemd_wanted_services_list_auto : [ ]
matrix_synapse_systemd_wanted_services_list_custom : [ ]
2019-01-12 17:53:00 +02:00
2024-01-17 12:24:11 +02:00
# Controls how long to sleep for after starting the matrix-synapse container.
#
# Delaying, so that the homeserver can manage to fully start and various services
# that depend on it (`matrix_synapse_systemd_required_services_list` and `matrix_synapse_systemd_wanted_services_list`)
# may only start after the homeserver is up and running.
#
# This can be set to 0 to remove the delay.
matrix_synapse_systemd_service_post_start_delay_seconds : 10
2023-01-31 23:34:25 +02:00
matrix_synapse_in_container_python_packages_path : "/usr/local/lib/python3.11/site-packages"
2019-01-12 17:53:00 +02:00
# Specifies which template files to use when configuring Synapse.
# If you'd like to have your own different configuration, feel free to copy and paste
# the original files into your inventory (e.g. in `inventory/host_vars/<host>/`)
2022-04-26 14:44:02 +02:00
# and then change the specific host's `vars.yml` file like this:
2019-01-12 17:53:00 +02:00
# matrix_synapse_template_synapse_homeserver: "{{ playbook_dir }}/inventory/host_vars/<host>/homeserver.yaml.j2"
matrix_synapse_template_synapse_homeserver : "{{ role_path }}/templates/synapse/homeserver.yaml.j2"
matrix_synapse_template_synapse_log : "{{ role_path }}/templates/synapse/synapse.log.config.j2"
2024-05-25 15:14:26 +02:00
matrix_synapse_public_baseurl : "{{ 'https' if matrix_playbook_ssl_enabled else 'http' }}://{{ matrix_server_fqn_matrix }}/"
2019-01-12 17:53:00 +02:00
matrix_synapse_macaroon_secret_key : ""
matrix_synapse_registration_shared_secret : "{{ matrix_synapse_macaroon_secret_key }}"
2019-08-08 11:53:07 +02:00
matrix_synapse_allow_guest_access : false
2019-01-12 17:53:00 +02:00
matrix_synapse_form_secret : "{{ matrix_synapse_macaroon_secret_key }}"
2020-10-27 14:24:02 +02:00
matrix_synapse_max_upload_size_mb : 50
2019-01-12 17:53:00 +02:00
2022-06-17 13:32:17 +02:00
# Controls whether local media should be removed under certain conditions, typically for the purpose of saving space.
# should be empty to disable
matrix_synapse_media_retention_local_media_lifetime :
# Controls whether remote media cache (media that is downloaded from other homeservers)
# should be removed under certain conditions, typically for the purpose of saving space.
# should be empty to disable
matrix_synapse_media_retention_remote_media_lifetime :
2019-01-29 18:52:02 +02:00
# The tmpfs at /tmp needs to be large enough to handle multiple concurrent file uploads.
matrix_synapse_tmp_directory_size_mb : "{{ matrix_synapse_max_upload_size_mb * 50 }}"
2019-01-12 17:53:00 +02:00
# Log levels
# Possible options are defined here https://docs.python.org/3/library/logging.html#logging-levels
# warning: setting log level to DEBUG will make synapse log sensitive information such
2019-11-10 08:35:17 +02:00
# as access tokens.
#
# Increasing verbosity may lead to an excessive amount of log messages being generated,
# some of which may get dropped by systemd-journald on certain distributions (like CentOS 7).
# You can work around it by adding `RateLimitInterval=0` and `RateLimitBurst=0` under `[Storage]` in
# `/etc/systemd/journald.conf` and restarting the logging service (`systemctl restart systemd-journald`).
2019-08-03 06:47:00 +02:00
matrix_synapse_log_level : "WARNING"
matrix_synapse_storage_sql_log_level : "WARNING"
matrix_synapse_root_log_level : "WARNING"
2019-01-12 17:53:00 +02:00
# Rate limits
2019-05-23 02:23:04 +02:00
matrix_synapse_rc_message :
per_second : 0.2
burst_count : 10
2019-01-12 17:53:00 +02:00
2019-04-01 20:40:14 +02:00
matrix_synapse_rc_registration :
per_second : 0.17
burst_count : 3
matrix_synapse_rc_login :
address :
per_second : 0.17
burst_count : 3
account :
per_second : 0.17
burst_count : 3
failed_attempts :
per_second : 0.17
burst_count : 3
2020-09-11 09:46:20 +02:00
matrix_synapse_rc_admin_redaction :
per_second : 1
burst_count : 50
matrix_synapse_rc_joins :
local :
per_second : 0.1
2022-09-24 18:53:56 +02:00
burst_count : 10
2020-09-11 09:46:20 +02:00
remote :
per_second : 0.01
2022-09-24 18:53:56 +02:00
burst_count : 10
2020-09-11 09:46:20 +02:00
2022-08-17 13:34:33 +02:00
matrix_synapse_rc_invites :
per_room :
2022-09-24 18:53:56 +02:00
per_second : 0.3
burst_count : 10
2022-08-17 13:34:33 +02:00
per_user :
2022-09-24 18:53:56 +02:00
per_second : 0.003
2022-08-17 13:34:33 +02:00
burst_count : 5
2022-09-24 18:53:56 +02:00
per_issuer :
per_second : 0.3
burst_count : 10
2022-08-17 13:34:33 +02:00
2019-05-23 02:23:04 +02:00
matrix_synapse_rc_federation :
window_size : 1000
sleep_limit : 10
sleep_delay : 500
reject_limit : 50
concurrent : 3
2019-04-01 20:40:14 +02:00
matrix_synapse_federation_rr_transactions_per_room_per_second : 50
2023-02-17 19:37:34 +02:00
# Controls the templates directory setting.
#
# See:
# - `matrix_synapse_container_image_customizations_templates_enabled`
2024-01-17 07:58:01 +02:00
# - https://github.com/element-hq/synapse/blob/develop/docs/templates.md
2023-02-17 19:37:34 +02:00
matrix_synapse_templates_custom_template_directory : "{{ matrix_synapse_container_image_customizations_templates_in_container_full_path if matrix_synapse_container_image_customizations_templates_enabled else '' }}"
2019-02-05 11:07:08 +02:00
# Controls whether the TLS federation listener is enabled (tcp/8448).
2019-02-14 18:40:55 +02:00
# Only makes sense if federation is enabled (`matrix_synapse_federation_enabled`).
2021-11-15 14:56:11 +02:00
# Note that federation may potentially be enabled as non-TLS on `matrix_synapse_container_federation_api_plain_port` as well.
2019-02-14 18:40:55 +02:00
# If you're serving Synapse behind an HTTPS-capable reverse-proxy,
# you can disable the TLS listener (`matrix_synapse_tls_federation_listener_enabled: false`).
matrix_synapse_tls_federation_listener_enabled : true
2019-02-28 11:51:09 +02:00
matrix_synapse_tls_certificate_path : "/data/{{ matrix_server_fqn_matrix }}.tls.crt"
matrix_synapse_tls_private_key_path : "/data/{{ matrix_server_fqn_matrix }}.tls.key"
2019-02-05 11:07:08 +02:00
2020-04-22 19:01:56 +02:00
# Resource names used by the unsecure HTTP listener. Here only the Client API
# is defined, see the homeserver config for a full list of valid resource
# names.
matrix_synapse_http_listener_resource_names : [ "client" ]
2020-12-08 16:48:25 +02:00
# Resources served on Synapse's federation port.
# When disabling federation, we may wish to serve the `openid` resource here,
# so that services like Dimension and ma1sd can work.
matrix_synapse_federation_listener_resource_names : "{{ ['federation'] if matrix_synapse_federation_enabled else (['openid'] if matrix_synapse_federation_port_openid_resource_required else []) }}"
2019-01-12 17:53:00 +02:00
# Enable this to allow Synapse to report utilization statistics about your server to matrix.org
# (things like number of users, number of messages sent, uptime, load, etc.)
matrix_synapse_report_stats : false
# Controls whether the Matrix server will track presence status (online, offline, unavailable) for users.
# If users participate in large rooms with many other servers,
# disabling this will decrease server load significantly.
2021-04-22 13:22:07 +02:00
matrix_synapse_presence_enabled : true
2019-01-12 17:53:00 +02:00
2019-11-10 08:48:42 +02:00
# Controls whether accessing the server's public rooms directory can be done without authentication.
# For private servers, you most likely wish to require authentication,
# unless you know what list of rooms you're publishing to the world and explicitly want to do it.
matrix_synapse_allow_public_rooms_without_auth : false
# Controls whether remote servers can fetch this server's public rooms directory via federation.
2023-10-23 11:11:04 +02:00
# The upstream default is `false`, but we try to make Matrix federation more useful.
#
# For private servers, you may wish to forbid it to align yourself with upstream defaults.
# However, disabling federation completely (see `matrix_synapse_federation_enabled`) is a better way to make your server private,
# instead of relying on security-by-obscurity -- federating with others, having your public rooms joinable by anyone,
# but hiding them and thinking you've secured them.
matrix_synapse_allow_public_rooms_over_federation : true
2019-11-10 08:48:42 +02:00
2021-03-14 05:39:44 +02:00
# Whether to require authentication to retrieve profile data (avatars,
# display names) of other users through the client API. Defaults to
# 'false'. Note that profile data is also available via the federation
# API, so this setting is of limited value if federation is enabled on
# the server.
matrix_synapse_require_auth_for_profile_requests : false
# Set to true to require a user to share a room with another user in order
# to retrieve their profile information. Only checked on Client-Server
# requests. Profile requests from other servers should be checked by the
# requesting server. Defaults to 'false'.
matrix_synapse_limit_profile_requests_to_users_who_share_rooms : false
# Set to false to prevent a user's profile data from being retrieved and
# displayed in a room until they have joined it. By default, a user's
# profile data is included in an invite event, regardless of the values
# of the above two settings, and whether or not the users share a server.
# Defaults to 'true'.
matrix_synapse_include_profile_data_on_invite : true
2023-06-02 20:50:46 +02:00
# User search behaviour
2023-06-03 07:38:57 +02:00
matrix_synapse_user_directory_search_all_users : false
matrix_synapse_user_directory_prefer_local_users : false
2023-06-02 20:50:46 +02:00
2019-01-12 17:53:00 +02:00
# Controls whether people with access to the homeserver can register by themselves.
matrix_synapse_enable_registration : false
2022-04-05 19:48:15 +02:00
# Controls whether people with access to the homeserver can register by themselves without verification (email/msisdn/token)
matrix_synapse_enable_registration_without_verification : false
2019-01-12 17:53:00 +02:00
2020-07-04 01:33:25 +02:00
# reCAPTCHA API for validating registration attempts
matrix_synapse_enable_registration_captcha : false
matrix_synapse_recaptcha_public_key : ''
matrix_synapse_recaptcha_private_key : ''
2022-04-12 09:31:49 +02:00
# Requires an MSC3231 token for registration. Note that `matrix_synapse_enable_registration` must be set to `true`.
# Tokens can be created via the API or through synapse-admin.
# Disabling this option will not delete any tokens previously generated.
matrix_synapse_registration_requires_token : false
2019-05-08 19:29:18 +02:00
# A list of 3PID types which users must supply when registering (possible values: email, msisdn).
matrix_synapse_registrations_require_3pid : [ ]
2020-04-18 01:11:30 +02:00
# A list of patterns 3pids must match in order to permit registration, e.g.:
# - medium: email
# pattern: '.*@example\.com'
# - medium: msisdn
# pattern: '\+44'
matrix_synapse_allowed_local_3pids : [ ]
2020-04-03 09:08:37 +02:00
# The server to use for phone number threepid validation. When empty, validation cannot happen, as Synapse doesn't support it.
# To make it work, this should be pointed to an identity server.
matrix_synapse_account_threepid_delegates_msisdn : ''
2019-01-12 17:53:00 +02:00
# Users who register on this homeserver will automatically be joined to these rooms.
# Rooms are to be specified using addresses (e.g. `#address:example.com`)
matrix_synapse_auto_join_rooms : [ ]
# Controls whether auto-join rooms (`matrix_synapse_auto_join_rooms`) are to be created
# automatically if they don't already exist.
matrix_synapse_autocreate_auto_join_rooms : true
2023-03-29 20:11:22 +02:00
# Controls whether password authentication is allowed
# It may be useful when you've configured OAuth, SAML or CAS and want authentication
# to happen only through them
matrix_synapse_password_config_enabled : true
2019-04-23 09:20:56 +02:00
# Controls password-peppering for Synapse. Not to be changed after initial setup.
2019-01-12 17:53:00 +02:00
matrix_synapse_password_config_pepper : ""
2019-07-04 16:11:51 +02:00
# Controls if Synapse allows people to authenticate against its local database.
# It may be useful to disable this if you've configured additional password providers
# and only wish authentication to happen through them.
2019-07-04 16:27:20 +02:00
matrix_synapse_password_config_localdb_enabled : true
2019-07-04 16:11:51 +02:00
2019-04-23 09:20:56 +02:00
# Controls the number of events that Synapse caches in memory.
2019-01-12 17:53:00 +02:00
matrix_synapse_event_cache_size : "100K"
2020-05-28 14:23:05 +02:00
# Controls cache sizes for Synapse.
2019-01-12 17:53:00 +02:00
# Raise this to increase cache sizes or lower it to potentially lower memory use.
2024-02-14 12:02:06 +02:00
# To learn more, see:
# - https://matrix-org.github.io/synapse/latest/usage/configuration/config_documentation.html#caching
# - https://github.com/matrix-org/synapse/issues/3939
# Defaults for timings of caches is from https://tcpipuk.github.io/synapse/deployment/synapse.html
# The idea with the timings used is that you get to evict soon but also you keep stuff around for a long time when its not forced out.
# Long cache lifetimes together with the low minimum TTL allows autotune to be the primary eviction method assuming size of cache is hit before we hit other caps.
matrix_synapse_caches_global_factor : 10
matrix_synapse_caches_expire_caches : true
matrix_synapse_caches_cache_entry_ttl : "1080m"
matrix_synapse_caches_sync_response_cache_duration : "2m"
Fix Synapse cache auto-tuning variables to use bytes, not KB
Fixup for https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/3017
This reverts 1cd82cf06823fb7680 and also multiplies results by `1024`
so as to pass bytes to Synapse, not KB (as done before).
1cd82cf06823fb7680 was correctly documenting what we were doing (passing KB values),
but that's incorrect.
Synapse's Config Conventions
(https://matrix-org.github.io/synapse/latest/usage/configuration/config_documentation.html#config-conventions)
are supposed to clear it up, but they don't currently state what happens when you pass a plain number (without a unit suffix).
Thankfully, the source code tells us:
https://github.com/element-hq/synapse/blob/bc1db16086d0718c9c0bb61b32b825ba62049bb0/synapse/config/_base.py#L181-L206
> If an integer is provided it is treated as bytes and is unchanged.
>
> String byte sizes can have a suffix of ...
> No suffix is understood as a plain byte count.
We were previously passing strings, but that has been improved in 3d73ec887aec27483.
Regardless, non-suffixed values seem to be treated as bytes by Synapse,
so this patch changes the variables to use bytes.
Moreover, we're moving from `matrix_synapse_memtotal_kb` to
`matrix_synapse_cache_size_calculations_memtotal_bytes` as working with
the base unit everywhere is preferrable.
Here, we also introduce 2 new variables to allow for the caps to be
tweaked:
- `matrix_synapse_cache_size_calculations_max_cache_memory_usage_cap_bytes`
- `matrix_synapse_cache_size_calculations_target_cache_memory_usage_cap_bytes`
2024-02-14 13:39:40 +02:00
# Controls how much memory this role thinks is available for cache-size-related calculations.
# By default, all of the server's memory is taken into account, but you can adjust this.
# You can also go for directly adjusting cache-sizes (matrix_synapse_cache_autotuning_max_cache_memory_usage, matrix_synapse_cache_autotuning_target_cache_memory_usage) instead of adjusting this.
matrix_synapse_cache_size_calculations_memtotal_bytes : "{{ (ansible_memtotal_mb * 1024 * 1024) | int }}"
# Controls the cap to use for matrix_synapse_cache_autotuning_max_cache_memory_usage.
2024-02-14 13:46:55 +02:00
matrix_synapse_cache_size_calculations_max_cache_memory_usage_cap_bytes : "{{ (2 * 1024 * 1024 * 1024) }}" # 2GB
Fix Synapse cache auto-tuning variables to use bytes, not KB
Fixup for https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/3017
This reverts 1cd82cf06823fb7680 and also multiplies results by `1024`
so as to pass bytes to Synapse, not KB (as done before).
1cd82cf06823fb7680 was correctly documenting what we were doing (passing KB values),
but that's incorrect.
Synapse's Config Conventions
(https://matrix-org.github.io/synapse/latest/usage/configuration/config_documentation.html#config-conventions)
are supposed to clear it up, but they don't currently state what happens when you pass a plain number (without a unit suffix).
Thankfully, the source code tells us:
https://github.com/element-hq/synapse/blob/bc1db16086d0718c9c0bb61b32b825ba62049bb0/synapse/config/_base.py#L181-L206
> If an integer is provided it is treated as bytes and is unchanged.
>
> String byte sizes can have a suffix of ...
> No suffix is understood as a plain byte count.
We were previously passing strings, but that has been improved in 3d73ec887aec27483.
Regardless, non-suffixed values seem to be treated as bytes by Synapse,
so this patch changes the variables to use bytes.
Moreover, we're moving from `matrix_synapse_memtotal_kb` to
`matrix_synapse_cache_size_calculations_memtotal_bytes` as working with
the base unit everywhere is preferrable.
Here, we also introduce 2 new variables to allow for the caps to be
tweaked:
- `matrix_synapse_cache_size_calculations_max_cache_memory_usage_cap_bytes`
- `matrix_synapse_cache_size_calculations_target_cache_memory_usage_cap_bytes`
2024-02-14 13:39:40 +02:00
# Controls the cap to use for matrix_synapse_cache_autotuning_target_cache_memory_usage.
2024-02-14 13:46:55 +02:00
matrix_synapse_cache_size_calculations_target_cache_memory_usage_cap_bytes : "{{ (1 * 1024 * 1024 * 1024) }}" # 1GB
Fix Synapse cache auto-tuning variables to use bytes, not KB
Fixup for https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/3017
This reverts 1cd82cf06823fb7680 and also multiplies results by `1024`
so as to pass bytes to Synapse, not KB (as done before).
1cd82cf06823fb7680 was correctly documenting what we were doing (passing KB values),
but that's incorrect.
Synapse's Config Conventions
(https://matrix-org.github.io/synapse/latest/usage/configuration/config_documentation.html#config-conventions)
are supposed to clear it up, but they don't currently state what happens when you pass a plain number (without a unit suffix).
Thankfully, the source code tells us:
https://github.com/element-hq/synapse/blob/bc1db16086d0718c9c0bb61b32b825ba62049bb0/synapse/config/_base.py#L181-L206
> If an integer is provided it is treated as bytes and is unchanged.
>
> String byte sizes can have a suffix of ...
> No suffix is understood as a plain byte count.
We were previously passing strings, but that has been improved in 3d73ec887aec27483.
Regardless, non-suffixed values seem to be treated as bytes by Synapse,
so this patch changes the variables to use bytes.
Moreover, we're moving from `matrix_synapse_memtotal_kb` to
`matrix_synapse_cache_size_calculations_memtotal_bytes` as working with
the base unit everywhere is preferrable.
Here, we also introduce 2 new variables to allow for the caps to be
tweaked:
- `matrix_synapse_cache_size_calculations_max_cache_memory_usage_cap_bytes`
- `matrix_synapse_cache_size_calculations_target_cache_memory_usage_cap_bytes`
2024-02-14 13:39:40 +02:00
2024-02-14 12:02:06 +02:00
matrix_synapse_cache_autotuning_min_cache_ttl : "30s"
Fix Synapse cache auto-tuning variables to use bytes, not KB
Fixup for https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/3017
This reverts 1cd82cf06823fb7680 and also multiplies results by `1024`
so as to pass bytes to Synapse, not KB (as done before).
1cd82cf06823fb7680 was correctly documenting what we were doing (passing KB values),
but that's incorrect.
Synapse's Config Conventions
(https://matrix-org.github.io/synapse/latest/usage/configuration/config_documentation.html#config-conventions)
are supposed to clear it up, but they don't currently state what happens when you pass a plain number (without a unit suffix).
Thankfully, the source code tells us:
https://github.com/element-hq/synapse/blob/bc1db16086d0718c9c0bb61b32b825ba62049bb0/synapse/config/_base.py#L181-L206
> If an integer is provided it is treated as bytes and is unchanged.
>
> String byte sizes can have a suffix of ...
> No suffix is understood as a plain byte count.
We were previously passing strings, but that has been improved in 3d73ec887aec27483.
Regardless, non-suffixed values seem to be treated as bytes by Synapse,
so this patch changes the variables to use bytes.
Moreover, we're moving from `matrix_synapse_memtotal_kb` to
`matrix_synapse_cache_size_calculations_memtotal_bytes` as working with
the base unit everywhere is preferrable.
Here, we also introduce 2 new variables to allow for the caps to be
tweaked:
- `matrix_synapse_cache_size_calculations_max_cache_memory_usage_cap_bytes`
- `matrix_synapse_cache_size_calculations_target_cache_memory_usage_cap_bytes`
2024-02-14 13:39:40 +02:00
matrix_synapse_cache_autotuning_max_cache_memory_usage : |-
{{
[
(((matrix_synapse_cache_size_calculations_memtotal_bytes | int) / 8) | int),
(matrix_synapse_cache_size_calculations_max_cache_memory_usage_cap_bytes | int),
] | min
}}
matrix_synapse_cache_autotuning_target_cache_memory_usage : |-
{{
[
(((matrix_synapse_cache_size_calculations_memtotal_bytes | int) / 16) | int),
(matrix_synapse_cache_size_calculations_target_cache_memory_usage_cap_bytes | int),
] | min
}}
2019-01-12 17:53:00 +02:00
2019-04-23 09:20:56 +02:00
# Controls whether Synapse will federate at all.
2019-01-12 17:53:00 +02:00
# Disable this to completely isolate your server from the rest of the Matrix network.
2020-12-08 16:48:25 +02:00
#
# Disabling this still keeps the federation port exposed, because it may be used for other services (`openid`).
#
# Also see:
# - `matrix_synapse_tls_federation_listener_enabled` if you wish to keep federation enabled,
2019-02-05 11:07:08 +02:00
# but want to stop the TLS listener (port 8448).
2020-12-08 16:48:25 +02:00
# - `matrix_synapse_federation_port_enabled` to avoid exposing the federation ports
2019-01-12 17:53:00 +02:00
matrix_synapse_federation_enabled : true
2020-12-08 16:48:25 +02:00
# Controls whether the federation ports are used at all.
# One may wish to disable federation (`matrix_synapse_federation_enabled: true`),
# but still run other resources (like `openid`) on the federation port
# by enabling them in `matrix_synapse_federation_listener_resource_names`.
matrix_synapse_federation_port_enabled : "{{ matrix_synapse_federation_enabled or matrix_synapse_federation_port_openid_resource_required }}"
# Controls whether an `openid` listener is to be enabled. Useful when disabling federation,
# but needing the `openid` APIs for Dimension or an identity server like ma1sd.
matrix_synapse_federation_port_openid_resource_required : false
2019-04-23 09:20:56 +02:00
# A list of domain names that are allowed to federate with the given Synapse server.
2019-01-12 17:53:00 +02:00
# An empty list value (`[]`) will also effectively stop federation, but if that's the desired
# result, it's better to accomplish it by changing `matrix_synapse_federation_enabled`.
matrix_synapse_federation_domain_whitelist : ~
2023-10-02 17:40:15 +02:00
# Enable/disable OpenID Connect
matrix_synapse_oidc_enabled : false
# List of OpenID Connect providers, ref: https://matrix-org.github.io/synapse/latest/openid.html#sample-configs
matrix_synapse_oidc_providers : [ ]
2019-01-12 17:53:00 +02:00
# A list of additional "volumes" to mount in the container.
# This list gets populated dynamically based on Synapse extensions that have been enabled.
2024-01-11 12:12:44 +02:00
# Contains definition objects like this: `{"src": "/outside", "dst": "/inside", "options": "ro"}
# Note: internally, this uses the `--mount` flag for mounting the specified volumes.
2019-01-12 17:53:00 +02:00
matrix_synapse_container_additional_volumes : [ ]
# A list of additional loggers to register in synapse.log.config.
# This list gets populated dynamically based on Synapse extensions that have been enabled.
# Contains definition objects like this: `{"name": "..", "level": "DEBUG"}
2023-08-30 11:50:47 +02:00
matrix_synapse_additional_loggers : "{{ matrix_synapse_additional_loggers_auto + matrix_synapse_additional_loggers_custom }}"
2023-08-30 11:52:44 +02:00
matrix_synapse_additional_loggers_auto :
# By default, we're disabling some useless (and even toxic) spammy WARNING-level logs.
# Related to:
# - https://github.com/matrix-org/synapse/issues/16208
# - https://github.com/matrix-org/synapse/issues/16101
2023-08-31 18:32:57 +02:00
# - https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/2853
2023-08-30 11:52:44 +02:00
- name : synapse.http.matrixfederationclient
level : CRITICAL
- name : synapse.federation.sender.per_destination_queue
level : CRITICAL
- name : synapse.handlers.device
level : CRITICAL
2023-08-31 18:32:57 +02:00
- name : synapse.replication.tcp.handler
level : CRITICAL
2023-08-30 11:52:44 +02:00
2023-08-30 11:50:47 +02:00
matrix_synapse_additional_loggers_custom : [ ]
2019-01-12 17:53:00 +02:00
2019-05-21 04:25:32 +02:00
# A list of appservice config files (in-container filesystem paths).
2019-01-12 17:53:00 +02:00
# This list gets populated dynamically based on Synapse extensions that have been enabled.
2019-05-29 08:59:50 +02:00
# You may wish to use this together with `matrix_synapse_container_additional_volumes` or `matrix_synapse_container_extra_arguments`.
2022-08-24 07:38:12 +02:00
# Also see `matrix_synapse_app_service_config_files_final`
2019-01-12 17:53:00 +02:00
matrix_synapse_app_service_config_files : [ ]
2022-11-22 21:36:49 +02:00
# matrix_synapse_app_service_config_files_auto is a list of appservice config files.
# This list is managed by the playbook. You're not meant to override this variable.
2022-08-24 07:38:12 +02:00
# If you'd like to inject your own arguments, see `matrix_synapse_app_service_config_files`.
2022-11-22 21:36:49 +02:00
matrix_synapse_app_service_config_files_auto : [ ]
2022-08-24 07:38:12 +02:00
# matrix_synapse_app_service_config_files_final holds the final list of config files to pass to the container.
# You're not meant to override this variable.
# If you'd like to inject your own arguments, see `matrix_synapse_app_service_config_files`.
2022-11-22 21:36:49 +02:00
matrix_synapse_app_service_config_files_final : "{{ matrix_synapse_app_service_config_files + matrix_synapse_app_service_config_files_auto }}"
2022-08-24 07:38:12 +02:00
2019-01-12 17:53:00 +02:00
# This is set dynamically during execution depending on whether
# any password providers have been enabled or not.
matrix_synapse_password_providers_enabled : false
2019-03-16 08:16:20 +02:00
# Whether clients can request to include message content in push notifications
# sent through third party servers. Setting this to false requires mobile clients
# to load message content directly from the homeserver.
matrix_synapse_push_include_content : true
2019-04-30 11:55:31 +02:00
# If url previews should be generated. This will cause a request from Synapse to
# URLs shared by users.
matrix_synapse_url_preview_enabled : true
2021-12-18 14:52:06 +02:00
# A list of values for the Accept-Language HTTP header used when downloading webpages during URL preview generation
matrix_url_preview_accept_language : [ 'en-US' , 'en' ]
2019-01-30 20:31:50 +02:00
# Enable exposure of metrics to Prometheus
2024-01-17 07:58:01 +02:00
# See https://github.com/element-hq/synapse/blob/master/docs/metrics-howto.md
2019-01-30 20:31:50 +02:00
matrix_synapse_metrics_enabled : false
matrix_synapse_metrics_port : 9100
2022-09-26 07:46:10 +02:00
# matrix_synapse_grafana_dashboard_urls contains a list of URLs with Grafana dashboard definitions.
# If the Grafana role is enabled, these dashboards will be downloaded.
matrix_synapse_grafana_dashboard_urls :
2024-01-17 07:58:01 +02:00
- https://raw.githubusercontent.com/element-hq/synapse/master/contrib/grafana/synapse.json
2022-09-26 07:46:10 +02:00
2022-06-23 16:44:11 +02:00
# Controls whether Synapse metrics should be proxied (exposed) on:
# - `matrix.DOMAIN/metrics/synapse/main-process` for the main process
# - `matrix.DOMAIN/metrics/synapse/worker/{type}-{id}` for each worker process
matrix_synapse_metrics_proxying_enabled : false
2024-01-12 09:52:08 +02:00
matrix_synapse_metrics_proxying_hostname : ''
matrix_synapse_metrics_proxying_path_prefix : /metrics/synapse
2022-06-23 16:44:11 +02:00
2019-12-05 08:07:15 +02:00
# Enable the Synapse manhole
2024-01-17 07:58:01 +02:00
# See https://github.com/element-hq/synapse/blob/master/docs/manhole.md
2019-12-05 08:07:15 +02:00
matrix_synapse_manhole_enabled : false
2020-04-10 23:44:53 +02:00
# Enable support for Synapse workers
matrix_synapse_workers_enabled : false
2021-02-19 11:38:47 +02:00
# Specifies worker configuration that should be used when workers are enabled.
#
# The posible values (as seen in `matrix_synapse_workers_presets`) are:
# - "little-federation-helper" - a very minimal worker configuration to improve federation performance
2024-01-20 12:41:21 +02:00
# - "one-of-each" - one worker of each supported type + a generic worker
# - "specialized-workers" - one worker of each supported type + specialized workers
2021-02-19 11:38:47 +02:00
#
# You can override `matrix_synapse_workers_presets` to define your own presets, which is ill-advised, because it's fragile.
# To use a more custom configuration, start with one of these presets as a base and configure `matrix_synapse_workers_*_count` variables manually, to suit your liking.
matrix_synapse_workers_preset : one-of-each
matrix_synapse_workers_presets :
little-federation-helper :
2024-01-16 17:17:24 +02:00
room_workers_count : 0
sync_workers_count : 0
client_reader_workers_count : 0
federation_reader_workers_count : 0
2021-02-19 11:38:47 +02:00
generic_workers_count : 0
pusher_workers_count : 0
federation_sender_workers_count : 1
media_repository_workers_count : 0
2022-09-15 09:00:57 +02:00
appservice_workers_count : 0
2021-02-19 11:38:47 +02:00
user_dir_workers_count : 0
2022-09-15 09:32:51 +02:00
background_workers_count : 0
2022-09-15 06:05:25 +02:00
stream_writer_events_stream_workers_count : 0
stream_writer_typing_stream_workers_count : 0
stream_writer_to_device_stream_workers_count : 0
stream_writer_account_data_stream_workers_count : 0
stream_writer_receipts_stream_workers_count : 0
stream_writer_presence_stream_workers_count : 0
2021-02-19 11:38:47 +02:00
one-of-each :
2024-01-16 17:17:24 +02:00
room_workers_count : 0
sync_workers_count : 0
client_reader_workers_count : 0
federation_reader_workers_count : 0
2021-02-19 11:38:47 +02:00
generic_workers_count : 1
pusher_workers_count : 1
federation_sender_workers_count : 1
media_repository_workers_count : 1
2022-09-15 09:00:57 +02:00
appservice_workers_count : 1
user_dir_workers_count : 1
2022-09-15 09:32:51 +02:00
background_workers_count : 1
2022-09-15 06:05:25 +02:00
stream_writer_events_stream_workers_count : 1
stream_writer_typing_stream_workers_count : 1
stream_writer_to_device_stream_workers_count : 1
stream_writer_account_data_stream_workers_count : 1
stream_writer_receipts_stream_workers_count : 1
stream_writer_presence_stream_workers_count : 1
2024-01-20 12:39:20 +02:00
specialized-workers :
2024-01-16 17:17:24 +02:00
room_workers_count : 1
sync_workers_count : 1
client_reader_workers_count : 1
federation_reader_workers_count : 1
generic_workers_count : 0
pusher_workers_count : 1
federation_sender_workers_count : 1
media_repository_workers_count : 1
appservice_workers_count : 1
user_dir_workers_count : 1
background_workers_count : 1
stream_writer_events_stream_workers_count : 1
stream_writer_typing_stream_workers_count : 1
stream_writer_to_device_stream_workers_count : 1
stream_writer_account_data_stream_workers_count : 1
stream_writer_receipts_stream_workers_count : 1
stream_writer_presence_stream_workers_count : 1
2021-02-19 11:38:47 +02:00
2021-01-25 08:25:43 +02:00
# Controls whether the matrix-synapse container exposes the various worker ports
# (see `port` and `metrics_port` in `matrix_synapse_workers_enabled_list`) outside of the container.
#
# Takes an "<ip>" value (e.g. "127.0.0.1", "0.0.0.0", etc), or empty string to not expose.
# It takes "*" to signify "bind on all interfaces" ("0.0.0.0" is IPv4-only).
matrix_synapse_workers_container_host_bind_address : ''
2024-01-12 12:15:40 +02:00
# matrix_synapse_worker_container_labels_traefik_enabled controls whether labels to assist a Traefik reverse-proxy will be attached to Synapse worker containers.
# See `../templates/worker-labels.j2` for details.
#
# To inject your own other container labels, see `matrix_synapse_worker_container_labels_additional_labels`.
matrix_synapse_worker_container_labels_traefik_enabled : true
matrix_synapse_worker_container_labels_traefik_docker_network : "{{ matrix_synapse_container_labels_traefik_docker_network }}"
matrix_synapse_worker_container_labels_traefik_entrypoints : "{{ matrix_synapse_container_labels_traefik_entrypoints }}"
matrix_synapse_worker_container_labels_traefik_tls_certResolver : "{{ matrix_synapse_container_labels_traefik_tls_certResolver }}" # noqa var-naming
matrix_synapse_worker_container_labels_traefik_hostname : "{{ matrix_synapse_container_labels_traefik_hostname }}"
# Controls whether labels will be added that expose metrics (see `matrix_synapse_metrics_proxying_enabled`)
2024-01-14 10:29:38 +02:00
matrix_synapse_worker_container_labels_public_metrics_enabled : "{{ matrix_synapse_metrics_enabled and matrix_synapse_metrics_proxying_enabled }}"
2024-01-12 12:15:40 +02:00
# The `__WORKER_ID__` placeholder will be replaced with the actual worker id during label-file generation (see `../templates/worker-labels.j2`).
2024-02-03 18:52:26 +02:00
matrix_synapse_worker_container_labels_public_metrics_traefik_path : "{{ matrix_synapse_metrics_proxying_path_prefix }}/worker/__WORKER_ID__"
2024-01-14 10:29:38 +02:00
matrix_synapse_worker_container_labels_public_metrics_traefik_rule : "Host(`{{ matrix_synapse_metrics_proxying_hostname }}`) && Path(`{{ matrix_synapse_worker_container_labels_public_metrics_traefik_path }}`)"
matrix_synapse_worker_container_labels_public_metrics_traefik_priority : 0
matrix_synapse_worker_container_labels_public_metrics_traefik_entrypoints : "{{ matrix_synapse_container_labels_traefik_entrypoints }}"
matrix_synapse_worker_container_labels_public_metrics_traefik_tls : "{{ matrix_synapse_container_labels_public_metrics_traefik_entrypoints != 'web' }}"
matrix_synapse_worker_container_labels_public_metrics_traefik_tls_certResolver : "{{ matrix_synapse_container_labels_traefik_tls_certResolver }}" # noqa var-naming
matrix_synapse_worker_container_labels_public_metrics_middleware_basic_auth_enabled : "{{ matrix_synapse_container_labels_public_metrics_middleware_basic_auth_enabled }}"
2024-01-12 12:15:40 +02:00
# See: https://doc.traefik.io/traefik/middlewares/http/basicauth/#users
2024-01-14 10:29:38 +02:00
matrix_synapse_worker_container_labels_public_metrics_middleware_basic_auth_users : "{{ matrix_synapse_container_labels_public_metrics_middleware_basic_auth_users }}"
2024-01-12 12:15:40 +02:00
# matrix_synapse_worker_container_labels_additional_labels contains a multiline string with additional labels to add to the label files for Synapse worker containers.
# See `../templates/labels.j2` for details.
#
# Example:
# matrix_synapse_worker_container_labels_additional_labels: |
# my.label=1
# another.label="here"
matrix_synapse_worker_container_labels_additional_labels : ''
2024-01-16 17:17:24 +02:00
# Room workers
matrix_synapse_workers_room_workers_count : "{{ matrix_synapse_workers_presets[matrix_synapse_workers_preset]['room_workers_count'] }}"
matrix_synapse_workers_room_workers_port_range_start : 28111
matrix_synapse_workers_room_workers_metrics_range_start : 29111
2024-01-24 21:14:34 +02:00
matrix_synapse_workers_room_workers_container_arguments : [ ]
2024-01-16 17:17:24 +02:00
# Sync workers
matrix_synapse_workers_sync_workers_count : "{{ matrix_synapse_workers_presets[matrix_synapse_workers_preset]['sync_workers_count'] }}"
matrix_synapse_workers_sync_workers_port_range_start : 28211
matrix_synapse_workers_sync_workers_metrics_range_start : 29211
2024-01-24 21:14:34 +02:00
matrix_synapse_workers_sync_workers_container_arguments : [ ]
2024-01-16 17:17:24 +02:00
# Client reader workers
matrix_synapse_workers_client_reader_workers_count : "{{ matrix_synapse_workers_presets[matrix_synapse_workers_preset]['client_reader_workers_count'] }}"
matrix_synapse_workers_client_reader_workers_port_range_start : 28311
matrix_synapse_workers_client_reader_workers_metrics_range_start : 29311
2024-01-24 21:14:34 +02:00
matrix_synapse_workers_client_reader_workers_container_arguments : [ ]
2024-01-16 17:17:24 +02:00
# Federation reader workers
matrix_synapse_workers_federation_reader_workers_count : "{{ matrix_synapse_workers_presets[matrix_synapse_workers_preset]['federation_reader_workers_count'] }}"
matrix_synapse_workers_federation_reader_workers_port_range_start : 28411
matrix_synapse_workers_federation_reader_workers_metrics_range_start : 29411
2024-01-24 21:14:34 +02:00
matrix_synapse_workers_federation_reader_workers_container_arguments : [ ]
2024-01-16 17:17:24 +02:00
# Generic workers
2021-02-19 11:38:47 +02:00
matrix_synapse_workers_generic_workers_count : "{{ matrix_synapse_workers_presets[matrix_synapse_workers_preset]['generic_workers_count'] }}"
2021-02-15 11:25:35 +02:00
matrix_synapse_workers_generic_workers_port_range_start : 18111
matrix_synapse_workers_generic_workers_metrics_range_start : 19111
2024-01-24 21:14:34 +02:00
matrix_synapse_workers_generic_workers_container_arguments : [ ]
2021-02-15 11:25:35 +02:00
2022-09-15 06:05:25 +02:00
# matrix_synapse_workers_stream_writer_events_stream_workers_count controls how many stream writers that handle the `events` stream to spawn.
# More than 1 worker is also supported of this type.
matrix_synapse_workers_stream_writer_events_stream_workers_count : "{{ matrix_synapse_workers_presets[matrix_synapse_workers_preset]['stream_writer_events_stream_workers_count'] }}"
# matrix_synapse_workers_stream_writer_typing_stream_workers_count controls how many stream writers that handle the `typing` stream to spawn.
# The count of these workers can only be 0 or 1.
matrix_synapse_workers_stream_writer_typing_stream_workers_count : "{{ matrix_synapse_workers_presets[matrix_synapse_workers_preset]['stream_writer_typing_stream_workers_count'] }}"
# matrix_synapse_workers_stream_writer_to_device_stream_workers_count controls how many stream writers that handle the `to_device` stream to spawn.
# The count of these workers can only be 0 or 1.
matrix_synapse_workers_stream_writer_to_device_stream_workers_count : "{{ matrix_synapse_workers_presets[matrix_synapse_workers_preset]['stream_writer_to_device_stream_workers_count'] }}"
# matrix_synapse_workers_stream_writer_account_data_stream_workers_count controls how many stream writers that handle the `account_data` stream to spawn.
# The count of these workers can only be 0 or 1.
matrix_synapse_workers_stream_writer_account_data_stream_workers_count : "{{ matrix_synapse_workers_presets[matrix_synapse_workers_preset]['stream_writer_account_data_stream_workers_count'] }}"
# matrix_synapse_workers_stream_writer_receipts_stream_workers_count controls how many stream writers that handle the `receipts` stream to spawn.
# The count of these workers can only be 0 or 1.
matrix_synapse_workers_stream_writer_receipts_stream_workers_count : "{{ matrix_synapse_workers_presets[matrix_synapse_workers_preset]['stream_writer_receipts_stream_workers_count'] }}"
# matrix_synapse_workers_stream_writer_presence_stream_workers_count controls how many stream writers that handle the `presence` stream to spawn.
# The count of these workers can only be 0 or 1.
matrix_synapse_workers_stream_writer_presence_stream_workers_count : "{{ matrix_synapse_workers_presets[matrix_synapse_workers_preset]['stream_writer_presence_stream_workers_count'] }}"
# A list of stream writer workers to enable. This list is built automatically based on other variables.
# You're encouraged to enable/disable stream writer workers by setting `matrix_synapse_workers_stream_writer_*_stream_workers_count` variables, instead of adjusting this list manually.
matrix_synapse_workers_stream_writers : |
{{
[ ]
+
([{'stream': 'events'}] * matrix_synapse_workers_stream_writer_events_stream_workers_count | int)
+
([{'stream': 'typing'}] * matrix_synapse_workers_stream_writer_typing_stream_workers_count | int)
+
([{'stream': 'to_device'}] * matrix_synapse_workers_stream_writer_to_device_stream_workers_count | int)
+
([{'stream': 'account_data'}] * matrix_synapse_workers_stream_writer_account_data_stream_workers_count | int)
+
([{'stream': 'receipts'}] * matrix_synapse_workers_stream_writer_receipts_stream_workers_count | int)
+
([{'stream': 'presence'}] * matrix_synapse_workers_stream_writer_presence_stream_workers_count | int)
}}
2024-01-24 21:14:34 +02:00
matrix_synapse_workers_stream_writers_container_arguments : [ ]
2022-09-15 06:05:25 +02:00
# matrix_synapse_stream_writers populates the `stream_writers` Synapse configuration used when Synapse workers are in use (`matrix_synapse_workers_enabled`).
# What you see below is an initial default value which will be adjusted at runtime based on the value of `matrix_synapse_workers_stream_writers`.
# Adjusting this value manually is generally not necessary.
#
# It's tempting to initialize this like this:
# matrix_synapse_stream_writers:
# - typing: []
# - events: []
# - to_device: []
# - account_data: []
# - receipts: []
# - presence: []
# .. but Synapse does not like empty lists (see https://github.com/matrix-org/synapse/issues/13804)
matrix_synapse_stream_writers : {}
# `matrix_synapse_workers_stream_writer_workers_` variables control the port numbers of various stream writer workers
# defined in `matrix_synapse_workers_stream_writers`.
# It should be noted that not all of the background worker types will need to expose HTTP services, etc.
matrix_synapse_workers_stream_writer_workers_http_port_range_start : 20011
matrix_synapse_workers_stream_writer_workers_replication_port_range_start : 25011
2022-09-17 09:22:05 +02:00
matrix_synapse_workers_stream_writer_workers_metrics_range_start : 19211
2022-09-15 06:05:25 +02:00
2022-09-15 07:32:55 +02:00
# matrix_synapse_workers_pusher_workers_count controls the number of pusher workers (workers who push out notifications) to spawn.
# See https://matrix-org.github.io/synapse/latest/workers.html#synapseapppusher
2021-02-19 11:38:47 +02:00
matrix_synapse_workers_pusher_workers_count : "{{ matrix_synapse_workers_presets[matrix_synapse_workers_preset]['pusher_workers_count'] }}"
2021-02-15 11:25:35 +02:00
matrix_synapse_workers_pusher_workers_metrics_range_start : 19200
2024-01-24 21:14:34 +02:00
matrix_synapse_workers_pusher_workers_container_arguments : [ ]
2021-02-15 11:25:35 +02:00
2022-09-15 07:32:55 +02:00
# matrix_synapse_federation_pusher_instances populates the `pusher_instances` Synapse configuration used when Synapse workers are in use (`matrix_synapse_workers_enabled`).
# What you see below is an initial default value which will be adjusted at runtime based on the value of `matrix_synapse_workers_pusher_workers_count` or `matrix_synapse_workers_enabled_list`.
# Adjusting this value manually is generally not necessary.
matrix_synapse_federation_pusher_instances : [ ]
2022-09-15 07:13:08 +02:00
# matrix_synapse_workers_federation_sender_workers_count controls the number of federation sender workers to spawn.
2022-09-15 07:32:55 +02:00
# See https://matrix-org.github.io/synapse/latest/workers.html#synapseappfederation_sender
2021-02-19 11:38:47 +02:00
matrix_synapse_workers_federation_sender_workers_count : "{{ matrix_synapse_workers_presets[matrix_synapse_workers_preset]['federation_sender_workers_count'] }}"
2021-02-15 11:25:35 +02:00
matrix_synapse_workers_federation_sender_workers_metrics_range_start : 19400
2024-01-24 21:14:34 +02:00
matrix_synapse_workers_federation_sender_workers_container_arguments : [ ]
2021-02-15 11:25:35 +02:00
2022-09-15 07:13:08 +02:00
# matrix_synapse_federation_sender_instances populates the `federation_sender_instances` Synapse configuration used when Synapse workers are in use (`matrix_synapse_workers_enabled`).
# What you see below is an initial default value which will be adjusted at runtime based on the value of `matrix_synapse_workers_federation_sender_workers_count` or `matrix_synapse_workers_enabled_list`.
# Adjusting this value manually is generally not necessary.
matrix_synapse_federation_sender_instances : [ ]
2023-07-12 08:09:27 +02:00
matrix_synapse_workers_media_repository_workers_count : "{{ matrix_synapse_workers_presets[matrix_synapse_workers_preset]['media_repository_workers_count'] if not matrix_synapse_ext_media_repo_enabled else 0 }}"
2021-02-15 11:25:35 +02:00
matrix_synapse_workers_media_repository_workers_port_range_start : 18551
matrix_synapse_workers_media_repository_workers_metrics_range_start : 19551
2024-01-24 21:14:34 +02:00
matrix_synapse_workers_media_repository_workers_container_arguments : [ ]
2021-02-15 11:25:35 +02:00
2022-09-15 07:37:19 +02:00
# matrix_synapse_enable_media_repo controls if the main Synapse process should serve media repository endpoints or if it should be left to media_repository workers (see `matrix_synapse_workers_media_repository_workers_count`).
2022-09-15 11:33:23 +02:00
# This is enabled if workers are disabled, or if they are enabled, but there are no media repository workers.
2022-09-15 07:37:19 +02:00
# Adjusting this value manually is generally not necessary.
2023-07-12 08:09:27 +02:00
matrix_synapse_enable_media_repo : "{{ not matrix_synapse_ext_media_repo_enabled and (not matrix_synapse_workers_enabled or (matrix_synapse_workers_enabled_list | selectattr('type', 'equalto', 'media_repository') | list | length == 0)) }}"
2022-09-15 07:37:19 +02:00
2022-09-15 09:45:03 +02:00
# matrix_synapse_media_instance_running_background_jobs populates the `media_instance_running_background_jobs` Synapse configuration used when Synapse workers are in use (`matrix_synapse_workers_enabled`).
# `media_instance_running_background_jobs` is meant to point to a single media-repository worker, which is dedicated to running background tasks that maintain the media repository.
# Multiple `media_repository` workers may be enabled. We always pick the first one as the background tasks worker.
matrix_synapse_media_instance_running_background_jobs : "{{ (matrix_synapse_workers_enabled_list | selectattr('type', 'equalto', 'media_repository') | list)[0].name if (matrix_synapse_workers_enabled and matrix_synapse_workers_enabled_list | selectattr('type', 'equalto', 'media_repository') | list | length > 0) else '' }}"
2022-09-15 09:00:57 +02:00
# matrix_synapse_workers_appservice_workers_count can only be 0 or 1. More instances are not supported.
2024-01-17 07:58:01 +02:00
# appservice workers were deprecated since Synapse v1.59 (see: https://github.com/element-hq/synapse/blob/v1.59.0/docs/upgrade.md#deprecation-of-the-synapseappappservice-and-synapseappuser_dir-worker-application-types).
2022-09-15 09:00:57 +02:00
# Our implementation uses generic worker services and assigns them to perform appservice work using the `notify_appservices_from_worker` Synapse option.
matrix_synapse_workers_appservice_workers_count : "{{ matrix_synapse_workers_presets[matrix_synapse_workers_preset]['appservice_workers_count'] }}"
matrix_synapse_workers_appservice_workers_metrics_range_start : 19300
2024-01-24 21:14:34 +02:00
matrix_synapse_workers_appservice_workers_container_arguments : [ ]
2022-09-15 09:00:57 +02:00
# matrix_synapse_notify_appservices_from_worker populates the `notify_appservices_from_worker` Synapse configuration used when Synapse workers are in use (`matrix_synapse_workers_enabled`).
# `notify_appservices_from_worker` is meant to point to a worker, which is dedicated to sending output traffic to Application Services.
matrix_synapse_notify_appservices_from_worker : "{{ (matrix_synapse_workers_enabled_list | selectattr('type', 'equalto', 'appservice') | list)[0].name if (matrix_synapse_workers_enabled and matrix_synapse_workers_enabled_list | selectattr('type', 'equalto', 'appservice') | list | length > 0) else '' }}"
# matrix_synapse_workers_user_dir_workers_count can only be 0 or 1. More instances are not supported.
2024-01-17 07:58:01 +02:00
# user_dir workers were deprecated since Synapse v1.59 (see: https://github.com/element-hq/synapse/blob/v1.59.0/docs/upgrade.md#deprecation-of-the-synapseappappservice-and-synapseappuser_dir-worker-application-types).
2022-09-15 09:00:57 +02:00
# Our implementation uses generic worker services and assigns them to perform appservice work using the `update_user_directory_from_worker` Synapse option.
matrix_synapse_workers_user_dir_workers_count : "{{ matrix_synapse_workers_presets[matrix_synapse_workers_preset]['user_dir_workers_count'] }}"
2021-02-15 11:25:35 +02:00
matrix_synapse_workers_user_dir_workers_port_range_start : 18661
matrix_synapse_workers_user_dir_workers_metrics_range_start : 19661
2024-01-24 21:14:34 +02:00
matrix_synapse_workers_user_dir_workers_container_arguments : [ ]
2021-02-15 11:25:35 +02:00
2022-09-15 09:00:57 +02:00
# matrix_synapse_update_user_directory_from_worker populates the `update_user_directory_from_worker` Synapse configuration used when Synapse workers are in use (`matrix_synapse_workers_enabled`).
# `update_user_directory_from_worker` is meant to point to a worker, which is dedicated to updating the user directory and servicing some user directory URL endpoints (`matrix_synapse_workers_user_dir_worker_client_server_endpoints`).
matrix_synapse_update_user_directory_from_worker : "{{ (matrix_synapse_workers_enabled_list | selectattr('type', 'equalto', 'user_dir') | list)[0].name if (matrix_synapse_workers_enabled and matrix_synapse_workers_enabled_list | selectattr('type', 'equalto', 'user_dir') | list | length > 0) else '' }}"
2022-09-15 09:32:51 +02:00
# matrix_synapse_workers_background_workers_count can only be 0 or 1. More instances are not supported.
# Our implementation uses a generic worker and assigns Synapse to perform background work on this worker using the `run_background_tasks_on` Synapse option.
matrix_synapse_workers_background_workers_count : "{{ matrix_synapse_workers_presets[matrix_synapse_workers_preset]['background_workers_count'] }}"
matrix_synapse_workers_background_workers_metrics_range_start : 19700
2024-01-24 21:14:34 +02:00
matrix_synapse_workers_background_workers_container_arguments : [ ]
2022-09-15 09:32:51 +02:00
# matrix_synapse_run_background_tasks_on populates the `run_background_tasks_on` Synapse configuration used when Synapse workers are in use (`matrix_synapse_workers_enabled`).
# `run_background_tasks_on` is meant to point to a worker, which is dedicated to processing background tasks.
matrix_synapse_run_background_tasks_on : "{{ (matrix_synapse_workers_enabled_list | selectattr('type', 'equalto', 'background') | list)[0].name if (matrix_synapse_workers_enabled and matrix_synapse_workers_enabled_list | selectattr('type', 'equalto', 'background') | list | length > 0) else '' }}"
2021-02-15 11:25:35 +02:00
# Default list of workers to spawn.
#
# Unless you populate this manually, this list is dynamically generated
# based on other variables above:
# - `matrix_synapse_workers_*_workers_count`
# - `matrix_synapse_workers_*_workers_port_range_start`
# - `matrix_synapse_workers_*_workers_port_metrics_range_start`
#
# We advise that you use those variables and let this list be populated dynamically.
# Doing that is simpler and also protects you from shooting yourself in the foot,
# as certain workers can only be spawned just once.
#
2021-02-18 18:19:51 +02:00
# Each worker instance in the list defines the following fields:
2022-09-15 06:05:25 +02:00
# - `id` - a string that uniquely identifies the worker
# - `name` - a string that will be used as the container and systemd service name
# - `type` - the type of worker (`generic_worker`, `stream_writer`, `pusher`, etc.)
# - `app` - the Synapse app (https://matrix-org.github.io/synapse/latest/workers.html#available-worker-applications) that powers this worker (`generic_worker`, `federation_sender`, etc.).
# The `app` usually matches the `type`, but not always. For example, `type = stream_writer` workers are served by the `generic_worker` type.
2021-02-18 18:19:51 +02:00
# - `port` - an HTTP port where the worker listens for requests (can be `0` for workers that don't do HTTP request processing)
# - `metrics_port` - an HTTP port where the worker exports Prometheus metrics
2022-09-15 06:05:25 +02:00
# - `replication_port` - an HTTP port where the worker serves `replication` endpoints (used by stream writers, etc.)
# - `webserving` - tells whether this type of worker serves web (client or federation) requests, so that it can be injected as a dependency to the reverse-proxy
2021-02-18 18:19:51 +02:00
#
# Example of what this needs to look like, if you're defining it manually:
2021-02-15 11:25:35 +02:00
# matrix_synapse_workers_enabled_list:
2022-09-15 06:05:25 +02:00
# - { 'id': 'generic-worker-0', 'name': 'matrix-synapse-worker-generic-0', 'type': 'generic_worker', 'app': 'generic_worker', 'port': 18111, 'metrics_port': 19111, 'webserving': true }
# - { 'id': 'generic-worker-1', 'name': 'matrix-synapse-worker-generic-1', 'type': 'generic_worker', 'app': 'generic_worker', 'port': 18112, 'metrics_port': 19112, 'webserving': true }
# - { 'id': 'generic-worker-2', 'name': 'matrix-synapse-worker-generic-2', 'type': 'generic_worker', 'app': 'generic_worker', 'port': 18113, 'metrics_port': 19113, 'webserving': true }
# - { 'id': 'generic-worker-3', 'name': 'matrix-synapse-worker-generic-3', 'type': 'generic_worker', 'app': 'generic_worker', 'port': 18114, 'metrics_port': 19114, 'webserving': true }
# - { 'id': 'generic-worker-4', 'name': 'matrix-synapse-worker-generic-4', 'type': 'generic_worker', 'app': 'generic_worker', 'port': 18115, 'metrics_port': 19115, 'webserving': true }
# - { 'id': 'generic-worker-5', 'name': 'matrix-synapse-worker-generic-5', 'type': 'generic_worker', 'app': 'generic_worker', 'port': 18116, 'metrics_port': 19116, 'webserving': true }
# - { 'id': 'stream-writer-0-events', 'name': 'matrix-synapse-worker-stream-writer-0-events', 'type': 'stream_writer', 'app': 'generic_worker', 'stream_writer_stream': 'events', 'port': 0, 'replication_port': 25011, metrics_port: 19111, 'webserving': false }
# - { 'id': 'stream-writer-1-typing', 'name': 'matrix-synapse-worker-stream-writer-1-typing', 'type': 'stream_writer', 'app': 'generic_worker', 'stream_writer_stream': 'typing', 'port': 20012, 'replication_port': 25012, metrics_port: 19112, 'webserving': true }
# - { 'id': 'pusher-0', 'name': 'matrix-synapse-worker-pusher-0', 'type': 'pusher', 'app': 'pusher', 'port': 0, 'metrics_port': 19200, 'webserving': false }
# - { 'id': 'appservice-0', 'name': 'matrix-synapse-worker-appservice-0', 'type': 'appservice', 'port': 0, 'metrics_port': 19300, 'webserving': false }
# - { 'id': 'federation-sender-0', 'name': 'matrix-synapse-worker-federation-sender-0', 'type': 'federation_sender', 'port': 0, 'metrics_port': 19400, 'webserving': false }
# - { 'id': 'media-repository-0', 'name': 'matrix-synapse-worker-media-repository-0', 'type': 'media_repository', 'port': 18551, 'metrics_port': 19551, 'webserving': true }
2021-02-15 11:25:35 +02:00
matrix_synapse_workers_enabled_list : [ ]
2020-04-10 23:44:53 +02:00
2023-05-15 06:33:26 +02:00
# matrix_synapse_instance_map holds the instance map used for mapping worker names (for the main process and certain generic workers only!) to where they live (host, port which handles replication traffic).
# This map starts off being populated with the Synapse main (master) process,
# but will be populated with workers automatically during runtime, based on `matrix_synapse_workers_enabled_list`.
matrix_synapse_instance_map : |
{{
{
'main' : {
'host' : 'matrix-synapse' ,
'port' : matrix_synapse_replication_http_port,
},
2023-05-15 06:37:25 +02:00
} if matrix_synapse_workers_enabled else {}
2023-05-15 06:33:26 +02:00
}}
2022-09-15 06:05:25 +02:00
2020-09-10 13:39:00 +02:00
# Redis information
matrix_synapse_redis_enabled : false
matrix_synapse_redis_host : ""
matrix_synapse_redis_port : 6379
matrix_synapse_redis_password : ""
2024-04-01 22:24:40 +02:00
matrix_synapse_redis_dbid : 0
2020-09-10 13:39:00 +02:00
2021-01-25 13:02:01 +02:00
# Controls whether Synapse starts a replication listener necessary for workers.
#
# If Redis is available, we prefer to use that, instead of talking over Synapse's custom replication protocol.
#
2023-02-17 16:13:38 +02:00
# matrix_synapse_replication_listener_enabled: "{{ matrix_synapse_workers_enabled and not redis_enabled }}"
2021-01-25 13:02:01 +02:00
# We force-enable this listener for now until we debug why communication via Redis fails.
matrix_synapse_replication_listener_enabled : true
# Port used for communication between main synapse process and workers.
# Only gets used if `matrix_synapse_replication_listener_enabled: true`
2020-04-10 23:44:53 +02:00
matrix_synapse_replication_http_port : 9093
2019-12-05 08:07:15 +02:00
2019-06-07 23:02:41 +02:00
# Send ERROR logs to sentry.io for easier tracking
# To set this up: go to sentry.io, create a python project, and set
# matrix_synapse_sentry_dsn to the URL it gives you.
# See https://github.com/matrix-org/synapse/issues/4632 for important privacy concerns
matrix_synapse_sentry_dsn : ""
2019-01-16 18:05:48 +02:00
# Postgres database information
2021-08-10 20:09:28 +02:00
matrix_synapse_database_txn_limit : 0
2022-11-27 08:31:54 +02:00
matrix_synapse_database_host : ''
2021-05-17 13:58:07 +02:00
matrix_synapse_database_port : 5432
2023-12-17 03:16:05 +02:00
matrix_synapse_database_cp_min : 5
matrix_synapse_database_cp_max : 10
2021-01-22 12:23:00 +02:00
matrix_synapse_database_user : "synapse"
2019-01-16 18:05:48 +02:00
matrix_synapse_database_password : ""
2021-01-22 12:23:00 +02:00
matrix_synapse_database_database : "synapse"
2019-01-16 18:05:48 +02:00
matrix_synapse_turn_uris : [ ]
matrix_synapse_turn_shared_secret : ""
2024-02-18 09:52:00 +02:00
matrix_synapse_turn_username : ""
matrix_synapse_turn_password : ""
2022-02-05 22:32:54 +02:00
matrix_synapse_turn_allow_guests : false
2019-01-16 18:05:48 +02:00
matrix_synapse_email_enabled : false
matrix_synapse_email_smtp_host : ""
matrix_synapse_email_smtp_port : 587
2021-11-17 21:34:46 +02:00
matrix_synapse_email_smtp_user : ""
matrix_synapse_email_smtp_pass : ""
2019-01-16 18:05:48 +02:00
matrix_synapse_email_smtp_require_transport_security : false
2019-02-28 11:51:09 +02:00
matrix_synapse_email_notif_from : "Matrix <matrix@{{ matrix_domain }}>"
2023-02-17 18:31:01 +02:00
matrix_synapse_email_app_name : Matrix
2024-05-25 15:14:26 +02:00
matrix_synapse_email_client_base_url : "{{ 'https' if matrix_playbook_ssl_enabled else 'http' }}://{{ matrix_server_fqn_element }}"
2021-08-25 08:51:42 +02:00
matrix_synapse_email_invite_client_location : "https://app.element.io"
2019-01-16 18:05:48 +02:00
2019-01-12 17:53:00 +02:00
# Enable this to activate the REST auth password provider module.
2020-01-25 10:23:59 +02:00
# See: https://github.com/ma1uta/matrix-synapse-rest-password-provider
2019-01-12 17:53:00 +02:00
matrix_synapse_ext_password_provider_rest_auth_enabled : false
2020-01-27 12:22:36 +02:00
matrix_synapse_ext_password_provider_rest_auth_download_url : "https://raw.githubusercontent.com/ma1uta/matrix-synapse-rest-password-provider/ed377fb70513c2e51b42055eb364195af1ccaf33/rest_auth_provider.py"
2019-01-12 17:53:00 +02:00
matrix_synapse_ext_password_provider_rest_auth_endpoint : ""
matrix_synapse_ext_password_provider_rest_auth_registration_enforce_lowercase : false
matrix_synapse_ext_password_provider_rest_auth_registration_profile_name_autofill : true
matrix_synapse_ext_password_provider_rest_auth_login_profile_name_autofill : false
# Enable this to activate the Shared Secret Auth password provider module.
# See: https://github.com/devture/matrix-synapse-shared-secret-auth
matrix_synapse_ext_password_provider_shared_secret_auth_enabled : false
2023-06-07 13:20:52 +02:00
matrix_synapse_ext_password_provider_shared_secret_auth_download_url : "https://raw.githubusercontent.com/devture/matrix-synapse-shared-secret-auth/2.0.3/shared_secret_authenticator.py"
2019-01-12 17:53:00 +02:00
matrix_synapse_ext_password_provider_shared_secret_auth_shared_secret : ""
2021-11-03 17:25:01 +02:00
matrix_synapse_ext_password_provider_shared_secret_auth_m_login_password_support_enabled : true
2023-06-07 13:12:38 +02:00
matrix_synapse_ext_password_provider_shared_secret_auth_com_devture_shared_secret_auth_support_enabled : true
2022-07-18 10:22:05 +02:00
matrix_synapse_ext_password_provider_shared_secret_config : "{{ matrix_synapse_ext_password_provider_shared_secret_config_yaml | from_yaml }}"
2021-11-03 17:25:01 +02:00
matrix_synapse_ext_password_provider_shared_secret_config_yaml : |
2022-07-18 11:28:39 +02:00
shared_secret : {{ matrix_synapse_ext_password_provider_shared_secret_auth_shared_secret | string | to_json }}
2022-07-18 10:22:05 +02:00
m_login_password_support_enabled : {{ matrix_synapse_ext_password_provider_shared_secret_auth_m_login_password_support_enabled | to_json }}
com_devture_shared_secret_auth_support_enabled : {{ matrix_synapse_ext_password_provider_shared_secret_auth_com_devture_shared_secret_auth_support_enabled | to_json }}
2019-01-12 17:53:00 +02:00
# Enable this to activate LDAP password provider
matrix_synapse_ext_password_provider_ldap_enabled : false
matrix_synapse_ext_password_provider_ldap_uri : "ldap://ldap.mydomain.tld:389"
matrix_synapse_ext_password_provider_ldap_start_tls : true
2023-01-09 22:18:37 +02:00
matrix_synapse_ext_password_provider_ldap_mode : "search"
2019-01-12 17:53:00 +02:00
matrix_synapse_ext_password_provider_ldap_base : ""
matrix_synapse_ext_password_provider_ldap_attributes_uid : "uid"
matrix_synapse_ext_password_provider_ldap_attributes_mail : "mail"
matrix_synapse_ext_password_provider_ldap_attributes_name : "cn"
matrix_synapse_ext_password_provider_ldap_bind_dn : ""
matrix_synapse_ext_password_provider_ldap_bind_password : ""
matrix_synapse_ext_password_provider_ldap_filter : ""
2021-05-25 13:11:38 +02:00
matrix_synapse_ext_password_provider_ldap_active_directory : false
2021-05-25 10:44:28 +02:00
matrix_synapse_ext_password_provider_ldap_default_domain : ""
2019-01-12 17:53:00 +02:00
2019-09-09 07:13:06 +02:00
# Enable this to activate the Synapse Antispam spam-checker module.
# See: https://github.com/t2bot/synapse-simple-antispam
matrix_synapse_ext_spam_checker_synapse_simple_antispam_enabled : false
matrix_synapse_ext_spam_checker_synapse_simple_antispam_git_repository_url : "https://github.com/t2bot/synapse-simple-antispam"
2022-01-19 16:35:55 +02:00
matrix_synapse_ext_spam_checker_synapse_simple_antispam_git_version : "5ab711971e3a4541a7a40310ff85e17f8262cc05"
2019-09-09 07:13:06 +02:00
matrix_synapse_ext_spam_checker_synapse_simple_antispam_config_blocked_homeservers : [ ]
2019-01-12 17:53:00 +02:00
2021-05-25 16:42:04 +02:00
# Enable this to activate the Mjolnir Antispam spam-checker module.
# See: https://github.com/matrix-org/mjolnir#synapse-module
matrix_synapse_ext_spam_checker_mjolnir_antispam_enabled : false
matrix_synapse_ext_spam_checker_mjolnir_antispam_git_repository_url : "https://github.com/matrix-org/mjolnir"
2023-08-26 19:04:58 +02:00
matrix_synapse_ext_spam_checker_mjolnir_antispam_git_version : "v1.6.4"
2021-05-25 16:42:04 +02:00
matrix_synapse_ext_spam_checker_mjolnir_antispam_config_block_invites : true
# Flag messages sent by servers/users in the ban lists as spam. Currently
# this means that spammy messages will appear as empty to users. Default
# false.
matrix_synapse_ext_spam_checker_mjolnir_antispam_config_block_messages : false
# Remove users from the user directory search by filtering matrix IDs and
# display names by the entries in the user ban list. Default false.
matrix_synapse_ext_spam_checker_mjolnir_antispam_config_block_usernames : false
# The room IDs of the ban lists to honour. Unlike other parts of Mjolnir,
# this list cannot be room aliases or permalinks. This server is expected
# to already be joined to the room - Mjolnir will not automatically join
# these rooms.
# ["!roomid:example.org"]
matrix_synapse_ext_spam_checker_mjolnir_antispam_config_ban_lists : [ ]
2023-08-26 19:07:40 +02:00
# A dictionary with various fields controlling max length.
# See https://github.com/matrix-org/mjolnir/blob/main/docs/synapse_module.md for details.
matrix_synapse_ext_spam_checker_mjolnir_antispam_config_message_max_length : {}
# Actual configuration passed to the mjolnir-antispam Synapse module
matrix_synapse_ext_spam_checker_mjolnir_antispam_config :
block_invites : "{{ matrix_synapse_ext_spam_checker_mjolnir_antispam_config_block_invites }}"
block_messages : "{{ matrix_synapse_ext_spam_checker_mjolnir_antispam_config_block_messages }}"
block_usernames : "{{ matrix_synapse_ext_spam_checker_mjolnir_antispam_config_block_usernames }}"
ban_lists : "{{ matrix_synapse_ext_spam_checker_mjolnir_antispam_config_ban_lists }}"
message_max_length : "{{ matrix_synapse_ext_spam_checker_mjolnir_antispam_config_message_max_length }}"
2021-05-25 16:42:04 +02:00
2022-02-11 20:06:11 +02:00
# Enable this to activate the E2EE disabling Synapse module.
# See: https://github.com/digitalentity/matrix_encryption_disabler
matrix_synapse_ext_encryption_disabler_enabled : false
2022-05-31 16:35:22 +02:00
matrix_synapse_ext_encryption_disabler_download_url : "https://raw.githubusercontent.com/digitalentity/matrix_encryption_disabler/cdc37a07441acb7c2a3288bcb29b376658d5e766/matrix_e2ee_filter.py"
2022-02-11 20:06:11 +02:00
# A list of server domain names for which to deny encryption if the event sender's domain matches the domain in the list.
# By default, with the configuration below, we prevent all homeserver users from initiating encryption in ANY room.
matrix_synapse_ext_encryption_disabler_deny_encryption_for_users_of : [ "{{ matrix_domain }}" ]
# A list of server domain names for which to deny encryption if the destination room id's domain matches the domain in the list.
# By default, with the configuration below, we prevent locally-created encryption events by ANY user encrypt rooms on the homeserver.
# Note: foreign users with enough room privileges will still be able to send an encryption event to your rooms and encrypt them.
matrix_synapse_ext_encryption_disabler_deny_encryption_for_rooms_of : [ "{{ matrix_domain }}" ]
2022-02-14 10:39:14 +02:00
# Specifies whether the power levels event (setting) provided during room creation should be patched.
# This makes it impossible for anybody (locally or over federation) from enabling room encryption
# for the lifetime of rooms created while this setting is enabled (irreversible).
# Enabling this may have incompatiblity consequences with servers / clients.
# Familiarize yourself with the caveats upstream: https://github.com/digitalentity/matrix_encryption_disabler
matrix_synapse_ext_encryption_disabler_patch_power_levels : false
2022-07-18 10:22:05 +02:00
matrix_synapse_ext_encryption_config : "{{ matrix_synapse_ext_encryption_config_yaml | from_yaml }}"
2022-02-11 20:06:11 +02:00
matrix_synapse_ext_encryption_config_yaml : |
2022-07-18 10:22:05 +02:00
deny_encryption_for_users_of : {{ matrix_synapse_ext_encryption_disabler_deny_encryption_for_users_of | to_json }}
deny_encryption_for_rooms_of : {{ matrix_synapse_ext_encryption_disabler_deny_encryption_for_rooms_of | to_json }}
patch_power_levels : {{ matrix_synapse_ext_encryption_disabler_patch_power_levels | to_json }}
2022-02-11 20:06:11 +02:00
2022-10-14 16:41:41 +02:00
# matrix_synapse_ext_synapse_s3_storage_provider_enabled controls whether to enable https://github.com/matrix-org/synapse-s3-storage-provider
# Installing it requires building a customized Docker image for Synapse (see `matrix_synapse_container_image_customizations_enabled`).
# Enabling this will enable customizations and inject the appropriate Dockerfile clauses for installing synapse-s3-storage-provider.
matrix_synapse_ext_synapse_s3_storage_provider_enabled : false
2023-11-17 19:35:28 +02:00
matrix_synapse_ext_synapse_s3_storage_provider_version : 1.3 .0
2022-10-14 16:41:41 +02:00
# Controls whether media from this (local) server is stored in s3-storage-provider
matrix_synapse_ext_synapse_s3_storage_provider_store_local : true
# Controls whether media from remote servers is stored in s3-storage-provider
matrix_synapse_ext_synapse_s3_storage_provider_store_remote : true
# Controls whether files are stored to S3 at the same time they are stored on the local filesystem.
# For slightly improved reliability, consider setting this to `true`.
# Even with asynchronous uploading to S3 (`false` value), data loss shouldn't be possible,
# because the local filesystem is a reliable data store anyway.
matrix_synapse_ext_synapse_s3_storage_provider_store_synchronous : false
matrix_synapse_ext_synapse_s3_storage_provider_config_bucket : ''
matrix_synapse_ext_synapse_s3_storage_provider_config_region_name : ''
matrix_synapse_ext_synapse_s3_storage_provider_config_endpoint_url : ''
matrix_synapse_ext_synapse_s3_storage_provider_config_access_key_id : ''
matrix_synapse_ext_synapse_s3_storage_provider_config_secret_access_key : ''
2023-06-13 21:48:44 +02:00
# Enable this to use EC2 instance profile metadata to grab IAM credentials instead of passing credentials directly
# via matrix_synapse_ext_synapse_s3_storage_provider_config_access_key_id and matrix_synapse_ext_synapse_s3_storage_provider_config_secret_access_key
2023-06-13 18:08:14 +02:00
matrix_synapse_ext_synapse_s3_storage_provider_config_ec2_instance_profile : false
2022-10-31 01:01:49 +02:00
matrix_synapse_ext_synapse_s3_storage_provider_config_sse_customer_enabled : false
matrix_synapse_ext_synapse_s3_storage_provider_config_sse_customer_key : ''
matrix_synapse_ext_synapse_s3_storage_provider_config_sse_customer_algo : 'AES256'
2022-10-14 16:41:41 +02:00
matrix_synapse_ext_synapse_s3_storage_provider_config_storage_class : STANDARD
matrix_synapse_ext_synapse_s3_storage_provider_config_threadpool_size : 40
# matrix_synapse_ext_synapse_s3_storage_provider_update_db_day_count is a day value (number) for the `s3_media_upload update-db` command.
# It specifies how old files need to have been inactive to be eligible for migration from the local filesystem to the S3 data store.
# By default, we use `0` which says "all files are eligible for migration".
matrix_synapse_ext_synapse_s3_storage_provider_update_db_day_count : 0
2023-02-22 08:18:21 +02:00
# Specifies how often periodic migration (`matrix-synapse-s3-storage-provider-migrate.timer`) will run.
# This is a systemd timer OnCalendar definition. Learn more here: https://man.archlinux.org/man/systemd.time.7#CALENDAR_EVENTS
matrix_synapse_ext_synapse_s3_storage_provider_periodic_migration_schedule : '*-*-* 05:00:00'
2022-10-14 16:41:41 +02:00
2024-02-21 18:04:14 +02:00
# Synapse module to automatically accept room invites.
# See: https://github.com/matrix-org/synapse-auto-accept-invite
# Installing it requires building a customized Docker image for Synapse (see `matrix_synapse_container_image_customizations_enabled`).
# Enabling this will enable customizations and inject the appropriate Dockerfile clauses for installing synapse-auto-accept-invite.
matrix_synapse_ext_synapse_auto_accept_invite_enabled : false
matrix_synapse_ext_synapse_auto_accept_invite_version : 1.1 .3
# Specifies whether only direct messages (1:1 rooms) will be auto accepted.
matrix_synapse_ext_synapse_auto_accept_invite_accept_invites_only_direct_messages : false
2024-05-17 05:08:12 +02:00
# Specifies whether only invites from local users will be auto accepted.
matrix_synapse_ext_synapse_auto_accept_invite_accept_invites_only_from_local_users : false
2024-02-21 18:04:14 +02:00
# When Synapse workers enabled it is possible (but not required) to assign a worker to run this module on (null = main process).
matrix_synapse_ext_synapse_auto_accept_invite_worker_to_run_on : null
2023-07-13 18:03:36 +02:00
# Specifies whether an external media repository is enabled.
# If it is, the Synapse media repo and media-repo workers will be disabled automatically.
2023-07-12 08:09:27 +02:00
matrix_synapse_ext_media_repo_enabled : false
2019-01-12 17:53:00 +02:00
matrix_s3_media_store_enabled : false
2019-04-05 11:33:38 +02:00
matrix_s3_media_store_custom_endpoint_enabled : false
2023-01-14 15:26:58 +02:00
matrix_s3_goofys_docker_image : "{{ matrix_s3_goofys_docker_image_name_prefix }}ewoutp/goofys:latest"
matrix_s3_goofys_docker_image_name_prefix : "docker.io/"
2019-06-10 13:23:51 +02:00
matrix_s3_goofys_docker_image_force_pull : "{{ matrix_s3_goofys_docker_image.endswith(':latest') }}"
2019-04-05 11:33:38 +02:00
matrix_s3_media_store_custom_endpoint : "your-custom-endpoint"
2019-01-12 17:53:00 +02:00
matrix_s3_media_store_bucket_name : "your-bucket-name"
matrix_s3_media_store_aws_access_key : "your-aws-access-key"
matrix_s3_media_store_aws_secret_key : "your-aws-secret-key"
matrix_s3_media_store_region : "eu-central-1"
2021-02-09 22:04:35 +02:00
matrix_s3_media_store_path : "{{ matrix_synapse_media_store_path }}"
2019-01-12 17:53:00 +02:00
2019-03-22 09:39:17 +02:00
# Controls whether the self-check feature should validate SSL certificates.
matrix_synapse_self_check_validate_certificates : true
2019-01-12 17:53:00 +02:00
2019-04-16 11:40:38 +02:00
# Controls whether searching the public room list is enabled.
2019-05-21 05:09:38 +02:00
matrix_synapse_enable_room_list_search : true
2019-04-16 11:40:38 +02:00
# Controls who's allowed to create aliases on this server.
2019-05-21 05:09:38 +02:00
matrix_synapse_alias_creation_rules :
2019-04-16 11:40:38 +02:00
- user_id : "*"
alias : "*"
room_id : "*"
action : allow
# Controls who can publish and which rooms can be published in the public room list.
2019-05-21 05:09:38 +02:00
matrix_synapse_room_list_publication_rules :
2019-04-16 11:40:38 +02:00
- user_id : "*"
alias : "*"
room_id : "*"
action : allow
2019-06-12 04:18:06 +02:00
2023-01-31 21:19:43 +02:00
matrix_synapse_default_room_version : "10"
2019-08-22 08:49:22 +02:00
2023-05-25 08:14:09 +02:00
# Controls whether leaving a room will automatically forget it.
# The upstream default is `false`, but we try to make Synapse less wasteful of resources, so we do things differently.
matrix_synapse_forget_rooms_on_leave : true
2021-11-03 17:25:01 +02:00
# Controls the Synapse `modules` list.
# You can define your own list of modules here. See the `modules` syntax in `homeserver.yaml.j2`
# Certain Synapse extensions that you can enable below auto-inject themselves into `matrix_synapse_modules` at runtime.
2022-01-19 16:35:55 +02:00
matrix_synapse_modules : [ ]
2022-10-14 15:28:47 +02:00
# matrix_synapse_media_storage_providers contains the Synapse `media_storage_providers` configuration setting.
# To add your own custom `media_storage_providers`, use `matrix_synapse_media_storage_providers_custom`.
matrix_synapse_media_storage_providers : "{{ matrix_synapse_media_storage_providers_auto + matrix_synapse_media_storage_providers_custom }}"
# matrix_synapse_media_storage_providers_auto contains a list of storage providers that are added by the playbook based on other configuration
matrix_synapse_media_storage_providers_auto : |
{{
[ ]
2022-10-14 16:41:41 +02:00
+
[
lookup('ansible.builtin.template', role_path + '/templates/synapse/ext/s3-storage-provider/media_storage_provider.yaml.j2') | from_yaml
] if matrix_synapse_ext_synapse_s3_storage_provider_enabled else []
2022-10-14 15:28:47 +02:00
}}
# matrix_synapse_media_storage_providers_custom contains your own custom list of storage providers.
# You're meant to define each custom module as valid keys and values, not as a YAML string that needs to be parsed.
#
# Example:
# matrix_synapse_media_storage_providers_custom:
# - module: module.SomeModule
# store_local: True
# # ...
matrix_synapse_media_storage_providers_custom : [ ]
2022-02-09 10:38:28 +02:00
matrix_synapse_encryption_enabled_by_default_for_room_type : "off"
2021-12-27 19:20:23 +02:00
2019-10-03 04:35:44 +02:00
matrix_synapse_trusted_key_servers :
- server_name : "matrix.org"
matrix_synapse_redaction_retention_period : 7d
2023-09-28 11:54:41 +02:00
# Controls how long to keep locally forgotten rooms before purging them from the DB.
# Defaults to `null`, meaning it's disabled.
# Example value: 28d
matrix_synapse_forgotten_room_retention_period : ~
2019-10-03 04:35:44 +02:00
matrix_synapse_user_ips_max_age : 28d
2020-08-21 12:52:16 +02:00
2023-09-05 22:35:01 +02:00
matrix_synapse_rust_synapse_compress_state_docker_image : "{{ matrix_synapse_rust_synapse_compress_state_docker_image_name_prefix }}mb-saces/rust-synapse-tools:v0.0.1"
2023-01-14 15:26:58 +02:00
matrix_synapse_rust_synapse_compress_state_docker_image_name_prefix : "registry.gitlab.com/"
2023-09-05 23:26:30 +02:00
matrix_synapse_rust_synapse_compress_state_docker_image_force_pull : "{{ matrix_synapse_rust_synapse_compress_state_docker_image.endswith(':stable') or matrix_synapse_rust_synapse_compress_state_docker_image.endswith(':latest') }}"
2020-08-21 12:52:16 +02:00
matrix_synapse_rust_synapse_compress_state_base_path : "{{ matrix_base_data_path }}/rust-synapse-compress-state"
2022-03-26 10:31:05 +02:00
matrix_synapse_rust_synapse_compress_state_synapse_compress_state_in_container_path : "/usr/local/bin/synapse_compress_state"
2020-08-21 12:52:16 +02:00
2019-08-22 08:49:22 +02:00
# Default Synapse 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_synapse_configuration_extension_yaml`)
# or completely replace this variable with your own template.
matrix_synapse_configuration_yaml : "{{ lookup('template', 'templates/synapse/homeserver.yaml.j2') }}"
matrix_synapse_configuration_extension_yaml : |
# Your custom YAML configuration for Synapse goes here.
# This configuration extends the default starting configuration (`matrix_synapse_configuration_yaml`).
#
# 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_synapse_configuration_yaml`.
#
# Example configuration extension follows:
#
# server_notices:
# system_mxid_localpart: notices
# system_mxid_display_name: "Server Notices"
# system_mxid_avatar_url: "mxc://server.com/oumMVlgDnLYFaPVkExemNVVZ"
# room_name: "Server Notices"
2022-07-18 10:22:05 +02:00
matrix_synapse_configuration_extension : "{{ matrix_synapse_configuration_extension_yaml | from_yaml if matrix_synapse_configuration_extension_yaml | from_yaml is mapping else {} }}"
2019-08-22 08:49:22 +02:00
# Holds the final Synapse configuration (a combination of the default and its extension).
# You most likely don't need to touch this variable. Instead, see `matrix_synapse_configuration_yaml`.
2022-07-18 11:28:39 +02:00
matrix_synapse_configuration : "{{ matrix_synapse_configuration_yaml | from_yaml | combine(matrix_synapse_configuration_extension, recursive=True) }}"