sneakygeek/SneakyScan
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

updating readme to align with new config layout

Browse Source
This commit is contained in:
Phillip Tarrant
2025-11-20 13:05:41 -06:00
parent 801ddc8d81
commit 949bccf644
1 changed files with 7 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@@ -3,7 +3,7 @@
A comprehensive network scanning and infrastructure monitoring platform with web interface and CLI scanner. SneakyScanner uses masscan for fast port discovery, nmap for service detection, sslyze for SSL/TLS analysis, and Playwright for webpage screenshots to perform comprehensive infrastructure audits. A comprehensive network scanning and infrastructure monitoring platform with web interface and CLI scanner. SneakyScanner uses masscan for fast port discovery, nmap for service detection, sslyze for SSL/TLS analysis, and Playwright for webpage screenshots to perform comprehensive infrastructure audits.
**Primary Interface**: Web Application (Flask-based GUI) **Primary Interface**: Web Application (Flask-based GUI)
**Alternative**: Standalone CLI Scanner (for testing and CI/CD) **Scripting/Automation**: REST API (see [API Reference](docs/API_REFERENCE.md))
--- ---
@@ -12,7 +12,7 @@ A comprehensive network scanning and infrastructure monitoring platform with web
- 🌐 **Web Dashboard** - Modern web UI for scan management, scheduling, and historical analysis - 🌐 **Web Dashboard** - Modern web UI for scan management, scheduling, and historical analysis
- 📊 **Database Storage** - SQLite-based scan history with trend analysis and comparison - 📊 **Database Storage** - SQLite-based scan history with trend analysis and comparison
- ⏰ **Scheduled Scans** - Cron-based automated scanning with APScheduler - ⏰ **Scheduled Scans** - Cron-based automated scanning with APScheduler
- 🔧 **Config Creator** - CIDR-to-YAML configuration builder for quick setup - 🔧 **Config Creator** - Web-based target configuration builder for quick setup
- 🔍 **Network Discovery** - Fast port scanning with masscan (all 65535 ports, TCP/UDP) - 🔍 **Network Discovery** - Fast port scanning with masscan (all 65535 ports, TCP/UDP)
- 🎯 **Service Detection** - Nmap-based service enumeration with version detection - 🎯 **Service Detection** - Nmap-based service enumeration with version detection
- 🔒 **SSL/TLS Analysis** - Certificate extraction, TLS version testing, cipher suite analysis - 🔒 **SSL/TLS Analysis** - Certificate extraction, TLS version testing, cipher suite analysis
@@ -27,7 +27,7 @@ A comprehensive network scanning and infrastructure monitoring platform with web
## Quick Start ## Quick Start
### Web Application (Recommended) ### Web Application
**Easy Setup (One Command):** **Easy Setup (One Command):**
@@ -69,28 +69,13 @@ docker compose up --build -d
**See [Deployment Guide](docs/DEPLOYMENT.md) for detailed setup instructions.** **See [Deployment Guide](docs/DEPLOYMENT.md) for detailed setup instructions.**
### CLI Scanner (Standalone)
For quick one-off scans without the web interface:
```bash
# Build and run
docker compose -f docker-compose-standalone.yml build
docker compose -f docker-compose-standalone.yml up
# Results saved to ./output/
```
**See [CLI Scanning Guide](docs/CLI_SCANNING.md) for detailed usage.**
--- ---
## Documentation ## Documentation
### User Guides ### User Guides
- **[Deployment Guide](docs/DEPLOYMENT.md)** - Installation, configuration, and production deployment - **[Deployment Guide](docs/DEPLOYMENT.md)** - Installation, configuration, and production deployment
- **[CLI Scanning Guide](docs/CLI_SCANNING.md)** - Standalone scanner usage, configuration, and output formats - **[API Reference](docs/API_REFERENCE.md)** - Complete REST API documentation for scripting and automation
- **[API Reference](docs/API_REFERENCE.md)** - Complete REST API documentation
### Developer Resources ### Developer Resources
- **[Roadmap](docs/ROADMAP.md)** - Project roadmap, architecture, and planned features - **[Roadmap](docs/ROADMAP.md)** - Project roadmap, architecture, and planned features
@@ -107,7 +92,7 @@ docker compose -f docker-compose-standalone.yml up
- ✅ **Phase 1**: Database schema, SQLAlchemy models, settings system - ✅ **Phase 1**: Database schema, SQLAlchemy models, settings system
- ✅ **Phase 2**: REST API, background jobs, authentication, web UI - ✅ **Phase 2**: REST API, background jobs, authentication, web UI
- ✅ **Phase 3**: Dashboard, scheduling, trend charts - ✅ **Phase 3**: Dashboard, scheduling, trend charts
- ✅ **Phase 4**: Config creator, YAML editor, config management UI - ✅ **Phase 4**: Config creator, target editor, config management UI
- ✅ **Phase 5**: Webhooks & alerting, notification templates, alert rules - ✅ **Phase 5**: Webhooks & alerting, notification templates, alert rules
### Next Up: Phase 6 - CLI as API Client ### Next Up: Phase 6 - CLI as API Client
@@ -188,7 +173,7 @@ See [Deployment Guide](docs/DEPLOYMENT.md) for production security checklist.
## Contributing ## Contributing
This is a personal/small team project. For bugs or feature requests: This is a personal project. For bugs or feature requests:
1. Check existing issues 1. Check existing issues
2. Create detailed bug reports with reproduction steps 2. Create detailed bug reports with reproduction steps
@@ -206,7 +191,6 @@ MIT License - See LICENSE file for details
**Documentation**: **Documentation**:
- [Deployment Guide](docs/DEPLOYMENT.md) - [Deployment Guide](docs/DEPLOYMENT.md)
- [CLI Scanning Guide](docs/CLI_SCANNING.md)
- [API Reference](docs/API_REFERENCE.md) - [API Reference](docs/API_REFERENCE.md)
- [Roadmap](docs/ROADMAP.md) - [Roadmap](docs/ROADMAP.md)
@@ -214,5 +198,5 @@ MIT License - See LICENSE file for details
--- ---
**Version**: Phase 5 Complete **Version**: 1.0.0-beta
**Last Updated**: 2025-11-19 **Last Updated**: 2025-11-19