ansible-roles: comparison dendrite/server/templates/dendrite.yaml.j2

equal deleted inserted replaced

-:65a0fb7c25a4
+:f2f99b9b16ee
 # This is the Dendrite configuration file.
 #
 # The configuration is split up into sections - each Dendrite component has a
 # configuration section, in addition to the "global" section which applies to
 # all components.
-#
-# At a minimum, to get started, you will need to update the settings in the
-# "global" section for your deployment, and you will need to check that the
-# database "connection_string" line in each component section is correct.
-#
-# Each component with a "database" section can accept the following formats
-# for "connection_string":
-#   SQLite:     file:filename.db
-#               file:///path/to/filename.db
-#   PostgreSQL: postgresql://user:pass@hostname/database?params=...
-#
-# SQLite is embedded into Dendrite and therefore no further prerequisites are
-# needed for the database when using SQLite mode. However, performance with
-# PostgreSQL is significantly better and recommended for multi-user deployments.
-# SQLite is typically around 20-30% slower than PostgreSQL when tested with a
-# small number of users and likely will perform worse still with a higher volume
-# of users.
-#
-# The "max_open_conns" and "max_idle_conns" settings configure the maximum
-# number of open/idle database connections. The value 0 will use the database
-# engine default, and a negative value will use unlimited connections. The
-# "conn_max_lifetime" option controls the maximum length of time a database
-# connection can be idle in seconds - a negative value is unlimited.
 # The version of the configuration file.
-version: 1
+version: 2
 # Global Matrix configuration. This configuration applies to all components.
 global:
 # The domain name of this homeserver.
 server_name: {{dendrite_name}}
 # The paths and expiry timestamps (as a UNIX timestamp in millisecond precision)
 # to old signing private keys that were formerly in use on this domain. These
 # keys will not be used for federation request or event signing, but will be
 # provided to any other homeserver that asks when trying to verify old events.
-{% if dendrite_old_key %}old_private_keys:
+old_private_keys:
-- private_key: old_matrix_key.pem
+{% if dendrite_old_key %}- private_key: old_matrix_key.pem
 expired_at: 1626538450
 {% endif %}
 # How long a remote server can cache our server signing key before requesting it
 # again. Increasing this number will reduce the number of requests made by other
 # servers for our key but increases the period that a compromised key will be
 # considered valid by other homeservers.
 key_validity_period: 168h0m0s
+# Global database connection pool, for PostgreSQL monolith deployments only. If
+# this section is populated then you can omit the "database" blocks in all other
+# sections. For polylith deployments, or monolith deployments using SQLite databases,
+# you must configure the "database" block for each component instead.
+database:
+connection_string: postgresql://{{dendrite_db_user}}:{{dendrite_db_pass}}@localhost/{{dendrite_db}}?sslmode=disable
+max_open_conns: 100
+max_idle_conns: 5
+conn_max_lifetime: -1
+# The server name to delegate server-server communications to, with optional port
+# e.g. localhost:443
+well_known_server_name: ""
 # Lists of domains that the server will trust as identity servers to verify third
 # party identifiers such as phone numbers and email addresses.
 trusted_third_party_id_servers:
 - matrix.org
 - vector.im
-# Disables federation. Dendrite will not be able to make any outbound HTTP requests
+# Disables federation. Dendrite will not be able to communicate with other servers
-# to other servers and the federation API will not be exposed.
+# in the Matrix federation and the federation API will not be exposed.
 disable_federation: false
-# Configuration for Kafka/Naffka.
+# Configures the handling of presence events. Inbound controls whether we receive
-kafka:
+# presence events from other servers, outbound controls whether we send presence
-# List of Kafka broker addresses to connect to. This is not needed if using
+# events for our local users to other servers.
-# Naffka in monolith mode.
+presence:
+enable_inbound: false
+enable_outbound: false
+# Configures phone-home statistics reporting. These statistics contain the server
+# name, number of active users and some information on your deployment config.
+# We use this information to understand how Dendrite is being used in the wild.
+report_stats:
+enabled: false
+endpoint: https://matrix.org/report-usage-stats/push
+# Server notices allows server admins to send messages to all users on the server.
+server_notices:
+enabled: false
+# The local part, display name and avatar URL (as a mxc:// URL) for the user that
+# will send the server notices. These are visible to all users on the deployment.
+local_part: "_server"
+display_name: "Server Alerts"
+avatar_url: ""
+# The room name to be used when sending server notices. This room name will
+# appear in user clients.
+room_name: "Server Alerts"
+# Configuration for NATS JetStream
+jetstream:
+# A list of NATS Server addresses to connect to. If none are specified, an
+# internal NATS server will be started automatically when running Dendrite in
+# monolith mode. For polylith deployments, it is required to specify the address
+# of at least one NATS Server node.
 addresses:
-- localhost:2181
+# - localhost:4222
-# The prefix to use for Kafka topic names for this homeserver. Change this only if
+# Persistent directory to store JetStream streams in. This directory should be
-# you are running more than one Dendrite homeserver on the same Kafka deployment.
+# preserved across Dendrite restarts.
+storage_path: ./
+# The prefix to use for stream names for this homeserver - really only useful
+# if you are running more than one Dendrite server on the same NATS deployment.
 topic_prefix: Dendrite
-# Whether to use Naffka instead of Kafka. This is only available in monolith
-# mode, but means that you can run a single-process server without requiring
-# Kafka.
-use_naffka: true
-# The max size a Kafka message is allowed to use.
-# You only need to change this value, if you encounter issues with too large messages.
-# Must be less than/equal to "max.message.bytes" configured in Kafka.
-# Defaults to 8388608 bytes.
-# max_message_bytes: 8388608
-# Naffka database options. Not required when using Kafka.
-naffka_database:
-connection_string: "postgres://{{dendrite_db_user}}:{{dendrite_db_pass}}@localhost/{{dendrite_db}}"
-max_open_conns: 10
-max_idle_conns: 2
-conn_max_lifetime: -1
 # Configuration for Prometheus metric collection.
 metrics:
-# Whether or not Prometheus metrics are enabled.
 enabled: true
-# HTTP basic authentication to protect access to monitoring.
 basic_auth:
 username: metrics
 password: metrics
-# DNS cache options. The DNS cache may reduce the load on DNS servers
+# Optional DNS cache. The DNS cache may reduce the load on DNS servers if there
-# if there is no local caching resolver available for use.
+# is no local caching resolver available for use.
 dns_cache:
-# Whether or not the DNS cache is enabled.
 enabled: false
-# Maximum number of entries to hold in the DNS cache, and
-# for how long those items should be considered valid in seconds.
 cache_size: 256
-cache_lifetime: "5m" # 5minutes; see https://pkg.go.dev/time@master#ParseDuration for more
+cache_lifetime: "5m" # 5 minutes; https://pkg.go.dev/time@master#ParseDuration
 # Configuration for the Appservice API.
 app_service_api:
-internal_api:
-listen: http://localhost:7777
-connect: http://localhost:7777
-database:
-connection_string: "postgres://{{dendrite_db_user}}:{{dendrite_db_pass}}@localhost/{{dendrite_db}}"
-max_open_conns: 10
-max_idle_conns: 2
-conn_max_lifetime: -1
 # Disable the validation of TLS certificates of appservices. This is
 # not recommended in production since it may allow appservice traffic
-# to be sent to an unverified endpoint.
+# to be sent to an insecure endpoint.
 disable_tls_validation: false
 # Appservice configuration files to load into this homeserver.
-config_files: []
+config_files:
+#  - /path/to/appservice_registration.yaml
 # Configuration for the Client API.
 client_api:
-internal_api:
-listen: http://localhost:7771
-connect: http://localhost:7771
-external_api:
-listen: http://[::]:8071
 # Prevents new users from being able to register on this homeserver, except when
 # using the registration shared secret below.
-registration_disabled: false
+registration_disabled: true
-# If set, allows registration by anyone who knows the shared secret, regardless of
+# Prevents new guest accounts from being created. Guest registration is also
-# whether registration is otherwise disabled.
+# disabled implicitly by setting 'registration_disabled' above.
+guests_disabled: true
+# If set, allows registration by anyone who knows the shared secret, regardless
+# of whether registration is otherwise disabled.
 registration_shared_secret: "{{dendrite_registration_secret}}"
-# Whether to require reCAPTCHA for registration.
+# Whether to require reCAPTCHA for registration. If you have enabled registration
-enable_registration_captcha: false
+# then this is HIGHLY RECOMMENDED to reduce the risk of your homeserver being used
+# for coordinated spam attacks.
+enable_registration_captcha: {{dendrite_recaptcha_enable}}
 # Settings for ReCAPTCHA.
-recaptcha_public_key: ""
+recaptcha_public_key: "{{dendrite_recaptcha_public_key}}"
-recaptcha_private_key: ""
+recaptcha_private_key: "{{dendrite_recaptcha_private_key}}"
-recaptcha_bypass_secret: ""
+recaptcha_bypass_secret: "{{dendrite_recaptcha_bypass_secret}}"
-recaptcha_siteverify_api: ""
+recaptcha_siteverify_api: "{{dendrite_recaptcha_siteverify_api}}"
 # TURN server information that this homeserver should send to clients.
 turn:
 turn_user_lifetime: ""
-turn_uris: []
+turn_uris:
+#  - turn:turn.server.org?transport=udp
+#  - turn:turn.server.org?transport=tcp
 turn_shared_secret: ""
 turn_username: ""
 turn_password: ""
-# Settings for rate-limited endpoints. Rate limiting will kick in after the
+# Settings for rate-limited endpoints. Rate limiting kicks in after the threshold
-# threshold number of "slots" have been taken by requests from a specific
+# number of "slots" have been taken by requests from a specific host. Each "slot"
-# host. Each "slot" will be released after the cooloff time in milliseconds.
+# will be released after the cooloff time in milliseconds.
 rate_limiting:
 enabled: true
 threshold: 5
 cooloff_ms: 500
-# Configuration for the EDU server.
-edu_server:
-internal_api:
-listen: http://localhost:7778
-connect: http://localhost:7778
 # Configuration for the Federation API.
 federation_api:
-internal_api:
-listen: http://localhost:7772
-connect: http://localhost:7772
-external_api:
-listen: http://[::]:8072
-# List of paths to X.509 certificates to be used by the external federation listeners.
-# These certificates will be used to calculate the TLS fingerprints and other servers
-# will expect the certificate to match these fingerprints. Certificates must be in PEM
-# format.
-federation_certificates: []
-# Configuration for the Federation Sender.
-federation_sender:
-internal_api:
-listen: http://localhost:7775
-connect: http://localhost:7775
-database:
-connection_string: "postgres://{{dendrite_db_user}}:{{dendrite_db_pass}}@localhost/{{dendrite_db}}"
-max_open_conns: 10
-max_idle_conns: 2
-conn_max_lifetime: -1
 # How many times we will try to resend a failed transaction to a specific server. The
-# backoff is 2**x seconds, so 1 = 2 seconds, 2 = 4 seconds, 3 = 8 seconds etc.
+# backoff is 2**x seconds, so 1 = 2 seconds, 2 = 4 seconds, 3 = 8 seconds etc. Once
+# the max retries are exceeded, Dendrite will no longer try to send transactions to
+# that server until it comes back to life and connects to us again.
 send_max_retries: 16
 # Disable the validation of TLS certificates of remote federated homeservers. Do not
 # enable this option in production as it presents a security risk!
 disable_tls_validation: false
-# Use the following proxy server for outbound federation traffic.
-proxy_outbound:
-enabled: false
-protocol: http
-host: localhost
-port: 8080
-# Configuration for the Key Server (for end-to-end encryption).
-key_server:
-internal_api:
-listen: http://localhost:7779
-connect: http://localhost:7779
-database:
-connection_string: "postgres://{{dendrite_db_user}}:{{dendrite_db_pass}}@localhost/{{dendrite_db}}"
-max_open_conns: 10
-max_idle_conns: 2
-conn_max_lifetime: -1
-# Configuration for the Media API.
-media_api:
-internal_api:
-listen: http://localhost:7774
-connect: http://localhost:7774
-external_api:
-listen: http://[::]:8074
-database:
-connection_string: "postgres://{{dendrite_db_user}}:{{dendrite_db_pass}}@localhost/{{dendrite_db}}"
-max_open_conns: 5
-max_idle_conns: 2
-conn_max_lifetime: -1
-# Storage path for uploaded media. May be relative or absolute.
-base_path: ./media_store
-# The maximum allowed file size (in bytes) for media uploads to this homeserver
-# (0 = unlimited). If using a reverse proxy, ensure it allows requests at
-# least this large (e.g. client_max_body_size in nginx.)
-max_file_size_bytes: 10485760
-# Whether to dynamically generate thumbnails if needed.
-dynamic_thumbnails: false
-# The maximum number of simultaneous thumbnail generators to run.
-max_thumbnail_generators: 10
-# A list of thumbnail sizes to be generated for media content.
-thumbnail_sizes:
-- width: 32
-height: 32
-method: crop
-- width: 96
-height: 96
-method: crop
-- width: 640
-height: 480
-method: scale
-# Configuration for experimental MSC's
-mscs:
-# A list of enabled MSC's
-# Currently valid values are:
-# - msc2836    (Threading, see https://github.com/matrix-org/matrix-doc/pull/2836)
-# - msc2946    (Spaces Summary, see https://github.com/matrix-org/matrix-doc/pull/2946)
-mscs: []
-database:
-connection_string: "postgres://{{dendrite_db_user}}:{{dendrite_db_pass}}@localhost/{{dendrite_db}}"
-max_open_conns: 5
-max_idle_conns: 2
-conn_max_lifetime: -1
-# Configuration for the Room Server.
-room_server:
-internal_api:
-listen: http://localhost:7770
-connect: http://localhost:7770
-database:
-connection_string: "postgres://{{dendrite_db_user}}:{{dendrite_db_pass}}@localhost/{{dendrite_db}}"
-max_open_conns: 10
-max_idle_conns: 2
-conn_max_lifetime: -1
-# Configuration for the Signing Key Server (for server signing keys).
-signing_key_server:
-internal_api:
-listen: http://localhost:7780
-connect: http://localhost:7780
-database:
-connection_string: "postgres://{{dendrite_db_user}}:{{dendrite_db_pass}}@localhost/{{dendrite_db}}"
-max_open_conns: 10
-max_idle_conns: 2
-conn_max_lifetime: -1
 # Perspective keyservers to use as a backup when direct key fetches fail. This may
 # be required to satisfy key requests for servers that are no longer online when
 # joining some rooms.
 key_perspectives:
 - server_name: matrix.org
 keys:
 - key_id: ed25519:auto
 public_key: Noi6WqcDj0QmPxCNQqgezwTlBKrfqehY1u2FyWP9uYw
 - key_id: ed25519:a_RXGa
 public_key: l8Hft5qXKn1vfHrg3p4+W8gELQVo8N13JkluMfmn2sQ
 # This option will control whether Dendrite will prefer to look up keys directly
 # or whether it should try perspective servers first, using direct fetches as a
 # last resort.
 prefer_direct_fetch: false
+# Configuration for the Media API.
+media_api:
+# Storage path for uploaded media. May be relative or absolute.
+base_path: ./media_store
+# The maximum allowed file size (in bytes) for media uploads to this homeserver
+# (0 = unlimited). If using a reverse proxy, ensure it allows requests at least
+#this large (e.g. the client_max_body_size setting in nginx).
+max_file_size_bytes: 10485760
+# Whether to dynamically generate thumbnails if needed.
+dynamic_thumbnails: false
+# The maximum number of simultaneous thumbnail generators to run.
+max_thumbnail_generators: 10
+# A list of thumbnail sizes to be generated for media content.
+thumbnail_sizes:
+- width: 32
+height: 32
+method: crop
+- width: 96
+height: 96
+method: crop
+- width: 640
+height: 480
+method: scale
+# Configuration for enabling experimental MSCs on this homeserver.
+mscs:
+mscs:
+#  - msc2836  # (Threading, see https://github.com/matrix-org/matrix-doc/pull/2836)
+#  - msc2946  # (Spaces Summary, see https://github.com/matrix-org/matrix-doc/pull/2946)
 # Configuration for the Sync API.
 sync_api:
-internal_api:
-listen: http://localhost:7773
-connect: http://localhost:7773
-external_api:
-listen: http://[::]:8073
-database:
-connection_string: "postgres://{{dendrite_db_user}}:{{dendrite_db_pass}}@localhost/{{dendrite_db}}"
-max_open_conns: 10
-max_idle_conns: 2
-conn_max_lifetime: -1
 # This option controls which HTTP header to inspect to find the real remote IP
 # address of the client. This is likely required if Dendrite is running behind
 # a reverse proxy server.
 # real_ip_header: X-Real-IP
 # Configuration for the User API.
 user_api:
 # The cost when hashing passwords on registration/login. Default: 10. Min: 4, Max: 31
 # See https://pkg.go.dev/golang.org/x/crypto/bcrypt for more information.
-# Setting this lower makes registration/login consume less CPU resources at the cost of security
+# Setting this lower makes registration/login consume less CPU resources at the cost
-# should the database be compromised. Setting this higher makes registration/login consume more
+# of security should the database be compromised. Setting this higher makes registration/login
-# CPU resources but makes it harder to brute force password hashes.
+# consume more CPU resources but makes it harder to brute force password hashes. This value
-# This value can be low if performing tests or on embedded Dendrite instances (e.g WASM builds)
+# can be lowered if performing tests or on embedded Dendrite instances (e.g WASM builds).
-# bcrypt_cost: 10
+bcrypt_cost: 10
-internal_api:
-listen: http://localhost:7781
-connect: http://localhost:7781
-account_database:
-connection_string: "postgres://{{dendrite_db_user}}:{{dendrite_db_pass}}@localhost/{{dendrite_db}}"
-max_open_conns: 10
-max_idle_conns: 2
-conn_max_lifetime: -1
-device_database:
-connection_string: "postgres://{{dendrite_db_user}}:{{dendrite_db_pass}}@localhost/{{dendrite_db}}"
-max_open_conns: 10
-max_idle_conns: 2
-conn_max_lifetime: -1
 # The length of time that a token issued for a relying party from
 # /_matrix/client/r0/user/{userId}/openid/request_token endpoint
 # is considered to be valid in milliseconds.
 # The default lifetime is 3600000ms (60 minutes).
 # openid_token_lifetime_ms: 3600000
 reporter: null
 headers: null
 baggage_restrictions: null
 throttler: null
-# Logging configuration, in addition to the standard logging that is sent to
+# Logging configuration. The "std" logging type controls the logs being sent to
-# stdout by Dendrite.
+# stdout. The "file" logging type controls logs being written to a log folder on
+# the disk. Supported log levels are "debug", "info", "warn", "error".
 logging:
-- type: file
+- type: std
 level: info
-params:
+- type: file
-path: ./logs
+level: info
+params:
+path: ./logs

changeset 180	f2f99b9b16ee
parent 174	431c6d5e5dd4
child 181	2b30d081dd9b