secubox-openwrt/luci-app-netdata-dashboard
CyberMind-FR 403283419c docs: Reorganize documentation structure and add architecture diagrams
Major documentation improvements and restructuring for better maintainability
and navigation.

## Structural Changes

### New Documentation Organization
- Move all documentation to DOCS/ directory for better organization
- Create DOCS/archive/ for historical documents
- Move deployment scripts to secubox-tools/ directory

### Archived Documents
- COMPLETION_REPORT.md → archive/ (project milestone)
- MODULE-ENABLE-DISABLE-DESIGN.md → archive/ (feature implemented)
- BUILD_ISSUES.md → archive/ (issues resolved)
- Add archive/README.md with archiving policy and document index

## Documentation Enhancements

### Version Standardization
- Add version headers to CLAUDE.md (v1.0.0)
- Add version headers to BUILD_ISSUES.md (v1.0.0)
- Standardize date format to YYYY-MM-DD across all docs

### Cross-References & Navigation
- Add "See Also" sections to PERMISSIONS-GUIDE.md
- Add "See Also" sections to VALIDATION-GUIDE.md
- Link quick references to detailed guides
- Improve documentation discoverability

### Architecture Diagrams (Mermaid)
Add 3 professional diagrams to DEVELOPMENT-GUIDELINES.md:

1. **System Architecture Diagram** (§2)
   - Complete data flow: Browser → LuCI → RPCD → ubus → System
   - Color-coded components by layer
   - Shows JavaScript, RPC, RPCD daemon, UCI, system services

2. **Deployment Workflow Diagram** (§9)
   - Step-by-step deployment process with validation checkpoints
   - Error recovery paths for common issues (403, 404, -32000)
   - Local validation, file transfer, permission fixes, service restarts

3. **Component Hierarchy Diagram** (§1)
   - Standard page structure and CSS class relationships
   - Page → Header → Stats → Content → Cards → Buttons
   - Shows design system component organization

## New Files

### TODO-ANALYSE.md
- Comprehensive documentation improvement roadmap
- Tasks categorized: Immediate, Short-term, Long-term, Optional
- Progress tracking with acceptance criteria
- Covers testing, security, performance guides
- Documentation automation plans

## Benefits

 Cleaner project structure (docs in DOCS/, tools in secubox-tools/)
 Better documentation navigation with cross-references
 Visual understanding through architecture diagrams
 Historical documents archived but accessible
 Standardized versioning across all documentation
 Clear roadmap for future documentation improvements

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

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
2025-12-28 09:52:15 +01:00
..
.github/workflows fix: hope modules refresh 2025-12-23 18:53:18 +01:00
htdocs/luci-static/resources feat: apply Design System v0.3.0 to all 15 SecuBox modules 2025-12-26 20:15:33 +01:00
root/usr fix: Add missing API functions to resolve module errors 2025-12-26 21:42:09 +01:00
Makefile makefile 2025-12-28 08:05:06 +01:00
README.md docs: Reorganize documentation structure and add architecture diagrams 2025-12-28 09:52:15 +01:00

LuCI Netdata Dashboard

Version: 1.0.0
Last Updated: 2025-12-28
Status: Active

Version License OpenWrt

Real-time system monitoring dashboard for OpenWrt with a modern, responsive interface inspired by Netdata.

Dashboard Preview

Features

📊 Real-time Monitoring

  • CPU Usage: Gauge visualization with sparkline history
  • Memory: Stacked bar showing used/buffers/cached/free
  • Disk: Per-filesystem usage with visual bars
  • Network: Interface statistics with RX/TX totals
  • Temperature: Sensor readings from thermal zones
  • Load Average: 1/5/15 minute load display

🖥️ System Information

  • Hostname, model, kernel version
  • OpenWrt version and target
  • Uptime with days/hours/minutes display
  • CPU cores and frequency

🌐 Network Details

  • Interface list with IP addresses
  • Link state and speed detection
  • Connection tracking statistics
  • Per-interface traffic breakdown

⚙️ Process Monitor

  • Running/sleeping process counts
  • Process list with PID, user, command
  • Memory usage per process
  • State visualization

🎨 Modern Design

  • Dark theme optimized for monitoring
  • Responsive grid layout
  • Animated gauges and sparklines
  • GitHub-inspired color palette

Screenshots

Real-time View

Real-time

Network Statistics

Network

Process Monitor

Processes

Installation

Prerequisites

  • OpenWrt 21.02 or later
  • LuCI web interface
# Clone into OpenWrt build environment
cd ~/openwrt/feeds/luci/applications/
git clone https://github.com/YOUR_USERNAME/luci-app-netdata-dashboard.git

# Update feeds and install
cd ~/openwrt
./scripts/feeds update -a
./scripts/feeds install -a

# Enable in menuconfig
make menuconfig
# Navigate to: LuCI > Applications > luci-app-netdata-dashboard

# Build package
make package/luci-app-netdata-dashboard/compile V=s

Manual Installation

# Transfer package to router
scp luci-app-netdata-dashboard_1.0.0-1_all.ipk root@192.168.1.1:/tmp/

# Install on router
ssh root@192.168.1.1
opkg install /tmp/luci-app-netdata-dashboard_1.0.0-1_all.ipk

# Restart services
/etc/init.d/rpcd restart
/etc/init.d/uhttpd restart

Usage

After installation, access the dashboard at:

Status → Netdata Dashboard

The dashboard has four tabs:

  1. Real-time: Overview with gauges and sparklines
  2. System: Detailed system information
  3. Network: Interface statistics
  4. Processes: Process monitor

Data refreshes automatically every 2 seconds.

Architecture

┌─────────────────────────────────────────────────────────┐
│                    LuCI JavaScript                       │
│              (realtime.js, system.js, etc.)             │
└───────────────────────────┬─────────────────────────────┘
                            │ ubus RPC
                            ▼
┌─────────────────────────────────────────────────────────┐
│                    RPCD Backend                          │
│               /usr/libexec/rpcd/netdata                 │
└───────────────────────────┬─────────────────────────────┘
                            │ reads
                            ▼
┌─────────────────────────────────────────────────────────┐
│                   Linux Proc/Sys                         │
│     /proc/stat, /proc/meminfo, /sys/class/thermal       │
└─────────────────────────────────────────────────────────┘

API Endpoints

Method Description
stats Quick overview (CPU%, memory%, load, etc.)
cpu Detailed CPU statistics and per-core data
memory Memory breakdown (total, free, buffers, cached)
disk Filesystem usage and I/O statistics
network Interface stats and connection tracking
processes Process list and counts
sensors Temperature sensor readings
system System information (hostname, kernel, uptime)

Customization

Modifying Refresh Rate

Edit the poll interval in the view files:

// In realtime.js
poll.add(L.bind(this.refresh, this), 2); // 2 seconds

Adding Custom Metrics

Extend the RPCD backend script at /usr/libexec/rpcd/netdata to add new data sources.

Requirements

  • OpenWrt 21.02+
  • LuCI (luci-base)
  • rpcd with luci module

Dependencies

  • luci-base
  • luci-lib-jsonc
  • rpcd
  • rpcd-mod-luci

Contributing

Contributions are welcome! Please feel free to submit issues and pull requests.

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.

Credits


Made with ❤️ for the OpenWrt community