secubox/secubox-deb
1
0
Fork 0
mirror of https://github.com/CyberMind-FR/secubox-deb.git synced 2026-07-29 13:59:40 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

docs(wiki): Reorganize to focus on SecuBox OS Appliance

Browse Source 
- Home.md: SecuBox OS as main product with full documentation
- _Sidebar.md: Eye Remote moved to "Addons" section
- Eye-Remote.md: Marked as optional addon, not main feature

The wiki now presents SecuBox OS as the core product with:
- Complete module stack (125 modules)
- ARM64 + x86_64 support
- Security features (firewall, IDS, WAF, DPI)
- Eye Remote as optional monitoring addon

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
CyberMind-FR 2026-04-26 20:41:06 +02:00
parent adc6baf57e
commit 223fce6c19
3 changed files with 170 additions and 124 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

111
docs/wiki/Eye-Remote.md
View File

@ -1,54 +1,68 @@
# 👁️ Eye Remote
# 👁️ Eye Remote — Addon
**SecuBox Eye Remote** — Compact USB gadget display for SecuBox monitoring and boot device.
**SecuBox Eye Remote** — Addon de monitoring USB gadget pour SecuBox OS.
> **Note:** Eye Remote est un **addon optionnel** pour SecuBox OS.
> Il n'est pas nécessaire pour utiliser SecuBox OS, mais offre un affichage
> déporté pratique pour le monitoring et le débogage.
**Hardware:** Raspberry Pi Zero W + HyperPixel 2.1 Round (480×480)
---
## Quick Links
## Pour qui ?
| Cas d'usage | Description |
|-------------|-------------|
| **Datacenter** | Monitoring visuel sans écran sur appliance |
| **Debug terrain** | Console série + affichage status |
| **Démonstration** | Dashboard compact pour salons/présentations |
| **Récupération** | Boot USB de secours via mass storage |
---
## Documentation
| Page | Description |
|------|-------------|
| [[Eye-Remote-Hardware]] | Hardware setup, GPIO, display config |
| [[Eye-Remote-Implementation]] | Software architecture, agent, renderer |
| [[Eye-Remote-Bootstrap]] | Boot device, A/B slots, mass storage |
| [[Eye-Remote-Gateway]] | Gateway emulator for testing |
| [[eye-remote-icons]] | Icon reference with images |
| [[Eye-Remote-Hardware]] | Configuration matérielle, GPIO, display |
| [[Eye-Remote-Implementation]] | Architecture logicielle, agent, renderer |
| [[Eye-Remote-Bootstrap]] | Boot device, slots A/B, mass storage |
| [[Eye-Remote-Gateway]] | Émulateur gateway pour tests |
---
## Features
### Display Dashboard
- 480×480 round framebuffer display
- Radial menu system with 6 slices
- Real-time SecuBox metrics
- Touch navigation
### Dashboard circulaire
- Affichage framebuffer 480×480 rond
- 6 anneaux de status (AUTH, WALL, BOOT, MIND, ROOT, MESH)
- Métriques temps réel SecuBox
- Navigation tactile
### USB Connection
- CDC-ECM network (10.55.0.2 ↔ 10.55.0.1)
- CDC-ACM serial console
- Mass storage for boot images
### Connexion USB OTG
- **CDC-ECM** : réseau 10.55.0.2 ↔ 10.55.0.1
- **CDC-ACM** : console série
- **Mass Storage** : images de boot
### Boot Device
- A/B slot boot media
- Atomic swap for safe updates
- 4-level rollback (R1-R4)
- TFTP netboot server
### Boot Device (optionnel)
- Slots A/B pour boot media
- Swap atomique pour mises à jour sécurisées
- Rollback 4 niveaux (R1-R4)
- Serveur TFTP netboot
---
## Connection Diagram
## Schéma de connexion
```
┌─────────────────┐ USB OTG ┌─────────────────┐
│ Eye Remote │◄────────────────►│ SecuBox │
│ Eye Remote │◄────────────────►│ SecuBox OS │
│ Pi Zero W │ 10.55.0.0/30 │ Appliance │
│ HyperPixel 2.1 │ │ │
└─────────────────┘ └─────────────────┘
│ │
│ Display │ LAN
│ Display │ LAN/WAN
▼ ▼
┌─────────┐ ┌─────────┐
│ 480×480 │ │ Network │
@ -58,45 +72,44 @@
---
## Radial Menu
The display shows a radial menu with 6 colored slices:
| Slice | Color | Function |
|-------|-------|----------|
| 0 | #C04E24 | DEVICES |
| 1 | #9A6010 | SECUBOX |
| 2 | #803018 | LOCAL |
| 3 | #3D35A0 | NETWORK |
| 4 | #0A5840 | SECURITY |
| 5 | #104A88 | EXIT |
See [[eye-remote-icons]] for complete icon reference.
---
## Build & Deploy
```bash
# Build Eye Remote image
# Prérequis: SecuBox OS déjà déployé sur l'appliance cible
# Build image Eye Remote
cd remote-ui/round
sudo ./build-eye-remote-image.sh -i raspios-lite.img.xz
# Flash to SD card
# Flasher sur carte SD
sudo dd if=eye-remote.img of=/dev/sdX bs=4M status=progress
# Test with gateway emulator
cd tools/secubox-eye-gateway
./secubox-eye-gateway --profile stressed
# Brancher le Pi Zero W sur le port USB de l'appliance SecuBox
# (port DATA, pas PWR)
```
---
## Translations
## Palette de couleurs
| Module | Couleur | Hex |
|--------|---------|-----|
| AUTH | Orange | #C04E24 |
| WALL | Jaune-brun | #9A6010 |
| BOOT | Rouge-brun | #803018 |
| MIND | Violet | #3D35A0 |
| ROOT | Vert | #0A5840 |
| MESH | Bleu | #104A88 |
Voir [[eye-remote-icons]] pour la référence des icônes.
---
## Traductions
- [[Eye-Remote-Bootstrap-FR|Français]]
- [[Eye-Remote-Bootstrap-ZH|中文]]
---
*← Back to [[Home|SecuBox Wiki]]*
*← Retour à [[Home|SecuBox OS]]*

154
docs/wiki/Home.md
View File

@ -1,23 +1,39 @@
# SecuBox-Deb
# SecuBox OS
**CyberMind · Gondwana · Notre-Dame-du-Cruet · Savoie** | [FR](Home-FR) | [中文](Home-ZH)
Complete security appliance ported from OpenWrt to Debian bookworm. Designed for GlobalScale ARM64 boards (MOCHAbin, ESPRESSObin) and x86_64 systems.
**SecuBox OS** — Appliance de cybersécurité complète portée depuis OpenWrt vers Debian bookworm.
Conçue pour boards ARM64 GlobalScale (MOCHAbin, ESPRESSObin) et systèmes x86_64.
**125 packages · 2000+ API endpoints · ANSSI CSPN candidate**
**125 modules · 2000+ endpoints API · Candidat ANSSI CSPN**
---
## 🔴 BOOT — Quick Start
## Qu'est-ce que SecuBox OS ?
### VirtualBox (Recommended) ⭐
SecuBox OS est un système d'exploitation durci orienté sécurité réseau :
| Fonction | Description |
|----------|-------------|
| **Firewall** | nftables DEFAULT DROP, règles automatiques |
| **IDS/IPS** | CrowdSec + Suricata, threat intelligence temps réel |
| **WAF** | HAProxy + mitmproxy, 300+ règles ModSecurity |
| **VPN** | WireGuard natif, mesh P2P |
| **DPI** | nDPId + netifyd, analyse trafic L7 |
| **DNS** | Unbound Vortex, blocklists automatiques |
---
## 🔴 BOOT — Démarrage rapide
### VirtualBox (Recommandé)
```bash
# One-liner with auto-download
# One-liner avec téléchargement auto
curl -sL https://raw.githubusercontent.com/CyberMind-FR/secubox-deb/master/image/create-vbox-vm.sh | bash -s -- --download
```
See [[Live-USB-VirtualBox]] for details.
Voir [[Live-USB-VirtualBox]] pour les détails.
### Live USB
@ -26,9 +42,9 @@ wget https://github.com/CyberMind-FR/secubox-deb/releases/latest/download/secubo
zcat secubox-live-amd64-bookworm.img.gz | sudo dd of=/dev/sdX bs=4M status=progress
```
See [[Live-USB]] for complete guide.
Voir [[Live-USB]] pour le guide complet.
### APT Install
### Installation APT
```bash
curl -fsSL https://apt.secubox.in/install.sh | sudo bash
@ -37,99 +53,123 @@ sudo apt install secubox-full
---
## 🟠 AUTH — Access
## 🟠 AUTH — Accès
| Service | Username | Password | Port |
|---------|----------|----------|------|
| Service | Utilisateur | Mot de passe | Port |
|---------|-------------|--------------|------|
| Web UI | admin | secubox | 9443 |
| SSH | root | secubox | 2222 |
---
## 🟢 ROOT — Hardware
## 🟢 ROOT — Matériel supporté
| Board | SoC | Profile |
|-------|-----|---------|
| MOCHAbin | Armada 7040 | Full |
| ESPRESSObin v7 | Armada 3720 | Lite |
| VM x86_64 | Any | Full |
### ARM64 (Production)
| Board | SoC | Profil | Usage |
|-------|-----|--------|-------|
| MOCHAbin | Armada 7040 | Full | Entreprise, datacenter |
| ESPRESSObin v7 | Armada 3720 | Lite | PME, agences |
| ESPRESSObin Ultra | Armada 3720 | Lite+ | PME étendu |
### x86_64 (Dev/Test)
| Plateforme | Profil | Usage |
|------------|--------|-------|
| VirtualBox | Full | Développement |
| QEMU/KVM | Full | Test/CI |
| Bare metal | Full | Production x86 |
---
## 🟣 MIND — Module Stack
## 🟣 MIND — Stack modulaire
| Stack | Function | Key Modules |
|-------|----------|-------------|
| 🟠 AUTH | Authentication | auth, portal, nac |
| 🟡 WALL | Firewall/IDS | crowdsec, waf, ipblock |
| 🔴 BOOT | Deployment | cloner, vault, vm |
| 🟣 MIND | AI/DPI | dpi, netifyd, ai-insights |
| 🟢 ROOT | System | core, hub, system |
| 🔵 MESH | Network | wireguard, haproxy, qos |
SecuBox OS est organisé en 6 stacks fonctionnelles :
See [[Modules]] for all 125 modules.
| Stack | Code couleur | Modules clés |
|-------|--------------|--------------|
| 🟠 **AUTH** | Orange | auth, portal, nac, users |
| 🟡 **WALL** | Jaune | crowdsec, waf, ipblock, threats |
| 🔴 **BOOT** | Rouge | cloner, vault, vm, backup |
| 🟣 **MIND** | Violet | dpi, ai-insights, netdata |
| 🟢 **ROOT** | Vert | core, hub, system, admin |
| 🔵 **MESH** | Bleu | wireguard, haproxy, qos, mesh |
Voir [[Modules]] pour les 125 modules.
---
## 🔵 MESH — Documentation
### Getting Started
- [[Live-USB-VirtualBox|VirtualBox]] ⭐
### Démarrage
- [[Live-USB-VirtualBox|VirtualBox]]
- [[Live-USB|USB Boot]]
- [[ARM-Installation|ARM Boards]]
- [[QEMU-ARM64|QEMU Emulation]]
- [[ARM-Installation|Boards ARM]]
- [[QEMU-ARM64|Émulation QEMU]]
### Configuration
- [[Configuration]]
- [[Configuration-Advanced]]
- [[Troubleshooting]]
### Architecture
- [[Architecture-Boot|Boot Layers]]
- [[Architecture-Modules|Module Design]]
- [[Architecture-Security|Security Model]]
- [[Architecture-Boot|Couches de boot]]
- [[Architecture-Modules|Design modulaire]]
- [[Architecture-Security|Modèle de sécurité]]
### Development
### Développement
- [[Developer-Guide]]
- [[Design-System|UI/UX]]
- [[API-Reference]]
---
## 👁️ Eye Remote
## 🟡 WALL — Sécurité
Compact USB gadget display for SecuBox monitoring.
### Firewall & IDS
- **nftables** — DEFAULT DROP, règles dynamiques
- **CrowdSec** — IDS communautaire, bouncer automatique
- **Suricata** — Signatures ET Open
**Hardware:** Pi Zero W + HyperPixel 2.1 Round (480×480)
**Connection:** USB OTG (10.55.0.0/30) or WiFi
### WAF & Inspection
- **HAProxy** — TLS 1.3, load balancing
- **mitmproxy** — Inspection HTTPS transparente
- **300+ règles** — OWASP ModSecurity CRS
| Page | Description |
|------|-------------|
| [[Eye-Remote]] | Overview & quick links |
| [[Eye-Remote-Hardware]] | Hardware setup |
| [[Eye-Remote-Implementation]] | Software architecture |
| [[Eye-Remote-Bootstrap]] | Boot device mode |
| [[eye-remote-icons]] | Icon reference |
### AI & Threat Intel
- **AI-Insights** — Détection ML anomalies
- **Threat feeds** — AbuseIPDB, Emerging Threats
- **Geo-blocking** — Blocage par pays
---
## Addons
### 👁️ Eye Remote (Addon)
Dashboard USB gadget compact pour monitoring SecuBox.
| Composant | Description |
|-----------|-------------|
| Hardware | Pi Zero W + HyperPixel 2.1 Round (480×480) |
| Connexion | USB OTG (10.55.0.0/30) ou WiFi |
| Modes | Normal, Flash, Debug, TTY, Auth |
**Documentation :** [[Eye-Remote|Eye Remote Addon]]
```bash
# Build image Pi Zero W
cd remote-ui/round
sudo ./build-eye-remote-image.sh -i raspios-lite.img.xz
```
---
## 🟡 WALL — Security
- **CrowdSec** — Community IDS/IPS
- **WAF** — 300+ ModSecurity rules
- **nftables** — Default DROP
- **AI-Insights** — ML threat detection
---
## Links
## Liens
- [GitHub](https://github.com/CyberMind-FR/secubox-deb)
- [Releases](https://github.com/CyberMind-FR/secubox-deb/releases)
- [APT Repository](https://apt.secubox.in)
- [CyberMind](https://cybermind.fr)
---

29
docs/wiki/_Sidebar.md
View File

@ -1,17 +1,17 @@
**[SecuBox-Deb](Home)** · [FR](Home-FR) · [中文](Home-ZH)
**[SecuBox OS](Home)** · [FR](Home-FR) · [中文](Home-ZH)
---
## SecuBox
## SecuBox OS
### 🔴 BOOT — Start
### 🔴 BOOT — Démarrage
* [[Home|Overview]]
* [[Live-USB-VirtualBox|VirtualBox]] ⭐
* [[Live-USB-VirtualBox|VirtualBox]]
* [[Live-USB|USB Boot]]
* [[Installation|APT Install]]
* [[ARM-Installation|ARM Boards]]
* [[ARM-Installation|Boards ARM]]
### 🟢 ROOT — Config
### 🟢 ROOT — Configuration
* [[Configuration]]
* [[Configuration-Advanced]]
* [[Troubleshooting]]
@ -33,20 +33,13 @@
---
## 👁️ Eye Remote
## Addons
### Hardware
* [[Eye-Remote-Hardware|Pi Zero W + HyperPixel]]
* [[eye-remote-icons|Icons Reference]]
### Software
* [[Eye-Remote-Implementation|Architecture]]
### 👁️ Eye Remote
* [[Eye-Remote|Overview]]
* [[Eye-Remote-Hardware|Hardware]]
* [[Eye-Remote-Implementation|Implementation]]
* [[Eye-Remote-Bootstrap|Boot Media]]
* [[Eye-Remote-Gateway|Gateway Emulator]]
### Translations
* [[Eye-Remote-Bootstrap-FR|Bootstrap FR]]
* [[Eye-Remote-Bootstrap-ZH|Bootstrap 中文]]
---