dendrite/server/templates/dendrite.yaml.j2
author Luke Hoersten <luke@hoersten.org>
Thu, 18 Jan 2024 16:04:11 -0600
changeset 225 6936497313ac
parent 215 dd52907adff9
child 227 2e0366f2dcbe
permissions -rw-r--r--
Minor cleanup.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
163
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
     1
# This is the Dendrite configuration file.
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
     2
#
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
     3
# The configuration is split up into sections - each Dendrite component has a
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
     4
# configuration section, in addition to the "global" section which applies to
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
     5
# all components.
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
     6
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
     7
# The version of the configuration file.
180
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
     8
version: 2
163
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
     9
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    10
# Global Matrix configuration. This configuration applies to all components.
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    11
global:
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    12
  # The domain name of this homeserver.
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    13
  server_name: {{dendrite_name}}
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    14
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    15
  # The path to the signing private key file, used to sign requests and events.
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    16
  # Note that this is NOT the same private key as used for TLS! To generate a
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    17
  # signing key, use "./bin/generate-keys --private-key matrix_key.pem".
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    18
  private_key: matrix_key.pem
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    19
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    20
  # The paths and expiry timestamps (as a UNIX timestamp in millisecond precision)
215
dd52907adff9 Split dendrite build out of install role.
Luke Hoersten <luke@hoersten.org>
parents: 207
diff changeset
    21
  # to old signing keys that were formerly in use on this domain name. These
163
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    22
  # keys will not be used for federation request or event signing, but will be
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    23
  # provided to any other homeserver that asks when trying to verify old events.
180
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
    24
  old_private_keys:
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
    25
    {% if dendrite_old_key %}- private_key: old_matrix_key.pem
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
    26
      expired_at: 1626538450
174
431c6d5e5dd4 Lots of updates.
Luke Hoersten <luke@hoersten.org>
parents: 168
diff changeset
    27
{% endif %}
163
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    28
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    29
  # How long a remote server can cache our server signing key before requesting it
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    30
  # again. Increasing this number will reduce the number of requests made by other
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    31
  # servers for our key but increases the period that a compromised key will be
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    32
  # considered valid by other homeservers.
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    33
  key_validity_period: 168h0m0s
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    34
180
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
    35
  # Global database connection pool, for PostgreSQL monolith deployments only. If
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
    36
  # this section is populated then you can omit the "database" blocks in all other
215
dd52907adff9 Split dendrite build out of install role.
Luke Hoersten <luke@hoersten.org>
parents: 207
diff changeset
    37
  # sections. For monolith deployments using SQLite databases,
180
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
    38
  # you must configure the "database" block for each component instead.
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
    39
  database:
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
    40
    connection_string: postgresql://{{dendrite_db_user}}:{{dendrite_db_pass}}@localhost/{{dendrite_db}}?sslmode=disable
203
4be395f0d127 Reduced number of open connections for dendrite due to startup error.
Luke Hoersten <luke@hoersten.org>
parents: 194
diff changeset
    41
    max_open_conns: 90
180
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
    42
    max_idle_conns: 5
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
    43
    conn_max_lifetime: -1
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
    44
215
dd52907adff9 Split dendrite build out of install role.
Luke Hoersten <luke@hoersten.org>
parents: 207
diff changeset
    45
  # Configuration for in-memory caches. Caches can often improve performance by
dd52907adff9 Split dendrite build out of install role.
Luke Hoersten <luke@hoersten.org>
parents: 207
diff changeset
    46
  # keeping frequently accessed items (like events, identifiers etc.) in memory
dd52907adff9 Split dendrite build out of install role.
Luke Hoersten <luke@hoersten.org>
parents: 207
diff changeset
    47
  # rather than having to read them from the database.
dd52907adff9 Split dendrite build out of install role.
Luke Hoersten <luke@hoersten.org>
parents: 207
diff changeset
    48
  cache:
dd52907adff9 Split dendrite build out of install role.
Luke Hoersten <luke@hoersten.org>
parents: 207
diff changeset
    49
    # The estimated maximum size for the global cache in bytes, or in terabytes,
dd52907adff9 Split dendrite build out of install role.
Luke Hoersten <luke@hoersten.org>
parents: 207
diff changeset
    50
    # gigabytes, megabytes or kilobytes when the appropriate 'tb', 'gb', 'mb' or
dd52907adff9 Split dendrite build out of install role.
Luke Hoersten <luke@hoersten.org>
parents: 207
diff changeset
    51
    # 'kb' suffix is specified. Note that this is not a hard limit, nor is it a
dd52907adff9 Split dendrite build out of install role.
Luke Hoersten <luke@hoersten.org>
parents: 207
diff changeset
    52
    # memory limit for the entire process. A cache that is too small may ultimately
dd52907adff9 Split dendrite build out of install role.
Luke Hoersten <luke@hoersten.org>
parents: 207
diff changeset
    53
    # provide little or no benefit.
dd52907adff9 Split dendrite build out of install role.
Luke Hoersten <luke@hoersten.org>
parents: 207
diff changeset
    54
    max_size_estimated: 1gb
dd52907adff9 Split dendrite build out of install role.
Luke Hoersten <luke@hoersten.org>
parents: 207
diff changeset
    55
dd52907adff9 Split dendrite build out of install role.
Luke Hoersten <luke@hoersten.org>
parents: 207
diff changeset
    56
    # The maximum amount of time that a cache entry can live for in memory before
dd52907adff9 Split dendrite build out of install role.
Luke Hoersten <luke@hoersten.org>
parents: 207
diff changeset
    57
    # it will be evicted and/or refreshed from the database. Lower values result in
dd52907adff9 Split dendrite build out of install role.
Luke Hoersten <luke@hoersten.org>
parents: 207
diff changeset
    58
    # easier admission of new cache entries but may also increase database load in
dd52907adff9 Split dendrite build out of install role.
Luke Hoersten <luke@hoersten.org>
parents: 207
diff changeset
    59
    # comparison to higher values, so adjust conservatively. Higher values may make
dd52907adff9 Split dendrite build out of install role.
Luke Hoersten <luke@hoersten.org>
parents: 207
diff changeset
    60
    # it harder for new items to make it into the cache, e.g. if new rooms suddenly
dd52907adff9 Split dendrite build out of install role.
Luke Hoersten <luke@hoersten.org>
parents: 207
diff changeset
    61
    # become popular.
dd52907adff9 Split dendrite build out of install role.
Luke Hoersten <luke@hoersten.org>
parents: 207
diff changeset
    62
    max_age: 1h
dd52907adff9 Split dendrite build out of install role.
Luke Hoersten <luke@hoersten.org>
parents: 207
diff changeset
    63
180
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
    64
  # The server name to delegate server-server communications to, with optional port
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
    65
  # e.g. localhost:443
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
    66
  well_known_server_name: ""
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
    67
215
dd52907adff9 Split dendrite build out of install role.
Luke Hoersten <luke@hoersten.org>
parents: 207
diff changeset
    68
  # The base URL to delegate client-server communications to e.g. https://localhost
dd52907adff9 Split dendrite build out of install role.
Luke Hoersten <luke@hoersten.org>
parents: 207
diff changeset
    69
  well_known_client_name: ""
dd52907adff9 Split dendrite build out of install role.
Luke Hoersten <luke@hoersten.org>
parents: 207
diff changeset
    70
163
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    71
  # Lists of domains that the server will trust as identity servers to verify third
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    72
  # party identifiers such as phone numbers and email addresses.
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    73
  trusted_third_party_id_servers:
180
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
    74
    - matrix.org
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
    75
    - vector.im
163
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    76
180
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
    77
  # Disables federation. Dendrite will not be able to communicate with other servers
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
    78
  # in the Matrix federation and the federation API will not be exposed.
163
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    79
  disable_federation: false
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    80
180
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
    81
  # Configures the handling of presence events. Inbound controls whether we receive
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
    82
  # presence events from other servers, outbound controls whether we send presence
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
    83
  # events for our local users to other servers.
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
    84
  presence:
205
2ea9460dc8d2 Enabled presence events in dendrite.
Luke Hoersten <luke@hoersten.org>
parents: 203
diff changeset
    85
    enable_inbound: true
2ea9460dc8d2 Enabled presence events in dendrite.
Luke Hoersten <luke@hoersten.org>
parents: 203
diff changeset
    86
    enable_outbound: true
163
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    87
180
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
    88
  # Configures phone-home statistics reporting. These statistics contain the server
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
    89
  # name, number of active users and some information on your deployment config.
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
    90
  # We use this information to understand how Dendrite is being used in the wild.
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
    91
  report_stats:
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
    92
    enabled: false
215
dd52907adff9 Split dendrite build out of install role.
Luke Hoersten <luke@hoersten.org>
parents: 207
diff changeset
    93
    endpoint: https://panopticon.matrix.org/push
163
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    94
180
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
    95
  # Server notices allows server admins to send messages to all users on the server.
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
    96
  server_notices:
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
    97
    enabled: false
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
    98
    # The local part, display name and avatar URL (as a mxc:// URL) for the user that
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
    99
    # will send the server notices. These are visible to all users on the deployment.
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   100
    local_part: "_server"
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   101
    display_name: "Server Alerts"
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   102
    avatar_url: ""
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   103
    # The room name to be used when sending server notices. This room name will
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   104
    # appear in user clients.
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   105
    room_name: "Server Alerts"
163
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   106
180
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   107
  # Configuration for NATS JetStream
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   108
  jetstream:
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   109
    # A list of NATS Server addresses to connect to. If none are specified, an
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   110
    # internal NATS server will be started automatically when running Dendrite in
215
dd52907adff9 Split dendrite build out of install role.
Luke Hoersten <luke@hoersten.org>
parents: 207
diff changeset
   111
    # monolith mode.
180
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   112
    addresses:
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   113
    # - localhost:4222
163
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   114
215
dd52907adff9 Split dendrite build out of install role.
Luke Hoersten <luke@hoersten.org>
parents: 207
diff changeset
   115
    # Disable the validation of TLS certificates of NATS. This is
dd52907adff9 Split dendrite build out of install role.
Luke Hoersten <luke@hoersten.org>
parents: 207
diff changeset
   116
    # not recommended in production since it may allow NATS traffic
dd52907adff9 Split dendrite build out of install role.
Luke Hoersten <luke@hoersten.org>
parents: 207
diff changeset
   117
    # to be sent to an insecure endpoint.
dd52907adff9 Split dendrite build out of install role.
Luke Hoersten <luke@hoersten.org>
parents: 207
diff changeset
   118
    disable_tls_validation: false
dd52907adff9 Split dendrite build out of install role.
Luke Hoersten <luke@hoersten.org>
parents: 207
diff changeset
   119
180
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   120
    # Persistent directory to store JetStream streams in. This directory should be
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   121
    # preserved across Dendrite restarts.
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   122
    storage_path: ./
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   123
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   124
    # The prefix to use for stream names for this homeserver - really only useful
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   125
    # if you are running more than one Dendrite server on the same NATS deployment.
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   126
    topic_prefix: Dendrite
163
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   127
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   128
  # Configuration for Prometheus metric collection.
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   129
  metrics:
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   130
    enabled: true
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   131
    basic_auth:
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   132
      username: metrics
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   133
      password: metrics
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   134
180
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   135
  # Optional DNS cache. The DNS cache may reduce the load on DNS servers if there
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   136
  # is no local caching resolver available for use.
163
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   137
  dns_cache:
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   138
    enabled: false
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   139
    cache_size: 256
180
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   140
    cache_lifetime: "5m" # 5 minutes; https://pkg.go.dev/time@master#ParseDuration
163
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   141
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   142
# Configuration for the Appservice API.
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   143
app_service_api:
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   144
  # Disable the validation of TLS certificates of appservices. This is
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   145
  # not recommended in production since it may allow appservice traffic
180
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   146
  # to be sent to an insecure endpoint.
163
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   147
  disable_tls_validation: false
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   148
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   149
  # Appservice configuration files to load into this homeserver.
180
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   150
  config_files:
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   151
  #  - /path/to/appservice_registration.yaml
163
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   152
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   153
# Configuration for the Client API.
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   154
client_api:
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   155
  # Prevents new users from being able to register on this homeserver, except when
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   156
  # using the registration shared secret below.
206
35f2b1e680ed Added variable for enabling dendrite reg.
Luke Hoersten <luke@hoersten.org>
parents: 205
diff changeset
   157
  registration_disabled: {{dendrite_registration_disabled}}
163
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   158
180
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   159
  # Prevents new guest accounts from being created. Guest registration is also
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   160
  # disabled implicitly by setting 'registration_disabled' above.
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   161
  guests_disabled: true
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   162
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   163
  # If set, allows registration by anyone who knows the shared secret, regardless
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   164
  # of whether registration is otherwise disabled.
168
8e61e4bb714b Minor dendrite tweaks.
Luke Hoersten <luke@hoersten.org>
parents: 163
diff changeset
   165
  registration_shared_secret: "{{dendrite_registration_secret}}"
163
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   166
180
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   167
  # Whether to require reCAPTCHA for registration. If you have enabled registration
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   168
  # then this is HIGHLY RECOMMENDED to reduce the risk of your homeserver being used
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   169
  # for coordinated spam attacks.
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   170
  enable_registration_captcha: {{dendrite_recaptcha_enable}}
163
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   171
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   172
  # Settings for ReCAPTCHA.
180
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   173
  recaptcha_public_key: "{{dendrite_recaptcha_public_key}}"
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   174
  recaptcha_private_key: "{{dendrite_recaptcha_private_key}}"
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   175
  recaptcha_bypass_secret: "{{dendrite_recaptcha_bypass_secret}}"
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   176
  recaptcha_siteverify_api: "{{dendrite_recaptcha_siteverify_api}}"
163
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   177
215
dd52907adff9 Split dendrite build out of install role.
Luke Hoersten <luke@hoersten.org>
parents: 207
diff changeset
   178
163
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   179
  # TURN server information that this homeserver should send to clients.
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   180
  turn:
215
dd52907adff9 Split dendrite build out of install role.
Luke Hoersten <luke@hoersten.org>
parents: 207
diff changeset
   181
    turn_user_lifetime: "5m"
180
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   182
    turn_uris:
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   183
    #  - turn:turn.server.org?transport=udp
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   184
    #  - turn:turn.server.org?transport=tcp
163
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   185
    turn_shared_secret: ""
215
dd52907adff9 Split dendrite build out of install role.
Luke Hoersten <luke@hoersten.org>
parents: 207
diff changeset
   186
    # If your TURN server requires static credentials, then you will need to enter
dd52907adff9 Split dendrite build out of install role.
Luke Hoersten <luke@hoersten.org>
parents: 207
diff changeset
   187
    # them here instead of supplying a shared secret. Note that these credentials
dd52907adff9 Split dendrite build out of install role.
Luke Hoersten <luke@hoersten.org>
parents: 207
diff changeset
   188
    # will be visible to clients!
dd52907adff9 Split dendrite build out of install role.
Luke Hoersten <luke@hoersten.org>
parents: 207
diff changeset
   189
    # turn_username: ""
dd52907adff9 Split dendrite build out of install role.
Luke Hoersten <luke@hoersten.org>
parents: 207
diff changeset
   190
    # turn_password: ""
163
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   191
180
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   192
  # Settings for rate-limited endpoints. Rate limiting kicks in after the threshold
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   193
  # number of "slots" have been taken by requests from a specific host. Each "slot"
215
dd52907adff9 Split dendrite build out of install role.
Luke Hoersten <luke@hoersten.org>
parents: 207
diff changeset
   194
  # will be released after the cooloff time in milliseconds. Server administrators
dd52907adff9 Split dendrite build out of install role.
Luke Hoersten <luke@hoersten.org>
parents: 207
diff changeset
   195
  # and appservice users are exempt from rate limiting by default.
163
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   196
  rate_limiting:
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   197
    enabled: true
215
dd52907adff9 Split dendrite build out of install role.
Luke Hoersten <luke@hoersten.org>
parents: 207
diff changeset
   198
    threshold: 20
163
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   199
    cooloff_ms: 500
215
dd52907adff9 Split dendrite build out of install role.
Luke Hoersten <luke@hoersten.org>
parents: 207
diff changeset
   200
    exempt_user_ids:
dd52907adff9 Split dendrite build out of install role.
Luke Hoersten <luke@hoersten.org>
parents: 207
diff changeset
   201
    #  - "@user:domain.com"
163
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   202
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   203
# Configuration for the Federation API.
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   204
federation_api:
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   205
  # How many times we will try to resend a failed transaction to a specific server. The
180
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   206
  # backoff is 2**x seconds, so 1 = 2 seconds, 2 = 4 seconds, 3 = 8 seconds etc. Once
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   207
  # the max retries are exceeded, Dendrite will no longer try to send transactions to
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   208
  # that server until it comes back to life and connects to us again.
163
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   209
  send_max_retries: 16
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   210
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   211
  # Disable the validation of TLS certificates of remote federated homeservers. Do not
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   212
  # enable this option in production as it presents a security risk!
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   213
  disable_tls_validation: false
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   214
215
dd52907adff9 Split dendrite build out of install role.
Luke Hoersten <luke@hoersten.org>
parents: 207
diff changeset
   215
  # Disable HTTP keepalives, which also prevents connection reuse. Dendrite will typically
dd52907adff9 Split dendrite build out of install role.
Luke Hoersten <luke@hoersten.org>
parents: 207
diff changeset
   216
  # keep HTTP connections open to remote hosts for 5 minutes as they can be reused much
dd52907adff9 Split dendrite build out of install role.
Luke Hoersten <luke@hoersten.org>
parents: 207
diff changeset
   217
  # more quickly than opening new connections each time. Disabling keepalives will close
dd52907adff9 Split dendrite build out of install role.
Luke Hoersten <luke@hoersten.org>
parents: 207
diff changeset
   218
  # HTTP connections immediately after a successful request but may result in more CPU and
dd52907adff9 Split dendrite build out of install role.
Luke Hoersten <luke@hoersten.org>
parents: 207
diff changeset
   219
  # memory being used on TLS handshakes for each new connection instead.
dd52907adff9 Split dendrite build out of install role.
Luke Hoersten <luke@hoersten.org>
parents: 207
diff changeset
   220
  disable_http_keepalives: false
dd52907adff9 Split dendrite build out of install role.
Luke Hoersten <luke@hoersten.org>
parents: 207
diff changeset
   221
180
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   222
  # Perspective keyservers to use as a backup when direct key fetches fail. This may
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   223
  # be required to satisfy key requests for servers that are no longer online when
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   224
  # joining some rooms.
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   225
  key_perspectives:
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   226
    - server_name: matrix.org
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   227
      keys:
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   228
        - key_id: ed25519:auto
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   229
          public_key: Noi6WqcDj0QmPxCNQqgezwTlBKrfqehY1u2FyWP9uYw
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   230
        - key_id: ed25519:a_RXGa
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   231
          public_key: l8Hft5qXKn1vfHrg3p4+W8gELQVo8N13JkluMfmn2sQ
163
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   232
180
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   233
  # This option will control whether Dendrite will prefer to look up keys directly
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   234
  # or whether it should try perspective servers first, using direct fetches as a
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   235
  # last resort.
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   236
  prefer_direct_fetch: false
163
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   237
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   238
# Configuration for the Media API.
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   239
media_api:
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   240
  # Storage path for uploaded media. May be relative or absolute.
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   241
  base_path: ./media_store
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   242
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   243
  # The maximum allowed file size (in bytes) for media uploads to this homeserver
180
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   244
  # (0 = unlimited). If using a reverse proxy, ensure it allows requests at least
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   245
  #this large (e.g. the client_max_body_size setting in nginx).
163
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   246
  max_file_size_bytes: 10485760
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   247
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   248
  # Whether to dynamically generate thumbnails if needed.
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   249
  dynamic_thumbnails: false
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   250
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   251
  # The maximum number of simultaneous thumbnail generators to run.
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   252
  max_thumbnail_generators: 10
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   253
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   254
  # A list of thumbnail sizes to be generated for media content.
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   255
  thumbnail_sizes:
180
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   256
    - width: 32
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   257
      height: 32
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   258
      method: crop
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   259
    - width: 96
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   260
      height: 96
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   261
      method: crop
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   262
    - width: 640
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   263
      height: 480
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   264
      method: scale
163
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   265
180
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   266
# Configuration for enabling experimental MSCs on this homeserver.
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   267
mscs:
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   268
  mscs:
215
dd52907adff9 Split dendrite build out of install role.
Luke Hoersten <luke@hoersten.org>
parents: 207
diff changeset
   269
  #  - msc2836  # (Threading, see https://github.com/matrix-org/matrix-doc/pull/2836)
163
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   270
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   271
# Configuration for the Sync API.
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   272
sync_api:
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   273
  # This option controls which HTTP header to inspect to find the real remote IP
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   274
  # address of the client. This is likely required if Dendrite is running behind
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   275
  # a reverse proxy server.
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   276
  # real_ip_header: X-Real-IP
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   277
215
dd52907adff9 Split dendrite build out of install role.
Luke Hoersten <luke@hoersten.org>
parents: 207
diff changeset
   278
  # Configuration for the full-text search engine.
dd52907adff9 Split dendrite build out of install role.
Luke Hoersten <luke@hoersten.org>
parents: 207
diff changeset
   279
  search:
dd52907adff9 Split dendrite build out of install role.
Luke Hoersten <luke@hoersten.org>
parents: 207
diff changeset
   280
    # Whether or not search is enabled.
dd52907adff9 Split dendrite build out of install role.
Luke Hoersten <luke@hoersten.org>
parents: 207
diff changeset
   281
    enabled: false
dd52907adff9 Split dendrite build out of install role.
Luke Hoersten <luke@hoersten.org>
parents: 207
diff changeset
   282
dd52907adff9 Split dendrite build out of install role.
Luke Hoersten <luke@hoersten.org>
parents: 207
diff changeset
   283
    # The path where the search index will be created in.
dd52907adff9 Split dendrite build out of install role.
Luke Hoersten <luke@hoersten.org>
parents: 207
diff changeset
   284
    index_path: "./searchindex"
dd52907adff9 Split dendrite build out of install role.
Luke Hoersten <luke@hoersten.org>
parents: 207
diff changeset
   285
dd52907adff9 Split dendrite build out of install role.
Luke Hoersten <luke@hoersten.org>
parents: 207
diff changeset
   286
    # The language most likely to be used on the server - used when indexing, to
dd52907adff9 Split dendrite build out of install role.
Luke Hoersten <luke@hoersten.org>
parents: 207
diff changeset
   287
    # ensure the returned results match expectations. A full list of possible languages
dd52907adff9 Split dendrite build out of install role.
Luke Hoersten <luke@hoersten.org>
parents: 207
diff changeset
   288
    # can be found at https://github.com/blevesearch/bleve/tree/master/analysis/lang
dd52907adff9 Split dendrite build out of install role.
Luke Hoersten <luke@hoersten.org>
parents: 207
diff changeset
   289
    language: "en"
dd52907adff9 Split dendrite build out of install role.
Luke Hoersten <luke@hoersten.org>
parents: 207
diff changeset
   290
163
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   291
# Configuration for the User API.
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   292
user_api:
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   293
  # The cost when hashing passwords on registration/login. Default: 10. Min: 4, Max: 31
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   294
  # See https://pkg.go.dev/golang.org/x/crypto/bcrypt for more information.
180
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   295
  # Setting this lower makes registration/login consume less CPU resources at the cost
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   296
  # of security should the database be compromised. Setting this higher makes registration/login
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   297
  # consume more CPU resources but makes it harder to brute force password hashes. This value
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   298
  # can be lowered if performing tests or on embedded Dendrite instances (e.g WASM builds).
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   299
  bcrypt_cost: 10
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   300
163
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   301
  # The length of time that a token issued for a relying party from
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   302
  # /_matrix/client/r0/user/{userId}/openid/request_token endpoint
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   303
  # is considered to be valid in milliseconds.
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   304
  # The default lifetime is 3600000ms (60 minutes).
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   305
  # openid_token_lifetime_ms: 3600000
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   306
215
dd52907adff9 Split dendrite build out of install role.
Luke Hoersten <luke@hoersten.org>
parents: 207
diff changeset
   307
  # Users who register on this homeserver will automatically be joined to the rooms listed under "auto_join_rooms" option.
dd52907adff9 Split dendrite build out of install role.
Luke Hoersten <luke@hoersten.org>
parents: 207
diff changeset
   308
  # By default, any room aliases included in this list will be created as a publicly joinable room
dd52907adff9 Split dendrite build out of install role.
Luke Hoersten <luke@hoersten.org>
parents: 207
diff changeset
   309
  # when the first user registers for the homeserver. If the room already exists,
dd52907adff9 Split dendrite build out of install role.
Luke Hoersten <luke@hoersten.org>
parents: 207
diff changeset
   310
  # make certain it is a publicly joinable room, i.e. the join rule of the room must be set to 'public'.
dd52907adff9 Split dendrite build out of install role.
Luke Hoersten <luke@hoersten.org>
parents: 207
diff changeset
   311
  # As Spaces are just rooms under the hood, Space aliases may also be used.
dd52907adff9 Split dendrite build out of install role.
Luke Hoersten <luke@hoersten.org>
parents: 207
diff changeset
   312
  auto_join_rooms:
dd52907adff9 Split dendrite build out of install role.
Luke Hoersten <luke@hoersten.org>
parents: 207
diff changeset
   313
  #  - "#main:matrix.org"
dd52907adff9 Split dendrite build out of install role.
Luke Hoersten <luke@hoersten.org>
parents: 207
diff changeset
   314
163
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   315
# Configuration for Opentracing.
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   316
# See https://github.com/matrix-org/dendrite/tree/master/docs/tracing for information on
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   317
# how this works and how to set it up.
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   318
tracing:
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   319
  enabled: false
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   320
  jaeger:
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   321
    serviceName: ""
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   322
    disabled: false
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   323
    rpc_metrics: false
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   324
    tags: []
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   325
    sampler: null
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   326
    reporter: null
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   327
    headers: null
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   328
    baggage_restrictions: null
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   329
    throttler: null
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   330
180
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   331
# Logging configuration. The "std" logging type controls the logs being sent to
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   332
# stdout. The "file" logging type controls logs being written to a log folder on
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   333
# the disk. Supported log levels are "debug", "info", "warn", "error".
163
40b78af86337 Tons of updates.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   334
logging:
180
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   335
  - type: std
207
e16c94c81b53 Updated dendrite logs to error for less verbose.
Luke Hoersten <luke@hoersten.org>
parents: 206
diff changeset
   336
    level: error
180
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   337
  - type: file
207
e16c94c81b53 Updated dendrite logs to error for less verbose.
Luke Hoersten <luke@hoersten.org>
parents: 206
diff changeset
   338
    level: error
180
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   339
    params:
f2f99b9b16ee Updated dendrite config.
Luke Hoersten <luke@hoersten.org>
parents: 174
diff changeset
   340
      path: ./logs