Merge pull request #43 from hhftechnology/pangolin

Pangolin

Author: hhftechnology

README.md

@@ -19,21 +19,75 @@ CrowdSec Manager is a web-based management interface for CrowdSec operations, Tr
 
 ## Images
 
-<img width="1200" height="630" alt="Dashboard" src="/images/Dashboard.png"/>
-<img width="1200" height="630" alt="Health & Diagnostics" src="/images/Health & Diagnostics.png"/>
-<img width="1200" height="630" alt="Whitelist Management" src="/images/Whitelist Management.png"/>
-<img width="1200" height="630" alt="IP Management" src="/images/IP Management.png"/>
-<img width="1200" height="630" alt="CrowdSec Allowlist Management" src="/images/CrowdSec Allowlist Management.png"/>
-<img width="1200" height="630" alt="Scenario Management" src="/images/Scenario Management.png"/>
-<img width="1200" height="630" alt="Captcha Setup" src="/images/Captcha Setup.png"/>
-<img width="1200" height="630" alt="Decision List Analysis" src="/images/Decision List Analysis.png"/>
-<img width="1200" height="630" alt="Alert List Analysis" src="/images/Alert List Analysis.png"/>
-<img width="1200" height="630" alt="Logs Viewer" src="/images/Logs Viewer.png"/>
-<img width="1200" height="630" alt="Backup Management" src="/images/Backup Management.png"/>
-<img width="1200" height="630" alt="System Update" src="/images/System Update.png"/>
-<img width="1200" height="630" alt="Cron Job Management" src="/images/Cron Job Management.png"/>
-<img width="1200" height="630" alt="Services Management" src="/images/Services Management.png"/>
-<img width="1200" height="630" alt="Configuration" src="/images/Configuration.png"/>
+<img width="1200" height="630" alt="Dashboard" src="/images/dashboard-overview-countries-systems.jpeg"/>
+<img width="1200" height="630" alt="Health & Diagnostics" src="/images/health-diagnostics-overview.jpeg"/>
+<img width="1200" height="630" alt="Whitelist Management" src="/images/whitelist-management.jpeg"/>
+<img width="1200" height="630" alt="IP Management" src="/images/ip-management.jpeg"/>
+<img width="1200" height="630" alt="CrowdSec Allowlist Management" src="/images/allowlists-management.jpeg"/>
+<img width="1200" height="630" alt="Scenario Management" src="/images/scenarios-management.jpeg"/>
+<img width="1200" height="630" alt="Captcha Setup" src="/images/captcha-protection-detect.jpeg"/>
+<img width="1200" height="630" alt="Decision List Analysis" src="/images/decisions-analysis-overview.jpeg"/>
+<img width="1200" height="630" alt="Alert List Analysis" src="/images/alerts-analysis-overview.jpeg"/>
+<img width="1200" height="630" alt="Logs Viewer" src="/images/logs-service-logs.jpeg"/>
+<img width="1200" height="630" alt="Backup Management" src="/images/backup-management.jpeg"/>
+<img width="1200" height="630" alt="System Update" src="/images/system-update.jpeg"/>
+<img width="1200" height="630" alt="Services Management" src="/images/services-management.jpeg"/>
+<img width="1200" height="630" alt="Configuration" src="/images/configuration-settings.jpeg"/>
+<img width="1200" height="630" alt="Alert Filters" src="/images/alerts-analysis-filters.jpeg"/>
+<img width="1200" height="630" alt="Alert Inspect Modal" src="/images/alerts-analysis-inspect-modal.jpeg"/>
+<img width="1200" height="630" alt="Alert Results Table" src="/images/alerts-analysis-results-table.jpeg"/>
+<img width="1200" height="630" alt="Bouncers Management" src="/images/bouncers-management.jpeg"/>
+<img width="1200" height="630" alt="Config Validation" src="/images/config-validation.jpeg"/>
+<img width="1200" height="630" alt="CrowdSec Health Overview" src="/images/crowdsec-health-overview.jpeg"/>
+<img width="1200" height="630" alt="Dashboard Scenarios and Blocked IPs" src="/images/dashboard-overview-scenarios-blocked-ips.jpeg"/>
+<img width="1200" height="630" alt="Decision Results Table" src="/images/decisions-results-table.jpeg"/>
+<img width="1200" height="630" alt="Hub AppSec Configurations" src="/images/hub-appsec-configurations.jpeg"/>
+<img width="1200" height="630" alt="Hub AppSec Rules" src="/images/hub-appsec-rules.jpeg"/>
+<img width="1200" height="630" alt="Hub Collections" src="/images/hub-collections.jpeg"/>
+<img width="1200" height="630" alt="Hub Home Categories" src="/images/hub-home-categories.jpeg"/>
+<img width="1200" height="630" alt="Hub Log Parsers" src="/images/hub-log-parsers.jpeg"/>
+<img width="1200" height="630" alt="Hub Postoverflows" src="/images/hub-postoverflows.jpeg"/>
+<img width="1200" height="630" alt="Hub Remediation Components" src="/images/hub-remediation-components.jpeg"/>
+<img width="1200" height="630" alt="Hub Scenarios Install Mode" src="/images/hub-scenarios-install-mode.jpeg"/>
+<img width="1200" height="630" alt="Notifications Detect" src="/images/notifications-detect.jpeg"/>
+<img width="1200" height="630" alt="Terminal Container Shell" src="/images/terminal-container-shell.png"/>
+
+### Image Index
+
+| Screenshot File | Page |
+| --- | --- |
+| `alerts-analysis-filters.jpeg` | Alerts Analysis (filters panel) |
+| `alerts-analysis-inspect-modal.jpeg` | Alerts Analysis (inspect modal) |
+| `alerts-analysis-overview.jpeg` | Alerts Analysis (overview charts) |
+| `alerts-analysis-results-table.jpeg` | Alerts Analysis (results table) |
+| `allowlists-management.jpeg` | Allowlists Management |
+| `backup-management.jpeg` | Backup Management |
+| `bouncers-management.jpeg` | Bouncers Management |
+| `captcha-protection-detect.jpeg` | Captcha Protection (detect) |
+| `config-validation.jpeg` | Config Validation |
+| `configuration-settings.jpeg` | Configuration Settings |
+| `crowdsec-health-overview.jpeg` | CrowdSec Health Overview |
+| `dashboard-overview-countries-systems.jpeg` | Dashboard (countries and systems) |
+| `dashboard-overview-scenarios-blocked-ips.jpeg` | Dashboard (scenarios and blocked IPs) |
+| `decisions-analysis-overview.jpeg` | Decisions Analysis (overview) |
+| `decisions-results-table.jpeg` | Decisions Analysis (results table) |
+| `health-diagnostics-overview.jpeg` | Health and Diagnostics |
+| `hub-appsec-configurations.jpeg` | Hub Browser (AppSec configurations) |
+| `hub-appsec-rules.jpeg` | Hub Browser (AppSec rules) |
+| `hub-collections.jpeg` | Hub Browser (collections) |
+| `hub-home-categories.jpeg` | Hub Browser (home categories) |
+| `hub-log-parsers.jpeg` | Hub Browser (log parsers) |
+| `hub-postoverflows.jpeg` | Hub Browser (postoverflows) |
+| `hub-remediation-components.jpeg` | Hub Browser (remediation components) |
+| `hub-scenarios-install-mode.jpeg` | Hub Browser (scenarios install mode) |
+| `ip-management.jpeg` | IP Management |
+| `logs-service-logs.jpeg` | Logs (service logs) |
+| `notifications-detect.jpeg` | Notifications (detect) |
+| `scenarios-management.jpeg` | Scenarios Management |
+| `services-management.jpeg` | Services Management |
+| `system-update.jpeg` | System Update |
+| `terminal-container-shell.png` | Terminal (container shell) |
+| `whitelist-management.jpeg` | Whitelist Management |
 
 ## Minimum Docker Compose
 
@@ -80,6 +134,160 @@ docker compose up -d
 curl http://localhost:8080/health
 ```
 
+## API Endpoints
+
+Base prefix: `/api`
+
+### Health
+- `GET /api/health/stack`
+- `GET /api/health/crowdsec`
+- `GET /api/health/complete`
+
+### IP
+- `GET /api/ip/public`
+- `GET /api/ip/blocked/:ip`
+- `GET /api/ip/security/:ip`
+- `POST /api/ip/unban`
+
+### Whitelist
+- `GET /api/whitelist/view`
+- `POST /api/whitelist/current`
+- `POST /api/whitelist/manual`
+- `POST /api/whitelist/cidr`
+- `POST /api/whitelist/crowdsec`
+- `POST /api/whitelist/traefik`
+- `POST /api/whitelist/comprehensive`
+- `DELETE /api/whitelist/remove`
+
+### Allowlist
+- `GET /api/allowlist/list`
+- `POST /api/allowlist/create`
+- `GET /api/allowlist/inspect/:name`
+- `POST /api/allowlist/add`
+- `POST /api/allowlist/remove`
+- `DELETE /api/allowlist/:name`
+
+### Scenarios
+- `POST /api/scenarios/setup`
+- `GET /api/scenarios/list`
+- `GET /api/scenarios/files`
+- `DELETE /api/scenarios/file`
+
+### Captcha
+- `POST /api/captcha/setup`
+- `GET /api/captcha/status`
+- `GET /api/captcha/detect`
+- `POST /api/captcha/config`
+- `POST /api/captcha/apply`
+
+### Logs
+- `GET /api/logs/crowdsec`
+- `GET /api/logs/traefik`
+- `GET /api/logs/traefik/advanced`
+- `GET /api/logs/:service`
+- `GET /api/logs/stream/:service`
+- `GET /api/logs/structured/:service`
+
+### Backup
+- `GET /api/backup/list`
+- `POST /api/backup/create`
+- `POST /api/backup/restore`
+- `DELETE /api/backup/:id`
+- `POST /api/backup/cleanup`
+- `GET /api/backup/latest`
+
+### Update
+- `GET /api/update/check`
+- `POST /api/update/with-crowdsec`
+- `POST /api/update/without-crowdsec`
+
+### Services
+- `GET /api/services/verify`
+- `POST /api/services/shutdown`
+- `POST /api/services/action`
+
+### CrowdSec
+- `GET /api/crowdsec/bouncers`
+- `POST /api/crowdsec/bouncers`
+- `DELETE /api/crowdsec/bouncers/:name`
+- `GET /api/crowdsec/decisions`
+- `POST /api/crowdsec/decisions`
+- `DELETE /api/crowdsec/decisions`
+- `POST /api/crowdsec/decisions/import`
+- `GET /api/crowdsec/decisions/analysis`
+- `GET /api/crowdsec/alerts/analysis`
+- `GET /api/crowdsec/alerts/:id`
+- `DELETE /api/crowdsec/alerts/:id`
+- `GET /api/crowdsec/metrics`
+- `POST /api/crowdsec/enroll`
+- `POST /api/crowdsec/enroll/finalize`
+- `GET /api/crowdsec/enroll/preferences`
+- `PUT /api/crowdsec/enroll/preferences`
+- `GET /api/crowdsec/status`
+
+### Traefik
+- `GET /api/traefik/config`
+- `GET /api/traefik/config-path`
+- `POST /api/traefik/config-path`
+
+### Config
+- `GET /api/config/settings`
+- `PUT /api/config/settings`
+- `GET /api/config/files/:container/:fileType`
+
+### Notifications
+- `GET /api/notifications/discord`
+- `POST /api/notifications/discord`
+- `GET /api/notifications/discord/preview`
+- `GET /api/notifications/discord/detect`
+- `POST /api/notifications/discord/config`
+- `POST /api/notifications/discord/apply`
+
+### Cron
+- `POST /api/cron/setup`
+- `GET /api/cron/list`
+- `DELETE /api/cron/:id`
+
+### Profiles
+- `GET /api/profiles`
+- `POST /api/profiles`
+
+### Hosts
+- `GET /api/hosts/list`
+
+### Terminal
+- `GET /api/terminal/:container`
+
+### Config Validation
+- `GET /api/config/validation/validate`
+- `GET /api/config/validation/snapshots`
+- `POST /api/config/validation/snapshot`
+- `POST /api/config/validation/restore/:type`
+- `POST /api/config/validation/accept/:type`
+- `DELETE /api/config/validation/snapshot/:type`
+
+### Hub
+- `GET /api/hub/list`
+- `POST /api/hub/upgrade`
+- `GET /api/hub/categories`
+- `GET /api/hub/:category/items`
+- `POST /api/hub/:category/install`
+- `POST /api/hub/:category/remove`
+- `POST /api/hub/:category/manual-apply`
+- `GET /api/hub/preferences`
+- `GET /api/hub/preferences/:category`
+- `PUT /api/hub/preferences/:category`
+- `GET /api/hub/history`
+- `GET /api/hub/history/:id`
+
+### Simulation
+- `GET /api/simulation/status`
+- `POST /api/simulation/toggle`
+
+### Events
+- `GET /api/events/ws`
+- `GET /api/events/sse`
+
 ## Documentation
 
 For installation details, feature guides, and API reference, use the docs in [`docs`](https://crowdsec-manager.hhf.technology).