gandalf/secubox-openwrt
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
829aa1d399
secubox-openwrt/docs/index.md
CyberMind-FR ef936f1295 docs: Add GitHub Pages documentation site structure 
Created comprehensive documentation site using MkDocs Material theme
for GitHub Pages deployment. Moved version sync scripts to secubox-tools.

## Documentation Site (18 new files)

Created docs/ directory with complete documentation:

**Main Pages:**
- index.md - Home page with navigation cards and module overview
- quick-start.md - Quick start guide
- documentation-index.md - Documentation index

**Development Guides:**
- development-guidelines.md - Complete development reference (1857 lines)
- code-templates.md - Working examples and patterns (1405 lines)
- module-implementation-guide.md - Step-by-step workflow (901 lines)

**Reference Documentation:**
- claude.md - Build system and RPCD architecture (553 lines)
- validation-guide.md - Validation workflows (518 lines)
- permissions-guide.md - Permission guidelines (248 lines)
- luci-development-reference.md - LuCI development (1196 lines)

**Module Information:**
- module-status.md - 15 module status (896 lines)
- feature-regeneration-prompts.md - AI prompts (2084 lines)
- todo-analyse.md - Roadmap and tasks (1080 lines)

**Archive (4 files):**
- archive/index.md - Archive index
- archive/build-issues.md - Build troubleshooting
- archive/completion-report.md - Project milestones
- archive/module-enable-disable-design.md - Feature design

**Styling:**
- stylesheets/extra.css - SecuBox custom CSS

## Scripts Reorganization (2 files moved)

Moved version sync utilities to secubox-tools:
- scripts/sync_module_versions.py → secubox-tools/sync_module_versions.py
- scripts/sync_module_versions.sh → secubox-tools/sync_module_versions.sh

## Site Features

- Material theme with dark/light mode
- Responsive design with navigation tabs
- Live search and syntax highlighting
- Custom SecuBox branding (indigo/violet gradients)
- 12,780+ lines of comprehensive documentation

Summary:
- 21 files changed (+12,780 lines)
- 18 new documentation pages
- 2 scripts relocated
- Ready for GitHub Pages deployment

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
2025-12-28 21:57:29 +01:00

5.1 KiB
Raw Blame History

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

📦 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

  1. Quick Start Guide - Essential rules and commands
  2. Development Guidelines - Complete reference
  3. CLAUDE.md - Build system and architecture

For AI-Assisted Development

  1. Module Implementation Guide - Step-by-step workflow
  2. Feature Regeneration Prompts - AI prompts for all modules
  3. Code Templates - Implementation patterns

📞 Support & Resources

📝 License

Apache-2.0

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