Let aggregator look for config files in similiar places like the othe…

…r tools. (#440)
gocsaf · Aug 22, 2023 · 7d3c3a6 · 7d3c3a6
1 parent f2657bb
commit 7d3c3a6
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 2 deletions.
diff --git a/cmd/csaf_aggregator/config.go b/cmd/csaf_aggregator/config.go
@@ -132,8 +132,9 @@ type config struct {
 
 // configPaths are the potential file locations of the config file.
 var configPaths = []string{
-	// TODO: Make symmetric to checker and downloader.
-	"aggregator.toml",
+	"~/.config/csaf/aggregator.toml",
+	"~/.csaf_aggregator.toml",
+	"csaf_aggregator.toml",
 }
 
 // parseArgsConfig parse the command arguments and loads configuration

diff --git a/docs/csaf_aggregator.md b/docs/csaf_aggregator.md
@@ -15,6 +15,15 @@ Help Options:
   -h, --help                Show this help message
 ```
 
+If no config file is explictly given the follwing places are searched for a config file:
+```
+~/.config/csaf/aggregator.toml
+~/.csaf_aggregator.toml
+csaf_aggregator.toml
+```
+
+with `~` expanding to `$HOME` on unixoid systems and `%HOMEPATH` on Windows systems.
+
 Usage example for a single run, to test if the config is good:
 ```bash
 ./csaf_aggregator -c docs/examples/aggregator.toml