doc changes

This commit is contained in:
2025-11-19 10:42:49 -06:00
parent 21254c3522
commit 4a4c33a10b
2 changed files with 99 additions and 350 deletions

View File

@@ -20,7 +20,8 @@ A comprehensive network scanning and infrastructure monitoring platform with web
- 📈 **Drift Detection** - Expected vs. actual infrastructure comparison
- 📋 **Multi-Format Reports** - JSON, HTML, and ZIP archives with visual reports
- 🔐 **Authentication** - Session-based login for single-user deployments
- 🔔 **Alerts** *(Phase 5 - Coming Soon)* - Email and webhook notifications for misconfigurations
- 🔔 **Webhook Alerts** - Real-time notifications via Slack, Discord, PagerDuty, and custom integrations
- ⚠️ **Alert Rules** - Automated detection of infrastructure misconfigurations and anomalies
---
@@ -98,8 +99,8 @@ docker compose -f docker-compose-standalone.yml up
## Current Status
**Latest Version**: Phase 4 Complete ✅
**Last Updated**: 2025-11-17
**Latest Version**: Phase 5 Complete ✅
**Last Updated**: 2025-11-19
### Completed Phases
@@ -107,18 +108,19 @@ docker compose -f docker-compose-standalone.yml up
-**Phase 2**: REST API, background jobs, authentication, web UI
-**Phase 3**: Dashboard, scheduling, trend charts
-**Phase 4**: Config creator, YAML editor, config management UI
-**Phase 5**: Webhooks & alerting, notification templates, alert rules
### Next Up: Phase 5 - Email, Webhooks & Comparisons
### Next Up: Phase 6 - CLI as API Client
**Core Use Case**: Monitor infrastructure for misconfigurations that expose unexpected ports/services. When a scan detects an open port not in the config's `expected_ports` list, trigger immediate notifications.
**Goal**: Create a thin CLI client that calls the Flask API for scan operations, enabling scripting and automation workflows while leveraging centralized database storage and web dashboard features.
**Planned Features**:
- Email notifications for infrastructure changes
- Webhook integrations (Slack, PagerDuty, custom SIEM)
- Alert rule engine (unexpected ports, cert expiry, weak TLS)
- Scan comparison reports for drift detection
- API token authentication for CLI access
- Remote scan triggering and status polling
- Centralized scan history accessible via web dashboard
- Scriptable automation workflows
See [Roadmap](docs/ROADMAP.md) for complete feature timeline.
See [Roadmap](docs/ROADMAP.md) for complete feature timeline and future phases.
---
@@ -212,5 +214,5 @@ MIT License - See LICENSE file for details
---
**Version**: Phase 4 Complete
**Last Updated**: 2025-11-17
**Version**: Phase 5 Complete
**Last Updated**: 2025-11-19