327 lines
9.8 KiB
YAML
327 lines
9.8 KiB
YAML
# 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
|
|
|
|
# Global Matrix configuration. This configuration applies to all components.
|
|
global:
|
|
# The domain name of this homeserver.
|
|
server_name: localhost
|
|
|
|
# The path to the signing private key file, used to sign requests and events.
|
|
private_key: matrix_key.pem
|
|
|
|
# A unique identifier for this private key. Must start with the prefix "ed25519:".
|
|
key_id: ed25519:auto
|
|
|
|
# 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
|
|
|
|
# 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
|
|
|
|
# Configuration for Kafka/Naffka.
|
|
kafka:
|
|
# List of Kafka broker addresses to connect to. This is not needed if using
|
|
# Naffka in monolith mode.
|
|
addresses:
|
|
- localhost:2181
|
|
|
|
# The prefix to use for Kafka topic names for this homeserver. Change this only if
|
|
# you are running more than one Dendrite homeserver on the same Kafka 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
|
|
|
|
# Naffka database options. Not required when using Kafka.
|
|
naffka_database:
|
|
connection_string: file:naffka.db
|
|
max_open_conns: 100
|
|
max_idle_conns: 2
|
|
conn_max_lifetime: -1
|
|
|
|
# Configuration for Prometheus metric collection.
|
|
metrics:
|
|
# Whether or not Prometheus metrics are enabled.
|
|
enabled: false
|
|
|
|
# HTTP basic authentication to protect access to monitoring.
|
|
basic_auth:
|
|
username: metrics
|
|
password: metrics
|
|
|
|
# Configuration for the Appservice API.
|
|
app_service_api:
|
|
internal_api:
|
|
listen: http://localhost:7777
|
|
connect: http://localhost:7777
|
|
database:
|
|
connection_string: file:appservice.db
|
|
max_open_conns: 100
|
|
max_idle_conns: 2
|
|
conn_max_lifetime: -1
|
|
|
|
# Appservice configuration files to load into this homeserver.
|
|
config_files: []
|
|
|
|
# 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
|
|
|
|
# If set, allows registration by anyone who knows the shared secret, regardless of
|
|
# whether registration is otherwise disabled.
|
|
registration_shared_secret: ""
|
|
|
|
# Whether to require reCAPTCHA for registration.
|
|
enable_registration_captcha: false
|
|
|
|
# Settings for ReCAPTCHA.
|
|
recaptcha_public_key: ""
|
|
recaptcha_private_key: ""
|
|
recaptcha_bypass_secret: ""
|
|
recaptcha_siteverify_api: ""
|
|
|
|
# TURN server information that this homeserver should send to clients.
|
|
turn:
|
|
turn_user_lifetime: ""
|
|
turn_uris: []
|
|
turn_shared_secret: ""
|
|
turn_username: ""
|
|
turn_password: ""
|
|
|
|
# Configuration for the Current State Server.
|
|
current_state_server:
|
|
internal_api:
|
|
listen: http://localhost:7782
|
|
connect: http://localhost:7782
|
|
database:
|
|
connection_string: file:currentstate.db
|
|
max_open_conns: 100
|
|
max_idle_conns: 2
|
|
conn_max_lifetime: -1
|
|
|
|
# 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: file:federationsender.db
|
|
max_open_conns: 100
|
|
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.
|
|
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: file:keyserver.db
|
|
max_open_conns: 100
|
|
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: file:mediaapi.db
|
|
max_open_conns: 100
|
|
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).
|
|
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 the Room Server.
|
|
room_server:
|
|
internal_api:
|
|
listen: http://localhost:7770
|
|
connect: http://localhost:7770
|
|
database:
|
|
connection_string: file:roomserver.db
|
|
max_open_conns: 100
|
|
max_idle_conns: 2
|
|
conn_max_lifetime: -1
|
|
|
|
# Configuration for the Server Key API (for server signing keys).
|
|
server_key_api:
|
|
internal_api:
|
|
listen: http://localhost:7780
|
|
connect: http://localhost:7780
|
|
database:
|
|
connection_string: file:serverkeyapi.db
|
|
max_open_conns: 100
|
|
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
|
|
|
|
# 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: file:syncapi.db
|
|
max_open_conns: 100
|
|
max_idle_conns: 2
|
|
conn_max_lifetime: -1
|
|
|
|
# Configuration for the User API.
|
|
user_api:
|
|
internal_api:
|
|
listen: http://localhost:7781
|
|
connect: http://localhost:7781
|
|
account_database:
|
|
connection_string: file:userapi_accounts.db
|
|
max_open_conns: 100
|
|
max_idle_conns: 2
|
|
conn_max_lifetime: -1
|
|
device_database:
|
|
connection_string: file:userapi_devices.db
|
|
max_open_conns: 100
|
|
max_idle_conns: 2
|
|
conn_max_lifetime: -1
|
|
|
|
# Configuration for Opentracing.
|
|
# See https://github.com/matrix-org/dendrite/tree/master/docs/tracing for information on
|
|
# how this works and how to set it up.
|
|
tracing:
|
|
enabled: false
|
|
jaeger:
|
|
serviceName: ""
|
|
disabled: false
|
|
rpc_metrics: false
|
|
tags: []
|
|
sampler: null
|
|
reporter: null
|
|
headers: null
|
|
baggage_restrictions: null
|
|
throttler: null
|
|
|
|
# Logging configuration, in addition to the standard logging that is sent to
|
|
# stdout by Dendrite.
|
|
logging:
|
|
- type: file
|
|
level: info
|
|
params:
|
|
path: /var/log/dendrite
|