gandalf/secubox-openwrt
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
15b7f45ab2
secubox-openwrt/docs/index.md
CyberMind-FR 75042a8efb Add GitHub Pages documentation site with MkDocs Material 
Generated professional documentation site structure:
- mkdocs.yml: Material theme with dark/light mode, search, navigation
- docs/: Complete documentation sync from DOCS/ (13 files + archive)
- docs/stylesheets/extra.css: SecuBox custom styling (indigo/violet)
- docs/archive/: Archived historical documents (4 files)

Features:
- Material Design theme matching SecuBox design system
- Dark/Light mode toggle with indigo/purple palette
- Advanced navigation (tabs, sections, instant loading)
- Search with suggestions and highlighting
- Mermaid diagram support for architecture visuals
- Code syntax highlighting with copy button
- Mobile responsive layout
- Custom CSS with gradient headings and card effects

Setup:
- Updated scripts/setup-github-pages.sh for Ubuntu 24.04 compatibility
- Added dependency check and auto-install (apt or pip)
- Fixed Python externally-managed-environment handling
- Updated .gitignore to exclude site/, .venv/, docs/.DS_Store

Next steps:
1. Test locally: mkdocs serve
2. Enable GitHub Pages: Settings → Pages → Source: master, Folder: /docs
3. Site will be live at: https://gkerma.github.io/secubox-openwrt/

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

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
2025-12-28 10:06:23 +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