mykey/Fail2Ban-Dashboard---NPM
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: wire in screenshots

Browse Source
This commit is contained in:
gitea
2026-02-20 19:57:52 +00:00
parent dba04152cb
commit a24ab962e1
2 changed files with 9 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
USERGUIDE.md
View File

@@ -18,7 +18,7 @@ The dashboard gives you a live view of what's happening, and lets you take actio
Navigate to `http://YOUR_SERVER_IP:4000` in your browser.
<!-- SCREENSHOT: Full dashboard on first load — ban grid visible with several cards, filter tabs across the top, action bar below the tabs, dark retro-terminal theme -->
![F2B Control Center dashboard](Screenshots/Full%20Ban%20Grid.png)
---
@@ -26,7 +26,7 @@ Navigate to `http://YOUR_SERVER_IP:4000` in your browser.
The main view is a grid of cards — one card per banned IP address.
<!-- SCREENSHOT: Close-up of 2-3 ban cards side by side — showing IP, jail badge (e.g. BADBOT), ban expiry time, AbuseIPDB score, and action buttons -->
![Ban cards](Screenshots/Full%20Ban%20Grid.png)
Each card shows:
@@ -54,7 +54,7 @@ Every ban comes from a "jail" — a rule set that detected bad behaviour:
## Filter Tabs
<!-- SCREENSHOT: The filter tab row at full width — [ALL] [BADBOT] [NPM] [HTTP-ERRORS] [PRISON] [WHITELIST] [EXEMPT] [SCAN] — with one tab highlighted/active -->
![Filter tabs](Screenshots/Filter%20Tab%20Row.png)
The row of buttons across the top filters the grid:
@@ -82,7 +82,7 @@ Each card has buttons for acting on that IP:
## The Action Bar
<!-- SCREENSHOT: The action bar — IP address input field on the left, dropdown selector showing options (ARREST / PAROLE / WHITELIST / SEARCH), GO button on the right -->
![Action bar](Screenshots/Action%20Bar.png)
The bar just below the filter tabs lets you act on any IP by address — even ones that aren't currently banned:
@@ -101,7 +101,6 @@ Actions available here:
## Scan
<!-- SCREENSHOT: Scan results — 4-5 suspect IP cards visible, each with [BAN], [EXEMPT], [THREAT], [RECORDS] buttons; one card showing a high AbuseIPDB score in red -->
The Scan reads your NPM access logs and surfaces IP addresses that are behaving suspiciously but haven't been banned yet. Click **`[SCAN]`** in the filter tabs to run it.
@@ -134,7 +133,7 @@ When in doubt about an IP you've reviewed: use Exempt. Reserve Whitelist for thi
## Live Log
<!-- SCREENSHOT: Live log stream panel — scrolling text of fail2ban log output showing detection events and ban notices, monospace font, dark background, newest entry at bottom -->
![Live log stream](Screenshots/Scan%20Log%20Stream.png)
The live log shows fail2ban's activity as it happens — every detection, ban, and unban in real time. Useful for confirming that a ban landed, watching a scan in progress, or just seeing what's hitting your server right now.
@@ -142,7 +141,7 @@ The live log shows fail2ban's activity as it happens — every detection, ban, a
## Access Log Viewer (Records)
<!-- SCREENSHOT: Per-IP log viewer — showing a filtered list of HTTP requests from one IP: method, path, status code, timestamp, one or two suspicious paths highlighted -->
![Per-IP access log viewer](Screenshots/Per-IP%20Records.png)
Click **`[RECORDS]`** on any ban card or scan result to open a filtered view of the NPM access log for that specific IP. You'll see every request it made — what paths it hit, what status codes it got back, and when.