From 4fe64b44e40e8e9ac2fd91e286e085e43546bb6a Mon Sep 17 00:00:00 2001 From: SubleXBle <51033045+SubleXBle@users.noreply.github.com> Date: Fri, 22 Aug 2025 15:46:08 +0200 Subject: [PATCH] Update README.md --- README.md | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 521b0e0..638b845 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # Fail2Ban-Report > Beta 5.0 | Version 0.5.0 -> A simple and clean web-based multi-Server dashboard to turn your daily Fail2Ban logs from your servers/hosts into searchable and filterable JSON reports β€” with optional IP blocklist management for UFW. +> A lightweight web-based multi-server dashboard that transforms daily Fail2Ban logs into searchable and filterable JSON reports, while also providing centralized UFW IP blocklist management across all your servers. **Integration** >Designed for easy integration on a wide range of Linux systems β€” from small Raspberry Pis to modest business setups β€” though it’s not (yet) targeted at large-scale enterprise environments. @@ -13,10 +13,10 @@ High flexibility comes from the backend shell scripts, which you can adapt to yo πŸ” Security Notice **Current Status:** -> Fail2Ban-Report currently manages bans and unbans through **UFW**, serving as a safe solution. -> It does **not** directly modify Fail2Ban jails or change existing fail2ban configurations as it uses ufw for it's own permanent "Jails" -> Fail2Ban-Report now supports **multi-server setups** and **role-based access**: -> Viewer accounts are read-only, while Admins can manage bans/unbans via the dashboard. +> Fail2Ban-Report currently manages bans and unbans via UFW, providing a safe and persistent solution. +It does not modify Fail2Ban jails or existing Fail2Ban configurations directly, instead using UFW for its own "permanent jails". + +> Version 0.5.0 introduces multi-server support and role-based access: Viewer accounts are read-only, while Admins can manage bans/unbans and blocklists across all connected servers via the dashboard. **Future Direction:** > A potential long-term enhancement could include **direct interaction with Fail2Ban jails** β€” for example, user-controlled bans and unbans per jail. @@ -32,12 +32,12 @@ Fail2Ban-Report parses your `fail2ban.log` and generates JSON-based reports view It provides optional tools to: - πŸ“Š Visualize **ban** and **unban** events, including per-jail statistics -- ⚑ Interact with IPs (e.g., manually block, unblock) β€” **only Admins** can perform actions +- ⚑ Interact with IPs (e.g., manually block, unblock) β€” **only Admins can perform actions** - πŸ“‚ Maintain **jail-specific and per-server** persistent blocklists (JSON) with `active`, `pending`, and `source` metadata - πŸ”„ Sync those lists with your system firewall using **ufw** - 🌐 Switch between multiple servers in the dashboard for multi-server setups -- 🚨 Show **warning indicators** when ban rates exceed configurable thresholds -- 🚨 Show **Markers** when an IP Address is present multiple times in one (yellow) or more (red) jails +- 🚨 Show **Warning and Critical indicators** when ban rates exceed configurable thresholds +- 🚨 Show **Markers** when an IP Address had a **ban-increase** (🟑) or **more than one ban event** on one day (πŸ”΄) > **Note:** Viewer accounts are read-only. Direct integration with other firewalls or native Fail2Ban jail commands is not yet implemented. @@ -71,13 +71,14 @@ It provides optional tools to: πŸ” **Searchable & filterable log reports** β€” by date, jail, IP πŸ”§ **Integrated JSON blocklist** β€” persistent Block-Overview per server -🧱 **Firewall sync** β€” UFW supported (future: nftables, firewalld, rsync backend) +🧱 **Firewall sync** β€” UFW supported ⚑ **Lightweight setup** β€” no DB, no frameworks -πŸ” **Secure & hardened** β€” minimal external dependencies, strict headers, htaccess protected +πŸ” **Secure & hardened** β€” minimal external dependencies (jq, awk), strict headers, htaccess protected πŸ› οΈ **Installer / Setup scripts** β€” automate folder creation, permissions, user management 🧩 **Modular & extendable design** β€” includes, paths, scripts clearly separated -πŸͺ΅ **Optional logging** β€” block/unblock actions logged via firewall-update.sh +πŸͺ΅ **Optional Backend logging** β€” block/unblock actions logged via firewall-update.sh πŸ•΅οΈ **Optional IP reputation check** β€” AbuseIPDB manual lookup from UI +πŸ•΅οΈ **Optional IP location/provider Check** β€” IP-Info manual lookup from UI πŸ‘₯ **User roles & authentication** β€” Viewer (read-only) / Admin (Ban/Unban) 🌐 **Multiserver support** β€” switch between servers in UI, central blocklist management