Configuration tweaks (#2567)

This makes the following changes:

* The various `Defaults` functions are now responsible for setting sane defaults if `generate` is specified, rather than hiding them in `generate-config`
* Some configuration options have been marked as `omitempty` so that they don't appear in generated configs unnecessarily (monolith-specific vs. polylith-specific options)
* A new option `-polylith` has been added to `generate-config` to create a config that makes sense for polylith deployments (i.e. including the internal/external API listeners and per-component database sections)
* A new option `-normalise` has been added to `generate-config` to take an existing file and add any missing options and/or defaults

3 files changed, 79 insertions, 81 deletions

diff --git a/cmd/dendrite-demo-pinecone/main.go b/cmd/dendrite-demo-pinecone/main.go
index 52c9dc8e..83b52132 100644
--- a/cmd/dendrite-demo-pinecone/main.go
+++ b/cmd/dendrite-demo-pinecone/main.go
@@ -115,7 +115,10 @@ func main() {
 				panic("failed to load PEM key: " + err.Error())
 			}
 		}
-		cfg.Defaults(true)
+		cfg.Defaults(config.DefaultOpts{
+			Generate:   true,
+			Monolithic: true,
+		})
 		cfg.Global.PrivateKey = sk
 		cfg.Global.JetStream.StoragePath = config.Path(fmt.Sprintf("%s/", *instanceName))
 		cfg.UserAPI.AccountDatabase.ConnectionString = config.DataSource(fmt.Sprintf("file:%s-account.db", *instanceName))
diff --git a/cmd/dendrite-demo-yggdrasil/main.go b/cmd/dendrite-demo-yggdrasil/main.go
index 086baa26..d2fddf8b 100644
--- a/cmd/dendrite-demo-yggdrasil/main.go
+++ b/cmd/dendrite-demo-yggdrasil/main.go
@@ -78,7 +78,10 @@ func main() {
 	if configFlagSet {
 		cfg = setup.ParseFlags(true)
 	} else {
-		cfg.Defaults(true)
+		cfg.Defaults(config.DefaultOpts{
+			Generate:   true,
+			Monolithic: true,
+		})
 		cfg.Global.JetStream.StoragePath = config.Path(fmt.Sprintf("%s/", *instanceName))
 		cfg.UserAPI.AccountDatabase.ConnectionString = config.DataSource(fmt.Sprintf("file:%s-account.db", *instanceName))
 		cfg.MediaAPI.Database.ConnectionString = config.DataSource(fmt.Sprintf("file:%s-mediaapi.db", *instanceName))
diff --git a/cmd/generate-config/main.go b/cmd/generate-config/main.go
index 6ae3ff9c..c24e8153 100644
--- a/cmd/generate-config/main.go
+++ b/cmd/generate-config/main.go
@@ -3,6 +3,7 @@ package main
 import (
 	"flag"
 	"fmt"
+	"path/filepath"
 
 	"github.com/matrix-org/dendrite/setup/config"
 	"github.com/matrix-org/gomatrixserverlib"
@@ -11,90 +12,81 @@ import (
 )
 
 func main() {
-	defaultsForCI := flag.Bool("ci", false, "sane defaults for CI testing")
+	defaultsForCI := flag.Bool("ci", false, "Populate the configuration with sane defaults for use in CI")
 	serverName := flag.String("server", "", "The domain name of the server if not 'localhost'")
-	dbURI := flag.String("db", "", "The DB URI to use for all components if not SQLite files")
+	dbURI := flag.String("db", "", "The DB URI to use for all components (PostgreSQL only)")
+	dirPath := flag.String("dir", "./", "The folder to use for paths (like SQLite databases, media storage)")
+	normalise := flag.String("normalise", "", "Normalise an existing configuration file by adding new/missing options and defaults")
+	polylith := flag.Bool("polylith", false, "Generate a config that makes sense for polylith deployments")
 	flag.Parse()
 
-	cfg := &config.Dendrite{
-		Version: config.Version,
-	}
-	cfg.Defaults(true)
-	if *serverName != "" {
-		cfg.Global.ServerName = gomatrixserverlib.ServerName(*serverName)
-	}
-	if *dbURI != "" {
-		cfg.FederationAPI.Database.ConnectionString = config.DataSource(*dbURI)
-		cfg.KeyServer.Database.ConnectionString = config.DataSource(*dbURI)
-		cfg.MSCs.Database.ConnectionString = config.DataSource(*dbURI)
-		cfg.MediaAPI.Database.ConnectionString = config.DataSource(*dbURI)
-		cfg.RoomServer.Database.ConnectionString = config.DataSource(*dbURI)
-		cfg.SyncAPI.Database.ConnectionString = config.DataSource(*dbURI)
-		cfg.UserAPI.AccountDatabase.ConnectionString = config.DataSource(*dbURI)
-	}
-	cfg.Global.TrustedIDServers = []string{
-		"matrix.org",
-		"vector.im",
-	}
-	cfg.Logging = []config.LogrusHook{
-		{
-			Type:  "file",
-			Level: "info",
-			Params: map[string]interface{}{
-				"path": "/var/log/dendrite",
-			},
-		},
-	}
-	cfg.FederationAPI.KeyPerspectives = config.KeyPerspectives{
-		{
-			ServerName: "matrix.org",
-			Keys: []config.KeyPerspectiveTrustKey{
-				{
-					KeyID:     "ed25519:auto",
-					PublicKey: "Noi6WqcDj0QmPxCNQqgezwTlBKrfqehY1u2FyWP9uYw",
-				},
-				{
-					KeyID:     "ed25519:a_RXGa",
-					PublicKey: "l8Hft5qXKn1vfHrg3p4+W8gELQVo8N13JkluMfmn2sQ",
+	var cfg *config.Dendrite
+	if *normalise == "" {
+		cfg = &config.Dendrite{
+			Version: config.Version,
+		}
+		cfg.Defaults(config.DefaultOpts{
+			Generate:   true,
+			Monolithic: !*polylith,
+		})
+		if *serverName != "" {
+			cfg.Global.ServerName = gomatrixserverlib.ServerName(*serverName)
+		}
+		uri := config.DataSource(*dbURI)
+		if *polylith || uri.IsSQLite() || uri == "" {
+			for name, db := range map[string]*config.DatabaseOptions{
+				"federationapi": &cfg.FederationAPI.Database,
+				"keyserver":     &cfg.KeyServer.Database,
+				"mscs":          &cfg.MSCs.Database,
+				"mediaapi":      &cfg.MediaAPI.Database,
+				"roomserver":    &cfg.RoomServer.Database,
+				"syncapi":       &cfg.SyncAPI.Database,
+				"userapi":       &cfg.UserAPI.AccountDatabase,
+			} {
+				if uri == "" {
+					path := filepath.Join(*dirPath, fmt.Sprintf("dendrite_%s.db", name))
+					db.ConnectionString = config.DataSource(fmt.Sprintf("file:%s", path))
+				} else {
+					db.ConnectionString = uri
+				}
+			}
+		} else {
+			cfg.Global.DatabaseOptions.ConnectionString = uri
+		}
+		cfg.Logging = []config.LogrusHook{
+			{
+				Type:  "file",
+				Level: "info",
+				Params: map[string]interface{}{
+					"path": filepath.Join(*dirPath, "log"),
 				},
 			},
-		},
-	}
-	cfg.MediaAPI.ThumbnailSizes = []config.ThumbnailSize{
-		{
-			Width:        32,
-			Height:       32,
-			ResizeMethod: "crop",
-		},
-		{
-			Width:        96,
-			Height:       96,
-			ResizeMethod: "crop",
-		},
-		{
-			Width:        640,
-			Height:       480,
-			ResizeMethod: "scale",
-		},
-	}
-
-	if *defaultsForCI {
-		cfg.AppServiceAPI.DisableTLSValidation = true
-		cfg.ClientAPI.RateLimiting.Enabled = false
-		cfg.FederationAPI.DisableTLSValidation = false
-		// don't hit matrix.org when running tests!!!
-		cfg.FederationAPI.KeyPerspectives = config.KeyPerspectives{}
-		cfg.MSCs.MSCs = []string{"msc2836", "msc2946", "msc2444", "msc2753"}
-		cfg.Logging[0].Level = "trace"
-		cfg.Logging[0].Type = "std"
-		cfg.UserAPI.BCryptCost = bcrypt.MinCost
-		cfg.Global.JetStream.InMemory = true
-		cfg.ClientAPI.RegistrationDisabled = false
-		cfg.ClientAPI.OpenRegistrationWithoutVerificationEnabled = true
-		cfg.ClientAPI.RegistrationSharedSecret = "complement"
-		cfg.Global.Presence = config.PresenceOptions{
-			EnableInbound:  true,
-			EnableOutbound: true,
+		}
+		if *defaultsForCI {
+			cfg.AppServiceAPI.DisableTLSValidation = true
+			cfg.ClientAPI.RateLimiting.Enabled = false
+			cfg.FederationAPI.DisableTLSValidation = false
+			// don't hit matrix.org when running tests!!!
+			cfg.FederationAPI.KeyPerspectives = config.KeyPerspectives{}
+			cfg.MediaAPI.BasePath = config.Path(filepath.Join(*dirPath, "media"))
+			cfg.MSCs.MSCs = []string{"msc2836", "msc2946", "msc2444", "msc2753"}
+			cfg.Logging[0].Level = "trace"
+			cfg.Logging[0].Type = "std"
+			cfg.UserAPI.BCryptCost = bcrypt.MinCost
+			cfg.Global.JetStream.InMemory = true
+			cfg.Global.JetStream.StoragePath = config.Path(*dirPath)
+			cfg.ClientAPI.RegistrationDisabled = false
+			cfg.ClientAPI.OpenRegistrationWithoutVerificationEnabled = true
+			cfg.ClientAPI.RegistrationSharedSecret = "complement"
+			cfg.Global.Presence = config.PresenceOptions{
+				EnableInbound:  true,
+				EnableOutbound: true,
+			}
+		}
+	} else {
+		var err error
+		if cfg, err = config.Load(*normalise, !*polylith); err != nil {
+			panic(err)
 		}
 	}