diff --git a/README.md b/README.md index cd75b97..9dd3720 100644 --- a/README.md +++ b/README.md @@ -131,47 +131,81 @@ Modern enterprises face increasing security challenges with generally distribute ## 📸 Screenshots -### Dashboard Overview -The central command center for monitoring all Fail2Ban instances and security events. +### Main Dashboard +![Dashboard](screenshots/0_Dashboard.png) +**Description:** The main dashboard view showing an overview of all active jails, banned IPs, and real-time statistics. Displays total bans, recent activity, and quick access to key features. -![Dashboard](./screenshots/0_Dashboard.jpg) +#### Unban IP +![Unban IP](screenshots/0.1_Dashboard_unban_IP.png) +**Description:** Unbanning a IP addresses directly from the dashboard. Shows the unban confirmation dialog. ### Server Management -Add, configure, and manage multiple Fail2Ban servers from the "Manage Servers" modal. +![Manage Servers](screenshots/1_Dashboard_Manage_Servers.png) +**Description:** Server management modal for configuring / adding and managing multiple Fail2Ban instances. Supports local, SSH, and API agent connections. -![Server Management](./screenshots/0.1_Dashboard_Manage_Servers.jpg) +### Jail / Filter Management +![Manage Jails](screenshots/1.1_Dashboard_Manage_Jails.png) +**Description:** Overview of all configured jails with their enabled/disabled status. Allows centralized management of jail configurations across multiple servers. -### IP Search and Management -Quickly locate and review / manage banned IPs across all jails and servers. +#### Edit Jail Configuration +![Edit Jail](screenshots/1.2_Dashboard_Manage_Jails_Edit.png) +**Description:** When clicking on "Edit Filter / Jail" the Jail configuration editor is opened. It shows the current filter and jail configuration with all options to modify the settings, test or add / modify the logpaths, and save changes. -![IP Search](./screenshots/1_Dashboard_search.jpg) +#### Logpath Test +![Logpath Test](screenshots/1.3_Dashboard_Manage_Jails_Edit_Logpathtest.png) +**Description:** Logpath testing functionality that verifies log file paths and checks if files are accessible. Shows test results with visual indicators (✓/✗) for each log path. -### Unban Operations -One-click unban action with confirmation dialog. +#### Create new Filter +![Create Filter](screenshots/1.4_Dashboard_Manage_Jails_Create_Filter.png) +**Description:** The first button opens the modal for creating new Fail2Ban filter files. Includes filter configuration editor with syntax highlighting and validation. -![Unban IP](./screenshots/2_Dashboard_unban_IP.jpg) +#### Create new Jail +![Create Jail](screenshots/1.5_Dashboard_Manage_Jails_Create_Jail.png) +**Description:** The second button opens the Jail creation modal for setting up new jails. Allows configuration of seperate jails with special parameters, filter selection, with automatic configuration generation. -### Configuration Editor -Edit Fail2Ban jail and filter configurations (with syntax highlighting - planned) and validation. +### Search Functionality +![Search](screenshots/1.6_Dashboard_search.png) +**Description:** Search for a specific IPs, that where blocked in a specific jail - searches in all active jails. Provides a quick and painless filtering. -![Configuration Editor](./screenshots/3_Dashboard_edit_filter.jpg) +### Internal Log Overview +![Log Overview](screenshots/2_Dashboard_Log_Overview.png) +**Description:** Comprehensive log overview showing ban / unban events, timestamps, and associated jails and recurring offenders. Provides detailed information about past security events. -### Service Management -Reload or restart Fail2Ban services when needed, with integrated change detection. +#### Whois Information +![Whois](screenshots/2.1_Dashboard_Log_Overview_Whois.png) +**Description:** Whois lookup modal displaying detailed information about banned IP addresses, including geographic location, ISP details, and network information. -![Service Reload](./screenshots/4_Dashboard_Reload.jpg) +#### Ban Logs +![Ban Logs](screenshots/2.2_Dashboard_Log_Overview_BanLogs.png) +**Description:** Detailed ban log view showing log lines that triggered the ban, timestamps, and context information for each security event. ### Filter Debugging -Test and validate Fail2Ban filters using `fail2ban-regex`. +![Filter Debug](screenshots/3_Filter_Debug.png) +**Description:** Filter debugging interface for testing Fail2Ban filter regex patterns against log lines. Helps validate filter configurations before deployment. -![Filter Debug](./screenshots/5_Filter_Debug.jpg) +#### Filter Test Results +![Filter Test Results](screenshots/3.1_Filter_Debug_Testresult.png) +**Description:** Results from filter testing showing matched lines, regex performance, and validation feedback. Displays which log lines match the filter pattern. -### Settings and Configuration -Comprehensive settings management for alerts, advanced banning, and system preferences. +### Settings +![Settings](screenshots/4_Settings.png) +**Description:** Main settings page with sections for different configuration categories including general settings, advanced ban actions, alert settings, and global fail2ban settings. -![Settings](./screenshots/6_Settings.jpg) +#### Debug Console +![Debug Console](screenshots/4.1_Settings_DebugConsole.png) +**Description:** When enabled the Debug console showing real-time application logs, system messages, and debugging information. Useful for troubleshooting and monitoring without the need to query the container logs manually everytime. -![Settings Advanced](./screenshots/7_Settings_Bottom.jpg) +#### Advanced Ban Actions +![Advanced Ban Actions](screenshots/4.2_Settings_AdvancedBanActions.png) +**Description:** Configuration for advanced ban actions including permanent blocking, firewall integrations (Mikrotik, pfSense, OPNsense), and threshold settings for recurring offenders. + +#### Alert Settings +![Alert Settings](screenshots/4.3_Settings_AlertSettings.png) +**Description:** Email alert configuration with SMTP settings, country-based filtering (blocks from what country to raport), GeoIP provider selection, and alert preferences for bans and unbans. + +#### Global Settings +![Global Settings](screenshots/4.4_Settings_GlobalSettings.png) +**Description:** Global Fail2Ban settings including default bantime, findtime, maxretry, banaction configuration (nftables/firewalld/iptables) and so on. --- diff --git a/screenshots/0.1_Dashboard_Manage_Servers.jpg b/screenshots/0.1_Dashboard_Manage_Servers.jpg deleted file mode 100644 index 59e3643..0000000 Binary files a/screenshots/0.1_Dashboard_Manage_Servers.jpg and /dev/null differ diff --git a/screenshots/0.1_Dashboard_unban_IP.png b/screenshots/0.1_Dashboard_unban_IP.png new file mode 100644 index 0000000..9e2b171 Binary files /dev/null and b/screenshots/0.1_Dashboard_unban_IP.png differ diff --git a/screenshots/0_Dashboard.jpg b/screenshots/0_Dashboard.jpg deleted file mode 100644 index c2c46fa..0000000 Binary files a/screenshots/0_Dashboard.jpg and /dev/null differ diff --git a/screenshots/0_Dashboard.png b/screenshots/0_Dashboard.png new file mode 100644 index 0000000..6c254f9 Binary files /dev/null and b/screenshots/0_Dashboard.png differ diff --git a/screenshots/1.1_Dashboard_Manage_Jails.png b/screenshots/1.1_Dashboard_Manage_Jails.png new file mode 100644 index 0000000..728d8f3 Binary files /dev/null and b/screenshots/1.1_Dashboard_Manage_Jails.png differ diff --git a/screenshots/1.2_Dashboard_Manage_Jails_Edit.png b/screenshots/1.2_Dashboard_Manage_Jails_Edit.png new file mode 100644 index 0000000..3740ef7 Binary files /dev/null and b/screenshots/1.2_Dashboard_Manage_Jails_Edit.png differ diff --git a/screenshots/1.3_Dashboard_Manage_Jails_Edit_Logpathtest.png b/screenshots/1.3_Dashboard_Manage_Jails_Edit_Logpathtest.png new file mode 100644 index 0000000..b8ec070 Binary files /dev/null and b/screenshots/1.3_Dashboard_Manage_Jails_Edit_Logpathtest.png differ diff --git a/screenshots/1.4_Dashboard_Manage_Jails_Create_Filter.png b/screenshots/1.4_Dashboard_Manage_Jails_Create_Filter.png new file mode 100644 index 0000000..28899d2 Binary files /dev/null and b/screenshots/1.4_Dashboard_Manage_Jails_Create_Filter.png differ diff --git a/screenshots/1.5_Dashboard_Manage_Jails_Create_Jail.png b/screenshots/1.5_Dashboard_Manage_Jails_Create_Jail.png new file mode 100644 index 0000000..bcc6447 Binary files /dev/null and b/screenshots/1.5_Dashboard_Manage_Jails_Create_Jail.png differ diff --git a/screenshots/1.6_Dashboard_search.png b/screenshots/1.6_Dashboard_search.png new file mode 100644 index 0000000..a0d11e5 Binary files /dev/null and b/screenshots/1.6_Dashboard_search.png differ diff --git a/screenshots/1_Dashboard_Manage_Servers.png b/screenshots/1_Dashboard_Manage_Servers.png new file mode 100644 index 0000000..1707bb8 Binary files /dev/null and b/screenshots/1_Dashboard_Manage_Servers.png differ diff --git a/screenshots/1_Dashboard_search.jpg b/screenshots/1_Dashboard_search.jpg deleted file mode 100644 index b474b21..0000000 Binary files a/screenshots/1_Dashboard_search.jpg and /dev/null differ diff --git a/screenshots/2.1_Dashboard_Log_Overview_Whois.png b/screenshots/2.1_Dashboard_Log_Overview_Whois.png new file mode 100644 index 0000000..68dfe48 Binary files /dev/null and b/screenshots/2.1_Dashboard_Log_Overview_Whois.png differ diff --git a/screenshots/2.2_Dashboard_Log_Overview_BanLogs.png b/screenshots/2.2_Dashboard_Log_Overview_BanLogs.png new file mode 100644 index 0000000..25c1631 Binary files /dev/null and b/screenshots/2.2_Dashboard_Log_Overview_BanLogs.png differ diff --git a/screenshots/2_Dashboard_Log_Overview.png b/screenshots/2_Dashboard_Log_Overview.png new file mode 100644 index 0000000..48eb3a9 Binary files /dev/null and b/screenshots/2_Dashboard_Log_Overview.png differ diff --git a/screenshots/2_Dashboard_unban_IP.jpg b/screenshots/2_Dashboard_unban_IP.jpg deleted file mode 100644 index 8a4f798..0000000 Binary files a/screenshots/2_Dashboard_unban_IP.jpg and /dev/null differ diff --git a/screenshots/3.1_Filter_Debug_Testresult.png b/screenshots/3.1_Filter_Debug_Testresult.png new file mode 100644 index 0000000..f23213c Binary files /dev/null and b/screenshots/3.1_Filter_Debug_Testresult.png differ diff --git a/screenshots/3_Dashboard_edit_filter.jpg b/screenshots/3_Dashboard_edit_filter.jpg deleted file mode 100644 index 4703f15..0000000 Binary files a/screenshots/3_Dashboard_edit_filter.jpg and /dev/null differ diff --git a/screenshots/3_Filter_Debug.png b/screenshots/3_Filter_Debug.png new file mode 100644 index 0000000..ddb4a6c Binary files /dev/null and b/screenshots/3_Filter_Debug.png differ diff --git a/screenshots/4.1_Settings_DebugConsole.png b/screenshots/4.1_Settings_DebugConsole.png new file mode 100644 index 0000000..5ef50a8 Binary files /dev/null and b/screenshots/4.1_Settings_DebugConsole.png differ diff --git a/screenshots/4.2_Settings_AdvancedBanActions.png b/screenshots/4.2_Settings_AdvancedBanActions.png new file mode 100644 index 0000000..3afa995 Binary files /dev/null and b/screenshots/4.2_Settings_AdvancedBanActions.png differ diff --git a/screenshots/4.3_Settings_AlertSettings.png b/screenshots/4.3_Settings_AlertSettings.png new file mode 100644 index 0000000..b36f858 Binary files /dev/null and b/screenshots/4.3_Settings_AlertSettings.png differ diff --git a/screenshots/4.4_Settings_GlobalSettings.png b/screenshots/4.4_Settings_GlobalSettings.png new file mode 100644 index 0000000..cc1a34b Binary files /dev/null and b/screenshots/4.4_Settings_GlobalSettings.png differ diff --git a/screenshots/4_Dashboard_Reload.jpg b/screenshots/4_Dashboard_Reload.jpg deleted file mode 100644 index 6c0eda5..0000000 Binary files a/screenshots/4_Dashboard_Reload.jpg and /dev/null differ diff --git a/screenshots/4_Settings.png b/screenshots/4_Settings.png new file mode 100644 index 0000000..338a950 Binary files /dev/null and b/screenshots/4_Settings.png differ diff --git a/screenshots/5_Filter_Debug.jpg b/screenshots/5_Filter_Debug.jpg deleted file mode 100644 index b1e5dd6..0000000 Binary files a/screenshots/5_Filter_Debug.jpg and /dev/null differ diff --git a/screenshots/6_Settings.jpg b/screenshots/6_Settings.jpg deleted file mode 100644 index ac815c7..0000000 Binary files a/screenshots/6_Settings.jpg and /dev/null differ diff --git a/screenshots/7_Settings_Bottom.jpg b/screenshots/7_Settings_Bottom.jpg deleted file mode 100644 index b4b034a..0000000 Binary files a/screenshots/7_Settings_Bottom.jpg and /dev/null differ diff --git a/screenshots/README.md b/screenshots/README.md new file mode 100644 index 0000000..1b2e669 --- /dev/null +++ b/screenshots/README.md @@ -0,0 +1,79 @@ +# Fail2Ban UI Screenshots + +This directory contains screenshots showcasing the features and the interface of Fail2Ban UI. + +## Main Dashboard +![Dashboard](0_Dashboard.png) +**Description:** The main dashboard view showing an overview of all active jails, banned IPs, and real-time statistics. Displays total bans, recent activity, and quick access to key features. + +## Unban IP +![Unban IP](0.1_Dashboard_unban_IP.png) +**Description:** Unbanning a IP addresses directly from the dashboard. Shows the unban confirmation dialog. + +## Server Management +![Manage Servers](1_Dashboard_Manage_Servers.png) +**Description:** Server management interface for configuring / adding and managing multiple Fail2Ban instances. Supports local, SSH, and API agent connections. + +## Jail Management +![Manage Jails](1.1_Dashboard_Manage_Jails.png) +**Description:** Overview of all configured jails with their enabled/disabled status. Allows centralized management of jail configurations across multiple servers. + +### Edit Jail Configuration +![Edit Jail](1.2_Dashboard_Manage_Jails_Edit.png) +**Description:** When clicking on "Edit Filter / Jail" the Jail configuration editor is opened. It shows the current filter and jail configuration with all options to modify the settings, test or add / modify the logpaths, and save changes. + +### Logpath Test +![Logpath Test](1.3_Dashboard_Manage_Jails_Edit_Logpathtest.png) +**Description:** Logpath testing functionality that verifies log file paths and checks if files are accessible. Shows test results with visual indicators (✓/✗) for each log path. + +### Create Filter +![Create Filter](1.4_Dashboard_Manage_Jails_Create_Filter.png) +**Description:** The first button opens the modal for creating new Fail2Ban filter files. Includes filter configuration editor with syntax highlighting and validation. + +### Create Jail +![Create Jail](1.5_Dashboard_Manage_Jails_Create_Jail.png) +**Description:** The second button opens the Jail creation modal for setting up new jails. Allows configuration of seperate jails with special parameters, filter selection, with automatic configuration generation. + +## Search Functionality +![Search](1.6_Dashboard_search.png) +**Description:** Search for a specific IPs, that where blocked in a specific jail - searches in all active jails. Provides a quick and painless filtering. + +## Internal Log Overview +![Log Overview](2_Dashboard_Log_Overview.png) +**Description:** Comprehensive log overview showing ban / unban events, timestamps, and associated jails and recurring offenders. Provides detailed information about past security events. + +### Whois Information +![Whois](2.1_Dashboard_Log_Overview_Whois.png) +**Description:** Whois lookup modal displaying detailed information about banned IP addresses, including geographic location, ISP details, and network information. + +### Ban Logs +![Ban Logs](2.2_Dashboard_Log_Overview_BanLogs.png) +**Description:** Detailed ban log view showing log lines that triggered the ban, timestamps, and context information for each security event. + +## Filter Debugging +![Filter Debug](3_Filter_Debug.png) +**Description:** Filter debugging interface for testing Fail2Ban filter regex patterns against log lines. Helps validate filter configurations before deployment. + +### Filter Test Results +![Filter Test Results](3.1_Filter_Debug_Testresult.png) +**Description:** Results from filter testing showing matched lines, regex performance, and validation feedback. Displays which log lines match the filter pattern. + +## Settings +![Settings](4_Settings.png) +**Description:** Main settings page with sections for different configuration categories including general settings, advanced ban actions, alert settings, and global fail2ban settings. + +### Debug Console +![Debug Console](4.1_Settings_DebugConsole.png) +**Description:** When enabled the Debug console showing real-time application logs, system messages, and debugging information. Useful for troubleshooting and monitoring without the need to query the container logs manually everytime. + +### Advanced Ban Actions +![Advanced Ban Actions](4.2_Settings_AdvancedBanActions.png) +**Description:** Configuration for advanced ban actions including permanent blocking, firewall integrations (Mikrotik, pfSense, OPNsense), and threshold settings for recurring offenders. + +### Alert Settings +![Alert Settings](4.3_Settings_AlertSettings.png) +**Description:** Email alert configuration with SMTP settings, country-based filtering (blocks from what country to raport), GeoIP provider selection, and alert preferences for bans and unbans. + +### Global Settings +![Global Settings](4.4_Settings_GlobalSettings.png) +**Description:** Global Fail2Ban settings including default bantime, findtime, maxretry, banaction configuration (nftables/firewalld/iptables) and so on.