Allow disabling the start-up configuration output

Author: PascalMinder

.traefik.yml

@@ -6,6 +6,7 @@ import: github.com/PascalMinder/geoblock
 summary: "block request based on their country of origin"
 
 testData:
+  silentStartUp: false
   allowLocalRequests: false
   logLocalRequests: false
   logAllowedRequests: false

docker/traefik-config/dynamic-configuration.yml

@@ -3,6 +3,7 @@ http:
     my-plugin:
       plugin:
         geoblock:
+          silentStartUp: false
           allowLocalRequests: true
           logLocalRequests: false
           logAllowedRequests: true

geoblock.go

@@ -30,6 +30,7 @@ var (
 
 // Config the plugin configuration.
 type Config struct {
+	SilentStartUp             bool     `yaml:"silentStartUp"`
 	AllowLocalRequests        bool     `yaml:"allowLocalRequests"`
 	LogLocalRequests          bool     `yaml:"logLocalRequests"`
 	LogAllowedRequests        bool     `yaml:"logAllowedRequests"`
@@ -59,6 +60,7 @@ func CreateConfig() *Config {
 // GeoBlock a Traefik plugin.
 type GeoBlock struct {
 	next                  http.Handler
+	silentStartUp         bool
 	allowLocalRequests    bool
 	logLocalRequests      bool
 	logAllowedRequests    bool
@@ -111,19 +113,21 @@ func New(_ context.Context, next http.Handler, config *Config, name string) (htt
 
 	infoLogger.SetOutput(os.Stdout)
 
-	infoLogger.Printf("allow local IPs: %t", config.AllowLocalRequests)
-	infoLogger.Printf("log local requests: %t", config.LogLocalRequests)
-	infoLogger.Printf("log allowed requests: %t", config.LogAllowedRequests)
-	infoLogger.Printf("log api requests: %t", config.LogAPIRequests)
-	infoLogger.Printf("API uri: %s", config.API)
-	infoLogger.Printf("API timeout: %d", config.APITimeoutMs)
-	infoLogger.Printf("cache size: %d", config.CacheSize)
-	infoLogger.Printf("force monthly update: %t", config.ForceMonthlyUpdate)
-	infoLogger.Printf("allow unknown countries: %t", config.AllowUnknownCountries)
-	infoLogger.Printf("unknown country api response: %s", config.UnknownCountryAPIResponse)
-	infoLogger.Printf("blacklist mode: %t", config.BlackListMode)
-	infoLogger.Printf("add country header: %t", config.AddCountryHeader)
-	infoLogger.Printf("countries: %v", config.Countries)
+	if !config.SilentStartUp {
+		infoLogger.Printf("allow local IPs: %t", config.AllowLocalRequests)
+		infoLogger.Printf("log local requests: %t", config.LogLocalRequests)
+		infoLogger.Printf("log allowed requests: %t", config.LogAllowedRequests)
+		infoLogger.Printf("log api requests: %t", config.LogAPIRequests)
+		infoLogger.Printf("API uri: %s", config.API)
+		infoLogger.Printf("API timeout: %d", config.APITimeoutMs)
+		infoLogger.Printf("cache size: %d", config.CacheSize)
+		infoLogger.Printf("force monthly update: %t", config.ForceMonthlyUpdate)
+		infoLogger.Printf("allow unknown countries: %t", config.AllowUnknownCountries)
+		infoLogger.Printf("unknown country api response: %s", config.UnknownCountryAPIResponse)
+		infoLogger.Printf("blacklist mode: %t", config.BlackListMode)
+		infoLogger.Printf("add country header: %t", config.AddCountryHeader)
+		infoLogger.Printf("countries: %v", config.Countries)
+	}
 
 	cache, err := lru.NewLRUCache(config.CacheSize)
 	if err != nil {
@@ -132,6 +136,7 @@ func New(_ context.Context, next http.Handler, config *Config, name string) (htt
 
 	return &GeoBlock{
 		next:                  next,
+		silentStartUp:         config.SilentStartUp,
 		allowLocalRequests:    config.AllowLocalRequests,
 		logLocalRequests:      config.LogLocalRequests,
 		logAllowedRequests:    config.LogAllowedRequests,

readme.md

@@ -60,6 +60,7 @@ http:
     geoblock-ch:
       plugin:
         geoblock:
+          silentStartUp: false
           allowLocalRequests: true
           logLocalRequests: false
           logAllowedRequests: false
@@ -110,6 +111,7 @@ http:
     my-GeoBlock:
       plugin:
         GeoBlock:
+          silentStartUp: false
           allowLocalRequests: true
           logLocalRequests: false
           logAllowedRequests: false
@@ -167,6 +169,7 @@ This configuration might not work. It's just to give you an idea how to configur
 my-GeoBlock:
     plugin:
         GeoBlock:
+            silentStartUp: false
             allowLocalRequests: false
             logLocalRequests: false
             logAllowedRequests: false
@@ -433,6 +436,10 @@ my-GeoBlock:
 
 ## Configuration options
 
+### Silent start-up: `silentStartUp`
+
+If set to true, the configuration is not written to the output upon the start-up of the plugin.
+
 ### Allow local requests: `allowLocalRequests`
 
 If set to true, will not block request from [Private IP Ranges](https://en.wikipedia.org/wiki/Private_network).