conduit/conduit-example.toml

62 lines
2.5 KiB
TOML
Raw Normal View History

2022-05-10 09:26:19 +02:00
# =============================================================================
# This is the official example config for Conduit.
# If you use it for your server, you will need to adjust it to your own needs.
# At the very least, change the server_name field!
# =============================================================================
2021-01-01 11:24:09 +01:00
[global]
# The server_name is the pretty name of this server. It is used as a suffix for user
2021-01-01 11:24:09 +01:00
# and room ids. Examples: matrix.org, conduit.rs
# The Conduit server needs all /_matrix/ requests to be reachable at
# https://your.server.name/ on port 443 (client-server) and 8448 (federation).
# If that's not possible for you, you can create /.well-known files to redirect
# requests. See
2021-01-01 11:24:09 +01:00
# https://matrix.org/docs/spec/client_server/latest#get-well-known-matrix-client
# and
# https://matrix.org/docs/spec/server_server/r0.1.4#get-well-known-matrix-server
2021-01-01 11:24:09 +01:00
# for more information
# YOU NEED TO EDIT THIS
#server_name = "your.server.name"
# This is the only directory where Conduit will save its data
2022-02-12 10:29:04 +01:00
database_path = "/var/lib/matrix-conduit/"
database_backend = "rocksdb"
2021-01-01 11:24:09 +01:00
# The port Conduit will be running on. You need to set up a reverse proxy in
# your web server (e.g. apache or nginx), so all requests to /_matrix on port
# 443 and 8448 will be forwarded to the Conduit instance running on this port
2022-02-02 14:07:35 +01:00
# Docker users: Don't change this, you'll need to map an external port to this.
2021-01-01 11:24:09 +01:00
port = 6167
# Max size for uploads
max_request_size = 20_000_000 # in bytes
2021-08-31 18:25:35 +02:00
# Enables registration. If set to false, no users can register on this server.
allow_registration = true
2021-01-01 11:24:09 +01:00
2022-02-12 10:29:04 +01:00
allow_federation = true
2023-07-29 20:01:38 +02:00
allow_check_for_updates = true
2021-02-28 12:41:03 +01:00
2022-06-23 08:58:34 +02:00
# Enable the display name lightning bolt on registration.
enable_lightning_bolt = true
2023-01-09 17:09:41 +01:00
# Servers listed here will be used to gather public keys of other servers.
# Generally, copying this exactly should be enough. (Currently, Conduit doesn't
# support batched key requests, so this list should only contain Synapse
# servers.)
trusted_servers = ["matrix.org"]
#max_concurrent_requests = 100 # How many requests Conduit sends to other servers at the same time
# Controls the log verbosity. See also [here][0].
#
# [0]: https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#directives
#log = "..."
2021-01-01 11:24:09 +01:00
address = "127.0.0.1" # This makes sure Conduit can only be reached using the reverse proxy
#address = "0.0.0.0" # If Conduit is running in a container, make sure the reverse proxy (ie. Traefik) can reach it.