gandalf/secubox-openwrt
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Page: Home
Pages
CLAUDE Code Templates Development Guidelines Documentation Index Feature Regeneration Prompts Home LuCI Development Reference Module Implementation Guide Module Status Permissions Guide Quick Start TODO Analyse Validation Guide archive
2 Home
CyberMind-FR edited this page 2025-12-28 10:15:39 +01:00
Table of Contents

SecuBox Documentation

Version: 1.0.0 Last Updated: 2025-12-28 Project: OpenWrt LuCI Security & Management Suite

Welcome to the SecuBox documentation wiki! This comprehensive guide covers all aspects of developing, deploying, and maintaining SecuBox modules.

📚 Quick Navigation

Getting Started

Core Guides

Reference

Module Specifications

Tools & Automation

🏗️ Architecture Overview

SecuBox is a comprehensive security and network management suite for OpenWrt consisting of 15 LuCI application modules:

Core Control (2 modules)

  • SecuBox Central Hub - Main dashboard and module management
  • System Hub - System administration (9 tabs: 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

🚀 Quick Start

For New Contributors

  1. Start with Quick Start Guide - Essential rules and commands
  2. Read Development Guidelines - Complete development guide
  3. Review CLAUDE - Build system and architecture

For AI-Assisted Development

  1. Use Module Implementation Guide - Step-by-step workflow
  2. Copy prompts from Feature Regeneration Prompts
  3. Reference Code Templates for implementation patterns

📊 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 (130px, 240px, 300px minimums)

See Development Guidelines - Design System for complete specifications.

🔧 Development Workflow

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

Tools

  • validate-modules.sh - 7 automated validation checks
  • fix-permissions.sh - Auto-fix file permissions
  • local-build.sh - Local package building

🌐 Live Demo

Production Demo: https://secubox.cybermood.eu

  • Main dashboard: /
  • System Hub: /system-hub
  • CrowdSec: /crowdsec
  • All 15 modules accessible

📞 Support

📝 License

Apache-2.0

Maintainer: CyberMind.fr Last Updated: 2025-12-28

📚 Navigation

Getting Started

Core Guides

Reference

Specifications

Tools

Quick Links