From 23c36f924f69802d43b85e24a8fb48bbc7f2e905 Mon Sep 17 00:00:00 2001 From: Greg Burd Date: Mon, 23 Oct 2023 10:12:45 -0400 Subject: [PATCH 1/6] import https://codeberg.org/gerald/dendrite-on-flyio --- dendrite/.gitignore | 2 + dendrite/Dockerfile | 3 + dendrite/README.md | 73 +++++++ dendrite/dendrite-example.yaml | 344 +++++++++++++++++++++++++++++++++ dendrite/fly.toml | 29 +++ 5 files changed, 451 insertions(+) create mode 100644 dendrite/.gitignore create mode 100644 dendrite/Dockerfile create mode 100644 dendrite/README.md create mode 100644 dendrite/dendrite-example.yaml create mode 100644 dendrite/fly.toml diff --git a/dendrite/.gitignore b/dendrite/.gitignore new file mode 100644 index 0000000..c7eda92 --- /dev/null +++ b/dendrite/.gitignore @@ -0,0 +1,2 @@ +matrix_key.pem +dendrite.yaml diff --git a/dendrite/Dockerfile b/dendrite/Dockerfile new file mode 100644 index 0000000..3cf9421 --- /dev/null +++ b/dendrite/Dockerfile @@ -0,0 +1,3 @@ +FROM matrixdotorg/dendrite-monolith:v0.3.11 + +COPY matrix_key.pem dendrite.yaml /etc/dendrite/ diff --git a/dendrite/README.md b/dendrite/README.md new file mode 100644 index 0000000..ecee6e8 --- /dev/null +++ b/dendrite/README.md @@ -0,0 +1,73 @@ +# Matrix Homeserver on fly.io + +Quick notes on how to run [dendrite] for a small scale Matrix homeserver on [fly.io] with sqlite storage. + +## Requirements + +- A domain name where you can create/change A, AAAA and SRV records +- A [fly.io] account and the [`flyctl`] cli installed +- Docker or similar container runtime installed + +## Preparations + +For federation (talking to other homeservers), your server needs is a matrix server key. + +To generate this server key, the dendrite container image can be used. + +``` +docker run --rm -it -v $(pwd):/key -w /key --entrypoint /usr/bin/generate-keys matrixdotorg/dendrite-monolith:v0.3.11 --private-key matrix_key.pem +``` + +**Do not loose this key!** + +Next, make copy the `dendrite-example.yaml` to `dentrite.yaml` and change the `global.server_name` to your desired domain. + +Finally, change the `app = "dendrite-on-fly"` line in `fly.toml` to an app name of your desire. + +## Deployment + +The deployment is using a persistent volume mount, so we need to create the volume before we can deploy. + +The following command will create a 10 GB volume in the `fra` region. (A list of available regions can be obtained using `flyctl platform regions`) + +``` +flyctl volumes create dendrite_data --region fra --size 10 +``` + +Now you simply can deploy dendrite using + +``` +flyctl deploy +``` + +## Domain configuration + +After deployment, execute `flyctl info` to obtain the IP addresses your app runs on. + +Use these IPs to create A and AAAA records for the domain name you configured in `dendrite.yaml` + +Usually matrix federates on port 8448, but it is possible to use a SRV record to specify a different port (8443 in our case). + +Create a SRV record at `_matrix._tcp.` with values `10 10 8443 ` + +It is possible to test federation with the [Matrix federation tester](https://federationtester.matrix.org/). + +Once you have set up the A and AAAA records, obtain a TLS certificate using `flyctl` + +``` +flyctl certs add +``` + +You now can create accounts on your homeserver and start chatting with people. + +## Still to figure out + +- How to backup your sqlite file + +## Useful information + +- flyctl v0.0.181 and dendrite v0.3.11 were used + +[dendrite]: https://github.com/matrix-org/dendrite +[fly.io]: https://fly.io +[`flyctl`]: https://github.com/superfly/flyctl/releases diff --git a/dendrite/dendrite-example.yaml b/dendrite/dendrite-example.yaml new file mode 100644 index 0000000..0a81a8b --- /dev/null +++ b/dendrite/dendrite-example.yaml @@ -0,0 +1,344 @@ +# 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: + + # The path to the signing private key file, used to sign requests and events. + private_key: /etc/dendrite/matrix_key.pem + + # 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. + # old_private_keys: + # - private_key: old_matrix_key.pem + # expired_at: 1601024554498 + + # 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: + - kafka:9092 + + # 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:///data/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: false + + # 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 + # if there 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: 300 + +# Configuration for the Appservice API. +app_service_api: + internal_api: + listen: http://0.0.0.0:7777 + connect: http://appservice_api:7777 + database: + connection_string: file:///data/dendrite.db + max_open_conns: 10 + 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://0.0.0.0:7771 + connect: http://client_api:7771 + external_api: + listen: http://0.0.0.0: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: "" + + # Settings for rate-limited endpoints. Rate limiting will kick in after the + # threshold number of "slots" have been taken by requests from a specific + # host. Each "slot" 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://0.0.0.0:7778 + connect: http://edu_server:7778 + +# Configuration for the Federation API. +federation_api: + internal_api: + listen: http://0.0.0.0:7772 + connect: http://federation_api:7772 + external_api: + listen: http://0.0.0.0: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://0.0.0.0:7775 + connect: http://federation_sender:7775 + database: + connection_string: file:///data/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. + 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://0.0.0.0:7779 + connect: http://key_server:7779 + database: + connection_string: file:///data/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://0.0.0.0:7774 + connect: http://media_api:7774 + external_api: + listen: http://0.0.0.0:8074 + database: + connection_string: file:///data/dendrite.db + max_open_conns: 10 + max_idle_conns: 2 + conn_max_lifetime: -1 + + # Storage path for uploaded media. May be relative or absolute. + base_path: /data/media + + # 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://0.0.0.0:7770 + connect: http://room_server:7770 + database: + connection_string: file:///data/dendrite.db + max_open_conns: 10 + max_idle_conns: 2 + conn_max_lifetime: -1 + +# Configuration for the Server Key API (for server signing keys). +signing_key_server: + internal_api: + listen: http://0.0.0.0:7780 + connect: http://signing_key_server:7780 + database: + connection_string: file:///data/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 Sync API. +sync_api: + internal_api: + listen: http://0.0.0.0:7773 + connect: http://sync_api:7773 + external_api: + listen: http://0.0.0.0:8073 + database: + connection_string: file:///data/dendrite.db + max_open_conns: 10 + max_idle_conns: 2 + conn_max_lifetime: -1 + +# Configuration for the User API. +user_api: + internal_api: + listen: http://0.0.0.0:7781 + connect: http://user_api:7781 + account_database: + connection_string: file:///data/dendrite.db + max_open_conns: 10 + max_idle_conns: 2 + conn_max_lifetime: -1 + device_database: + connection_string: file:///data/dendrite.db + max_open_conns: 10 + 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 diff --git a/dendrite/fly.toml b/dendrite/fly.toml new file mode 100644 index 0000000..883bbb3 --- /dev/null +++ b/dendrite/fly.toml @@ -0,0 +1,29 @@ +app = "dendrite-on-fly" + +kill_signal = "SIGINT" +kill_timeout = 20 + +[[services]] + internal_port = 8008 + protocol = "tcp" + + [services.concurrency] + hard_limit = 100 + soft_limit = 80 + + [[services.ports]] + handlers = ["tls", "http"] + port = "443" + + [[services.ports]] + handlers = ["tls", "http"] + port = "8443" + + [[services.tcp_checks]] + interval = "10s" + grace_period = "5s" + timeout = "2s" + +[mounts] +source="dendrite_data" +destination="/data" From 7fa500dbf31c3e038059aec4653376feddf84c9f Mon Sep 17 00:00:00 2001 From: Greg Burd Date: Wed, 25 Oct 2023 10:50:32 -0400 Subject: [PATCH 2/6] update to allow for secrets to remain hidden --- dendrite/.dockerignore | 4 + dendrite/.gitignore | 1 - dendrite/Dockerfile | 10 +- dendrite/README.md | 32 ++- dendrite/TODO | 8 + dendrite/dendrite-example.yaml | 344 -------------------------- dendrite/dendrite-sample.in.yaml | 353 ++++++++++++++++++++++++++ dendrite/dendrite.in.yaml | 409 +++++++++++++++++++++++++++++++ dendrite/docker-entrypoint.sh | 9 + dendrite/fly.toml | 41 ++-- 10 files changed, 840 insertions(+), 371 deletions(-) create mode 100644 dendrite/.dockerignore create mode 100644 dendrite/TODO delete mode 100644 dendrite/dendrite-example.yaml create mode 100644 dendrite/dendrite-sample.in.yaml create mode 100644 dendrite/dendrite.in.yaml create mode 100755 dendrite/docker-entrypoint.sh diff --git a/dendrite/.dockerignore b/dendrite/.dockerignore new file mode 100644 index 0000000..72f1a30 --- /dev/null +++ b/dendrite/.dockerignore @@ -0,0 +1,4 @@ +# flyctl launch added from .gitignore +fly.toml +matrix_key.pem +dendrite-sample.in.yaml diff --git a/dendrite/.gitignore b/dendrite/.gitignore index c7eda92..cd36fdd 100644 --- a/dendrite/.gitignore +++ b/dendrite/.gitignore @@ -1,2 +1 @@ matrix_key.pem -dendrite.yaml diff --git a/dendrite/Dockerfile b/dendrite/Dockerfile index 3cf9421..035c95c 100644 --- a/dendrite/Dockerfile +++ b/dendrite/Dockerfile @@ -1,3 +1,9 @@ -FROM matrixdotorg/dendrite-monolith:v0.3.11 +FROM matrixdotorg/dendrite-monolith:v0.13.3 + +RUN apk --update --no-cache add envsubst tini + +COPY dendrite.in.yaml /etc/dendrite/ +COPY docker-entrypoint.sh / + +ENTRYPOINT ["/sbin/tini", "--", "/docker-entrypoint.sh"] -COPY matrix_key.pem dendrite.yaml /etc/dendrite/ diff --git a/dendrite/README.md b/dendrite/README.md index ecee6e8..9c213e3 100644 --- a/dendrite/README.md +++ b/dendrite/README.md @@ -12,26 +12,34 @@ Quick notes on how to run [dendrite] for a small scale Matrix homeserver on [fly For federation (talking to other homeservers), your server needs is a matrix server key. -To generate this server key, the dendrite container image can be used. +Generate the server key using either the dendrite container: +```shell +docker run --rm -it -v $(pwd):/key -w /key --entrypoint /usr/bin/generate-keys matrixdotorg/dendrite-monolith:latest --private-key matrix_key.pem ``` -docker run --rm -it -v $(pwd):/key -w /key --entrypoint /usr/bin/generate-keys matrixdotorg/dendrite-monolith:v0.3.11 --private-key matrix_key.pem + +or the `generate-keys` app: +```shell +go run github.com/matrix-org/dendrite/cmd/generate-keys \ + --private-key=matrix_key.pem \ + --tls-cert=server.crt \ + --tls-key=server.key ``` **Do not loose this key!** -Next, make copy the `dendrite-example.yaml` to `dentrite.yaml` and change the `global.server_name` to your desired domain. +Next, make copy the `dendrite-sample.in.yaml` to `dentrite.in.yaml` and change the `global.server_name` to your desired domain. Finally, change the `app = "dendrite-on-fly"` line in `fly.toml` to an app name of your desire. ## Deployment -The deployment is using a persistent volume mount, so we need to create the volume before we can deploy. +Choose your Fly.io region (`flyctl platform regions`) and edit the `fly.toml` +file. +Create a 10GB persistent volume mount in your desired region. -The following command will create a 10 GB volume in the `fra` region. (A list of available regions can be obtained using `flyctl platform regions`) - -``` -flyctl volumes create dendrite_data --region fra --size 10 +```shell +flyctl volumes create dendrite_data --region bos --size 10 ``` Now you simply can deploy dendrite using @@ -40,6 +48,14 @@ Now you simply can deploy dendrite using flyctl deploy ``` +## Secrets + +```shell +flyctl secrets set "DATABASE_URL=postgresql://user:pass@hostname/database?params=..." +flyctl secrets set "REGISTRATION_SHARED_SECRET=" +base64 -w0 matrix_key.pem | flyctl secrets set MATRIX_KEY_PEM=- +``` + ## Domain configuration After deployment, execute `flyctl info` to obtain the IP addresses your app runs on. diff --git a/dendrite/TODO b/dendrite/TODO new file mode 100644 index 0000000..7c0aa80 --- /dev/null +++ b/dendrite/TODO @@ -0,0 +1,8 @@ +* video/voice calls + https://landchad.net/coturn/ + https://landchad.net/dendrite/ +* media on s3 + https://github.com/turt2live/matrix-media-repo/ + https://quentin.dufour.io/blog/2021-09-14/matrix-synapse-s3-storage/ +* migration + https://ems.element.io/tools/matrix-migration diff --git a/dendrite/dendrite-example.yaml b/dendrite/dendrite-example.yaml deleted file mode 100644 index 0a81a8b..0000000 --- a/dendrite/dendrite-example.yaml +++ /dev/null @@ -1,344 +0,0 @@ -# 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: - - # The path to the signing private key file, used to sign requests and events. - private_key: /etc/dendrite/matrix_key.pem - - # 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. - # old_private_keys: - # - private_key: old_matrix_key.pem - # expired_at: 1601024554498 - - # 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: - - kafka:9092 - - # 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:///data/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: false - - # 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 - # if there 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: 300 - -# Configuration for the Appservice API. -app_service_api: - internal_api: - listen: http://0.0.0.0:7777 - connect: http://appservice_api:7777 - database: - connection_string: file:///data/dendrite.db - max_open_conns: 10 - 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://0.0.0.0:7771 - connect: http://client_api:7771 - external_api: - listen: http://0.0.0.0: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: "" - - # Settings for rate-limited endpoints. Rate limiting will kick in after the - # threshold number of "slots" have been taken by requests from a specific - # host. Each "slot" 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://0.0.0.0:7778 - connect: http://edu_server:7778 - -# Configuration for the Federation API. -federation_api: - internal_api: - listen: http://0.0.0.0:7772 - connect: http://federation_api:7772 - external_api: - listen: http://0.0.0.0: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://0.0.0.0:7775 - connect: http://federation_sender:7775 - database: - connection_string: file:///data/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. - 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://0.0.0.0:7779 - connect: http://key_server:7779 - database: - connection_string: file:///data/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://0.0.0.0:7774 - connect: http://media_api:7774 - external_api: - listen: http://0.0.0.0:8074 - database: - connection_string: file:///data/dendrite.db - max_open_conns: 10 - max_idle_conns: 2 - conn_max_lifetime: -1 - - # Storage path for uploaded media. May be relative or absolute. - base_path: /data/media - - # 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://0.0.0.0:7770 - connect: http://room_server:7770 - database: - connection_string: file:///data/dendrite.db - max_open_conns: 10 - max_idle_conns: 2 - conn_max_lifetime: -1 - -# Configuration for the Server Key API (for server signing keys). -signing_key_server: - internal_api: - listen: http://0.0.0.0:7780 - connect: http://signing_key_server:7780 - database: - connection_string: file:///data/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 Sync API. -sync_api: - internal_api: - listen: http://0.0.0.0:7773 - connect: http://sync_api:7773 - external_api: - listen: http://0.0.0.0:8073 - database: - connection_string: file:///data/dendrite.db - max_open_conns: 10 - max_idle_conns: 2 - conn_max_lifetime: -1 - -# Configuration for the User API. -user_api: - internal_api: - listen: http://0.0.0.0:7781 - connect: http://user_api:7781 - account_database: - connection_string: file:///data/dendrite.db - max_open_conns: 10 - max_idle_conns: 2 - conn_max_lifetime: -1 - device_database: - connection_string: file:///data/dendrite.db - max_open_conns: 10 - 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 diff --git a/dendrite/dendrite-sample.in.yaml b/dendrite/dendrite-sample.in.yaml new file mode 100644 index 0000000..7affc25 --- /dev/null +++ b/dendrite/dendrite-sample.in.yaml @@ -0,0 +1,353 @@ +# 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. + +# The version of the configuration file. +version: 2 + +# 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. + # Note that this is NOT the same private key as used for TLS! To generate a + # signing key, use "./bin/generate-keys --private-key matrix_key.pem". + private_key: matrix_key.pem + + # The paths and expiry timestamps (as a UNIX timestamp in millisecond precision) + # to old signing keys that were formerly in use on this domain name. 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. + old_private_keys: + # If the old private key file is available: + # - private_key: old_matrix_key.pem + # expired_at: 1601024554498 + # If only the public key (in base64 format) and key ID are known: + # - public_key: mn59Kxfdq9VziYHSBzI7+EDPDcBS2Xl7jeUdiiQcOnM= + # key_id: ed25519:mykeyid + # expired_at: 1601024554498 + + # 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 monolith deployments using SQLite databases, + # you must configure the "database" block for each component instead. + database: + connection_string: postgresql://username:password@hostname/dendrite?sslmode=disable + max_open_conns: 90 + max_idle_conns: 5 + conn_max_lifetime: -1 + + # Configuration for in-memory caches. Caches can often improve performance by + # keeping frequently accessed items (like events, identifiers etc.) in memory + # rather than having to read them from the database. + cache: + # The estimated maximum size for the global cache in bytes, or in terabytes, + # gigabytes, megabytes or kilobytes when the appropriate 'tb', 'gb', 'mb' or + # 'kb' suffix is specified. Note that this is not a hard limit, nor is it a + # memory limit for the entire process. A cache that is too small may ultimately + # provide little or no benefit. + max_size_estimated: 1gb + + # The maximum amount of time that a cache entry can live for in memory before + # it will be evicted and/or refreshed from the database. Lower values result in + # easier admission of new cache entries but may also increase database load in + # comparison to higher values, so adjust conservatively. Higher values may make + # it harder for new items to make it into the cache, e.g. if new rooms suddenly + # become popular. + max_age: 1h + + # The server name to delegate server-server communications to, with optional port + # e.g. localhost:443 + well_known_server_name: "" + + # The base URL to delegate client-server communications to e.g. https://localhost + well_known_client_name: "" + + # The server name to delegate sliding sync communications to, with optional port. + # Requires `well_known_client_name` to also be configured. + well_known_sliding_sync_proxy: "" + + # 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 communicate with other servers + # in the Matrix federation and the federation API will not be exposed. + disable_federation: false + + # Configures the handling of presence events. Inbound controls whether we receive + # presence events from other servers, outbound controls whether we send presence + # events for our local users to other servers. + 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://panopticon.matrix.org/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. + addresses: + # - localhost:4222 + + # Disable the validation of TLS certificates of NATS. This is + # not recommended in production since it may allow NATS traffic + # to be sent to an insecure endpoint. + disable_tls_validation: false + + # Persistent directory to store JetStream streams in. This directory should be + # 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 + + # Configuration for Prometheus metric collection. + metrics: + enabled: false + basic_auth: + username: metrics + password: metrics + + # Optional DNS cache. The DNS cache may reduce the load on DNS servers if there + # is no local caching resolver available for use. + dns_cache: + enabled: false + cache_size: 256 + cache_lifetime: "5m" # 5 minutes; https://pkg.go.dev/time@master#ParseDuration + +# Configuration for the Appservice API. +app_service_api: + # 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 insecure endpoint. + disable_tls_validation: false + + # Appservice configuration files to load into this homeserver. + config_files: + # - /path/to/appservice_registration.yaml + +# Configuration for the Client API. +client_api: + # Prevents new users from being able to register on this homeserver, except when + # using the registration shared secret below. + registration_disabled: true + + # Prevents new guest accounts from being created. Guest registration is also + # 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: "" + + # Whether to require reCAPTCHA for registration. If you have enabled registration + # then this is HIGHLY RECOMMENDED to reduce the risk of your homeserver being used + # for coordinated spam attacks. + enable_registration_captcha: false + + # Settings for ReCAPTCHA. + recaptcha_public_key: "" + recaptcha_private_key: "" + recaptcha_bypass_secret: "" + + # To use hcaptcha.com instead of ReCAPTCHA, set the following parameters, otherwise just keep them empty. + # recaptcha_siteverify_api: "https://hcaptcha.com/siteverify" + # recaptcha_api_js_url: "https://js.hcaptcha.com/1/api.js" + # recaptcha_form_field: "h-captcha-response" + # recaptcha_sitekey_class: "h-captcha" + + + # TURN server information that this homeserver should send to clients. + turn: + turn_user_lifetime: "5m" + turn_uris: + # - turn:turn.server.org?transport=udp + # - turn:turn.server.org?transport=tcp + turn_shared_secret: "" + # If your TURN server requires static credentials, then you will need to enter + # them here instead of supplying a shared secret. Note that these credentials + # will be visible to clients! + # turn_username: "" + # turn_password: "" + + # Settings for rate-limited endpoints. Rate limiting kicks in after the threshold + # number of "slots" have been taken by requests from a specific host. Each "slot" + # will be released after the cooloff time in milliseconds. Server administrators + # and appservice users are exempt from rate limiting by default. + rate_limiting: + enabled: true + threshold: 20 + cooloff_ms: 500 + exempt_user_ids: + # - "@user:domain.com" + +# Configuration for the Federation API. +federation_api: + # 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. 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 + + # Disable HTTP keepalives, which also prevents connection reuse. Dendrite will typically + # keep HTTP connections open to remote hosts for 5 minutes as they can be reused much + # more quickly than opening new connections each time. Disabling keepalives will close + # HTTP connections immediately after a successful request but may result in more CPU and + # memory being used on TLS handshakes for each new connection instead. + disable_http_keepalives: false + + # 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) + +# Configuration for the Sync API. +sync_api: + # 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 full-text search engine. + search: + # Whether or not search is enabled. + enabled: false + + # The path where the search index will be created in. + index_path: "./searchindex" + + # The language most likely to be used on the server - used when indexing, to + # ensure the returned results match expectations. A full list of possible languages + # can be found at https://github.com/blevesearch/bleve/tree/master/analysis/lang + language: "en" + +# 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 should the database be compromised. Setting this higher makes registration/login + # consume more CPU resources but makes it harder to brute force password hashes. This value + # can be lowered if performing tests or on embedded Dendrite instances (e.g WASM builds). + bcrypt_cost: 10 + + # 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 + + # Users who register on this homeserver will automatically be joined to the rooms listed under "auto_join_rooms" option. + # By default, any room aliases included in this list will be created as a publicly joinable room + # when the first user registers for the homeserver. If the room already exists, + # make certain it is a publicly joinable room, i.e. the join rule of the room must be set to 'public'. + # As Spaces are just rooms under the hood, Space aliases may also be used. + auto_join_rooms: + # - "#main:matrix.org" + +# 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. The "std" logging type controls the logs being sent to +# 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: std + level: info + - type: file + level: info + params: + path: ./logs diff --git a/dendrite/dendrite.in.yaml b/dendrite/dendrite.in.yaml new file mode 100644 index 0000000..7c98765 --- /dev/null +++ b/dendrite/dendrite.in.yaml @@ -0,0 +1,409 @@ +# 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. + +# NOTES: +# ----------------------------------------------------------------------------- +# +# 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: 2 + +client_api: + registration_shared_secret: ${REGISTRATION_SHARED_SECRET} + +# Global Matrix configuration. This configuration applies to all components. +global: + # The domain name of this homeserver. + server_name: matrix.burd.me + + # The path to the signing private key file, used to sign requests and events. + # Note that this is NOT the same private key as used for TLS! To generate a + # signing key, use "./bin/generate-keys --private-key matrix_key.pem". + private_key: /etc/dendrite/matrix_key.pem + + # The paths and expiry timestamps (as a UNIX timestamp in millisecond precision) + # to old signing keys that were formerly in use on this domain name. 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. + old_private_keys: + # If the old private key file is available: + # - private_key: old_matrix_key.pem + # expired_at: 1601024554498 + # If only the public key (in base64 format) and key ID are known: + # - public_key: mn59Kxfdq9VziYHSBzI7+EDPDcBS2Xl7jeUdiiQcOnM= + # key_id: ed25519:mykeyid + # expired_at: 1601024554498 + + # 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 monolith deployments using SQLite databases, + # you must configure the "database" block for each component instead. + database: + connection_string: ${DATABASE_URL} + max_open_conns: 90 + max_idle_conns: 5 + conn_max_lifetime: -1 + + # Configuration for in-memory caches. Caches can often improve performance by + # keeping frequently accessed items (like events, identifiers etc.) in memory + # rather than having to read them from the database. + cache: + # The estimated maximum size for the global cache in bytes, or in terabytes, + # gigabytes, megabytes or kilobytes when the appropriate 'tb', 'gb', 'mb' or + # 'kb' suffix is specified. Note that this is not a hard limit, nor is it a + # memory limit for the entire process. A cache that is too small may ultimately + # provide little or no benefit. + max_size_estimated: 1gb + + # The maximum amount of time that a cache entry can live for in memory before + # it will be evicted and/or refreshed from the database. Lower values result in + # easier admission of new cache entries but may also increase database load in + # comparison to higher values, so adjust conservatively. Higher values may make + # it harder for new items to make it into the cache, e.g. if new rooms suddenly + # become popular. + max_age: 1h + + # The server name to delegate server-server communications to, with optional port + # e.g. localhost:443 + well_known_server_name: "" + + # The base URL to delegate client-server communications to e.g. https://localhost + well_known_client_name: "" + + # The server name to delegate sliding sync communications to, with optional port. + # Requires `well_known_client_name` to also be configured. + well_known_sliding_sync_proxy: "" + + # 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 communicate with other servers + # in the Matrix federation and the federation API will not be exposed. + disable_federation: false + + # Configures the handling of presence events. Inbound controls whether we receive + # presence events from other servers, outbound controls whether we send presence + # events for our local users to other servers. + presence: + enable_inbound: true + enable_outbound: true + + # 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: true + endpoint: https://panopticon.matrix.org/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. + addresses: + # - localhost:4222 + + # Disable the validation of TLS certificates of NATS. This is + # not recommended in production since it may allow NATS traffic + # to be sent to an insecure endpoint. + disable_tls_validation: false + + # Persistent directory to store JetStream streams in. This directory should be + # preserved across Dendrite restarts. + storage_path: /data/nats + + # 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 + + # Configuration for Kafka/Naffka. + kafka: + # List of Kafka broker addresses to connect to. This is not needed if using + # Naffka in monolith mode. + addresses: + - kafka:9092 + + # 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:///data/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: false + + # HTTP basic authentication to protect access to monitoring. + basic_auth: + username: metrics + password: metrics + + # Optional DNS cache. The DNS cache may reduce the load on DNS servers if there + # 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" # 5 minutes; https://pkg.go.dev/time@master#ParseDuration + +# Configuration for the AppService API. +app_service_api: + # 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 insecure endpoint. + disable_tls_validation: false + + # Appservice configuration files to load into this homeserver. + config_files: + # - /path/to/appservice_registration.yaml + + # Prevents new users from being able to register on this homeserver, except when + # using the registration shared secret below. + registration_disabled: true + + # Prevents new guest accounts from being created. Guest registration is also + # 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: "" + + # Whether to require reCAPTCHA for registration. If you have enabled registration + # then this is HIGHLY RECOMMENDED to reduce the risk of your homeserver being used + # for coordinated spam attacks. + enable_registration_captcha: false + + # Settings for ReCAPTCHA. + # recaptcha_public_key: "" + # recaptcha_private_key: "" + # recaptcha_bypass_secret: "" + + # To use hcaptcha.com instead of ReCAPTCHA, set the following parameters, otherwise just keep them empty. + # recaptcha_siteverify_api: "https://hcaptcha.com/siteverify" + # recaptcha_api_js_url: "https://js.hcaptcha.com/1/api.js" + # recaptcha_form_field: "h-captcha-response" + # recaptcha_sitekey_class: "h-captcha" + + + # TURN server information that this homeserver should send to clients. + turn: + turn_user_lifetime: "5m" + turn_uris: + # - turn:turn.server.org?transport=udp + # - turn:turn.server.org?transport=tcp + turn_shared_secret: "" + # If your TURN server requires static credentials, then you will need to enter + # them here instead of supplying a shared secret. Note that these credentials + # will be visible to clients! + # turn_username: "" + # turn_password: "" + + # Settings for rate-limited endpoints. Rate limiting kicks in after the threshold + # number of "slots" have been taken by requests from a specific host. Each "slot" + # will be released after the cooloff time in milliseconds. Server administrators + # and appservice users are exempt from rate limiting by default. + rate_limiting: + enabled: true + threshold: 20 + cooloff_ms: 500 + exempt_user_ids: + # - "@user:domain.com" + +# Configuration for the Federation API. +federation_api: + # 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. 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 + + # Disable HTTP keepalives, which also prevents connection reuse. Dendrite will typically + # keep HTTP connections open to remote hosts for 5 minutes as they can be reused much + # more quickly than opening new connections each time. Disabling keepalives will close + # HTTP connections immediately after a successful request but may result in more CPU and + # memory being used on TLS handshakes for each new connection instead. + disable_http_keepalives: false + + # 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: /data/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) + +# Configuration for the Sync API. +sync_api: + # 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 full-text search engine. + search: + # Whether or not search is enabled. + enabled: true + + # The path where the search index will be created in. + index_path: "/data/searchindex" + + # The language most likely to be used on the server - used when indexing, to + # ensure the returned results match expectations. A full list of possible languages + # can be found at https://github.com/blevesearch/bleve/tree/master/analysis/lang + language: "en" + +# Configuration for the 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 should the database be compromised. Setting this higher makes registration/login + # consume more CPU resources but makes it harder to brute force password hashes. This value + # can be lowered if performing tests or on embedded Dendrite instances (e.g WASM builds). + bcrypt_cost: 10 + + # 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 + + # Users who register on this homeserver will automatically be joined to the rooms listed under "auto_join_rooms" option. + # By default, any room aliases included in this list will be created as a publicly joinable room + # when the first user registers for the homeserver. If the room already exists, + # make certain it is a publicly joinable room, i.e. the join rule of the room must be set to 'public'. + # As Spaces are just rooms under the hood, Space aliases may also be used. + auto_join_rooms: + - "#main:matrix.burd.me" + +# 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. The "std" logging type controls the logs being sent to +# 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: std + level: info + - type: file + level: info + params: + path: /var/logs/dendrite diff --git a/dendrite/docker-entrypoint.sh b/dendrite/docker-entrypoint.sh new file mode 100755 index 0000000..f0071b9 --- /dev/null +++ b/dendrite/docker-entrypoint.sh @@ -0,0 +1,9 @@ +#!/bin/sh + +set -euo pipefail + +envsubst < /etc/dendrite/dendrite.in.yaml > /etc/dendrite/dendrite.yaml +echo ${MATRIX_KEY_PEM} | base64 -d > /etc/dendrite/matrix_key.pem +chmod 0660 /etc/dendrite/matrix_key.pem + +/usr/bin/dendrite diff --git a/dendrite/fly.toml b/dendrite/fly.toml index 883bbb3..6d55938 100644 --- a/dendrite/fly.toml +++ b/dendrite/fly.toml @@ -1,29 +1,38 @@ -app = "dendrite-on-fly" +# fly.toml app configuration file generated for burd-infra-dendrite on 2023-10-24T10:06:17-04:00 +# +# See https://fly.io/docs/reference/configuration/ for information about how to use this file. +# +app = "burd-infra-dendrite" +primary_region = "bos" kill_signal = "SIGINT" -kill_timeout = 20 +kill_timeout = "20s" + +[build] + +[env] + DENDRITE__global__database__connection_string = "${DATABASE_URL}" + +[[mounts]] + source = "dendrite_data" + destination = "/data" [[services]] - internal_port = 8008 protocol = "tcp" + internal_port = 8008 + [[services.ports]] + port = 443 + handlers = ["tls", "http"] + + [[services.ports]] + port = 8443 + handlers = ["tls", "http"] [services.concurrency] hard_limit = 100 soft_limit = 80 - [[services.ports]] - handlers = ["tls", "http"] - port = "443" - - [[services.ports]] - handlers = ["tls", "http"] - port = "8443" - [[services.tcp_checks]] interval = "10s" - grace_period = "5s" timeout = "2s" - -[mounts] -source="dendrite_data" -destination="/data" + grace_period = "5s" From fc29b7c9fc3ff872aacd7c8a565ec6faac8728de Mon Sep 17 00:00:00 2001 From: Greg Burd Date: Wed, 25 Oct 2023 10:51:54 -0400 Subject: [PATCH 3/6] house keeping --- .env | 0 .envrc | 6 ++++++ .gitignore | 3 ++- shell.nix | 10 ++++++++++ 4 files changed, 18 insertions(+), 1 deletion(-) create mode 100644 .env create mode 100644 .envrc create mode 100644 shell.nix diff --git a/.env b/.env new file mode 100644 index 0000000..e69de29 diff --git a/.envrc b/.envrc new file mode 100644 index 0000000..9d142d2 --- /dev/null +++ b/.envrc @@ -0,0 +1,6 @@ +dotenv +#[ -d .venv ] || (python -m venv .venv; python -m pip install rbtools) +#[ -f .venv/bin/activate ] && source .venv/bin/activate +watch_file devShell.nix shell.nix flake.nix +#use flake || use nix + diff --git a/.gitignore b/.gitignore index a23f68e..085e004 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ +.direnv/ .nvimlog -*.priv.* \ No newline at end of file +*.priv.* diff --git a/shell.nix b/shell.nix new file mode 100644 index 0000000..e74aab0 --- /dev/null +++ b/shell.nix @@ -0,0 +1,10 @@ +{ pkgs ? import {} }: + +pkgs.mkShell { + # nativeBuildInputs is usually what you want -- tools you need to run + nativeBuildInputs = with pkgs.buildPackages; [ + ripgrep + envsubst + ]; + DOCKER_BUILDKIT = 1; +} From 35421db73dc86264455558fcb80a0ca76b375bee Mon Sep 17 00:00:00 2001 From: Greg Burd Date: Wed, 25 Oct 2023 10:55:53 -0400 Subject: [PATCH 4/6] fix docs --- dendrite/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/dendrite/README.md b/dendrite/README.md index 9c213e3..49e440c 100644 --- a/dendrite/README.md +++ b/dendrite/README.md @@ -52,7 +52,7 @@ flyctl deploy ```shell flyctl secrets set "DATABASE_URL=postgresql://user:pass@hostname/database?params=..." -flyctl secrets set "REGISTRATION_SHARED_SECRET=" +flyctl secrets set "REGISTRATION_SHARED_SECRET=imabad5cret!" base64 -w0 matrix_key.pem | flyctl secrets set MATRIX_KEY_PEM=- ``` From c949ca01ebb4e4a041dd83948b361857e6124a0b Mon Sep 17 00:00:00 2001 From: Greg Burd Date: Wed, 25 Oct 2023 11:03:09 -0400 Subject: [PATCH 5/6] more closely align config and sample config --- dendrite/dendrite-sample.in.yaml | 76 +++++++++++++++++++++++++++----- dendrite/dendrite.in.yaml | 21 ++++----- 2 files changed, 75 insertions(+), 22 deletions(-) diff --git a/dendrite/dendrite-sample.in.yaml b/dendrite/dendrite-sample.in.yaml index 7affc25..7c6232f 100644 --- a/dendrite/dendrite-sample.in.yaml +++ b/dendrite/dendrite-sample.in.yaml @@ -4,9 +4,39 @@ # configuration section, in addition to the "global" section which applies to # all components. +# NOTES: +# ----------------------------------------------------------------------------- +# +# 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: 2 +client_api: + registration_shared_secret: ${REGISTRATION_SHARED_SECRET} + # Global Matrix configuration. This configuration applies to all components. global: # The domain name of this homeserver. @@ -41,7 +71,7 @@ global: # sections. For monolith deployments using SQLite databases, # you must configure the "database" block for each component instead. database: - connection_string: postgresql://username:password@hostname/dendrite?sslmode=disable + connection_string: ${DATABASE_URL} max_open_conns: 90 max_idle_conns: 5 conn_max_lifetime: -1 @@ -90,14 +120,14 @@ global: # presence events from other servers, outbound controls whether we send presence # events for our local users to other servers. presence: - enable_inbound: false - enable_outbound: false + enable_inbound: true + enable_outbound: true # 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 + enabled: true endpoint: https://panopticon.matrix.org/push # Server notices allows server admins to send messages to all users on the server. @@ -127,15 +157,39 @@ global: # Persistent directory to store JetStream streams in. This directory should be # preserved across Dendrite restarts. - storage_path: ./ + storage_path: /data/nats # 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 + # Configuration for Kafka/Naffka. + kafka: + # List of Kafka broker addresses to connect to. This is not needed if using + # Naffka in monolith mode. + addresses: + - kafka:9092 + + # 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:///data/dendrite.db + max_open_conns: 10 + max_idle_conns: 2 + conn_max_lifetime: -1 + # Configuration for Prometheus metric collection. metrics: enabled: false + # HTTP basic authentication to protect access to monitoring. basic_auth: username: metrics password: metrics @@ -144,6 +198,8 @@ global: # is no local caching resolver available for use. dns_cache: 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" # 5 minutes; https://pkg.go.dev/time@master#ParseDuration @@ -251,7 +307,7 @@ federation_api: # Configuration for the Media API. media_api: # Storage path for uploaded media. May be relative or absolute. - base_path: ./media_store + base_path: /data/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 @@ -291,10 +347,10 @@ sync_api: # Configuration for the full-text search engine. search: # Whether or not search is enabled. - enabled: false + enabled: true # The path where the search index will be created in. - index_path: "./searchindex" + index_path: "/data/searchindex" # The language most likely to be used on the server - used when indexing, to # ensure the returned results match expectations. A full list of possible languages @@ -325,7 +381,7 @@ user_api: auto_join_rooms: # - "#main:matrix.org" -# Configuration for Opentracing. +# 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: @@ -350,4 +406,4 @@ logging: - type: file level: info params: - path: ./logs + path: /var/logs/dendrite diff --git a/dendrite/dendrite.in.yaml b/dendrite/dendrite.in.yaml index 7c98765..e86a9d0 100644 --- a/dendrite/dendrite.in.yaml +++ b/dendrite/dendrite.in.yaml @@ -34,9 +34,6 @@ # The version of the configuration file. version: 2 -client_api: - registration_shared_secret: ${REGISTRATION_SHARED_SECRET} - # Global Matrix configuration. This configuration applies to all components. global: # The domain name of this homeserver. @@ -188,9 +185,7 @@ global: # 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 @@ -199,14 +194,13 @@ global: # Optional DNS cache. The DNS cache may reduce the load on DNS servers if there # 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" # 5 minutes; https://pkg.go.dev/time@master#ParseDuration -# Configuration for the AppService API. +# Configuration for the Appservice API. app_service_api: # Disable the validation of TLS certificates of appservices. This is # not recommended in production since it may allow appservice traffic @@ -217,6 +211,8 @@ app_service_api: config_files: # - /path/to/appservice_registration.yaml +# Configuration for the Client API. +client_api: # Prevents new users from being able to register on this homeserver, except when # using the registration shared secret below. registration_disabled: true @@ -227,7 +223,7 @@ app_service_api: # If set, allows registration by anyone who knows the shared secret, regardless # of whether registration is otherwise disabled. - registration_shared_secret: "" + registration_shared_secret: ${REGISTRATION_SHARED_SECRET} # Whether to require reCAPTCHA for registration. If you have enabled registration # then this is HIGHLY RECOMMENDED to reduce the risk of your homeserver being used @@ -235,9 +231,9 @@ app_service_api: enable_registration_captcha: false # Settings for ReCAPTCHA. - # recaptcha_public_key: "" - # recaptcha_private_key: "" - # recaptcha_bypass_secret: "" + recaptcha_public_key: "" + recaptcha_private_key: "" + recaptcha_bypass_secret: "" # To use hcaptcha.com instead of ReCAPTCHA, set the following parameters, otherwise just keep them empty. # recaptcha_siteverify_api: "https://hcaptcha.com/siteverify" @@ -359,6 +355,7 @@ sync_api: language: "en" # 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 @@ -379,7 +376,7 @@ sync_api: # make certain it is a publicly joinable room, i.e. the join rule of the room must be set to 'public'. # As Spaces are just rooms under the hood, Space aliases may also be used. auto_join_rooms: - - "#main:matrix.burd.me" + # - "#main:matrix.org" # Configuration for OpenTracing. # See https://github.com/matrix-org/dendrite/tree/master/docs/tracing for information on From aa1351d743c0d3a3fa2aeafa8abbd292de87b652 Mon Sep 17 00:00:00 2001 From: Greg Burd Date: Wed, 25 Oct 2023 11:04:37 -0400 Subject: [PATCH 6/6] remove unused env var --- dendrite/fly.toml | 3 --- 1 file changed, 3 deletions(-) diff --git a/dendrite/fly.toml b/dendrite/fly.toml index 6d55938..d6d6e39 100644 --- a/dendrite/fly.toml +++ b/dendrite/fly.toml @@ -10,9 +10,6 @@ kill_timeout = "20s" [build] -[env] - DENDRITE__global__database__connection_string = "${DATABASE_URL}" - [[mounts]] source = "dendrite_data" destination = "/data"