Malin/krawl.es
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

added configuration variable documentation and filename documentation

Browse Source
This commit is contained in:
carnivuth
2026-02-02 14:54:36 +01:00
parent ee46887761
commit 813c4b80d0
2 changed files with 13 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@@ -112,6 +112,8 @@ services:
- TZ="Europe/Rome" - TZ="Europe/Rome"
volumes: volumes:
- ./config.yaml:/app/config.yaml:ro - ./config.yaml:/app/config.yaml:ro
# bind mount for firewall exporters
- ./exports:/app/exports
- krawl-data:/app/data - krawl-data:/app/data
restart: unless-stopped restart: unless-stopped
@@ -204,6 +206,7 @@ Krawl uses a **configuration hierarchy** in which **environment variables take p
| `KRAWL_DASHBOARD_SECRET_PATH` | Custom dashboard path | Auto-generated | | `KRAWL_DASHBOARD_SECRET_PATH` | Custom dashboard path | Auto-generated |
| `KRAWL_PROBABILITY_ERROR_CODES` | Error response probability (0-100%) | `0` | | `KRAWL_PROBABILITY_ERROR_CODES` | Error response probability (0-100%) | `0` |
| `KRAWL_DATABASE_PATH` | Database file location | `data/krawl.db` | | `KRAWL_DATABASE_PATH` | Database file location | `data/krawl.db` |
| `KRAWL_EXPORTS_PATH` | Path where firewalls rule sets are exported | `exports` |
| `KRAWL_DATABASE_RETENTION_DAYS` | Days to retain data in database | `30` | | `KRAWL_DATABASE_RETENTION_DAYS` | Days to retain data in database | `30` |
| `KRAWL_HTTP_RISKY_METHODS_THRESHOLD` | Threshold for risky HTTP methods detection | `0.1` | | `KRAWL_HTTP_RISKY_METHODS_THRESHOLD` | Threshold for risky HTTP methods detection | `0.1` |
| `KRAWL_VIOLATED_ROBOTS_THRESHOLD` | Threshold for robots.txt violations | `0.1` | | `KRAWL_VIOLATED_ROBOTS_THRESHOLD` | Threshold for robots.txt violations | `0.1` |

2
docs/firewall-exporters.md
View File

@@ -14,6 +14,8 @@ class Iptables{ }
note for Iptables "implements the getBanlist method for iptables rules" note for Iptables "implements the getBanlist method for iptables rules"
``` ```
Rule sets are generated trough the `top_attacking_ips__export-malicious-ips` that writes down the files in the `exports_path` configuration path. Files are named after the specific firewall that they implement as `[firewall]_banlist.txt` except for raw file that is called `malicious_ips.txt` to support legacy
## Adding firewalls exporters ## Adding firewalls exporters
To add a firewall exporter create a new python class in `src/firewall` that implements `FWType` class To add a firewall exporter create a new python class in `src/firewall` that implements `FWType` class