CyberMind-FR
ce543762cc
Replace github.com/gkerma/secubox-openwrt with github.com/CyberMind-FR/secubox-openwrt across all files. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
5.2 KiB
SecuBox Documentation
Version: 1.0.0 Last Updated: 2025-12-28 Project: OpenWrt LuCI Security & Management Suite
Welcome to the SecuBox documentation! This comprehensive guide covers all aspects of developing, deploying, and maintaining SecuBox modules.
🏗️ What is SecuBox?
SecuBox is a comprehensive security and network management suite for OpenWrt consisting of 15 LuCI application modules that provide:
- Security Monitoring - CrowdSec intrusion prevention, Netdata metrics
- Network Intelligence - Deep packet inspection, traffic classification
- Access Control - Captive portal, authentication, VPN management
- Performance Optimization - QoS, bandwidth management, caching
- System Administration - Centralized dashboard, service management
🚀 Quick Navigation
-
:fontawesome-solid-rocket:{ .lg .middle } Getting Started
New to SecuBox? Start here!
-
:fontawesome-solid-book:{ .lg .middle } Development Guide
Complete development reference with architecture diagrams
-
:fontawesome-solid-code:{ .lg .middle } Code Templates
Working examples and implementation patterns
-
:fontawesome-solid-list-check:{ .lg .middle } Validation
Module validation and testing workflows
📦 15 Module Suite
Core Control (2 modules)
- SecuBox Central Hub - Main dashboard and module management
- System Hub - System administration (health, services, logs, backup, etc.)
Security & Monitoring (2 modules)
- CrowdSec Dashboard - Intrusion prevention and threat intelligence
- Netdata Dashboard - Real-time system monitoring
Network Intelligence (2 modules)
- Netifyd Dashboard - Deep packet inspection and classification
- Network Modes - Network profile management
VPN & Access Control (3 modules)
- WireGuard Dashboard - VPN tunnel management
- Client Guardian - Network access control and captive portal
- Auth Guardian - Authentication system
Bandwidth & Traffic (2 modules)
- Bandwidth Manager - QoS and bandwidth quotas
- Traffic Shaper - Advanced traffic shaping
Performance & Services (2 modules)
- CDN Cache - Content delivery network proxy cache
- VHost Manager - Virtual host configuration
System Optimization (2 modules)
- Media Flow - Media traffic optimization
- KSM Manager - Kernel same-page merging
View Module Status →{ .md-button .md-button--primary }
🎨 Design System
SecuBox uses a modern, consistent design system:
- Color Palette: Indigo/Violet gradients with dark mode support
- Typography: Inter (text) + JetBrains Mono (code/values)
- Components: Cards, badges, buttons with gradient effects
- Layout: Responsive grid system
See the Design System section for complete specifications.
🔧 Development Workflow
!!! warning "Critical Rules"
1. RPCD Naming: Script name must match ubus object (luci.module-name)
2. Menu Paths: Must match view file locations exactly
3. Permissions: 755 for RPCD scripts, 644 for CSS/JS
4. Validation: Always run ./secubox-tools/validate-modules.sh before commit
Development Tools
# Validate all modules (7 automated checks)
./secubox-tools/validate-modules.sh
# Fix file permissions automatically
./secubox-tools/fix-permissions.sh --local
# Build packages locally
./secubox-tools/local-build.sh build luci-app-module-name
Complete Development Workflow →{ .md-button }
🌐 Live Demo
Experience SecuBox in action:
Production Demo: https://secubox.cybermood.eu
- Main dashboard:
/ - System Hub:
/system-hub - CrowdSec:
/crowdsec - All 15 modules accessible
📚 Documentation Sections
For New Contributors
- Quick Start Guide - Essential rules and commands
- Development Guidelines - Complete reference
- CLAUDE.md - Build system and architecture
- Repository Guidelines - Structure, workflows, and PR expectations
For AI-Assisted Development
- Module Implementation Guide - Step-by-step workflow
- Feature Regeneration Prompts - AI prompts for all modules
- Code Templates - Implementation patterns
📞 Support & Resources
- GitHub Repository: gkerma/secubox-openwrt
- Documentation Issues: GitHub Issues
- Technical Support: support@cybermind.fr
- Company: CyberMind.fr
📝 License
Apache-2.0
Last Updated: 2025-12-28 | Maintainer: CyberMind.fr