Set some default configuration values (#4223)

Closes #3946 Signed-off-by: Sergio Castaño Arteaga <[email protected]>
artifacthub · Jan 8, 2025 · 451a914 · 451a914
1 parent b3d8208
commit 451a914
Show file tree

Hide file tree

Showing 4 changed files with 49 additions and 3 deletions.
diff --git a/cmd/hub/main.go b/cmd/hub/main.go
@@ -29,6 +29,7 @@ import (
 	"github.com/artifacthub/hub/internal/webhook"
 	"github.com/prometheus/client_golang/prometheus/promhttp"
 	"github.com/rs/zerolog/log"
+	"github.com/spf13/viper"
 )
 
 func main() {
@@ -37,6 +38,7 @@ func main() {
 	if err != nil {
 		log.Fatal().Err(err).Msg("configuration setup failed")
 	}
+	setCfgDefaults(cfg)
 	fields := map[string]interface{}{"cmd": "hub"}
 	if err := util.SetupLogger(cfg, fields); err != nil {
 		log.Fatal().Err(err).Msg("logger setup failed")
@@ -157,3 +159,24 @@ func main() {
 	}
 	log.Info().Msg("hub server stopped")
 }
+
+// setCfgDefaults sets the default values for some configuration options.
+func setCfgDefaults(cfg *viper.Viper) {
+	cfg.SetDefault("server.addr", "0.0.0.0:8000")
+	cfg.SetDefault("server.allowUserSignUp", true)
+	cfg.SetDefault("server.baseURL", "http://localhost:8000")
+	cfg.SetDefault("server.cookie.hashKey", "sample hash key")
+	cfg.SetDefault("server.csrf.authKey", "sample auth key")
+	cfg.SetDefault("server.metricsAddr", "0.0.0.0:8001")
+	cfg.SetDefault("server.shutdownTimeout", 10*time.Second)
+	cfg.SetDefault("server.webBuildPath", "../../web/build")
+	cfg.SetDefault("server.widgetBuildPath", "../../widget/build")
+	cfg.SetDefault("theme.colors.primary", "#417598")
+	cfg.SetDefault("theme.colors.secondary", "#2D4857")
+	cfg.SetDefault("theme.images.appleTouchIcon192", "/static/media/logo192_v2.png")
+	cfg.SetDefault("theme.images.appleTouchIcon512", "/static/media/logo512_v2.png")
+	cfg.SetDefault("theme.images.openGraphImage", "/static/media/artifactHub_v2.png")
+	cfg.SetDefault("theme.images.shortcutIcon", "/static/media/logo_v2.png")
+	cfg.SetDefault("theme.images.websiteLogo", "/static/media/logo/artifacthub-brand-white.svg")
+	cfg.SetDefault("theme.siteName", "Artifact hub")
+}
diff --git a/cmd/scanner/main.go b/cmd/scanner/main.go
@@ -16,6 +16,7 @@ import (
 	"github.com/artifacthub/hub/internal/scanner"
 	"github.com/artifacthub/hub/internal/util"
 	"github.com/rs/zerolog/log"
+	"github.com/spf13/viper"
 )
 
 func main() {
@@ -24,6 +25,7 @@ func main() {
 	if err != nil {
 		log.Fatal().Err(err).Msg("configuration setup failed")
 	}
+	setCfgDefaults(cfg)
 	fields := map[string]interface{}{"cmd": "scanner"}
 	if err := util.SetupLogger(cfg, fields); err != nil {
 		log.Fatal().Err(err).Msg("logger setup failed")
@@ -65,7 +67,6 @@ func main() {
 	if err != nil {
 		log.Fatal().Err(err).Msg("error getting snapshots to scan")
 	}
-	cfg.SetDefault("scanner.concurrency", 1)
 	limiter := make(chan struct{}, cfg.GetInt("scanner.concurrency"))
 	var wg sync.WaitGroup
 L:
@@ -105,3 +106,9 @@ L:
 	ec.Flush()
 	log.Info().Msg("scanner finished")
 }
+
+// setCfgDefaults sets the default values for some configuration options.
+func setCfgDefaults(cfg *viper.Viper) {
+	cfg.SetDefault("scanner.concurrency", 1)
+	cfg.SetDefault("scanner.trivyURL", "http://localhost:8081")
+}
diff --git a/cmd/tracker/main.go b/cmd/tracker/main.go
@@ -19,6 +19,7 @@ import (
 	"github.com/artifacthub/hub/internal/tracker"
 	"github.com/artifacthub/hub/internal/util"
 	"github.com/rs/zerolog/log"
+	"github.com/spf13/viper"
 )
 
 var (
@@ -31,6 +32,7 @@ func main() {
 	if err != nil {
 		log.Fatal().Err(err).Msg("configuration setup failed")
 	}
+	setCfgDefaults(cfg)
 	fields := map[string]interface{}{"cmd": "tracker"}
 	if err := util.SetupLogger(cfg, fields); err != nil {
 		log.Fatal().Err(err).Msg("logger setup failed")
@@ -92,8 +94,6 @@ func main() {
 	if err != nil {
 		log.Fatal().Err(err).Msg("error getting repositories")
 	}
-	cfg.SetDefault("tracker.concurrency", 1)
-	cfg.SetDefault("tracker.repositoryTimeout", 15*time.Minute)
 	limiter := make(chan struct{}, cfg.GetInt("tracker.concurrency"))
 	var wg sync.WaitGroup
 L:
@@ -140,3 +140,10 @@ L:
 	ec.Flush()
 	log.Info().Msg("tracker finished")
 }
+
+// setCfgDefaults sets the default values for some configuration options.
+func setCfgDefaults(cfg *viper.Viper) {
+	cfg.SetDefault("tracker.categoryModelPath", "../../ml/category/model")
+	cfg.SetDefault("tracker.concurrency", 1)
+	cfg.SetDefault("tracker.repositoryTimeout", 15*time.Minute)
+}
diff --git a/internal/util/config.go b/internal/util/config.go
@@ -26,5 +26,14 @@ func SetupConfig(cmd string) (*viper.Viper, error) {
 	cfg.SetEnvKeyReplacer(strings.NewReplacer("-", "_", ".", "_"))
 	cfg.AutomaticEnv()
 
+	// Set some defaults
+	cfg.SetDefault("db.database", "hub")
+	cfg.SetDefault("db.host", "localhost")
+	cfg.SetDefault("db.port", "5432")
+	cfg.SetDefault("db.user", "postgres")
+	cfg.SetDefault("images.store", "pg")
+	cfg.SetDefault("log.level", "debug")
+	cfg.SetDefault("log.pretty", true)
+
 	return cfg, nil
 }