adding phase 5 init framework, added deployment ease scripts
This commit is contained in:
34
README.md
34
README.md
@@ -28,6 +28,28 @@ A comprehensive network scanning and infrastructure monitoring platform with web
|
||||
|
||||
### Web Application (Recommended)
|
||||
|
||||
**Easy Setup (One Command):**
|
||||
|
||||
```bash
|
||||
# 1. Clone repository
|
||||
git clone <repository-url>
|
||||
cd SneakyScan
|
||||
|
||||
# 2. Run setup script
|
||||
./setup.sh
|
||||
|
||||
# 3. Access web interface at http://localhost:5000
|
||||
```
|
||||
|
||||
The setup script will:
|
||||
- Generate secure keys automatically
|
||||
- Create required directories
|
||||
- Build and start the Docker containers
|
||||
- Initialize the database on first run
|
||||
- Display your login credentials
|
||||
|
||||
**Manual Setup (Alternative):**
|
||||
|
||||
```bash
|
||||
# 1. Clone repository
|
||||
git clone <repository-url>
|
||||
@@ -35,16 +57,12 @@ cd SneakyScan
|
||||
|
||||
# 2. Configure environment
|
||||
cp .env.example .env
|
||||
# Edit .env and set SECRET_KEY and SNEAKYSCANNER_ENCRYPTION_KEY
|
||||
# Edit .env and set SECRET_KEY, SNEAKYSCANNER_ENCRYPTION_KEY, and INITIAL_PASSWORD
|
||||
|
||||
# 3. Build and start
|
||||
docker compose build
|
||||
docker compose up -d
|
||||
# 3. Build and start (database auto-initializes on first run)
|
||||
docker compose up --build -d
|
||||
|
||||
# 4. Initialize database
|
||||
docker compose run --rm init-db --password "YourSecurePassword"
|
||||
|
||||
# 5. Access web interface
|
||||
# 4. Access web interface
|
||||
# Open http://localhost:5000
|
||||
```
|
||||
|
||||
|
||||
Reference in New Issue
Block a user