2022-02-05 22:32:54 +02:00
---
2019-05-14 16:47:22 +02:00
# Synapse is a Matrix homeserver
# See: https://github.com/matrix-org/synapse
matrix_synapse_enabled : true
2020-03-15 10:10:41 +02:00
2020-03-15 10:15:27 +02:00
matrix_synapse_container_image_self_build : false
2020-11-28 21:34:14 +02:00
matrix_synapse_container_image_self_build_repo : "https://github.com/matrix-org/synapse.git"
2019-05-14 16:47:22 +02:00
2020-12-09 13:30:28 +02:00
matrix_synapse_docker_image : "{{ matrix_synapse_docker_image_name_prefix }}matrixdotorg/synapse:{{ matrix_synapse_docker_image_tag }}"
2021-04-12 14:39:16 +02:00
matrix_synapse_docker_image_name_prefix : "{{ 'localhost/' if matrix_synapse_container_image_self_build else matrix_container_global_registry_prefix }}"
2022-05-18 13:37:34 +02:00
matrix_synapse_version : v1.59.1
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') }}"
2019-01-12 17:53:00 +02:00
matrix_synapse_base_path : "{{ matrix_base_data_path }}/synapse"
2020-03-08 01:28:14 +02:00
matrix_synapse_docker_src_files_path : "{{ matrix_synapse_base_path }}/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"
matrix_synapse_ext_path : "{{ matrix_synapse_base_path }}/ext"
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
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 : ''
2019-04-30 16:35:18 +02:00
# A list of extra arguments to pass to the container
matrix_synapse_container_extra_arguments : [ ]
2019-01-16 18:05:48 +02:00
# List of systemd services that matrix-synapse.service depends on
matrix_synapse_systemd_required_services_list : [ 'docker.service' ]
# List of systemd services that matrix-synapse.service wants
matrix_synapse_systemd_wanted_services_list : [ ]
2019-01-12 17:53:00 +02:00
2022-03-08 16:56:42 +02:00
matrix_synapse_in_container_python_packages_path : "/usr/local/lib/python3.9/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"
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
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
burst_count : 3
remote :
per_second : 0.01
burst_count : 3
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
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.
# For private servers, you most likely wish to forbid it.
matrix_synapse_allow_public_rooms_over_federation : false
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
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
2020-02-18 19:02:24 +02:00
# Allows non-server-admin users to create groups on this server
matrix_synapse_enable_group_creation : 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 email threepid validation. When empty, Synapse does it by itself.
# Otherwise, this should be pointed to an identity server.
matrix_synapse_account_threepid_delegates_email : ''
# 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
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.
# To learn more, see:
# - https://github.com/matrix-org/synapse#help-synapse-eats-all-my-ram
# - https://github.com/matrix-org/synapse/issues/3939
2020-05-28 14:23:05 +02:00
matrix_synapse_caches_global_factor : 0.5
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 : ~
# A list of additional "volumes" to mount in the container.
# This list gets populated dynamically based on Synapse extensions that have been enabled.
# Contains definition objects like this: `{"src": "/outside", "dst": "/inside", "options": "rw|ro|slave|.."}
2019-05-29 08:59:50 +02:00
#
# Note: internally, this uses the `-v` flag for mounting the specified volumes.
# It's better (safer) to use the `--mount` flag for mounting volumes.
2019-12-31 11:25:09 +02:00
# To use `--mount`, specify it in `matrix_synapse_container_extra_arguments`.
2019-05-29 08:59:50 +02:00
# Example: `matrix_synapse_container_extra_arguments: ['--mount type=bind,src=/outside,dst=/inside,ro']
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"}
matrix_synapse_additional_loggers : [ ]
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`.
2019-01-12 17:53:00 +02:00
matrix_synapse_app_service_config_files : [ ]
# 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
2019-12-05 08:07:15 +02:00
# See https://github.com/matrix-org/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
2019-12-05 08:07:15 +02:00
# Enable the Synapse manhole
# See https://github.com/matrix-org/synapse/blob/master/docs/manhole.md
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
# - "one-of-each" - one worker of each supported type
#
# 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 :
generic_workers_count : 0
pusher_workers_count : 0
appservice_workers_count : 0
federation_sender_workers_count : 1
media_repository_workers_count : 0
user_dir_workers_count : 0
frontend_proxy_workers_count : 0
one-of-each :
generic_workers_count : 1
pusher_workers_count : 1
2022-05-31 15:28:33 +02:00
# appservice workers are deprecated since Synapse v1.59. This will be removed.
appservice_workers_count : 0
2021-02-19 11:38:47 +02:00
federation_sender_workers_count : 1
media_repository_workers_count : 1
# Disabled until https://github.com/matrix-org/synapse/issues/8787 is resolved.
2022-05-31 15:28:33 +02:00
# user_dir workers are deprecated since Synapse v1.59. This will be removed.
# See: https://github.com/matrix-org/synapse/blob/v1.59.0/docs/upgrade.md#deprecation-of-the-synapseappappservice-and-synapseappuser_dir-worker-application-types
2021-02-19 11:38:47 +02:00
user_dir_workers_count : 0
frontend_proxy_workers_count : 1
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 : ''
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
2021-02-16 17:45:41 +02:00
# matrix_synapse_workers_pusher_workers_count can only be 0 or 1 for now.
# More instances are not supported due to a playbook limitation having to do with keeping `pusher_instances` in `homeserver.yaml` updated.
# See https://github.com/matrix-org/synapse/commit/ddfdf945064925eba761ae3748e38f3a1c73c328
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
# matrix_synapse_workers_appservice_workers_count can only be 0 or 1. More instances are not supported.
2022-05-31 15:28:33 +02:00
# appservice workers are deprecated since Synapse v1.59. This will be removed.
# See: https://github.com/matrix-org/synapse/blob/v1.59.0/docs/upgrade.md#deprecation-of-the-synapseappappservice-and-synapseappuser_dir-worker-application-types
matrix_synapse_workers_appservice_workers_count : 0
2021-02-15 11:25:35 +02:00
matrix_synapse_workers_appservice_workers_metrics_range_start : 19300
2021-02-15 11:37:03 +02:00
# matrix_synapse_workers_federation_sender_workers_count can only be 0 or 1 for now.
# More instances are not supported due to a playbook limitation having to do with keeping `federation_sender_instances` in `homeserver.yaml` updated.
# See https://github.com/matrix-org/synapse/blob/master/docs/workers.md#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
2021-02-19 11:38:47 +02:00
matrix_synapse_workers_media_repository_workers_count : "{{ matrix_synapse_workers_presets[matrix_synapse_workers_preset]['media_repository_workers_count'] }}"
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
# Disabled until https://github.com/matrix-org/synapse/issues/8787 is resolved.
2022-05-31 15:28:33 +02:00
# user_dir workers are deprecated since Synapse v1.59. This will be removed.
# See: https://github.com/matrix-org/synapse/blob/v1.59.0/docs/upgrade.md#deprecation-of-the-synapseappappservice-and-synapseappuser_dir-worker-application-types
matrix_synapse_workers_user_dir_workers_count : 0
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
2021-02-19 11:38:47 +02:00
matrix_synapse_workers_frontend_proxy_workers_count : "{{ matrix_synapse_workers_presets[matrix_synapse_workers_preset]['frontend_proxy_workers_count'] }}"
2021-02-15 11:25:35 +02:00
matrix_synapse_workers_frontend_proxy_workers_port_range_start : 18771
matrix_synapse_workers_frontend_proxy_workers_metrics_range_start : 19771
# 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:
# - `type` - the type of worker (`generic_worker`, etc.)
# - `instanceId` - a string that identifies the worker. The combination of (`type` + `instanceId`) represents the name of the worker and must be unique.
# - `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
#
# 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:
2021-02-18 18:19:51 +02:00
# - { type: generic_worker, instanceId: '18111', port: 18111, metrics_port: 19111 }
# - { type: generic_worker, instanceId: '18112', port: 18112, metrics_port: 19112 }
# - { type: generic_worker, instanceId: '18113', port: 18113, metrics_port: 19113 }
# - { type: generic_worker, instanceId: '18114', port: 18114, metrics_port: 19114 }
# - { type: generic_worker, instanceId: '18115', port: 18115, metrics_port: 19115 }
# - { type: generic_worker, instanceId: '18116', port: 18116, metrics_port: 19116 }
# - { type: pusher, instanceId: '0', port: 0, metrics_port: 19200 }
# - { type: appservice, instanceId: '0', port: 0, metrics_port: 19300 }
# - { type: federation_sender, instanceId: '0', port: 0, metrics_port: 19400 }
# - { type: media_repository, instanceId: '18551', port: 18551, metrics_port: 19551 }
2021-02-15 11:25:35 +02:00
matrix_synapse_workers_enabled_list : [ ]
2020-04-10 23:44:53 +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 : ""
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.
#
# matrix_synapse_replication_listener_enabled: "{{ matrix_synapse_workers_enabled and not matrix_redis_enabled }}"
# 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
2021-01-22 12:23:00 +02:00
matrix_synapse_database_host : "matrix-postgres"
2021-05-17 13:58:07 +02:00
matrix_synapse_database_port : 5432
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 : ""
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 }}>"
2020-07-17 10:31:20 +02:00
matrix_synapse_email_client_base_url : "https://{{ 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
2021-11-03 17:25:01 +02:00
matrix_synapse_ext_password_provider_shared_secret_auth_download_url : "https://raw.githubusercontent.com/devture/matrix-synapse-shared-secret-auth/2.0.2/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
# We'd like to enable this, but it causes trouble for Element: https://github.com/vector-im/element-web/issues/19605
matrix_synapse_ext_password_provider_shared_secret_auth_com_devture_shared_secret_auth_support_enabled : false
matrix_synapse_ext_password_provider_shared_secret_config : "{{ matrix_synapse_ext_password_provider_shared_secret_config_yaml|from_yaml }}"
matrix_synapse_ext_password_provider_shared_secret_config_yaml : |
shared_secret : {{ matrix_synapse_ext_password_provider_shared_secret_auth_shared_secret|string|to_json }}
2022-02-11 20:05:32 +02:00
m_login_password_support_enabled : {{ matrix_synapse_ext_password_provider_shared_secret_auth_m_login_password_support_enabled|to_json }}
2021-11-03 17:25:01 +02:00
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
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"
2022-03-23 21:17:54 +02:00
matrix_synapse_ext_spam_checker_mjolnir_antispam_git_version : "4008e3f65d3745b9307dd31f1c5aa80c13a61a58"
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 : [ ]
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-02-14 10:39:14 +02:00
matrix_synapse_ext_encryption_disabler_download_url : "https://raw.githubusercontent.com/digitalentity/matrix_encryption_disabler/1182388f7019e8ec1e28f035070c7919d0e4cc24/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-02-11 20:06:11 +02:00
matrix_synapse_ext_encryption_config : "{{ matrix_synapse_ext_encryption_config_yaml|from_yaml }}"
matrix_synapse_ext_encryption_config_yaml : |
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 }}
2022-02-14 10:39:14 +02:00
patch_power_levels : {{ matrix_synapse_ext_encryption_disabler_patch_power_levels|to_json }}
2022-02-11 20:06:11 +02:00
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
2019-01-12 17:53:00 +02:00
matrix_s3_goofys_docker_image : "ewoutp/goofys:latest"
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
2021-10-12 18:49:16 +02:00
matrix_synapse_default_room_version : "9"
2019-08-22 08:49:22 +02:00
2019-09-09 07:11:32 +02:00
# Controls the Synapse `spam_checker` setting.
#
# If a spam-checker extension is enabled, this variable's value is set automatically by the playbook during runtime.
# If not, you can also control its value manually.
2020-05-28 14:23:05 +02:00
matrix_synapse_spam_checker : [ ]
2019-09-09 07:11:32 +02:00
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-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
matrix_synapse_user_ips_max_age : 28d
2020-08-21 12:52:16 +02:00
2022-03-26 10:31:05 +02:00
matrix_synapse_rust_synapse_compress_state_docker_image : "registry.gitlab.com/mb-saces/rust-synapse-compress-state:latest"
2020-08-21 12:52:16 +02:00
matrix_synapse_rust_synapse_compress_state_docker_image_force_pull : "{{ matrix_synapse_rust_synapse_compress_state_docker_image.endswith(':latest') }}"
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"
matrix_synapse_configuration_extension : "{{ matrix_synapse_configuration_extension_yaml|from_yaml if matrix_synapse_configuration_extension_yaml|from_yaml is mapping else {} }}"
# 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`.
matrix_synapse_configuration : "{{ matrix_synapse_configuration_yaml|from_yaml|combine(matrix_synapse_configuration_extension, recursive=True) }}"