From fd5b6b2c3690831defe0dae50f90d44ce1d5ae55 Mon Sep 17 00:00:00 2001 From: Greg Burd Date: Mon, 23 Oct 2023 10:12:45 -0400 Subject: [PATCH] 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"