added env config COUNTER_FILE, DEBUG

README.md

@@ -10,6 +10,8 @@ _a web based password generator, with an API endpoint_
 * copy to clipboard
 * very small docker container, that only contains the application and has minimum attack surface
 * supports DarkMode and LightMode, you can toggle
+* prepared to run behind a reverse-proxy, like traefik.
+* logs in combined log format
 
 ## Demo
 

main.go

@@ -1,17 +1,17 @@
 package main
 
 import (
-	"os"
+	"crypto/rand"
+	"encoding/json"
+	"html/template"
+	"log"
 	"net"
-	"time"
+	"net/http"
+	"os"
 	"strconv"
 	"strings"
 	"sync"
-	"crypto/rand"
-	"html/template"
-	"log"
-	"net/http"
-	"encoding/json"
+	"time"
 )
 
 const (
@@ -27,6 +27,21 @@ var (
 	mu          sync.Mutex
 )
 
+func initConfig() {
+	// 1. Counter-Pfad auslesen
+	if envFile := os.Getenv("COUNTER_FILE"); envFile != "" {
+		counterFile = envFile
+		log.Printf("counterFile st to %s, by ENV\n", envFile)
+	}
+
+	// 2. Debug-Modus auslesen (String zu Bool)
+	envDebug := strings.ToLower(os.Getenv("DEBUG"))
+	if envDebug == "true" || envDebug == "1" {
+		debug = true
+		log.Println("DEBUG-Modus ist aktiviert")
+	}
+}
+
 type responseWriter struct {
 	http.ResponseWriter
 	statusCode int
@@ -44,19 +59,14 @@ func newResponseWriter(w http.ResponseWriter) *responseWriter {
 func LoggingMiddleware(next http.Handler) http.Handler {
 	return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 		start := time.Now()
-        
-        // ResponseWriter einpacken
 		rw := newResponseWriter(w)
-        
-        // Den nächsten Handler ausführen
 		next.ServeHTTP(rw, r)
-        
-        // Log-Daten sammeln
 		duration := time.Since(start)
-        clientIP := getClientIP(r) // Deine Funktion von vorhin
-        
-        // Format: IP - - [Datum] "Method Path Proto" Status Duration
-        log.Printf("%s - - [%s] \"%s %s %s\" %d %v\n",
+		clientIP := getClientIP(r)
+		userAgent := r.UserAgent()
+		// Format: IP - - [Datum] "Method Path Proto" Status Duration User-Agent
+		// "Combined Log Format"
+		log.Printf("%s - - [%s] \"%s %s %s\" %d %v \"%s\"\n",
 			clientIP,
 			time.Now().Format("02/Jan/2006:15:04:05 -0700"),
 			r.Method,
@@ -64,6 +74,7 @@ func LoggingMiddleware(next http.Handler) http.Handler {
 			r.Proto,
 			rw.statusCode,
 			duration,
+			userAgent,
 		)
 	})
 }
@@ -142,7 +153,9 @@ func loadTemplates() {
 }
 
 func generatePassword() string {
-	if debug { log.Printf("called generatePassword\n") }
+	if debug {
+		log.Printf("called generatePassword\n")
+	}
 	password := make([]byte, passwordLength)
 	_, err := rand.Read(password)
 	if err != nil {
@@ -156,7 +169,9 @@ func generatePassword() string {
 }
 
 func passwordHandler(w http.ResponseWriter, r *http.Request) {
-    if debug { log.Printf("called passwordHandler\n") }
+	if debug {
+		log.Printf("called passwordHandler\n")
+	}
 	password := generatePassword()
 	currentCount := GetPasswordCount()
 	response := map[string]interface{}{
@@ -173,14 +188,18 @@ func passwordHandler(w http.ResponseWriter, r *http.Request) {
 }
 
 func passwordAPIHandler(w http.ResponseWriter, r *http.Request) {
-	if debug { log.Printf("called passwordHandler\n") }
+	if debug {
+		log.Printf("called passwordHandler\n")
+	}
 	password := generatePassword()
 	w.Header().Set("Content-Type", "text/plain")
 	w.Write([]byte(password))
 }
 
 func indexHandler(w http.ResponseWriter, r *http.Request) {
-	if debug { log.Printf("call indexHandler: Request %s %s\n", r.Method, r.URL) }
+	if debug {
+		log.Printf("call indexHandler: Request %s %s\n", r.Method, r.URL)
+	}
 	password := generatePassword()
 	//password := "load..."
 	data := struct {
@@ -188,7 +207,9 @@ func indexHandler(w http.ResponseWriter, r *http.Request) {
 	}{
 		Password: password,
 	}
-	if debug { log.Printf("prepare template for index\n") }
+	if debug {
+		log.Printf("prepare template for index\n")
+	}
 	err := templates["index.html"].ExecuteTemplate(w, "base.html", data)
 	if err != nil {
 		log.Printf("Fehler beim Rendern des Templates: %v", err)
@@ -197,7 +218,9 @@ func indexHandler(w http.ResponseWriter, r *http.Request) {
 }
 
 func helpHandler(w http.ResponseWriter, r *http.Request) {
-	if debug { log.Printf("call helpHandler\n") }
+	if debug {
+		log.Printf("call helpHandler\n")
+	}
 	err := templates["help.html"].ExecuteTemplate(w, "base.html", nil)
 	if err != nil {
 		log.Printf("Fehler beim Rendern des Templates: %v", err)
@@ -206,6 +229,7 @@ func helpHandler(w http.ResponseWriter, r *http.Request) {
 }
 
 func main() {
+	initConfig()
 	loadTemplates()
 	mux := http.NewServeMux()
 

misc/MoreUsage.md

@@ -25,21 +25,32 @@ for i in {1..10}; do echo $(curl -s https://passwd.scu.si/api/password); done
 you can build the app yourself like this:
 
 ```
-go build -o password-generator ./
+go build ./
 ```
 
+NOTE: If you build the app manually in go, like shown in this example, it will probably not run, since it misses a writeable `/data` directory.
+You can set the counterFile by environment variable `COUNTER_FILE`, like this:
+```
+COUNTER_FILE=./counter.txt ./Web-Password
+```
 
+## debuging the app
+
+You can turn on debug mode via environment variable `DEBUG`
+```
+DEBUG=true ./Web-Password
+```
 
 # build a docker container
 
 ```
-docker build -t password-generator .
+docker build -t web-password:dev .
 ```
 
 # start the docker container
 
 ```
-docker run -p 8080:8080 password-generator
+docker run -p 8080:8080 -v app_data:/data web-password:dev
 ```
 
 ## docker-compose