add viper configuration example and minor improvements - read HISTORY.md

_examples/configuration/viper/config.yml

@@ -0,0 +1,50 @@
+Addr:
+  Internal:
+    IP: 127.0.0.1
+    Plain: 8080
+    Secure: 443
+Locale:
+  Pattern: "./locales/*/*.ini"
+  Default: "en-US"
+  Supported:
+  - "en-US"
+  - "el-GR"
+Iris:
+  LogLevel: debug
+  SocketSharding: true
+  EnableOptimizations: true
+  DisableStartupLog: false
+  FireMethodNotAllowed: true
+  ForceLowercaseRouting: true
+  EnablePathIntelligence: true
+  Charset: "utf-8"
+  TimeFormat: "2006-01-02 15:04:05"
+  DisableBodyConsumptionOnUnmarshal: true
+  FireEmptyFormError: true
+  PostMaxMemory: 67108864
+  RemoteAddrHeaders:
+    - "X-Real-Ip"
+    - "X-Forwarded-For"
+    - "CF-Connecting-IP"
+    - "True-Client-Ip"
+  IgnoreServerErrors:
+    - "http: Server closed"
+  # Tunneling:
+  #   WebInterface: "http://127.0.0.1:4040"
+  #   AuthToken: "<secret>"
+  #   Tunnels:
+  #     - Name: "My awesome App"
+  #       Addr: "localhost:8080"
+  #     - Name:  "My Second awesome App"
+  #       Addr: "localhost:9090"
+  RemoteAddrPrivateSubnets:
+    - Start: "192.168.0.0"
+      End: "192.168.255.255"
+    - Start: "198.18.0.0"
+      End: "198.19.255.255"
+  SSLProxyHeaders:
+    X-Forwarded-Proto: "https"
+  HostProxyHeaders:
+    X-Host: true
+  Other:
+    ServerName: "My awesome Iris web server"

_examples/configuration/viper/config/config.go

@@ -0,0 +1,54 @@
+package config
+
+import (
+	"fmt"
+
+	"github.com/kataras/iris/v12"
+	// Viper is a third-party package:
+	// go get github.com/spf13/viper
+	"github.com/spf13/viper"
+)
+
+func init() {
+	loadConfiguration()
+}
+
+// C is the configuration of the app.
+var C = struct {
+	Iris iris.Configuration
+	Addr struct {
+		Internal struct {
+			IP     string
+			Plain  int
+			Secure int
+		}
+	}
+	Locale struct {
+		Pattern   string
+		Default   string
+		Supported []string
+	}
+}{
+	Iris: iris.DefaultConfiguration(),
+	// other default values...
+}
+
+func loadConfiguration() {
+	viper.SetConfigName("config")     // name of config file (without extension)
+	viper.SetConfigType("yaml")       // REQUIRED if the config file does not have the extension in the name
+	viper.AddConfigPath("/etc/app/")  // path to look for the config file in
+	viper.AddConfigPath("$HOME/.app") // call multiple times to add many search paths
+	viper.AddConfigPath(".")          // optionally look for config in the working directory
+	err := viper.ReadInConfig()       // Find and read the config file
+	if err := viper.ReadInConfig(); err != nil {
+		if _, ok := err.(viper.ConfigFileNotFoundError); ok {
+		} else {
+			panic(fmt.Errorf("load configuration: %w", err))
+		}
+	}
+
+	err = viper.Unmarshal(&C)
+	if err != nil {
+		panic(fmt.Errorf("load configuration: unmarshal: %w", err))
+	}
+}

_examples/configuration/viper/go.mod

@@ -0,0 +1,8 @@
+module app
+
+go 1.15
+
+require (
+	github.com/kataras/iris/v12 master
+	github.com/spf13/viper v1.3.2
+)

_examples/configuration/viper/main.go

@@ -0,0 +1,19 @@
+package main
+
+import (
+	"fmt"
+
+	"app/config"
+
+	"github.com/kataras/iris/v12"
+)
+
+func main() {
+	app := iris.New()
+	app.Get("/", func(ctx iris.Context) {
+		ctx.TextYAML(config.C)
+	})
+
+	addr := fmt.Sprintf("%s:%d", config.C.Addr.Internal.IP, config.C.Addr.Internal.Plain)
+	app.Listen(addr, iris.WithConfiguration(config.C.Iris))
+}