From c0b383b08a04e9c9811f54f738b8fd3014882d7b Mon Sep 17 00:00:00 2001 From: elpatron Date: Sat, 23 Aug 2025 11:34:40 +0200 Subject: [PATCH] =?UTF-8?q?Docs:=20README=20f=C3=BCr=20Health-Check-Endpun?= =?UTF-8?q?kt=20aktualisiert?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Neue Sektion 'Health-Check' mit Details zum /health Endpunkt - JSON-Beispiel-Antwort dokumentiert - Klarstellung: Wird NICHT geloggt (keine Statistiken) - Health-Check-URL von / auf /health aktualisiert - Verwendungszweck: Docker, Load Balancer, Monitoring-Tools --- README.md | 21 ++++++++++++++++++--- 1 file changed, 18 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 1c76f2f..a5575b1 100644 --- a/README.md +++ b/README.md @@ -56,9 +56,24 @@ export FLASK_SECRET_KEY="your-super-secret-key-change-this-in-production" export ADMIN_PASSWORD="your-secure-admin-password" ``` -### Docker (empfohlen) +### Health-Check -- Build: +Für Container-Monitoring steht ein dedizierter Health-Check-Endpunkt zur Verfügung: + +- **URL:** `/health` +- **Antwort:** JSON mit Status und Zeitstempel +- **Logging:** **Wird NICHT geloggt** (keine Statistiken) +- **Verwendung:** Docker Health-Checks, Load Balancer, Monitoring-Tools + +Beispiel-Antwort: +```json +{ + "status": "healthy", + "timestamp": "2025-08-20T09:15:30.123456" +} +``` + +### Docker (empfohlen) ```bash docker build -t wordle-cheater . @@ -70,7 +85,7 @@ docker build -t wordle-cheater . docker run --rm -p 8000:8000 wordle-cheater ``` -- Health‑Check (lokal): `http://localhost:8000/` +- Health‑Check (lokal): `http://localhost:8000/health` - Admin‑Dashboard: `http://localhost:8000/stats` (passwortgeschützt) Hinweise: