diff --git a/README.md b/README.md
index 6bc0e14..ceb0098 100644
--- a/README.md
+++ b/README.md
@@ -24,7 +24,7 @@ Dendrite is a second-generation Matrix homeserver written in Go. It intends to p
- Scalable: can run on multiple machines and eventually scale to massive homeserver deployments.
-**Shipped version:** 0.9.9~ynh3
+**Shipped version:** 0.10.0~ynh1 *(:warning: This is the `ci-auto-update-v0.10.0` branch. The [`master` branch](https://github.com/YunoHost-Apps/dendrite_ynh/tree/master) used in the catalog is currently on version 0.9.9\~ynh3.)*
## Disclaimers / important information
@@ -38,6 +38,10 @@ Dendrite is a second-generation Matrix homeserver written in Go. It intends to p
* Dendrite does not implement secondary user registration schemes yet, so YunoHost users cannot be integrated at the moment.
+## :red_circle: Antifeatures
+
+- **Alpha software**: Early development stage. May contain changing or unstable features, bugs, and security vulnerability.
+
## Documentation and resources
* Official app website:
diff --git a/README_fr.md b/README_fr.md
index fda0de3..96e027c 100644
--- a/README_fr.md
+++ b/README_fr.md
@@ -24,7 +24,7 @@ Dendrite is a second-generation Matrix homeserver written in Go. It intends to p
- Scalable: can run on multiple machines and eventually scale to massive homeserver deployments.
-**Version incluse :** 0.9.9~ynh3
+**Version incluse :** 0.10.0~ynh1 *(:warning: Il s'agit de la branche `ci-auto-update-v0.10.0`. La [branche `master`](https://github.com/YunoHost-Apps/dendrite_ynh/tree/master) utilisée dans le catalogue est actuellement en 0.9.9\~ynh3.)*
## Avertissements / informations importantes
@@ -38,6 +38,10 @@ Dendrite is a second-generation Matrix homeserver written in Go. It intends to p
* Dendrite does not implement secondary user registration schemes yet, so YunoHost users cannot be integrated at the moment.
+## :red_circle: Fonctions indésirables
+
+- **Alpha software**: Early development stage. May contain changing or unstable features, bugs, and security vulnerability.
+
## Documentations et ressources
* Site officiel de l'app :
diff --git a/conf/app.src b/conf/app.src
index b15e1fe..8010386 100644
--- a/conf/app.src
+++ b/conf/app.src
@@ -1,5 +1,5 @@
-SOURCE_URL=https://api.github.com/repos/matrix-org/dendrite/tarball/v0.9.9
-SOURCE_SUM=8fb10221399961efb5ec31ec65e94f87a20f09c48c5ef4eb1d7cef161afa7ed3
+SOURCE_URL=https://api.github.com/repos/matrix-org/dendrite/tarball/v0.10.0
+SOURCE_SUM=fc896ec001904760ed6d37cab1661abf174128c20bbbdd910babc2335dd065be
SOURCE_SUM_PRG=sha256sum
SOURCE_FORMAT=tar.gz
SOURCE_IN_SUBDIR=true
diff --git a/conf/dendrite.yaml b/conf/dendrite.yaml
index e334ec7..8bbde43 100644
--- a/conf/dendrite.yaml
+++ b/conf/dendrite.yaml
@@ -3,31 +3,8 @@
# 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.
+# The version of the configuration file.
version: 2
# Global Matrix configuration. This configuration applies to all components.
@@ -44,9 +21,9 @@ global:
# 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
+ 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
@@ -54,102 +31,128 @@ global:
# 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 polylith deployments, or monolith deployments using SQLite databases,
+ # you must configure the "database" block for each component instead.
+ database:
+ connection_string: postgres://__DB_USER__:__DB_PWD__@localhost/__DB_NAME__?sslmode=disable
+ max_open_conns: 100
+ 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 server name to delegate client-server communications to, with optional port
+ # e.g. localhost:443
+ well_known_client_name: ""
+
# 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
+ - matrix.org
+ - vector.im
- # Disables federation. Dendrite will not be able to make any outbound HTTP requests
- # to other servers and the federation API will not be exposed.
+ # 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
- # Server notices allows server admins to send messages to all users.
+ # 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://matrix.org/report-usage-stats/push
+
+ # Server notices allows server admins to send messages to all users on the server.
server_notices:
enabled: false
- # The server localpart to be used when sending notices, ensure this is not yet taken
+ # 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"
- # The displayname to be used when sending notices
- display_name: "Server alerts"
- # The mxid of the avatar to use
+ display_name: "Server Alerts"
avatar_url: ""
- # The roomname to be used when creating messages
+ # 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. It is required to specify the address of at least one
- # NATS Server node if running in polylith mode.
+ # internal NATS server will be started automatically when running Dendrite in
+ # monolith mode. For polylith deployments, it is required to specify the address
+ # of at least one NATS Server node.
addresses:
# - localhost:4222
- # Keep all NATS streams in memory, rather than persisting it to the storage
- # path below. This option is present primarily for integration testing and
- # should not be used on a real world Dendrite deployment.
- in_memory: false
+ # 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.
+ # 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 running more than one Dendrite on the same NATS deployment.
+ # 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:
- # 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.
+ # 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: true
-
- # Maximum number of entries to hold in the DNS cache, and
- # for how long those items should be considered valid in seconds.
cache_size: 4096
- cache_lifetime: "10m" # 5minutes; see https://pkg.go.dev/time@master#ParseDuration for more
+ cache_lifetime: "10m" # 5 minutes; https://pkg.go.dev/time@master#ParseDuration
# Configuration for the Appservice API.
app_service_api:
- internal_api:
- listen: http://localhost:7777 # Only used in polylith deployments
- connect: http://localhost:7777 # Only used in polylith deployments
- database:
- connection_string: postgres://__DB_USER__:__DB_PWD__@localhost/__DB_NAME__
- max_open_conns: 10
- max_idle_conns: 2
- conn_max_lifetime: -1
-
# 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 unverified endpoint.
+ # to be sent to an insecure endpoint.
disable_tls_validation: false
# Appservice configuration files to load into this homeserver.
- config_files: []
+ config_files:
+ # - /path/to/appservice_registration.yaml
# Configuration for the Client API.
client_api:
- internal_api:
- listen: http://localhost:7771 # Only used in polylith deployments
- connect: http://localhost:7771 # Only used in polylith deployments
- external_api:
- listen: http://[::]:8071
-
# Prevents new users from being able to register on this homeserver, except when
# using the registration shared secret below.
registration_disabled: __REGISTRATION_DISABLED__
@@ -158,68 +161,64 @@ client_api:
# 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.
+ # 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.
+ # 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.
+ # 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 server information that this homeserver should send to clients.
turn:
- turn_user_lifetime: ""
- turn_uris: []
+ turn_user_lifetime: "5m"
+ turn_uris:
+ # - turn:turn.server.org?transport=udp
+ # - turn:turn.server.org?transport=tcp
turn_shared_secret: ""
- turn_username: ""
- turn_password: ""
+ # 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 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.
+ # 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: 5
+ threshold: 20
cooloff_ms: 500
-
-# Configuration for the EDU server.
-edu_server:
- internal_api:
- listen: http://localhost:7778 # Only used in polylith deployments
- connect: http://localhost:7778 # Only used in polylith deployments
+ exempt_user_ids:
+ # - "@user:domain.com"
# Configuration for the Federation API.
federation_api:
- internal_api:
- listen: http://localhost:7772 # Only used in polylith deployments
- connect: http://localhost:7772 # Only used in polylith deployments
- external_api:
- listen: http://[::]:8072
- database:
- connection_string: postgres://__DB_USER__:__DB_PWD__@localhost/__DB_NAME__
- max_open_conns: 10
- max_idle_conns: 2
- conn_max_lifetime: -1
-
- # 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: []
-
# 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.
+ # 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.
@@ -236,36 +235,14 @@ federation_api:
# last resort.
prefer_direct_fetch: false
-# Configuration for the Key Server (for end-to-end encryption).
-key_server:
- internal_api:
- listen: http://localhost:7779 # Only used in polylith deployments
- connect: http://localhost:7779 # Only used in polylith deployments
- database:
- connection_string: postgres://__DB_USER__:__DB_PWD__@localhost/__DB_NAME__
- max_open_conns: 10
- max_idle_conns: 2
- conn_max_lifetime: -1
-
# Configuration for the Media API.
media_api:
- internal_api:
- listen: http://localhost:7774 # Only used in polylith deployments
- connect: http://localhost:7774 # Only used in polylith deployments
- external_api:
- listen: http://[::]:8074
- database:
- connection_string: postgres://__DB_USER__:__DB_PWD__@localhost/__DB_NAME__
- max_open_conns: 5
- max_idle_conns: 2
- conn_max_lifetime: -1
-
# Storage path for uploaded media. May be relative or absolute.
base_path: ./media_store
# The maximum allowed file size (in bytes) for media uploads to this homeserver
- # (0 = unlimited). If using a reverse proxy, ensure it allows requests at
- # least this large (e.g. client_max_body_size in nginx.)
+ # (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.
@@ -276,75 +253,52 @@ media_api:
# 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
+ - width: 32
+ height: 32
+ method: crop
+ - width: 96
+ height: 96
+ method: crop
+ - width: 640
+ height: 480
+ method: scale
-# Configuration for experimental MSC's
+# Configuration for enabling experimental MSCs on this homeserver.
mscs:
- # A list of enabled MSC's
- # Currently valid values are:
- # - msc2836 (Threading, see https://github.com/matrix-org/matrix-doc/pull/2836)
- # - msc2946 (Spaces Summary, see https://github.com/matrix-org/matrix-doc/pull/2946)
- mscs: []
- database:
- connection_string: postgres://__DB_USER__:__DB_PWD__@localhost/__DB_NAME__
- max_open_conns: 5
- max_idle_conns: 2
- conn_max_lifetime: -1
-
-# Configuration for the Room Server.
-room_server:
- internal_api:
- listen: http://localhost:7770 # Only used in polylith deployments
- connect: http://localhost:7770 # Only used in polylith deployments
- database:
- connection_string: postgres://__DB_USER__:__DB_PWD__@localhost/__DB_NAME__
- max_open_conns: 10
- max_idle_conns: 2
- conn_max_lifetime: -1
+ mscs:
+ - msc2836 # (Threading, see https://github.com/matrix-org/matrix-doc/pull/2836)
+ - msc2946 # (Spaces Summary, see https://github.com/matrix-org/matrix-doc/pull/2946)
# Configuration for the Sync API.
sync_api:
- internal_api:
- listen: http://localhost:7773 # Only used in polylith deployments
- connect: http://localhost:7773 # Only used in polylith deployments
- external_api:
- listen: http://[::]:8073
- database:
- connection_string: postgres://__DB_USER__:__DB_PWD__@localhost/__DB_NAME__
- max_open_conns: 10
- max_idle_conns: 2
- conn_max_lifetime: -1
-
# 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: "./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 low if performing tests or on embedded Dendrite instances (e.g WASM builds)
- # bcrypt_cost: 10
- internal_api:
- listen: http://localhost:7781 # Only used in polylith deployments
- connect: http://localhost:7781 # Only used in polylith deployments
- account_database:
- connection_string: postgres://__DB_USER__:__DB_PWD__@localhost/__DB_NAME__
- max_open_conns: 10
- max_idle_conns: 2
- conn_max_lifetime: -1
+ # 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.
@@ -367,12 +321,13 @@ tracing:
baggage_restrictions: null
throttler: null
-# Logging configuration
+# 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
- # The logging level, must be one of debug, info, warn, error, fatal, panic.
- level: info
+ level: warn
params:
path: /var/log/__APP__
diff --git a/conf/systemd.service b/conf/systemd.service
index a37eabc..15da083 100644
--- a/conf/systemd.service
+++ b/conf/systemd.service
@@ -8,7 +8,7 @@ User=__APP__
Group=__APP__
WorkingDirectory=__FINALPATH__/
ExecStart=__FINALPATH__/bin/dendrite-monolith-server --tls-cert=/etc/yunohost/certs/__DOMAIN__/crt.pem --tls-key=/etc/yunohost/certs/__DOMAIN__/key.pem --config=dendrite.yaml --http-bind-address=:__PORT__ --https-bind-address=:__TLS_PORT__ __REALLY_ENABLE_OPEN_REGISTRATION__
-StandardOutput=append:/var/log/__APP__/__APP__.log
+StandardOutput=journal
StandardError=inherit
LimitNOFILE=65535
diff --git a/manifest.json b/manifest.json
index d81bcaf..c9afb3b 100644
--- a/manifest.json
+++ b/manifest.json
@@ -6,7 +6,7 @@
"en": "Matrix homeserver of second generation",
"fr": "Serveur Matrix de seconde génération"
},
- "version": "0.9.9~ynh3",
+ "version": "0.10.0~ynh1",
"url": "https://matrix.org/",
"upstream": {
"license": "Apache-2.0",