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>
This commit is contained in:
CyberMind-FR 2025-12-28 09:47:10 +01:00
parent 5d10e6c31c
commit 403283419c
45 changed files with 1757 additions and 20 deletions

View File

@ -1,5 +1,9 @@
# CLAUDE.md # CLAUDE.md
**Version:** 1.0.0
**Last Updated:** 2025-12-28
**Status:** Active
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository. This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
## 📚 Documentation Index ## 📚 Documentation Index

View File

@ -1,11 +1,21 @@
# SecuBox Module Code Templates # SecuBox Module Code Templates
**Version:** 1.0.0 **Version:** 1.0.0
**Date:** 2025-12-27 **Last Updated:** 2025-12-28
**Status:** Active
**Purpose:** Ready-to-use code templates extracted from working SecuBox modules **Purpose:** Ready-to-use code templates extracted from working SecuBox modules
--- ---
## See Also
- **Implementation Workflow:** [MODULE-IMPLEMENTATION-GUIDE.md](./MODULE-IMPLEMENTATION-GUIDE.md)
- **Quick Commands:** [QUICK-START.md](./QUICK-START.md)
- **Automation Guardrails:** [CODEX.md](./CODEX.md)
- **Module Prompts:** [FEATURE-REGENERATION-PROMPTS.md](./FEATURE-REGENERATION-PROMPTS.md)
---
## Table of Contents ## Table of Contents
1. [File Structure Template](#file-structure-template) 1. [File Structure Template](#file-structure-template)

113
DOCS/CODEX.md Normal file
View File

@ -0,0 +1,113 @@
# SecuBox Codex Field Manual
**Version:** 1.0.0
**Last Updated:** 2025-12-28
**Status:** Active
---
## Context & Scope
SecuBox bundles fifteen+ security and network dashboards for OpenWrt with a unified build/validation toolchain and CI that ships `.ipk`/`.apk` artifacts automatically (see `README.md` for the module catalogue and CI badges, `README.md:7-34`). The documentation set is intentionally layered—`DOCS/DOCUMENTATION-INDEX.md` routes newcomers, AI assistants, and maintainers to the right depth, so always start requests there before diving into large guides (`DOCS/DOCUMENTATION-INDEX.md:15-31`).
Use this file when you need to brief Codex (or any automation agent) quickly about SecuBox expectations: what standards are immutable, how to craft prompts, where to get help, which decisions shaped todays tree, and what TODOs should stay in sight during automation runs.
### Module & Documentation Map
- `README.md`: one-page overview, compatibility matrix, and “whats new” callouts (`README.md:7-34`).
- `DOCS/QUICK-START.md`: critical rules, design tokens, commands, and error playbooks (`DOCS/QUICK-START.md:9-195`).
- `DOCS/DEVELOPMENT-GUIDELINES.md`: deep dive into architecture, RPCD, ubus, CSS/JS conventions, and deployment (see summary in `DOCS/DOCUMENTATION-INDEX.md:68-82`).
- `DOCS/MODULE-IMPLEMENTATION-GUIDE.md` + `DOCS/FEATURE-REGENERATION-PROMPTS.md`: regeneration workflow plus ready-to-use prompts for all modules (`DOCS/DOCUMENTATION-INDEX.md:102-149`).
- `DOCS/CODE-TEMPLATES.md`: copy/paste-safe scaffolding for LuCI JS, RPCD scripts, and APIs (`DOCS/DOCUMENTATION-INDEX.md:153-159`).
---
## Best-Practice Snapshot
### Non-Negotiables (bake into every prompt or PR)
- RPCD filename **must** equal the ubus object (prevents `-32000 Object not found`, `DOCS/QUICK-START.md:11-18`).
- Menu JSON `path` **must** mirror the view path (avoids 404s, `DOCS/QUICK-START.md:20-26`).
- Permissions: RPCD 755, LuCI assets 644, otherwise RPCD wont execute or LuCI returns 403 (`DOCS/QUICK-START.md:28-37`).
- Always run `./secubox-tools/validate-modules.sh` before opening PRs or tagging builds (reinforced in `README.md:18-23` and `DOCS/QUICK-START.md:122-134`).
- Keep design tokens consistent: dark palette (`#0a0a0f` base, `#6366f1→#8b5cf6` gradients), Inter + JetBrains Mono fonts, `.sh-*`/`.sb-*` components, and responsive grid widths defined in the quick start (`DOCS/QUICK-START.md:74-114`).
### Validation & Toolchain Flow
1. **Permissions Repair (local/remote):** `./secubox-tools/fix-permissions.sh --local|--remote` for automated chmod sanity (`DOCS/QUICK-START.md:55-66, 125-127`).
2. **Full Validation:** `./secubox-tools/validate-modules.sh` (runs seven structural checks including permission scan) (`DOCS/QUICK-START.md:122-134,185-189`).
3. **Module Builds:** `./secubox-tools/local-build.sh build <module>` for quick smoke tests or `make package/<module>/compile V=s` inside SDK (`DOCS/QUICK-START.md:135-143`).
4. **Deploy/Fix:** Copy to router via `scp`, normalize perms, flush `luci` caches, restart `rpcd`/`uhttpd` (`DOCS/QUICK-START.md:144-167`).
5. **Debug:** Validate ubus objects, inspect LuCI resources, and tail `logread` immediately after deployment (`DOCS/QUICK-START.md:156-167`).
### Design & UX Reminders
- Stats tiles minimum 130px width, metrics 240px, detail cards 300px: encode these CSS grid rules to keep dashboards fluid on 720p+ viewports (`DOCS/QUICK-START.md:105-114`).
- Buttons, tabs, and cards expose `.sh-` utility classes; prefer gradient borders and neon states over inline styles for maintainability (same section).
- Align copy with README taxonomy (Core Control, Security & Monitoring, Network Intelligence, etc.) so documentation and UI stay in sync (`README.md:37-152` excerpt).
---
## Prompt Playbook
When drafting Codex/LLM prompts, supply enough structure so the assistant can reuse existing patterns instead of inventing them. Reuse this outline:
```text
Context:
- Target module + file(s) + desired change.
- Any relevant excerpts from CODE-TEMPLATES or existing JS/RPCD files.
Requirements:
- Restate non-negotiables (RPCD naming, menu path, permissions, design tokens).
- Mention validation commands Codex should run or assume.
- Call out API endpoints, ubus objects, or metrics to surface.
Deliverables:
- Files to touch (path + rationale).
- Expected tests/validations (e.g., run ./secubox-tools/validate-modules.sh).
- UX cues (colors, grid sizes, component classes) referencing QUICK-START.
Guardrails:
- Note TODO items or documentation standards (version headers, cross-links, etc.).
- Remind Codex where to log changes (README, module changelog, etc.).
```
Pair the template with module-specific prompts from `DOCS/FEATURE-REGENERATION-PROMPTS.md` and the workflow from `DOCS/MODULE-IMPLEMENTATION-GUIDE.md` (`DOCS/DOCUMENTATION-INDEX.md:102-149`). That combination lets Codex inherit existing layout structures, RPCD shells, and API modules without brittle guesswork.
---
## Help & Troubleshooting
- **Pre-deploy Sanity:** Run the overlay disk/permission SSH checks before copying files; they are scripted inside the quick start so you can paste directly into terminal sessions (`DOCS/QUICK-START.md:40-53`).
- **Common Error Fixes:** Keep the quick fixes near: HTTP 403 (chmod assets), “No space left” (purge `/tmp/*.ipk` and backups), ubus `-32000` (chmod 755 + ubus list). Automate via `secubox-tools` whenever possible (`DOCS/QUICK-START.md:55-70,171-180`).
- **Design Drift:** If CSS feels inconsistent, cross-check against the palette/fonts/components found in this manual and in the design section of the quick start (`DOCS/QUICK-START.md:74-114`).
- **Need Examples?:** Pull actual JS/RPCD snippets from `DOCS/CODE-TEMPLATES.md` or live modules under `luci-app-*` to keep generated code idiomatic (`DOCS/DOCUMENTATION-INDEX.md:153-159`).
- **Still Blocked?:** `DOCS/DEVELOPMENT-GUIDELINES.md` holds the long-form reasoning for every standard; cite relevant sections when escalating issues so maintainers see the source of truth quickly (`DOCS/DOCUMENTATION-INDEX.md:68-82`).
---
## History
- **2025-12-26 Full Dev Guides Released:** README announces the arrival of the comprehensive dev guides set (README badge section, `README.md:7-16`).
- **2025-12-27 Documentation Index v1.0.0:** Central index formalized the document map and AI workflow branches (`DOCS/DOCUMENTATION-INDEX.md:1-31`).
- **2025-12-28 Documentation Improvement Plan:** `TODO-ANALYSE.md` generated to coordinate versioning, cross-links, and archival tasks (`TODO-ANALYSE.md:1-34,71-150`).
- **2025-12-28 Codex Manual Drafted:** This CODEX field manual formalizes how automation agents should operate going forward.
---
## TODO Radar (keep Codex aligned)
1. **Standardize version headers & dates** ensure every `.md` shows `Version/Last Updated/Status` with consistent `YYYY-MM-DD` formatting; DOCUMENTATION-INDEX must describe the policy once updates land (`TODO-ANALYSE.md:24-68`).
2. **Add “See Also” cross-links** wire QUICK-START, PERMISSIONS-GUIDE, VALIDATION-GUIDE, and other quick refs back to their parent guides and vice-versa so AI/users dont get orphaned instructions (`TODO-ANALYSE.md:71-116`).
3. **Archive historical docs** create `docs/archive/`, move outdated references (COMPLETION_REPORT, MODULE-ENABLE-DISABLE-DESIGN, BUILD_ISSUES, etc.), and drop an archive README describing contents (`TODO-ANALYSE.md:120-153`).
4. **Future work (Monthly/Quarterly)** new diagrams, TESTING/SECURITY/PERFORMANCE guides, automation for doc freshness, and i18n decisions are queued later in `TODO-ANALYSE.md`; mention them when prompts may impact scope or format downstream.
Codex should treat the TODOs above as guardrails: if a task touches documentation, prefer solutions that inch us toward these goals (e.g., add version headers while editing a doc, or cross-link when touching quick references).
---
## Quick Reference Checklist for Codex Runs
- [ ] Confirm the request references the right guide/template to minimize hallucinations (`DOCS/DOCUMENTATION-INDEX.md` paths).
- [ ] Copy/paste the non-negotiables + validation flow into the prompt.
- [ ] State which TODO radar items the change advances (or at least does not regress).
- [ ] Cite commands/scripts to run post-change.
- [ ] Capture findings in PR/commit descriptions referencing this CODEX manual when relevant.
Use this living manual as both a pre-flight briefing and a debrief log for automation work. Update it whenever the standards above evolve so every future Codex session starts with the correct mental model.

View File

@ -1,7 +1,8 @@
# SecuBox & System Hub - Development Guidelines # SecuBox & System Hub - Development Guidelines
**Version:** 1.0.0 **Version:** 1.0.0
**Date:** 2025-12-26 **Last Updated:** 2025-12-28
**Status:** Active
**Audience:** Développeurs, IA assistants, mainteneurs **Audience:** Développeurs, IA assistants, mainteneurs
Ce document définit les standards, bonnes pratiques et validations obligatoires pour le développement de modules SecuBox et System Hub dans l'écosystème OpenWrt LuCI. Ce document définit les standards, bonnes pratiques et validations obligatoires pour le développement de modules SecuBox et System Hub dans l'écosystème OpenWrt LuCI.
@ -93,6 +94,77 @@ font-family: 'JetBrains Mono', 'Courier New', monospace;
### Component Patterns ### Component Patterns
#### Component Hierarchy
The following diagram shows the standard page structure and component relationships:
```mermaid
graph TB
PAGE[Page Container<br/>.module-dashboard] --> HEADER[sh-page-header]
PAGE --> CONTENT[sh-content]
HEADER --> TITLE_SECTION[Title Section<br/>div]
HEADER --> STATS[sh-stats-grid]
TITLE_SECTION --> TITLE[sh-page-title<br/>gradient text]
TITLE_SECTION --> SUBTITLE[sh-page-subtitle]
STATS --> BADGE1[sh-stat-badge]
STATS --> BADGE2[sh-stat-badge]
STATS --> BADGE3[...]
BADGE1 --> VALUE1[sh-stat-value<br/>monospace font]
BADGE1 --> LABEL1[sh-stat-label<br/>uppercase]
CONTENT --> TABS[sh-filter-tabs]
CONTENT --> CARD_GRID[Card Grid<br/>grid layout]
TABS --> TAB1[sh-filter-tab<br/>active]
TABS --> TAB2[sh-filter-tab]
CARD_GRID --> CARD1[sh-card]
CARD_GRID --> CARD2[sh-card-success]
CARD_GRID --> CARD3[sh-card-danger]
CARD1 --> CH1[sh-card-header]
CARD1 --> CB1[sh-card-body]
CH1 --> CT1[sh-card-title]
CT1 --> ICON1[sh-card-title-icon]
CB1 --> BUTTONS[Button Group]
CB1 --> INFO[Info Rows]
BUTTONS --> BTN1[sh-btn<br/>sh-btn-primary]
BUTTONS --> BTN2[sh-btn<br/>sh-btn-secondary]
style PAGE fill:#0a0a0f,color:#fafafa,stroke:#6366f1,stroke-width:3px
style HEADER fill:#12121a,color:#fafafa,stroke:#6366f1,stroke-width:2px
style CONTENT fill:#12121a,color:#fafafa,stroke:#6366f1,stroke-width:2px
style CARD1 fill:#12121a,color:#fafafa,stroke:#6366f1,stroke-width:2px
style CARD2 fill:#12121a,color:#fafafa,stroke:#22c55e,stroke-width:2px
style CARD3 fill:#12121a,color:#fafafa,stroke:#ef4444,stroke-width:2px
style TITLE fill:#6366f1,color:#fff
style BTN1 fill:#6366f1,color:#fff
style VALUE1 fill:#8b5cf6,color:#fff
```
**Component Categories:**
1. **Layout Containers:** Page wrapper, header, content sections
2. **Typography:** Titles with gradient effects, subtitles, labels
3. **Data Display:** Stat badges with monospace values, cards with borders
4. **Navigation:** Filter tabs, nav tabs (sticky)
5. **Interactive:** Buttons with gradients and hover effects
**Styling Rules:**
- **Cards:** 3px top border (gradient on hover, or colored for status)
- **Stat Badges:** Minimum 130px width, monospace font for values
- **Buttons:** Gradient backgrounds, shadow on hover, smooth transitions
- **Tabs:** Active state with gradient background and glow
- **Grid Layouts:** Auto-fit with minimums (130px, 240px, or 300px)
---
#### 1. Page Header (Standard) #### 1. Page Header (Standard)
**HTML Structure:** **HTML Structure:**
@ -275,6 +347,61 @@ box-shadow: 0 8px 20px rgba(99, 102, 241, 0.5);
## Architecture & Naming Conventions ## Architecture & Naming Conventions
### System Architecture Overview
The following diagram illustrates the complete data flow from browser JavaScript to system backend:
```mermaid
graph TB
subgraph "Browser"
UI[JavaScript View<br/>view/module/overview.js]
API[API Module<br/>module/api.js]
end
subgraph "LuCI Framework"
RPC[RPC Layer<br/>L.rpc.declare]
UHTTPD[uhttpd<br/>Web Server]
end
subgraph "Backend Services"
RPCD[RPCD Daemon]
SCRIPT[RPCD Script<br/>/usr/libexec/rpcd/luci.module-name]
UBUS[ubus Message Bus]
end
subgraph "System Layer"
UCI[UCI Configuration]
SYS[System Services<br/>init.d scripts]
FS[Filesystem<br/>proc, sys, etc]
end
UI -->|"API.getStatus()"| API
API -->|"rpc.declare({ object: 'luci.module' })"| RPC
RPC -->|"HTTP POST /ubus"| UHTTPD
UHTTPD -->|"call method"| RPCD
RPCD -->|"execute script"| SCRIPT
SCRIPT -->|"ubus call"| UBUS
UBUS -->|"read/write"| UCI
UBUS -->|"control"| SYS
SCRIPT -->|"read metrics"| FS
style UI fill:#6366f1,color:#fff,stroke:#4f46e5
style API fill:#8b5cf6,color:#fff,stroke:#7c3aed
style SCRIPT fill:#22c55e,color:#fff,stroke:#16a34a
style RPCD fill:#f59e0b,color:#fff,stroke:#d97706
style UCI fill:#ef4444,color:#fff,stroke:#dc2626
```
**Key Components:**
1. **Browser Layer:** JavaScript views and API modules handle UI and data requests
2. **LuCI Framework:** RPC layer translates JavaScript calls to ubus protocol
3. **Backend Services:** RPCD executes shell scripts via ubus message bus
4. **System Layer:** UCI configs, system services, and filesystem provide data
**Critical Naming Rule:** The RPCD script name **MUST** match the `object` parameter in JavaScript's `rpc.declare()`.
---
### CRITICAL: RPCD Script Naming ### CRITICAL: RPCD Script Naming
**RÈGLE ABSOLUE:** Le nom du fichier RPCD DOIT correspondre EXACTEMENT au nom de l'objet ubus dans JavaScript. **RÈGLE ABSOLUE:** Le nom du fichier RPCD DOIT correspondre EXACTEMENT au nom de l'objet ubus dans JavaScript.
@ -1201,6 +1328,72 @@ Après déploiement:
## Deployment Procedures ## Deployment Procedures
### Deployment Workflow
The following flowchart illustrates the complete deployment process with validation checkpoints:
```mermaid
flowchart TD
START([Start Deployment]) --> LOCAL_VAL{Local Validation<br/>Passed?}
LOCAL_VAL -->|No| FIX_LOCAL[Fix Issues Locally]
FIX_LOCAL --> LOCAL_VAL
LOCAL_VAL -->|Yes| CHECK_DISK{Disk Space<br/>< 90%?}
CHECK_DISK -->|No| CLEAN_DISK[Clean Temp Files<br/>& Old Backups]
CLEAN_DISK --> CHECK_DISK
CHECK_DISK -->|Yes| FIX_PERM_LOCAL[Fix Permissions<br/>Local Source]
FIX_PERM_LOCAL --> COPY[Copy Files to Router<br/>scp JS/CSS/RPCD]
COPY --> FIX_PERM_REMOTE[Fix Permissions<br/>Remote Files<br/>755 RPCD / 644 CSS-JS]
FIX_PERM_REMOTE --> CLEAR[Clear LuCI Cache<br/>/tmp/luci-*]
CLEAR --> RESTART[Restart Services<br/>rpcd + uhttpd]
RESTART --> V1{ubus Object<br/>Available?}
V1 -->|No| DEBUG1[Debug RPCD Script<br/>Check naming & permissions]
DEBUG1 --> FIX_PERM_REMOTE
V1 -->|Yes| V2{Files<br/>Accessible?}
V2 -->|403 Error| DEBUG2[Fix File Permissions<br/>chmod 644]
DEBUG2 --> FIX_PERM_REMOTE
V2 -->|Yes| V3{Menu Path<br/>Matches View?}
V3 -->|404 Error| DEBUG3[Fix Menu JSON Path]
DEBUG3 --> COPY
V3 -->|Yes| V4{UI Loads<br/>Correctly?}
V4 -->|Errors| DEBUG4[Check Browser Console<br/>Fix JavaScript Errors]
DEBUG4 --> COPY
V4 -->|Yes| TEST[Browser Testing<br/>Private Mode<br/>Dark/Light Mode<br/>Responsive]
TEST --> SUCCESS([✅ Deployment Success])
style START fill:#6366f1,color:#fff,stroke:#4f46e5
style SUCCESS fill:#22c55e,color:#fff,stroke:#16a34a
style DEBUG1 fill:#ef4444,color:#fff,stroke:#dc2626
style DEBUG2 fill:#ef4444,color:#fff,stroke:#dc2626
style DEBUG3 fill:#ef4444,color:#fff,stroke:#dc2626
style DEBUG4 fill:#ef4444,color:#fff,stroke:#dc2626
style CHECK_DISK fill:#f59e0b,color:#fff,stroke:#d97706
style LOCAL_VAL fill:#8b5cf6,color:#fff,stroke:#7c3aed
```
**Deployment Stages:**
1. **Local Validation:** Run `validate-modules.sh` and `fix-permissions.sh --local`
2. **Pre-Flight Checks:** Disk space and permission verification
3. **File Transfer:** Copy JavaScript, CSS, and RPCD scripts
4. **Remote Setup:** Fix permissions and clear caches
5. **Service Restart:** Reload rpcd and uhttpd daemons
6. **Validation:** Multi-stage verification (ubus, files, menu, UI)
7. **Testing:** Browser testing in private mode
**Common Error Recovery Paths:**
- **Object not found (-32000):** Check RPCD script naming and permissions
- **403 Forbidden:** Fix file permissions to 644 for CSS/JS
- **404 Not Found:** Verify menu path matches view file location
- **JavaScript errors:** Check browser console and fix code issues
---
### ⚠️ Pre-Deployment Checks (CRITICAL) ### ⚠️ Pre-Deployment Checks (CRITICAL)
**TOUJOURS exécuter ces vérifications AVANT tout déploiement:** **TOUJOURS exécuter ces vérifications AVANT tout déploiement:**

View File

@ -1,7 +1,8 @@
# SecuBox Documentation Index # SecuBox Documentation Index
**Version:** 1.0.0 **Version:** 1.0.0
**Date:** 2025-12-27 **Last Updated:** 2025-12-28
**Status:** Active
**Complete Documentation for SecuBox OpenWrt Project** **Complete Documentation for SecuBox OpenWrt Project**
--- ---
@ -12,6 +13,26 @@ This index provides quick access to all SecuBox documentation. Choose the docume
--- ---
## 📅 Version & Status Policy
Every Markdown document in SecuBox must begin with metadata so contributors instantly see freshness:
- Include `Version`, `Last Updated` (YYYY-MM-DD), and `Status` (Active | Draft | Archived).
- New or regenerated docs start at `Version 1.0.0`; bump minor/patch numbers for incremental updates, major for structural rewrites.
- When editing any doc, update the `Last Updated` date and keep statuses in sync with the archive plan outlined in `TODO-ANALYSE.md`.
Follow this template when creating or revising documentation:
```
# Title
**Version:** 1.0.0
**Last Updated:** 2025-12-28
**Status:** Active
```
---
## 🚀 Getting Started ## 🚀 Getting Started
### For New Contributors ### For New Contributors
@ -49,6 +70,20 @@ This index provides quick access to all SecuBox documentation. Choose the docume
--- ---
#### **CODEX.md** 🤖
*Field manual for Codex/automation agents*
**Contents:**
- Repository context and document map
- Non-negotiable build/design standards
- Prompt template for LLM workflows
- Help & troubleshooting pointers
- Documentation TODO radar and history
**When to use:** Before launching Codex/AI-assisted edits, when crafting prompts, or when aligning work with current documentation initiatives
---
#### **README.md** 📋 #### **README.md** 📋
*Project overview and compatibility matrix* *Project overview and compatibility matrix*

View File

@ -1,11 +1,21 @@
# SecuBox Feature Regeneration Prompts # SecuBox Feature Regeneration Prompts
**Version:** 1.0.0 **Version:** 1.0.0
**Date:** 2025-12-27 **Last Updated:** 2025-12-28
**Status:** Active
**Purpose:** Comprehensive prompts for Claude.ai to regenerate all SecuBox module features matching the live demo at secubox.cybermood.eu **Purpose:** Comprehensive prompts for Claude.ai to regenerate all SecuBox module features matching the live demo at secubox.cybermood.eu
--- ---
## See Also
- **Implementation Workflow:** [MODULE-IMPLEMENTATION-GUIDE.md](./MODULE-IMPLEMENTATION-GUIDE.md)
- **Code Templates:** [CODE-TEMPLATES.md](./CODE-TEMPLATES.md)
- **Quick Commands:** [QUICK-START.md](./QUICK-START.md)
- **Automation Guardrails:** [CODEX.md](./CODEX.md)
---
## Table of Contents ## Table of Contents
1. [Design System Reference](#design-system-reference) 1. [Design System Reference](#design-system-reference)

View File

@ -1,9 +1,24 @@
# LuCI Development Reference Guide # LuCI Development Reference Guide
**Version**: 1.0 **Version:** 1.0.0
**Date**: 2025-12-26 **Last Updated:** 2025-12-28
**Based on**: luci-app-secubox and luci-app-system-hub implementations **Status:** Active
**Target Audience**: Claude.ai and developers working on OpenWrt LuCI applications
**Version:** 1.0.0
**Last Updated:** 2025-12-28
**Status:** Active
**Based on:** luci-app-secubox and luci-app-system-hub implementations
**Target Audience:** Claude.ai and developers working on OpenWrt LuCI applications
---
## See Also
- **Design & Standards:** [DEVELOPMENT-GUIDELINES.md](./DEVELOPMENT-GUIDELINES.md)
- **Quick Commands:** [QUICK-START.md](./QUICK-START.md)
- **Automation Briefing:** [CODEX.md](./CODEX.md)
- **Code Templates:** [CODE-TEMPLATES.md](./CODE-TEMPLATES.md)
This document captures critical patterns, best practices, and common pitfalls discovered during the development of SecuBox LuCI applications. Use this as a validation reference for all future LuCI application development. This document captures critical patterns, best practices, and common pitfalls discovered during the development of SecuBox LuCI applications. Use this as a validation reference for all future LuCI application development.

View File

@ -1,11 +1,21 @@
# SecuBox Module Implementation Guide # SecuBox Module Implementation Guide
**Version:** 1.0.0 **Version:** 1.0.0
**Date:** 2025-12-27 **Last Updated:** 2025-12-28
**Status:** Active
**Purpose:** Complete guide for regenerating SecuBox modules matching the live demo **Purpose:** Complete guide for regenerating SecuBox modules matching the live demo
--- ---
## See Also
- **Automation Briefing:** [CODEX.md](./CODEX.md)
- **Module Prompts:** [FEATURE-REGENERATION-PROMPTS.md](./FEATURE-REGENERATION-PROMPTS.md)
- **Code Templates:** [CODE-TEMPLATES.md](./CODE-TEMPLATES.md)
- **Quick Commands:** [QUICK-START.md](./QUICK-START.md)
---
## Quick Navigation ## Quick Navigation
📋 **[FEATURE-REGENERATION-PROMPTS.md](./FEATURE-REGENERATION-PROMPTS.md)** - Complete feature specifications for all 15 modules 📋 **[FEATURE-REGENERATION-PROMPTS.md](./FEATURE-REGENERATION-PROMPTS.md)** - Complete feature specifications for all 15 modules

View File

@ -1,7 +1,22 @@
# SecuBox Modules - Implementation Status # SecuBox Modules - Implementation Status
**Last Updated**: 2025-12-25 **Version:** 1.0.0
**Total Modules**: 15 **Last Updated:** 2025-12-28
**Status:** Active
**Version:** 1.0.0
**Last Updated:** 2025-12-28
**Status:** Active
**Total Modules:** 15
---
## See Also
- **Feature Regeneration Prompts:** [FEATURE-REGENERATION-PROMPTS.md](./FEATURE-REGENERATION-PROMPTS.md)
- **Implementation Workflow:** [MODULE-IMPLEMENTATION-GUIDE.md](./MODULE-IMPLEMENTATION-GUIDE.md)
- **Automation Guardrails:** [CODEX.md](./CODEX.md)
## Module Categories ## Module Categories

View File

@ -1,9 +1,28 @@
# OpenWrt Package Permissions Guide # OpenWrt Package Permissions Guide
**Version:** 0.3.1 **Version:** 0.3.1
**Date:** 2025-12-28 **Last Updated:** 2025-12-28
**Status:** Active
**Author:** CyberMind **Author:** CyberMind
> **📚 This is a quick reference guide.**
> For complete deployment procedures, see [DEVELOPMENT-GUIDELINES.md §9](./DEVELOPMENT-GUIDELINES.md#deployment-procedures)
>
> **Related Documentation:**
> - Complete guide: [DEVELOPMENT-GUIDELINES.md](./DEVELOPMENT-GUIDELINES.md)
> - Quick reference: [QUICK-START.md](./QUICK-START.md)
> - Validation tools: [VALIDATION-GUIDE.md](./VALIDATION-GUIDE.md)
> - Automation briefing: [CODEX.md](./CODEX.md)
---
## See Also
- **Deployment Procedures:** [DEVELOPMENT-GUIDELINES.md §9](./DEVELOPMENT-GUIDELINES.md#deployment-procedures)
- **Quick Rules & Commands:** [QUICK-START.md](./QUICK-START.md)
- **Validation Checklist:** [VALIDATION-GUIDE.md](./VALIDATION-GUIDE.md)
- **Automation Standards:** [CODEX.md](./CODEX.md)
## 🎯 Objectif ## 🎯 Objectif
Assurer que tous les fichiers des packages SecuBox ont les **bonnes permissions** dès l'installation, sans nécessiter de correction manuelle. Assurer que tous les fichiers des packages SecuBox ont les **bonnes permissions** dès l'installation, sans nécessiter de correction manuelle.

View File

@ -1,11 +1,25 @@
# Quick Start Guide - SecuBox Development # Quick Start Guide - SecuBox Development
**Version:** 1.0.0
**Last Updated:** 2025-12-28
**Status:** Active
**⚡ Aide-mémoire rapide pour développement** **⚡ Aide-mémoire rapide pour développement**
Pour le guide complet, voir [DEVELOPMENT-GUIDELINES.md](./DEVELOPMENT-GUIDELINES.md) Pour le guide complet, voir [DEVELOPMENT-GUIDELINES.md](./DEVELOPMENT-GUIDELINES.md)
--- ---
## See Also
- **Complete Guide:** [DEVELOPMENT-GUIDELINES.md](./DEVELOPMENT-GUIDELINES.md)
- **Architecture & Build:** [CLAUDE.md](./CLAUDE.md)
- **Code Templates:** [CODE-TEMPLATES.md](./CODE-TEMPLATES.md)
- **Module Prompts:** [FEATURE-REGENERATION-PROMPTS.md](./FEATURE-REGENERATION-PROMPTS.md)
- **Automation Briefing:** [CODEX.md](./CODEX.md)
---
## ⚠️ RÈGLES CRITIQUES (À NE JAMAIS OUBLIER) ## ⚠️ RÈGLES CRITIQUES (À NE JAMAIS OUBLIER)
### 1. RPCD Script Naming ### 1. RPCD Script Naming

View File

@ -1,5 +1,28 @@
# SecuBox Module Validation Guide # SecuBox Module Validation Guide
**Version:** 1.0.0
**Last Updated:** 2025-12-28
**Status:** Active
> **📚 Complete Reference:**
> This is a detailed validation guide. For quick commands, see [QUICK-START.md](./QUICK-START.md)
>
> **Related Documentation:**
> - Complete guide: [DEVELOPMENT-GUIDELINES.md §8](./DEVELOPMENT-GUIDELINES.md#validation-checklist)
> - Pre-commit checklist: [DEVELOPMENT-GUIDELINES.md §8.1](./DEVELOPMENT-GUIDELINES.md#pre-commit-checklist)
> - Post-deploy checklist: [DEVELOPMENT-GUIDELINES.md §8.3](./DEVELOPMENT-GUIDELINES.md#post-deploy-checklist)
> - Permissions guide: [PERMISSIONS-GUIDE.md](./PERMISSIONS-GUIDE.md)
> - Automation briefing: [CODEX.md](./CODEX.md)
---
## See Also
- **Quick Commands:** [QUICK-START.md](./QUICK-START.md)
- **Permissions Reference:** [PERMISSIONS-GUIDE.md](./PERMISSIONS-GUIDE.md)
- **Automation Guardrails:** [CODEX.md](./CODEX.md)
- **Deployment Procedures:** [DEVELOPMENT-GUIDELINES.md §9](./DEVELOPMENT-GUIDELINES.md#deployment-procedures)
This guide explains the validation checks performed on SecuBox modules during generation and before git push. This guide explains the validation checks performed on SecuBox modules during generation and before git push.
## Overview ## Overview

View File

@ -1,5 +1,9 @@
# Build Issues & Solutions # Build Issues & Solutions
**Version:** 1.0.0
**Last Updated:** 2025-12-28
**Status:** Active
## Current Problem: No IPK Generated on GitHub Actions ## Current Problem: No IPK Generated on GitHub Actions
### Root Cause ### Root Cause

View File

@ -1,7 +1,14 @@
# Rapport de Complétion - SecuBox Components # Rapport de Complétion - SecuBox Components
**Date:** 23 décembre 2025 **Version:** 1.0.0
**Status:** ✅ Tous les composants sont complets **Last Updated:** 2025-12-28
**Status:** Active
**Version:** 1.0.0
**Last Updated:** 2025-12-28
**Status:** Archived
**Report Date:** 2025-12-23
--- ---

93
DOCS/archive/README.md Normal file
View File

@ -0,0 +1,93 @@
# Documentation Archive
**Version:** 1.0.0
**Last Updated:** 2025-12-28
**Status:** Active
**Version:** 1.0.0
**Last Updated:** 2025-12-28
**Status:** Archived
**Purpose:** Historical and completed documentation
---
## 📦 Contents
### Historical Documents
#### COMPLETION_REPORT.md
- **Type:** Project completion report
- **Date:** 2025-12-26
- **Status:** Historical
- **Description:** Comprehensive report documenting the completion of the SecuBox documentation initiative, including all 15 modules, validation tools, and implementation guides.
#### MODULE-ENABLE-DISABLE-DESIGN.md
- **Type:** Design document
- **Date:** 2025-12-27
- **Version:** 0.3.1
- **Status:** Archived (feature implemented)
- **Description:** Design specification for the module enable/disable feature in SecuBox Central Hub. This feature has been implemented and deployed.
#### BUILD_ISSUES.md
- **Type:** Troubleshooting guide
- **Date:** 2025-12-28
- **Version:** 1.0.0
- **Status:** Archived (issues resolved)
- **Description:** Documentation of build issues encountered with GitHub Actions SDK compilation. Issues have been resolved and solutions integrated into main documentation.
---
## 🔍 Why These Documents Were Archived
### Completion Reports
Historical completion reports are archived after project milestones are achieved. They provide valuable project history but are not needed for daily development.
### Design Documents
Design documents are archived once features are fully implemented and deployed. The implementation details are now documented in the main guides.
### Issue Trackers
Build issue documentation is archived once problems are resolved and solutions are incorporated into [DEVELOPMENT-GUIDELINES.md](../DEVELOPMENT-GUIDELINES.md) and [CLAUDE.md](../CLAUDE.md).
---
## 📚 Active Documentation
For current, actively maintained documentation, see:
- **[DOCUMENTATION-INDEX.md](../DOCUMENTATION-INDEX.md)** - Complete documentation index
- **[QUICK-START.md](../QUICK-START.md)** - Quick reference guide
- **[DEVELOPMENT-GUIDELINES.md](../DEVELOPMENT-GUIDELINES.md)** - Complete development guide
- **[CLAUDE.md](../CLAUDE.md)** - Build system and architecture
- **[CODE-TEMPLATES.md](../CODE-TEMPLATES.md)** - Working code templates
- **[FEATURE-REGENERATION-PROMPTS.md](../FEATURE-REGENERATION-PROMPTS.md)** - Module specifications
---
## 📋 Archive Policy
Documents are moved to the archive when:
1. ✅ Feature/project is completed
2. ✅ Information is outdated but historically valuable
3. ✅ Content has been migrated to active documentation
4. ✅ Document serves as historical reference only
---
## 🔄 Restoring Archived Documents
If you need to reference or restore an archived document:
```bash
# View archived document
cat /path/to/secubox-openwrt/DOCS/archive/DOCUMENT_NAME.md
# Restore to active documentation (if needed)
cp archive/DOCUMENT_NAME.md ../DOCUMENT_NAME.md
```
---
**Maintainer:** CyberMind.fr
**License:** Apache-2.0
**Last Updated:** 2025-12-28

View File

@ -1,5 +1,9 @@
# SecuBox - Security Suite for OpenWrt # SecuBox - Security Suite for OpenWrt
**Version:** 1.0.0
**Last Updated:** 2025-12-28
**Status:** Active
[![Build OpenWrt Packages](https://github.com/gkerma/secubox/actions/workflows/build-openwrt-packages.yml/badge.svg)](https://github.com/gkerma/secubox/actions/workflows/build-openwrt-packages.yml) [![Build OpenWrt Packages](https://github.com/gkerma/secubox/actions/workflows/build-openwrt-packages.yml/badge.svg)](https://github.com/gkerma/secubox/actions/workflows/build-openwrt-packages.yml)
[![Test & Validate](https://github.com/gkerma/secubox/actions/workflows/test-validate.yml/badge.svg)](https://github.com/gkerma/secubox/actions/workflows/test-validate.yml) [![Test & Validate](https://github.com/gkerma/secubox/actions/workflows/test-validate.yml/badge.svg)](https://github.com/gkerma/secubox/actions/workflows/test-validate.yml)
[![License](https://img.shields.io/badge/License-Apache%202.0-green.svg)](LICENSE) [![License](https://img.shields.io/badge/License-Apache%202.0-green.svg)](LICENSE)

1080
TODO-ANALYSE.md Normal file

File diff suppressed because it is too large Load Diff

View File

@ -1,5 +1,10 @@
# Auth Guardian for OpenWrt # Auth Guardian for OpenWrt
**Version:** 1.0.0
**Last Updated:** 2025-12-28
**Status:** Active
Comprehensive authentication and session management system. Comprehensive authentication and session management system.
## Features ## Features

View File

@ -1,5 +1,10 @@
# Bandwidth Manager - QoS & Traffic Control # Bandwidth Manager - QoS & Traffic Control
**Version:** 1.0.0
**Last Updated:** 2025-12-28
**Status:** Active
Advanced bandwidth management for OpenWrt with QoS rules, client quotas, and SQM/CAKE integration. Advanced bandwidth management for OpenWrt with QoS rules, client quotas, and SQM/CAKE integration.
## Features ## Features

View File

@ -1,5 +1,10 @@
# SecuBox CDN Cache Dashboard # SecuBox CDN Cache Dashboard
**Version:** 1.0.0
**Last Updated:** 2025-12-28
**Status:** Active
[![OpenWrt](https://img.shields.io/badge/OpenWrt-23.05+-blue.svg)](https://openwrt.org/) [![OpenWrt](https://img.shields.io/badge/OpenWrt-23.05+-blue.svg)](https://openwrt.org/)
[![License](https://img.shields.io/badge/License-Apache%202.0-green.svg)](LICENSE) [![License](https://img.shields.io/badge/License-Apache%202.0-green.svg)](LICENSE)
[![SecuBox](https://img.shields.io/badge/SecuBox-Module-cyan.svg)](https://cybermind.fr/secubox) [![SecuBox](https://img.shields.io/badge/SecuBox-Module-cyan.svg)](https://cybermind.fr/secubox)

View File

@ -1,5 +1,10 @@
# luci-app-client-guardian # luci-app-client-guardian
**Version:** 1.0.0
**Last Updated:** 2025-12-28
**Status:** Active
**Network Access Control & Captive Portal Dashboard for OpenWrt** **Network Access Control & Captive Portal Dashboard for OpenWrt**
🛡️ Client Guardian est un système de contrôle d'accès réseau (NAC) nouvelle génération pour OpenWrt avec portail captif, surveillance en temps réel, gestion des zones et alertes SMS/Email. 🛡️ Client Guardian est un système de contrôle d'accès réseau (NAC) nouvelle génération pour OpenWrt avec portail captif, surveillance en temps réel, gestion des zones et alertes SMS/Email.

View File

@ -1,5 +1,10 @@
# 🛡️ LuCI CrowdSec Dashboard # 🛡️ LuCI CrowdSec Dashboard
**Version:** 1.0.0
**Last Updated:** 2025-12-28
**Status:** Active
A modern, responsive, and dynamic dashboard for monitoring CrowdSec security on OpenWrt routers. A modern, responsive, and dynamic dashboard for monitoring CrowdSec security on OpenWrt routers.
![License](https://img.shields.io/badge/license-Apache--2.0-blue) ![License](https://img.shields.io/badge/license-Apache--2.0-blue)

View File

@ -1,5 +1,10 @@
# LuCI App - Key Storage Manager (KSM) # LuCI App - Key Storage Manager (KSM)
**Version:** 1.0.0
**Last Updated:** 2025-12-28
**Status:** Active
Centralized cryptographic key management system for OpenWrt with hardware security module (HSM) support for Nitrokey and YubiKey devices. Centralized cryptographic key management system for OpenWrt with hardware security module (HSM) support for Nitrokey and YubiKey devices.
## Overview ## Overview

View File

@ -1,5 +1,10 @@
# LuCI Media Flow - Streaming Detection & Monitoring # LuCI Media Flow - Streaming Detection & Monitoring
**Version:** 1.0.0
**Last Updated:** 2025-12-28
**Status:** Active
Real-time detection and monitoring of streaming services with quality estimation and configurable alerts. Real-time detection and monitoring of streaming services with quality estimation and configurable alerts.
## Features ## Features

View File

@ -1,5 +1,10 @@
# LuCI Netdata Dashboard # LuCI Netdata Dashboard
**Version:** 1.0.0
**Last Updated:** 2025-12-28
**Status:** Active
![Version](https://img.shields.io/badge/version-1.0.0-blue) ![Version](https://img.shields.io/badge/version-1.0.0-blue)
![License](https://img.shields.io/badge/license-Apache--2.0-green) ![License](https://img.shields.io/badge/license-Apache--2.0-green)
![OpenWrt](https://img.shields.io/badge/OpenWrt-21.02+-orange) ![OpenWrt](https://img.shields.io/badge/OpenWrt-21.02+-orange)

View File

@ -1,5 +1,10 @@
# LuCI Netifyd Dashboard # LuCI Netifyd Dashboard
**Version:** 1.0.0
**Last Updated:** 2025-12-28
**Status:** Active
![Version](https://img.shields.io/badge/version-1.0.0-purple) ![Version](https://img.shields.io/badge/version-1.0.0-purple)
![License](https://img.shields.io/badge/license-Apache--2.0-green) ![License](https://img.shields.io/badge/license-Apache--2.0-green)
![OpenWrt](https://img.shields.io/badge/OpenWrt-21.02+-orange) ![OpenWrt](https://img.shields.io/badge/OpenWrt-21.02+-orange)

View File

@ -1,5 +1,10 @@
# LuCI Network Modes Dashboard # LuCI Network Modes Dashboard
**Version:** 1.0.0
**Last Updated:** 2025-12-28
**Status:** Active
![Version](https://img.shields.io/badge/version-1.0.0-orange) ![Version](https://img.shields.io/badge/version-1.0.0-orange)
![License](https://img.shields.io/badge/license-Apache--2.0-green) ![License](https://img.shields.io/badge/license-Apache--2.0-green)
![OpenWrt](https://img.shields.io/badge/OpenWrt-21.02+-blue) ![OpenWrt](https://img.shields.io/badge/OpenWrt-21.02+-blue)

View File

@ -1,5 +1,10 @@
# SecuBox Central Hub # SecuBox Central Hub
**Version:** 1.0.0
**Last Updated:** 2025-12-28
**Status:** Active
Central management dashboard for the SecuBox security and network management suite for OpenWrt. Central management dashboard for the SecuBox security and network management suite for OpenWrt.
## Features ## Features

View File

@ -1,5 +1,10 @@
# System Hub - Central Control Dashboard # System Hub - Central Control Dashboard
**Version:** 1.0.0
**Last Updated:** 2025-12-28
**Status:** Active
Central system control and monitoring dashboard for OpenWrt with comprehensive system management capabilities. Central system control and monitoring dashboard for OpenWrt with comprehensive system management capabilities.
## Features ## Features

View File

@ -1,5 +1,10 @@
# Traffic Shaper - Advanced QoS Control # Traffic Shaper - Advanced QoS Control
**Version:** 1.0.0
**Last Updated:** 2025-12-28
**Status:** Active
LuCI application for advanced traffic shaping and Quality of Service (QoS) management using Linux Traffic Control (TC) and CAKE qdisc. LuCI application for advanced traffic shaping and Quality of Service (QoS) management using Linux Traffic Control (TC) and CAKE qdisc.
## Features ## Features

View File

@ -1,5 +1,10 @@
# VHost Manager - Reverse Proxy & SSL Certificate Management # VHost Manager - Reverse Proxy & SSL Certificate Management
**Version:** 1.0.0
**Last Updated:** 2025-12-28
**Status:** Active
LuCI application for managing nginx reverse proxy virtual hosts and SSL certificates via Let's Encrypt. LuCI application for managing nginx reverse proxy virtual hosts and SSL certificates via Let's Encrypt.
## Features ## Features

View File

@ -1,5 +1,10 @@
# LuCI WireGuard Dashboard # LuCI WireGuard Dashboard
**Version:** 1.0.0
**Last Updated:** 2025-12-28
**Status:** Active
![Version](https://img.shields.io/badge/version-1.0.0-cyan) ![Version](https://img.shields.io/badge/version-1.0.0-cyan)
![License](https://img.shields.io/badge/license-Apache--2.0-green) ![License](https://img.shields.io/badge/license-Apache--2.0-green)
![OpenWrt](https://img.shields.io/badge/OpenWrt-21.02+-orange) ![OpenWrt](https://img.shields.io/badge/OpenWrt-21.02+-orange)

View File

@ -1,7 +1,20 @@
# SecuBox Development Tools # SecuBox Development Tools
**Version:** 1.0.0
**Last Updated:** 2025-12-28
**Status:** Active
This directory contains utilities for validating, debugging, and maintaining SecuBox modules. This directory contains utilities for validating, debugging, and maintaining SecuBox modules.
---
## See Also
- **Quick Commands & Rules:** [DOCS/QUICK-START.md](../DOCS/QUICK-START.md)
- **Automation Guardrails:** [DOCS/CODEX.md](../DOCS/CODEX.md)
- **Validation Guide:** [DOCS/VALIDATION-GUIDE.md](../DOCS/VALIDATION-GUIDE.md)
- **Deployment Procedures:** [DOCS/DEVELOPMENT-GUIDELINES.md §9](../DOCS/DEVELOPMENT-GUIDELINES.md#deployment-procedures)
## Tools Overview ## Tools Overview
### Build and Test Tools ### Build and Test Tools