From 5553559ea631826ebf35b358129715cb5631b198 Mon Sep 17 00:00:00 2001
From: Lorenzo Venerandi <lollo.venerandi@gmail.com>
Date: Fri, 6 Mar 2026 22:40:16 +0100
Subject: [PATCH] feat: add dashboard password configuration to README and
 docker-compose

---
 README.md           | 7 ++++++-
 docker-compose.yaml | 2 ++
 2 files changed, 8 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 6bc2ba5..87a9af9 100644
--- a/README.md
+++ b/README.md
@@ -117,6 +117,7 @@ docker run -d \
   -e KRAWL_PORT=5000 \
   -e KRAWL_DELAY=100 \
   -e KRAWL_DASHBOARD_SECRET_PATH="/my-secret-dashboard" \
+  -e KRAWL_DASHBOARD_PASSWORD="my-secret-password" \
   -v krawl-data:/app/data \
   --name krawl \
   ghcr.io/blessedrebus/krawl:latest
@@ -138,6 +139,7 @@ services:
     environment:
       - CONFIG_LOCATION=config.yaml
       - TZ=Europe/Rome
+      # - KRAWL_DASHBOARD_PASSWORD=my-secret-password
     volumes:
       - ./config.yaml:/app/config.yaml:ro
       # bind mount for firewall exporters
@@ -197,6 +199,7 @@ You can use the [config.yaml](config.yaml) file for advanced configurations, suc
 | `KRAWL_CANARY_TOKEN_URL` | External canary token URL | None |
 | `KRAWL_CANARY_TOKEN_TRIES` | Requests before showing canary token | `10` |
 | `KRAWL_DASHBOARD_SECRET_PATH` | Custom dashboard path | Auto-generated |
+| `KRAWL_DASHBOARD_PASSWORD` | Password for protected dashboard panels | Auto-generated |
 | `KRAWL_PROBABILITY_ERROR_CODES` | Error response probability (0-100%) | `0` |
 | `KRAWL_DATABASE_PATH` | Database file location | `data/krawl.db` |
 | `KRAWL_EXPORTS_PATH` | Path where firewalls rule sets are exported | `exports` |
@@ -228,8 +231,9 @@ export KRAWL_LINKS_PER_PAGE_RANGE="5,25"
 export KRAWL_HTTP_RISKY_METHODS_THRESHOLD="0.2"
 export KRAWL_VIOLATED_ROBOTS_THRESHOLD="0.15"
 
-# Set custom dashboard path
+# Set custom dashboard path and password
 export KRAWL_DASHBOARD_SECRET_PATH="/my-secret-dashboard"
+export KRAWL_DASHBOARD_PASSWORD="my-secret-password"
 ```
 
 Example of a Docker run with env variables:
@@ -239,6 +243,7 @@ docker run -d \
   -p 5000:5000 \
   -e KRAWL_PORT=5000 \
   -e KRAWL_DELAY=100 \
+  -e KRAWL_DASHBOARD_PASSWORD="my-secret-password" \
   -e KRAWL_CANARY_TOKEN_URL="http://your-canary-token-url" \
   --name krawl \
   ghcr.io/blessedrebus/krawl:latest
diff --git a/docker-compose.yaml b/docker-compose.yaml
index 17680de..feab0f5 100644
--- a/docker-compose.yaml
+++ b/docker-compose.yaml
@@ -10,6 +10,8 @@ services:
       - "5000:5000"
     environment:
       - CONFIG_LOCATION=config.yaml
+      # Uncomment to set a custom dashboard password (auto-generated if not set)
+      # - KRAWL_DASHBOARD_PASSWORD=your-secret-password
       # set this to change timezone, alternatively mount /etc/timezone or /etc/localtime based on the time system management of the host environment
       # - TZ=${TZ}
     volumes: