b884b12970
3 Commits
| Author | SHA1 | Message | Date | |
|---|---|---|---|---|
| 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> |
|||
| 6200167434 |
feat: implement Media Flow streaming detection and monitoring module
Complete implementation of Media Flow module for real-time detection and
monitoring of streaming services with quality estimation and alerts.
Features:
---------
1. Streaming Service Detection
- Video: Netflix, YouTube, Disney+, Prime Video, Twitch, HBO, Hulu, Vimeo
- Audio: Spotify, Apple Music, Deezer, SoundCloud, Tidal, Pandora
- Visio: Zoom, Teams, Google Meet, Discord, Skype, WebEx
2. Quality Estimation
- SD (< 1 Mbps), HD (1-3 Mbps), FHD (3-8 Mbps), 4K (> 8 Mbps)
- Based on real-time bandwidth analysis
3. Real-time Monitoring
- Active streams dashboard with 5-second auto-refresh
- Bandwidth consumption per stream
- Client IP tracking
- Service categorization (video/audio/visio)
4. Historical Data
- Session history with timestamps
- Usage statistics per service
- Usage statistics per client
- Configurable retention (last 1000 entries)
5. Configurable Alerts
- Service-specific usage thresholds
- Actions: notify, limit, block
- UCI-based alert configuration
RPCD Backend:
-------------
Script: root/usr/libexec/rpcd/luci.media-flow
Methods implemented:
- status: Module status and netifyd integration check
- get_active_streams: Currently active streaming sessions
- get_stream_history: Historical sessions (configurable timeframe)
- get_stats_by_service: Aggregated stats per service
- get_stats_by_client: Aggregated stats per client IP
- get_service_details: Detailed info for specific service
- set_alert: Configure usage alerts
- list_alerts: List all configured alerts
Integration with netifyd DPI for application detection.
Views:
------
1. dashboard.js - Main overview with active streams and service stats
2. services.js - Detailed per-service statistics and details modal
3. clients.js - Per-client streaming activity
4. history.js - Chronological session list with filters
5. alerts.js - Alert configuration interface
All views follow naming conventions:
- Menu paths match view file locations (media-flow/*)
- RPC object: 'luci.media-flow' matches RPCD script name
- All views use 'use strict'
- All RPC methods exist in RPCD implementation
Files Structure:
----------------
✓ Makefile: Complete with all required fields
✓ RPCD: luci.media-flow (matches ubus object)
✓ ACL: All 8 RPCD methods covered (read/write separated)
✓ Menu: 5 views with correct paths
✓ Views: All menu paths have corresponding .js files
✓ UCI Config: media_flow with global settings and alerts
✓ README: Complete documentation with API reference
Validation:
-----------
✓ RPCD script name matches ubus object (luci.media-flow)
✓ Menu paths match view file locations
✓ ACL permissions cover all RPCD methods
✓ RPCD script is executable
✓ JSON files have valid syntax
✓ All views use strict mode
✓ RPC method calls match RPCD implementations
Dependencies:
-------------
- netifyd: Deep Packet Inspection for application detection
- luci-app-netifyd-dashboard: Integration with Netifyd dashboard
- jq: JSON processing for historical data aggregation
Usage:
------
# View status
ubus call luci.media-flow status
# Get active streaming sessions
ubus call luci.media-flow get_active_streams
# Get 24h history
ubus call luci.media-flow get_stream_history '{"hours": 24}'
# Set alert for Netflix
ubus call luci.media-flow set_alert '{"service": "Netflix", "threshold_hours": 4, "action": "notify"}'
Data Storage:
-------------
- History: /tmp/media-flow-history.json (last 1000 entries)
- Stats: /tmp/media-flow-stats/ (aggregated data)
- Alerts: /etc/config/media_flow (UCI persistence)
All data stored locally, no external telemetry.
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
|
|||
| ef240b650b | Initial commit: SecuBox v1.0.0-try2 |
