Config, certs and script to run local dendrite test server

This commit is contained in:
sergekh2 2022-07-12 10:51:14 -07:00
parent 7cbc3850d2
commit 6c2a82bf7d
6 changed files with 489 additions and 0 deletions

13
local_test/README.md Normal file
View file

@ -0,0 +1,13 @@
# Run local dendirete test server
Build from project root:
```bash
./build.sh
```
Then run dendrite monolith server with test config:
```bash
./local_test/run.sh
```

383
local_test/dendrite.yaml Normal file
View file

@ -0,0 +1,383 @@
# 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: 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 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
# The server name to delegate server-server communications to, with optional port
# e.g. localhost:443
well_known_server_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
# Disables federation. Dendrite will not be able to make any outbound HTTP requests
# to other servers and the federation API will not be exposed.
disable_federation: false
# Configures the handling of presence events.
presence:
# Whether inbound presence events are allowed, e.g. receiving presence events from other servers
enable_inbound: false
# Whether outbound presence events are allowed, e.g. sending presence events to other servers
enable_outbound: false
# Server notices allows server admins to send messages to all users.
server_notices:
enabled: false
# The server localpart to be used when sending notices, ensure this is not yet taken
local_part: "_server"
# The displayname to be used when sending notices
display_name: "Server alerts"
# The mxid of the avatar to use
avatar_url: ""
# The roomname to be used when creating messages
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.
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
# 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.
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.
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" # 5minutes; see https://pkg.go.dev/time@master#ParseDuration for more
# 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: file:appservice.db
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.
disable_tls_validation: false
# Appservice configuration files to load into this homeserver.
config_files: []
# 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: false
# 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: ""
# Disable password authentication.
password_authentication_disabled: false
# public key authentication
public_key_authentication:
ethereum:
enabled: true
version: 1
chain_ids: [4] # https://chainlist.org/
# 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 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: file:federationapi.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
# 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 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: file:keyserver.db
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: file:mediaapi.db
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.)
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 experimental MSC's
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: [msc2946]
database:
connection_string: file:mscs.db
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: file:roomserver.db
max_open_conns: 10
max_idle_conns: 2
conn_max_lifetime: -1
# 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: file:syncapi.db
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 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: file:userapi_accounts.db
max_open_conns: 10
max_idle_conns: 2
conn_max_lifetime: -1
# 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
# 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
logging:
- type: std
level: info
- type: file
# The logging level, must be one of debug, info, warn, error, fatal, panic.
level: info
params:
path: ./logs

View file

@ -0,0 +1,5 @@
-----BEGIN MATRIX PRIVATE KEY-----
Key-ID: ed25519:2Wof34
f34OhC7xbKGCcA/fpH3iTMAURhqvCe9rGI4JA099l/g=
-----END MATRIX PRIVATE KEY-----

9
local_test/run.sh Executable file
View file

@ -0,0 +1,9 @@
#!/bin/bash -eu
cd $(dirname "$0")
../bin/dendrite-monolith-server \
--tls-cert server.crt \
--tls-key server.key \
--config dendrite.yaml \
--really-enable-open-registration

28
local_test/server.crt Normal file
View file

@ -0,0 +1,28 @@
-----BEGIN CERTIFICATE-----
MIIEvzCCAqegAwIBAgIQPIVV4A5e74rWm5UqwCgeLTANBgkqhkiG9w0BAQsFADAA
MB4XDTIyMDcxMjE3MTM0NVoXDTMyMDcwOTE3MTM0NVowADCCAiIwDQYJKoZIhvcN
AQEBBQADggIPADCCAgoCggIBAMgkrQS4iqrC+iy5WvthG44Uh0Cqeki2uWAkKvH9
eWrT49FO9eNGZIsNbXs0gFW8n15+eHzfSpAgzxxXzEZ/NaEBTWPCaUTbexjETU7y
u18ejL72ZwFweT5FEaMK5DaH+Vw0e2FuztKRnJq89ND7WFnSKJNjQcRWMzTO+xeA
aineRfSsiRmNqCbeJGsNAuBXpSoYum1Vc6RBV7vk1du3xLmx1l6faSD4FIE/rCC5
eKXI6CkHHji6ZMnJD71vGKoFjW7+WeJ4HD8rY98q1h/VA0dNhZqwVlCDhvVUoy4M
eyWW47ZP7pSA0Fv94sP59kTiVsC4M8HpWc7WnlgZdzEazCEtPz/JMCakjr5aUKdW
yy08z29lLR8MaVQYl2SwhOrEB4n5Zhw/ilBgjrSF7acsKnMRZLk9kXQ6hRNpHegv
BmcwcSsOZl8h2yOvRVVhNYmWkKwq/cguItBedxsYvGP1K0oA9DOKxikyMI+o+vgq
YAAO0tVt+PFpR36ANIMT1WFP0hDZmosadW69X27VsUIU2eHmCidqEUU+DP7pWcUt
us5Z5RNp7vmVvzcIHWMjpuTqrzhCSsizh6J7XEAMlPawNRcntIsL6C6sJ6Asr1OJ
N6eR8op0T98oxmf85rxGJxh4q1chXls1LyJxKryrTaFkZe4dsnhj2UbIxswUl/PF
vB6jAgMBAAGjNTAzMA4GA1UdDwEB/wQEAwIFoDATBgNVHSUEDDAKBggrBgEFBQcD
ATAMBgNVHRMBAf8EAjAAMA0GCSqGSIb3DQEBCwUAA4ICAQAh+Nxwx6Ad+SFmaJ2X
8GYXr192s5EEC/T/dEDXOvLu6/XuXX60j4YlkaGEuYZWBNONAiKi/eYYklhUu9Gi
GYBN35GQbLBlPHk7N2W4XcsdYE0evXi42GymcrNdo6BviFkTeoz1MhdHlEVH3LJi
lLhWf87+e6Z/0vFGEwkoDDGsXLuDAerSBjmZOs5b06OfmO4T7XOVPoANc4bZGvte
PZ8mTqm67lJxcrGUe7nT87cHFmaDK/QNAVW5gsSkMnf1xmsKyS8zA/m8LNpk41wL
suTdQBG9tURKNjVwhUlbLUbxwrDeN/1ioBjOmaOSTvSLwyuLgBhE7zOxpvUkE+k5
YfR/7seEl/K9tV1+IIDzQ9565anRhlgonTPBwzhEXT8uFe3d1E/Un1HGcxBYf9lk
j+IyjiI6rqjA96PiDiyrlDi4n7Y14uqDgDJaJJ9T8xpqcFunRMZe8cljkAmLO8c9
W4Ozbpqh3V1Zbu/tVwUzoeE1Ap+IAkAakGxGY+Jgzy4p7vCd7QSKJM+9lqeDSUVW
qEtZ3OK/fsBFQkcBHpZTm6Oj5ymzpQOnqxSE+lnUnlVOAFFmprS094/tL1Kzlr0i
UacIWlFGPxOaeT81kO0Loo3J0lyHK8f4uy144opjJobRKatv519HFoa5mqOJJck2
rFlb5szgzwSfEcg+lLRDt4H7yg==
-----END CERTIFICATE-----

51
local_test/server.key Normal file
View file

@ -0,0 +1,51 @@
-----BEGIN RSA PRIVATE KEY-----
MIIJKAIBAAKCAgEAyCStBLiKqsL6LLla+2EbjhSHQKp6SLa5YCQq8f15atPj0U71
40Zkiw1tezSAVbyfXn54fN9KkCDPHFfMRn81oQFNY8JpRNt7GMRNTvK7Xx6MvvZn
AXB5PkURowrkNof5XDR7YW7O0pGcmrz00PtYWdIok2NBxFYzNM77F4BqKd5F9KyJ
GY2oJt4kaw0C4FelKhi6bVVzpEFXu+TV27fEubHWXp9pIPgUgT+sILl4pcjoKQce
OLpkyckPvW8YqgWNbv5Z4ngcPytj3yrWH9UDR02FmrBWUIOG9VSjLgx7JZbjtk/u
lIDQW/3iw/n2ROJWwLgzwelZztaeWBl3MRrMIS0/P8kwJqSOvlpQp1bLLTzPb2Ut
HwxpVBiXZLCE6sQHiflmHD+KUGCOtIXtpywqcxFkuT2RdDqFE2kd6C8GZzBxKw5m
XyHbI69FVWE1iZaQrCr9yC4i0F53Gxi8Y/UrSgD0M4rGKTIwj6j6+CpgAA7S1W34
8WlHfoA0gxPVYU/SENmaixp1br1fbtWxQhTZ4eYKJ2oRRT4M/ulZxS26zlnlE2nu
+ZW/NwgdYyOm5OqvOEJKyLOHontcQAyU9rA1Fye0iwvoLqwnoCyvU4k3p5HyinRP
3yjGZ/zmvEYnGHirVyFeWzUvInEqvKtNoWRl7h2yeGPZRsjGzBSX88W8HqMCAwEA
AQKCAgBqSngMmskh+RyN5f54pFDS+vn9kMwSk+ANPAgGrjvuTQufXFTf18GLy5zK
Is7JObxVncr1XkymEJaNkd8tzV84240zHstzQzCzrYT1GZoC4SGURR3dONNbC6lb
MmySvVHj8wdXblauo6BM2W8XEXURdrgP1lXWJIVbVVUqXQuEosP6Nis1g/K6eZ1T
sPxHEqTnn2xaplgc8oragaRF5Om4SMb1R6m4VafmIF+UnYuCWBlbuKkHLY5bT8lp
LHgny30aZkBsMqelsLCAk6pWC3WLR5Nd3KpqZf+liMaErSI1i1Xxu6+T9Hkzcbkd
pUFxwdaa0PjD0d7dJ0O+u/9996JSRp9/Uxu2gTI09Ck1wJE8+IEfv3XahlHrxPJt
0Uf+IkcRoWCYrqFoiCyIsvIRqKKTUo9DeXNqBUWEykwuAyxdygEGvowZJdAqI/IC
ax8KCc0kGnhguS3DrRr0mx/HyoppNkshCJTpzd6q9FG7IqCaXoVMOl5bdJ5vTOJz
WOYK+b8fA1qk+wdKSp1xekDY5mGNZEGy1uJQIyFZfbwNiGZEx2RN7z3xA9Q4P9S5
g0ytSvHq4/iwLRHT1bBMCp6eZcfXCZkHBfFx5grgcJ4ELT0+MPU7Scn1W/U1ZGSw
5c9Z6sjuWXcYUkrTq3PeuNgWcqWTo3H6r+gjwDNVyma7jW7uOQKCAQEA+o2FBLtR
yZ6w5yjpUH4YsKLcGZEi5vHgUqim6SKO09Ce3PazvRYb/bpsQJVo/TQG5+vAIP0v
xQ1Tnp9pccwW6PIG5UO7Yg0Sh3n2U/hM5ln88uKDHYuwXHVEsZOgbnHMcqJXjC9A
S62KTAdqRPyLm8oO4NIsDrydRpUEUE3IMkMYUOcjvGhw/qLlif1I544G6jfETu/E
sxXtrE9f6gKb++Apl3TMYn+GsQcZiklGza7aR8FHYnf9+ae3Fxn9gsQOPvZKJmgJ
3wDiW+kK4z4ilRBm58boJJax3YhnQf0U+2AZh34lmFcDOY8/YOWTW8pJD0gsSN1R
YgL+zuMLrLyKpQKCAQEAzH6YnMoF4tbhuFZxBiOsa8Qg9fewxLCrDmrRq2u/rlyB
JdknifLCFLkijK9kGDusMimDj9gnLgtPX9105S3F7IzWrvcsGg8hzLLHrAsaNyMk
Z/a0kQggAkCrFlRSgL5F8AZL2wFO5cISUrrZZSxml1PeCgg9kXy078rvBGwcxri0
1Sdolzxmn95NvCmiZ7sGSRh3pv138PbfHJewMHUhUBo4G4udL4/j2yiMT6g9YxDu
r9y6mAgzJL21gMT/IeCX6/T6vf/VEvY4+7Bs6k8yowVeZ9hbRs5iTClT8jGA2B4q
pMXmtbu8/jIQq5Inejl+dovo7Yeqwfgxhsg+dGBppwKCAQACLdzsT5zEfibXu9lb
o90fHCuB5WtCSvRCg8j/2hcX7IaVMWgayuhvaoGqhiIloaA1wC0pnEogEp+Zj5Vh
Mf85A3Hf6Jjmn2p71ym3TT+N+VZj3mh5h09/Xl28laYdj8vRa2wLghWzEs1TH/Vi
qDemoTlD51AOyMEtbfpdoG+PUFoTyg7bgqUI8e3BJ3zM1sVkoBuK/Dbfv98TUpVo
+aDVrftun8tvR+CqBX/JXh3JiC3J1fqC9rw0waqr/sPfsUjWb1nxv5HmaKGPXxWD
KHUwirX6ahZ2ywC9BoSvZD4ceZd/QC+fhZI3m/FXLGf9smK0SVJpR9N/YLtKnVrq
o7EpAoIBAB5N5G/XwGeNUIXwyW8Pek2+EuRggGGljLPmQIwWu6ErNDhXpfRbdUd8
6BHRLBQrQ6lrXYPDlIrOQkUCnIAZ+GrFtErZdj+mXmvnUo+8VXY2Tv7ZIIkdmyC6
VKBKfq91gwe+5x7dYsPJrs1zwyOrIMjsNMtnzTfyMx4WBLWzD9CjLqkn3egLm2m1
l+96fAbDQHs0lQa6KTwcWZPzJrkHopgsSoRKfFDAEhQ4PhLP68jyiWymWUCOdoXL
V0pt5yEuF1VwSHg/oWPd+TPTQVC3y9k8wnDBL0We8BI5TadmjqF4Vvl0Gmx0Fd3V
rYK/dfo26vbGZQ5OPI/iJ/TBWAAHCaECggEBAMHUzVCqEk9HRYcJwhBlUBEzVVgK
woeYDwuQ4u8KO07TQpEF4zUnEsraBKDEOAQt3X40HWyjlMpfWwt/CaJDuYSGWxmC
IIksIahG1zQTgL/vmHxbCrumkLEC8b7jM/ydkvKsgDdXuD8uU2+bAvE+purVr2Kx
n2LPlXFi1TfyeDEk+0BGgDjuiYX0Gic4sWCtHuSGLFUNQ1tYSbq9YRL1yhMY7P1D
l6R2faugKrqFn2cZqIwwzhhJMDLt3C1+lDyUe7WR7RUW4ZU79xqcgCEKjwYhSQAG
IzN1IA6FcpbqVb2tI0+KmdrwcUsi74v3QTCBQ02cIu909104or3QQvW7Fqc=
-----END RSA PRIVATE KEY-----