New sample config (#1258)

* Config tweaks

* Tweaks to config

* Add new sample dendrite-config.yaml file

* Review comments @Kegsay

internal/config/config.go

@@ -110,21 +110,6 @@ type Derived struct {
 	// servers from creating RoomIDs in exclusive application service namespaces
 }
 
-// KeyPerspectives are used to configure perspective key servers for
-// retrieving server keys.
-type KeyPerspectives []struct {
-	// The server name of the perspective key server
-	ServerName gomatrixserverlib.ServerName `yaml:"server_name"`
-	// Server keys for the perspective user, used to verify the
-	// keys have been signed by the perspective server
-	Keys []struct {
-		// The key ID, e.g. ed25519:auto
-		KeyID gomatrixserverlib.KeyID `yaml:"key_id"`
-		// The public key in base64 unpadded format
-		PublicKey string `yaml:"public_key"`
-	} `yaml:"keys"`
-}
-
 // A Path on the filesystem.
 type Path string
 

internal/config/config_clientapi.go

@@ -12,24 +12,25 @@ type ClientAPI struct {
 	Listen Address `yaml:"listen"`
 	Bind   Address `yaml:"bind"`
 
+	// If set disables new users from registering (except via shared
+	// secrets)
+	RegistrationDisabled bool `yaml:"registration_disabled"`
 	// If set, allows registration by anyone who also has the shared
 	// secret, even if registration is otherwise disabled.
 	RegistrationSharedSecret string `yaml:"registration_shared_secret"`
+
+	// Boolean stating whether catpcha registration is enabled
+	// and required
+	RecaptchaEnabled bool `yaml:"enable_registration_captcha"`
 	// This Home Server's ReCAPTCHA public key.
 	RecaptchaPublicKey string `yaml:"recaptcha_public_key"`
 	// This Home Server's ReCAPTCHA private key.
 	RecaptchaPrivateKey string `yaml:"recaptcha_private_key"`
-	// Boolean stating whether catpcha registration is enabled
-	// and required
-	RecaptchaEnabled bool `yaml:"enable_registration_captcha"`
 	// Secret used to bypass the captcha registration entirely
-	RecaptchaBypassSecret string `yaml:"captcha_bypass_secret"`
+	RecaptchaBypassSecret string `yaml:"recaptcha_bypass_secret"`
 	// HTTP API endpoint used to verify whether the captcha response
 	// was successful
 	RecaptchaSiteVerifyAPI string `yaml:"recaptcha_siteverify_api"`
-	// If set disables new users from registering (except via shared
-	// secrets)
-	RegistrationDisabled bool `yaml:"registration_disabled"`
 
 	// TURN options
 	TURN TURN `yaml:"turn"`

internal/config/config_global.go

@@ -20,7 +20,7 @@ type Global struct {
 
 	// An arbitrary string used to uniquely identify the PrivateKey. Must start with the
 	// prefix "ed25519:".
-	KeyID gomatrixserverlib.KeyID `yaml:"-"`
+	KeyID gomatrixserverlib.KeyID `yaml:"key_id"`
 
 	// How long a remote server can cache our server key for before requesting it again.
 	// Increasing this number will reduce the number of requests made by remote servers
@@ -43,7 +43,7 @@ type Global struct {
 
 func (c *Global) Defaults() {
 	c.ServerName = "localhost"
-	c.PrivateKeyPath = "matrix.pem"
+	c.PrivateKeyPath = "matrix_key.pem"
 	_, c.PrivateKey, _ = ed25519.GenerateKey(rand.New(rand.NewSource(0)))
 	c.KeyID = "ed25519:auto"
 	c.KeyValidityPeriod = time.Hour * 24 * 7

internal/config/config_kafka.go

@@ -14,6 +14,9 @@ const (
 type Kafka struct {
 	// A list of kafka addresses to connect to.
 	Addresses []string `yaml:"addresses"`
+	// The prefix to use for Kafka topic names for this homeserver - really only
+	// useful if running more than one Dendrite on the same Kafka deployment.
+	TopicPrefix string `yaml:"topic_prefix"`
 	// Whether to use naffka instead of kafka.
 	// Naffka can only be used when running dendrite as a single monolithic server.
 	// Kafka can be used both with a monolithic server and when running the
@@ -21,9 +24,6 @@ type Kafka struct {
 	UseNaffka bool `yaml:"use_naffka"`
 	// The Naffka database is used internally by the naffka library, if used.
 	Database DatabaseOptions `yaml:"naffka_database"`
-	// The prefix to use for Kafka topic names for this homeserver - really only
-	// useful if running more than one Dendrite on the same Kafka deployment.
-	TopicPrefix string `yaml:"topic_prefix"`
 }
 
 func (k *Kafka) TopicFor(name string) string {
@@ -33,6 +33,7 @@ func (k *Kafka) TopicFor(name string) string {
 func (c *Kafka) Defaults() {
 	c.UseNaffka = true
 	c.Database.Defaults()
+	c.Addresses = []string{"localhost:2181"}
 	c.Database.ConnectionString = DataSource("file:naffka.db")
 	c.TopicPrefix = "Dendrite"
 }

internal/config/config_serverkey.go

@@ -1,5 +1,7 @@
 package config
 
+import "github.com/matrix-org/gomatrixserverlib"
+
 type ServerKeyAPI struct {
 	Matrix *Global `yaml:"-"`
 
@@ -27,3 +29,22 @@ func (c *ServerKeyAPI) Verify(configErrs *ConfigErrors, isMonolith bool) {
 	checkNotEmpty(configErrs, "server_key_api.bind", string(c.Bind))
 	checkNotEmpty(configErrs, "server_key_api.database.connection_string", string(c.Database.ConnectionString))
 }
+
+// KeyPerspectives are used to configure perspective key servers for
+// retrieving server keys.
+type KeyPerspectives []KeyPerspective
+
+type KeyPerspective struct {
+	// The server name of the perspective key server
+	ServerName gomatrixserverlib.ServerName `yaml:"server_name"`
+	// Server keys for the perspective user, used to verify the
+	// keys have been signed by the perspective server
+	Keys []KeyPerspectiveTrustKey `yaml:"keys"`
+}
+
+type KeyPerspectiveTrustKey struct {
+	// The key ID, e.g. ed25519:auto
+	KeyID gomatrixserverlib.KeyID `yaml:"key_id"`
+	// The public key in base64 unpadded format
+	PublicKey string `yaml:"public_key"`
+}

internal/config/config_test.go

@@ -37,22 +37,20 @@ version: 1
 global:
   server_name: localhost
   private_key: matrix_key.pem
+  key_id: ed25519:auto
   key_validity_period: 168h0m0s
-  trusted_third_party_id_servers: []
+  trusted_third_party_id_servers:
+  - matrix.org
+  - vector.im
   kafka:
     addresses: []
+    topic_prefix: Dendrite
     use_naffka: true
     naffka_database:
       connection_string: file:naffka.db
-      max_open_conns: 0
-      max_idle_conns: 0
+      max_open_conns: 100
+      max_idle_conns: 2
       conn_max_lifetime: -1
-    topics:
-      output_room_event: OutputRoomEventTopic
-      output_client_data: OutputClientDataTopic
-      output_typing_event: OutputTypingEventTopic
-      output_send_to_device_event: OutputSendToDeviceEventTopic
-      output_key_change_event: OutputKeyChangeEventTopic
   metrics:
     enabled: false
     basic_auth:
@@ -63,20 +61,20 @@ app_service_api:
   bind: localhost:7777
   database:
     connection_string: file:appservice.db
-    max_open_conns: 0
-    max_idle_conns: 0
+    max_open_conns: 100
+    max_idle_conns: 2
     conn_max_lifetime: -1
   config_files: []
 client_api:
   listen: localhost:7771
   bind: localhost:7771
+  registration_disabled: false
   registration_shared_secret: ""
+  enable_registration_captcha: false
   recaptcha_public_key: ""
   recaptcha_private_key: ""
-  enable_registration_captcha: false
-  captcha_bypass_secret: ""
+  recaptcha_bypass_secret: ""
   recaptcha_siteverify_api: ""
-  registration_disabled: false
   turn:
     turn_user_lifetime: ""
     turn_uris: []
@@ -88,8 +86,8 @@ current_state_server:
   bind: localhost:7782
   database:
     connection_string: file:currentstate.db
-    max_open_conns: 0
-    max_idle_conns: 0
+    max_open_conns: 100
+    max_idle_conns: 2
     conn_max_lifetime: -1
 edu_server:
   listen: localhost:7778
@@ -103,10 +101,11 @@ federation_sender:
   bind: localhost:7775
   database:
     connection_string: file:federationsender.db
-    max_open_conns: 0
-    max_idle_conns: 0
+    max_open_conns: 100
+    max_idle_conns: 2
     conn_max_lifetime: -1
-  federation_max_retries: 16
+  send_max_retries: 16
+  disable_tls_validation: false
   proxy_outbound:
     enabled: false
     protocol: http
@@ -117,59 +116,74 @@ key_server:
   bind: localhost:7779
   database:
     connection_string: file:keyserver.db
-    max_open_conns: 0
-    max_idle_conns: 0
+    max_open_conns: 100
+    max_idle_conns: 2
     conn_max_lifetime: -1
 media_api:
   listen: localhost:7774
   bind: localhost:7774
   database:
     connection_string: file:mediaapi.db
-    max_open_conns: 0
-    max_idle_conns: 0
+    max_open_conns: 100
+    max_idle_conns: 2
     conn_max_lifetime: -1
-  base_path: ""
+  base_path: ./media_store
   max_file_size_bytes: 10485760
   dynamic_thumbnails: false
   max_thumbnail_generators: 10
-  thumbnail_sizes: []
+  thumbnail_sizes:
+  - width: 32
+    height: 32
+    method: crop
+  - width: 96
+    height: 96
+    method: crop
+  - width: 640
+    height: 480
+    method: scale
 room_server:
   listen: localhost:7770
   bind: localhost:7770
   database:
     connection_string: file:roomserver.db
-    max_open_conns: 0
-    max_idle_conns: 0
+    max_open_conns: 100
+    max_idle_conns: 2
     conn_max_lifetime: -1
 server_key_api:
   listen: localhost:7780
   bind: localhost:7780
   database:
     connection_string: file:serverkeyapi.db
-    max_open_conns: 0
-    max_idle_conns: 0
+    max_open_conns: 100
+    max_idle_conns: 2
     conn_max_lifetime: -1
-  key_perspectives: []
+  key_perspectives:
+  - server_name: matrix.org
+    keys:
+    - key_id: ed25519:auto
+      public_key: Noi6WqcDj0QmPxCNQqgezwTlBKrfqehY1u2FyWP9uYw
+    - key_id: ed25519:a_RXGa
+      public_key: l8Hft5qXKn1vfHrg3p4+W8gELQVo8N13JkluMfmn2sQ
 sync_api:
   listen: localhost:7773
   bind: localhost:7773
   database:
     connection_string: file:syncapi.db
-    max_open_conns: 0
-    max_idle_conns: 0
+    max_open_conns: 100
+    max_idle_conns: 2
     conn_max_lifetime: -1
 user_api:
   listen: localhost:7781
   bind: localhost:7781
   account_database:
     connection_string: file:userapi_accounts.db
-    max_open_conns: 0
-    max_idle_conns: 0
+    max_open_conns: 100
+    max_idle_conns: 2
     conn_max_lifetime: -1
   device_database:
     connection_string: file:userapi_devices.db
-    max_open_conns: 0
-    max_idle_conns: 0
+    max_open_conns: 100
+    max_idle_conns: 2
     conn_max_lifetime: -1
 tracing:
   enabled: false
@@ -183,7 +197,11 @@ tracing:
     headers: null
     baggage_restrictions: null
     throttler: null
-logging: []
+logging:
+- type: file
+  level: info
+  params:
+    path: /var/log/dendrite
 `
 
 type mockReadFile map[string]string