mirror of https://github.com/CyberMind-FR/secubox-deb.git synced 2026-07-29 13:59:40 +00:00

CyberMind-FR b0ae4f1f23 docs(wiki): Add missing wiki pages for complete navigation

Add placeholder pages for sidebar links:
- Architecture-Modules.md
- Architecture-Security.md
- Configuration-Advanced.md
- Modules-Networking.md
- Modules-Security.md
- QEMU-ARM64.md

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

2026-04-26 21:33:29 +02:00

3.2 KiB

Raw Blame History

Architecture — Modules

SecuBox OS modular architecture with 125 packages.

Module Stacks

SecuBox organizes modules into 6 functional stacks:

Stack	Color	Function	Key Modules
🟠 AUTH	Orange	Authentication	auth, portal, nac, users
🟡 WALL	Yellow	Security	crowdsec, waf, ipblock, threats
🔴 BOOT	Red	Deployment	cloner, vault, vm, backup
🟣 MIND	Purple	Intelligence	dpi, ai-insights, netdata
🟢 ROOT	Green	System	core, hub, system, admin
🔵 MESH	Blue	Network	wireguard, haproxy, qos, mesh

Package Naming

All packages follow the pattern: secubox-<module>

secubox-core        # Core library (required)
secubox-hub         # Central dashboard
secubox-crowdsec    # CrowdSec IDS
secubox-wireguard   # WireGuard VPN
...

Module Structure

Each module follows a standard structure:

packages/secubox-<module>/
├── api/
│   └── main.py           # FastAPI endpoints
├── www/
│   ├── index.html        # Web UI
│   └── assets/           # CSS, JS, images
├── debian/
│   ├── control           # Package metadata
│   ├── postinst          # Post-install script
│   └── secubox-<module>.service
└── README.md

API Pattern

All modules expose REST APIs via Unix socket:

Socket: /run/secubox/<module>.sock
Nginx:  /api/v1/<module>/* → unix:/run/secubox/<module>.sock

Endpoint Convention

RPCD (OpenWrt)	FastAPI (SecuBox)
`luci.module/get_status`	`GET /api/v1/module/status`
`luci.module/set_config`	`POST /api/v1/module/config`
`luci.module/apply`	`POST /api/v1/module/apply`

Dependencies

secubox-core (required by all)
    ├── secubox-hub
    ├── secubox-system
    └── secubox-* (all modules)

Install Order

secubox-core — Base library
secubox-hub — Dashboard
Other modules (any order)

Module Communication

┌─────────────┐     ┌─────────────┐     ┌─────────────┐
│   nginx     │────►│  FastAPI    │────►│  Backend    │
│  :443/9443  │     │  Unix sock  │     │  Service    │
└─────────────┘     └─────────────┘     └─────────────┘
       │                   │
       │              JWT Auth
       │                   │
       ▼                   ▼
┌─────────────┐     ┌─────────────┐
│   Web UI    │     │ secubox-core│
│   Browser   │     │   Library   │
└─────────────┘     └─────────────┘

Creating New Modules

# Scaffold new module
bash scripts/new-module.sh mymodule

# Build package
cd packages/secubox-mymodule
dpkg-buildpackage -us -uc -b

# Install
sudo dpkg -i ../secubox-mymodule_*.deb

See Developer-Guide for details.

← Back to Home

3.2 KiB Raw Blame History