Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,24 @@

A comprehensive, self-contained network assessment platform designed for deployment as a network monitoring appliance. Provides complete visibility into LAN environments through passive discovery, real-time traffic analysis, and intelligent topology mapping.

## 🚀 Deployment Options

### Docker Deployment (Recommended for Production)
Traditional multi-container deployment with full features.

### 📦 **NEW: Portable Executable** (Without Docker)
Single executable that runs anywhere - **no Docker, no dependencies, no installation required!**

**Choose your path:**
- ⚡ **Quick portable (1-2 weeks)**: Single 200-400MB executable using Nuitka
- 🖥️ **Professional desktop app (2-4 weeks)**: Native 80-150MB app using Tauri
- 🌐 **Server-client (1-3 weeks)**: Flexible multi-user deployment
- 🚀 **Ultimate performance (4-6 months)**: 30-60MB Go binary

👉 **[Portable Executable Quick Start Guide](docs/PORTABLE_EXECUTABLE_QUICK_START.md)**
📖 **[Full Analysis & Implementation Options](docs/architecture/PORTABLE_EXECUTABLE_SOLUTIONS.md)**


## Core Value Proposition

- **Single-pane visibility** into all network assets and traffic
Expand Down
35 changes: 35 additions & 0 deletions docs/INDEX.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
|----------|---------|----------|
| [Quick Start](guides/QUICK_START.md) | Get running in 5 minutes | All users |
| [Deployment Guide](guides/DEPLOYMENT.md) | Full installation & production setup | DevOps/SysAdmins |
| [Portable Executable Quick Start](PORTABLE_EXECUTABLE_QUICK_START.md) | **NEW**: Docker-free portable deployment options | DevOps/Developers |
| [API Reference](technical/API_rest_v1.md) | REST API documentation | Developers |
| [Contributing](development/CONTRIBUTING.md) | How to contribute | Contributors |

Expand Down Expand Up @@ -63,6 +64,23 @@

---

### [PORTABLE_BUILD_GUIDE_NUITKA.md](guides/PORTABLE_BUILD_GUIDE_NUITKA.md)
**Portable Executable Build Guide (Nuitka)**
- Single executable without Docker
- Database migration (PostgreSQL → SQLite)
- Redis replacement with in-memory cache
- Guacamole handling options
- Frontend embedding
- Nuitka compilation process
- Cross-platform builds (Windows/Linux/macOS)
- Distribution and packaging

**Audience**: Developers, DevOps, Portable deployment users

**Time to implement**: 1-2 weeks

---

### [CONFIGURATION.md](guides/CONFIGURATION.md)
**Configuration Guide**
- Environment variables
Expand Down Expand Up @@ -90,6 +108,23 @@

---

### [PORTABLE_EXECUTABLE_SOLUTIONS.md](architecture/PORTABLE_EXECUTABLE_SOLUTIONS.md)
**Portable Executable Solutions - Comprehensive Analysis**
- Overview of 4 different approaches for Docker-free deployment
- **Option 1**: Nuitka-based all-in-one executable (1-2 weeks)
- **Option 2**: Electron/Tauri desktop application (2-4 weeks)
- **Option 3**: Separate server-client architecture (1-3 weeks)
- **Option 4**: Go/Rust complete rewrite (4-6 months)
- Detailed comparison matrix and use case recommendations
- Implementation steps, pros/cons, and effort estimates
- Hybrid approach and migration paths

**Topics**: Deployment options, Portable executables, Architecture decisions

**Related**: [PORTABLE_EXECUTABLE_QUICK_START.md](PORTABLE_EXECUTABLE_QUICK_START.md), [PORTABLE_BUILD_GUIDE_NUITKA.md](guides/PORTABLE_BUILD_GUIDE_NUITKA.md)

---

## Technical

### [API_rest_v1.md](technical/API_rest_v1.md)
Expand Down
Loading