gandalf/secubox-openwrt
gandalf/secubox-openwrt
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
master
secubox-openwrt/site/claude/index.html
CyberMind-FR ce543762cc chore: Update GitHub repo URL to CyberMind-FR organization 
Replace github.com/gkerma/secubox-openwrt with
github.com/CyberMind-FR/secubox-openwrt across all files.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-14 09:44:01 +01:00

2809 lines
93 KiB
HTML
Raw Permalink Blame History

<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta name="description" content="OpenWrt LuCI Security & Management Suite">
<meta name="author" content="CyberMind.fr">
<link rel="canonical" href="https://gkerma.github.io/secubox-openwrt/claude/">
<link rel="prev" href="../module-implementation-guide/">
<link rel="next" href="../validation-guide/">
<link rel="icon" href="../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.1">
<title>RPCD & Architecture - SecuBox Documentation</title>
<link rel="stylesheet" href="../assets/stylesheets/main.484c7ddc.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.ab4e12ef.min.css">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Inter:300,300i,400,400i,700,700i%7CJetBrains+Mono:400,400i,700,700i&display=fallback">
<style>:root{--md-text-font:"Inter";--md-code-font:"JetBrains Mono"}</style>
<link rel="stylesheet" href="../stylesheets/extra.css">
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
</head>
<body dir="ltr" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="purple">
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#claudemd" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<div data-md-color-scheme="default" data-md-component="outdated" hidden>
</div>
<header class="md-header md-header--shadow md-header--lifted" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href=".." title="SecuBox Documentation" class="md-header__button md-logo" aria-label="SecuBox Documentation" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
SecuBox Documentation
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
RPCD & Architecture
</span>
</div>
</div>
</div>
<form class="md-header__option" data-md-component="palette">
<input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="purple" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_0">
<label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_1" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
</label>
<input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="indigo" data-md-color-accent="purple" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_1">
<label class="md-header__button md-icon" title="Switch to light mode" for="__palette_0" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12s-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
</label>
</form>
<script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
</label>
<nav class="md-search__options" aria-label="Search">
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
</button>
</nav>
<div class="md-search__suggest" data-md-component="search-suggest"></div>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list" role="presentation"></ol>
</div>
</div>
</div>
</div>
</div>
<div class="md-header__source">
<a href="https://github.com/CyberMind-FR/secubox-openwrt" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
</div>
<div class="md-source__repository">
gkerma/secubox-openwrt
</div>
</a>
</div>
</nav>
<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
<div class="md-grid">
<ul class="md-tabs__list">
<li class="md-tabs__item">
<a href=".." class="md-tabs__link">
Home
</a>
</li>
<li class="md-tabs__item">
<a href="../quick-start/" class="md-tabs__link">
Getting Started
</a>
</li>
<li class="md-tabs__item">
<a href="../development-guidelines/" class="md-tabs__link">
Development
</a>
</li>
<li class="md-tabs__item md-tabs__item--active">
<a href="./" class="md-tabs__link">
Reference
</a>
</li>
<li class="md-tabs__item">
<a href="../module-status/" class="md-tabs__link">
Modules
</a>
</li>
<li class="md-tabs__item">
<a href="../todo-analyse/" class="md-tabs__link">
Tools & Roadmap
</a>
</li>
<li class="md-tabs__item">
<a href="../archive/" class="md-tabs__link">
Archive
</a>
</li>
</ul>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href=".." title="SecuBox Documentation" class="md-nav__button md-logo" aria-label="SecuBox Documentation" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
</a>
SecuBox Documentation
</label>
<div class="md-nav__source">
<a href="https://github.com/CyberMind-FR/secubox-openwrt" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
</div>
<div class="md-source__repository">
gkerma/secubox-openwrt
</div>
</a>
</div>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href=".." class="md-nav__link">
<span class="md-ellipsis">
Home
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
<span class="md-ellipsis">
Getting Started
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
Getting Started
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../quick-start/" class="md-nav__link">
<span class="md-ellipsis">
Quick Start
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../documentation-index/" class="md-nav__link">
<span class="md-ellipsis">
Documentation Index
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../repository-guidelines/" class="md-nav__link">
<span class="md-ellipsis">
Repository Guidelines
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
<span class="md-ellipsis">
Development
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
Development
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../development-guidelines/" class="md-nav__link">
<span class="md-ellipsis">
Development Guidelines
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../code-templates/" class="md-nav__link">
<span class="md-ellipsis">
Code Templates
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../module-implementation-guide/" class="md-nav__link">
<span class="md-ellipsis">
Module Implementation
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="">
<span class="md-ellipsis">
Reference
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
Reference
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis">
RPCD & Architecture
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
RPCD & Architecture
</span>
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#documentation-index" class="md-nav__link">
<span class="md-ellipsis">
📚 Documentation Index
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#project-overview" class="md-nav__link">
<span class="md-ellipsis">
Project Overview
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#build-commands" class="md-nav__link">
<span class="md-ellipsis">
Build Commands
</span>
</a>
<nav class="md-nav" aria-label="Build Commands">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#openwrt-sdk-build" class="md-nav__link">
<span class="md-ellipsis">
OpenWrt SDK Build
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#testing-packages" class="md-nav__link">
<span class="md-ellipsis">
Testing Packages
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#validation" class="md-nav__link">
<span class="md-ellipsis">
Validation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#local-build-replicates-github-actions" class="md-nav__link">
<span class="md-ellipsis">
Local Build (Replicates GitHub Actions)
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#architecture" class="md-nav__link">
<span class="md-ellipsis">
Architecture
</span>
</a>
<nav class="md-nav" aria-label="Architecture">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#luci-package-structure" class="md-nav__link">
<span class="md-ellipsis">
LuCI Package Structure
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#frontend-backend-communication" class="md-nav__link">
<span class="md-ellipsis">
Frontend-Backend Communication
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#critical-naming-conventions" class="md-nav__link">
<span class="md-ellipsis">
Critical Naming Conventions
</span>
</a>
<nav class="md-nav" aria-label="Critical Naming Conventions">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#1-rpcd-script-must-match-ubus-object-name" class="md-nav__link">
<span class="md-ellipsis">
1. RPCD Script Must Match ubus Object Name
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#2-menu-paths-must-match-view-file-locations" class="md-nav__link">
<span class="md-ellipsis">
2. Menu Paths Must Match View File Locations
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#3-ubus-object-naming-convention" class="md-nav__link">
<span class="md-ellipsis">
3. ubus Object Naming Convention
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#4-validation-before-deployment" class="md-nav__link">
<span class="md-ellipsis">
4. Validation Before Deployment
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#makefile-structure" class="md-nav__link">
<span class="md-ellipsis">
Makefile Structure
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#common-development-patterns" class="md-nav__link">
<span class="md-ellipsis">
Common Development Patterns
</span>
</a>
<nav class="md-nav" aria-label="Common Development Patterns">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#creating-a-new-module" class="md-nav__link">
<span class="md-ellipsis">
Creating a New Module
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#rpcd-backend-pattern" class="md-nav__link">
<span class="md-ellipsis">
RPCD Backend Pattern
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#javascript-view-pattern" class="md-nav__link">
<span class="md-ellipsis">
JavaScript View Pattern
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#module-categories" class="md-nav__link">
<span class="md-ellipsis">
Module Categories
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#cicd-integration" class="md-nav__link">
<span class="md-ellipsis">
CI/CD Integration
</span>
</a>
<nav class="md-nav" aria-label="CI/CD Integration">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#github-actions-workflows" class="md-nav__link">
<span class="md-ellipsis">
GitHub Actions Workflows
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#supported-architectures" class="md-nav__link">
<span class="md-ellipsis">
Supported Architectures
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#key-files-and-directories" class="md-nav__link">
<span class="md-ellipsis">
Key Files and Directories
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#common-issues-and-solutions" class="md-nav__link">
<span class="md-ellipsis">
Common Issues and Solutions
</span>
</a>
<nav class="md-nav" aria-label="Common Issues and Solutions">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#rpc-errors-object-not-found-or-method-not-found" class="md-nav__link">
<span class="md-ellipsis">
RPC Errors: "Object not found" or "Method not found"
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#http-404-errors-view-files-not-found" class="md-nav__link">
<span class="md-ellipsis">
HTTP 404 Errors: View Files Not Found
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#rpcd-not-responding" class="md-nav__link">
<span class="md-ellipsis">
RPCD Not Responding
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#menu-not-appearing" class="md-nav__link">
<span class="md-ellipsis">
Menu Not Appearing
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#build-failures" class="md-nav__link">
<span class="md-ellipsis">
Build Failures
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#quick-diagnosis" class="md-nav__link">
<span class="md-ellipsis">
Quick Diagnosis
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#development-workflow" class="md-nav__link">
<span class="md-ellipsis">
Development Workflow
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#important-notes" class="md-nav__link">
<span class="md-ellipsis">
Important Notes
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../validation-guide/" class="md-nav__link">
<span class="md-ellipsis">
Validation Guide
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../permissions-guide/" class="md-nav__link">
<span class="md-ellipsis">
Permissions Guide
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../luci-development-reference/" class="md-nav__link">
<span class="md-ellipsis">
LuCI Development
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../codex/" class="md-nav__link">
<span class="md-ellipsis">
Codex Manual
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
<span class="md-ellipsis">
Modules
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span>
Modules
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../module-status/" class="md-nav__link">
<span class="md-ellipsis">
Module Status
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../feature-regeneration-prompts/" class="md-nav__link">
<span class="md-ellipsis">
Feature Prompts
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
<span class="md-ellipsis">
Tools & Roadmap
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6">
<span class="md-nav__icon md-icon"></span>
Tools & Roadmap
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../todo-analyse/" class="md-nav__link">
<span class="md-ellipsis">
TODO Roadmap
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
<label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
<span class="md-ellipsis">
Archive
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_7">
<span class="md-nav__icon md-icon"></span>
Archive
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../archive/" class="md-nav__link">
<span class="md-ellipsis">
Archive Index
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../archive/build-issues/" class="md-nav__link">
<span class="md-ellipsis">
Build Issues
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../archive/completion-report/" class="md-nav__link">
<span class="md-ellipsis">
Completion Report
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../archive/module-enable-disable-design/" class="md-nav__link">
<span class="md-ellipsis">
Module Enable/Disable
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#documentation-index" class="md-nav__link">
<span class="md-ellipsis">
📚 Documentation Index
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#project-overview" class="md-nav__link">
<span class="md-ellipsis">
Project Overview
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#build-commands" class="md-nav__link">
<span class="md-ellipsis">
Build Commands
</span>
</a>
<nav class="md-nav" aria-label="Build Commands">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#openwrt-sdk-build" class="md-nav__link">
<span class="md-ellipsis">
OpenWrt SDK Build
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#testing-packages" class="md-nav__link">
<span class="md-ellipsis">
Testing Packages
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#validation" class="md-nav__link">
<span class="md-ellipsis">
Validation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#local-build-replicates-github-actions" class="md-nav__link">
<span class="md-ellipsis">
Local Build (Replicates GitHub Actions)
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#architecture" class="md-nav__link">
<span class="md-ellipsis">
Architecture
</span>
</a>
<nav class="md-nav" aria-label="Architecture">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#luci-package-structure" class="md-nav__link">
<span class="md-ellipsis">
LuCI Package Structure
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#frontend-backend-communication" class="md-nav__link">
<span class="md-ellipsis">
Frontend-Backend Communication
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#critical-naming-conventions" class="md-nav__link">
<span class="md-ellipsis">
Critical Naming Conventions
</span>
</a>
<nav class="md-nav" aria-label="Critical Naming Conventions">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#1-rpcd-script-must-match-ubus-object-name" class="md-nav__link">
<span class="md-ellipsis">
1. RPCD Script Must Match ubus Object Name
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#2-menu-paths-must-match-view-file-locations" class="md-nav__link">
<span class="md-ellipsis">
2. Menu Paths Must Match View File Locations
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#3-ubus-object-naming-convention" class="md-nav__link">
<span class="md-ellipsis">
3. ubus Object Naming Convention
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#4-validation-before-deployment" class="md-nav__link">
<span class="md-ellipsis">
4. Validation Before Deployment
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#makefile-structure" class="md-nav__link">
<span class="md-ellipsis">
Makefile Structure
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#common-development-patterns" class="md-nav__link">
<span class="md-ellipsis">
Common Development Patterns
</span>
</a>
<nav class="md-nav" aria-label="Common Development Patterns">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#creating-a-new-module" class="md-nav__link">
<span class="md-ellipsis">
Creating a New Module
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#rpcd-backend-pattern" class="md-nav__link">
<span class="md-ellipsis">
RPCD Backend Pattern
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#javascript-view-pattern" class="md-nav__link">
<span class="md-ellipsis">
JavaScript View Pattern
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#module-categories" class="md-nav__link">
<span class="md-ellipsis">
Module Categories
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#cicd-integration" class="md-nav__link">
<span class="md-ellipsis">
CI/CD Integration
</span>
</a>
<nav class="md-nav" aria-label="CI/CD Integration">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#github-actions-workflows" class="md-nav__link">
<span class="md-ellipsis">
GitHub Actions Workflows
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#supported-architectures" class="md-nav__link">
<span class="md-ellipsis">
Supported Architectures
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#key-files-and-directories" class="md-nav__link">
<span class="md-ellipsis">
Key Files and Directories
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#common-issues-and-solutions" class="md-nav__link">
<span class="md-ellipsis">
Common Issues and Solutions
</span>
</a>
<nav class="md-nav" aria-label="Common Issues and Solutions">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#rpc-errors-object-not-found-or-method-not-found" class="md-nav__link">
<span class="md-ellipsis">
RPC Errors: "Object not found" or "Method not found"
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#http-404-errors-view-files-not-found" class="md-nav__link">
<span class="md-ellipsis">
HTTP 404 Errors: View Files Not Found
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#rpcd-not-responding" class="md-nav__link">
<span class="md-ellipsis">
RPCD Not Responding
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#menu-not-appearing" class="md-nav__link">
<span class="md-ellipsis">
Menu Not Appearing
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#build-failures" class="md-nav__link">
<span class="md-ellipsis">
Build Failures
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#quick-diagnosis" class="md-nav__link">
<span class="md-ellipsis">
Quick Diagnosis
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#development-workflow" class="md-nav__link">
<span class="md-ellipsis">
Development Workflow
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#important-notes" class="md-nav__link">
<span class="md-ellipsis">
Important Notes
</span>
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<h1 id="claudemd">CLAUDE.md<a class="headerlink" href="#claudemd" title="Permanent link">&para;</a></h1>
<p><strong>Version:</strong> 1.0.0
<strong>Last Updated:</strong> 2025-12-28
<strong>Status:</strong> Active</p>
<p>This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.</p>
<h2 id="documentation-index">📚 Documentation Index<a class="headerlink" href="#documentation-index" title="Permanent link">&para;</a></h2>
<p><strong>IMPORTANT:</strong> Before working on any code, consult these guides:</p>
<ol>
<li><strong><a href="../development-guidelines/">DEVELOPMENT-GUIDELINES.md</a></strong> - ⭐ <strong>GUIDE COMPLET</strong></li>
<li>Design System &amp; UI Guidelines (palettes, typographie, composants)</li>
<li>Architecture &amp; Naming Conventions (RPCD, menu paths, prefixes)</li>
<li>RPCD &amp; ubus Best Practices (erreurs communes, solutions)</li>
<li>ACL &amp; Permissions (templates, validations)</li>
<li>JavaScript Patterns (API modules, views, event handling)</li>
<li>CSS/Styling Standards (variables, responsive, dark mode)</li>
<li>Common Errors &amp; Solutions (diagnostics, fixes)</li>
<li>Validation Checklist (pre-commit, pre-deploy, post-deploy)</li>
<li>
<p>Deployment Procedures (scripts, rollback, versioning)</p>
</li>
<li>
<p><strong><a href="../quick-start/">QUICK-START.md</a></strong> - ⚡ <strong>AIDE-MÉMOIRE RAPIDE</strong></p>
</li>
<li>Règles critiques (RPCD naming, menu paths, permissions)</li>
<li>Design system essentials (couleurs, fonts, classes)</li>
<li>Common commands (validation, build, deploy, debug)</li>
<li>Quick code templates (RPCD, View, Headers, Cards)</li>
<li>
<p>Error quick fixes</p>
</li>
<li>
<p><strong>CLAUDE.md</strong> (ce fichier) - 🏗️ <strong>ARCHITECTURE &amp; BUILD</strong></p>
</li>
<li>Build commands (OpenWrt SDK, local build)</li>
<li>Module structure (files, directories)</li>
<li>CI/CD workflows</li>
<li>Common issues techniques</li>
</ol>
<p><strong>⚠️ RÈGLES CRITIQUES À TOUJOURS RESPECTER:</strong></p>
<ol>
<li><strong>RPCD Script Naming:</strong> Nom fichier = objet ubus (<code>luci.system-hub</code>)</li>
<li><strong>Menu Path Matching:</strong> Path menu = fichier vue (<code>system-hub/overview.js</code>)</li>
<li><strong>Permissions:</strong> RPCD = 755, CSS/JS = 644</li>
<li><strong>Auto-fix:</strong> <code>./secubox-tools/fix-permissions.sh --local</code> (avant commit)</li>
<li><strong>Auto-fix remote:</strong> <code>./secubox-tools/fix-permissions.sh --remote</code> (après deploy)</li>
<li><strong>Validation:</strong> Toujours exécuter <code>./secubox-tools/validate-modules.sh</code> avant commit</li>
<li><strong>7 checks automatiques:</strong> RPCD naming, menu paths, view files, RPCD permissions, JSON syntax, ubus naming, <strong>htdocs permissions</strong></li>
<li><strong>CSS Variables:</strong> Toujours utiliser <code>var(--sh-*)</code>, jamais hardcoder les couleurs</li>
<li><strong>Dark Mode:</strong> Toujours supporter dark mode avec <code>[data-theme="dark"]</code></li>
<li><strong>Typography:</strong> Inter (texte), JetBrains Mono (valeurs numériques)</li>
<li><strong>Gradient Effects:</strong> Utiliser <code>--sh-primary</code> → <code>--sh-primary-end</code> pour dégradés</li>
</ol>
<h2 id="project-overview">Project Overview<a class="headerlink" href="#project-overview" title="Permanent link">&para;</a></h2>
<p>SecuBox is a comprehensive security and network management suite for OpenWrt. The repository contains 13 LuCI application packages that provide dashboards for security monitoring, network intelligence, access control, bandwidth management, and system administration.</p>
<h2 id="build-commands">Build Commands<a class="headerlink" href="#build-commands" title="Permanent link">&para;</a></h2>
<h3 id="openwrt-sdk-build">OpenWrt SDK Build<a class="headerlink" href="#openwrt-sdk-build" title="Permanent link">&para;</a></h3>
<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="c1"># Build a single package</span>
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a>make<span class="w"> </span>package/luci-app-&lt;module-name&gt;/compile<span class="w"> </span><span class="nv">V</span><span class="o">=</span>s
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a>
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a><span class="c1"># Clean build for a package</span>
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a>make<span class="w"> </span>package/luci-app-&lt;module-name&gt;/clean
<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a>make<span class="w"> </span>package/luci-app-&lt;module-name&gt;/compile<span class="w"> </span><span class="nv">V</span><span class="o">=</span>s
<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a>
<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a><span class="c1"># Install package to staging directory</span>
<a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a>make<span class="w"> </span>package/luci-app-&lt;module-name&gt;/install
</code></pre></div>
<h3 id="testing-packages">Testing Packages<a class="headerlink" href="#testing-packages" title="Permanent link">&para;</a></h3>
<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="c1"># Transfer to router</span>
<a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a>scp<span class="w"> </span>bin/packages/*/base/luci-app-*.ipk<span class="w"> </span>root@192.168.1.1:/tmp/
<a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a>
<a id="__codelineno-1-4" name="__codelineno-1-4" href="#__codelineno-1-4"></a><span class="c1"># Install on router</span>
<a id="__codelineno-1-5" name="__codelineno-1-5" href="#__codelineno-1-5"></a>ssh<span class="w"> </span>root@192.168.1.1
<a id="__codelineno-1-6" name="__codelineno-1-6" href="#__codelineno-1-6"></a>opkg<span class="w"> </span>install<span class="w"> </span>/tmp/luci-app-*.ipk
<a id="__codelineno-1-7" name="__codelineno-1-7" href="#__codelineno-1-7"></a>/etc/init.d/rpcd<span class="w"> </span>restart
<a id="__codelineno-1-8" name="__codelineno-1-8" href="#__codelineno-1-8"></a>/etc/init.d/uhttpd<span class="w"> </span>restart
</code></pre></div>
<h3 id="validation">Validation<a class="headerlink" href="#validation" title="Permanent link">&para;</a></h3>
<div class="highlight"><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a><span class="c1"># Fix file permissions FIRST (CRITICAL)</span>
<a id="__codelineno-2-2" name="__codelineno-2-2" href="#__codelineno-2-2"></a>./secubox-tools/fix-permissions.sh<span class="w"> </span>--local
<a id="__codelineno-2-3" name="__codelineno-2-3" href="#__codelineno-2-3"></a>
<a id="__codelineno-2-4" name="__codelineno-2-4" href="#__codelineno-2-4"></a><span class="c1"># Run comprehensive module validation (RECOMMENDED - 7 checks)</span>
<a id="__codelineno-2-5" name="__codelineno-2-5" href="#__codelineno-2-5"></a>./secubox-tools/validate-modules.sh
<a id="__codelineno-2-6" name="__codelineno-2-6" href="#__codelineno-2-6"></a><span class="c1"># Checks:</span>
<a id="__codelineno-2-7" name="__codelineno-2-7" href="#__codelineno-2-7"></a><span class="c1"># 1. RPCD script names vs ubus objects</span>
<a id="__codelineno-2-8" name="__codelineno-2-8" href="#__codelineno-2-8"></a><span class="c1"># 2. Menu paths vs view file locations</span>
<a id="__codelineno-2-9" name="__codelineno-2-9" href="#__codelineno-2-9"></a><span class="c1"># 3. View files have menu entries</span>
<a id="__codelineno-2-10" name="__codelineno-2-10" href="#__codelineno-2-10"></a><span class="c1"># 4. RPCD script permissions (755)</span>
<a id="__codelineno-2-11" name="__codelineno-2-11" href="#__codelineno-2-11"></a><span class="c1"># 5. JSON syntax validation</span>
<a id="__codelineno-2-12" name="__codelineno-2-12" href="#__codelineno-2-12"></a><span class="c1"># 6. ubus object naming convention</span>
<a id="__codelineno-2-13" name="__codelineno-2-13" href="#__codelineno-2-13"></a><span class="c1"># 7. htdocs file permissions (644 for CSS/JS) ← NEW</span>
<a id="__codelineno-2-14" name="__codelineno-2-14" href="#__codelineno-2-14"></a>
<a id="__codelineno-2-15" name="__codelineno-2-15" href="#__codelineno-2-15"></a><span class="c1"># Validate shell scripts (RPCD backends)</span>
<a id="__codelineno-2-16" name="__codelineno-2-16" href="#__codelineno-2-16"></a>shellcheck<span class="w"> </span>luci-app-*/root/usr/libexec/rpcd/*
<a id="__codelineno-2-17" name="__codelineno-2-17" href="#__codelineno-2-17"></a>
<a id="__codelineno-2-18" name="__codelineno-2-18" href="#__codelineno-2-18"></a><span class="c1"># Validate JSON files</span>
<a id="__codelineno-2-19" name="__codelineno-2-19" href="#__codelineno-2-19"></a>find<span class="w"> </span>.<span class="w"> </span>-name<span class="w"> </span><span class="s2">&quot;*.json&quot;</span><span class="w"> </span>-exec<span class="w"> </span>jsonlint<span class="w"> </span><span class="o">{}</span><span class="w"> </span><span class="se">\;</span>
<a id="__codelineno-2-20" name="__codelineno-2-20" href="#__codelineno-2-20"></a>
<a id="__codelineno-2-21" name="__codelineno-2-21" href="#__codelineno-2-21"></a><span class="c1"># Run automated repair tool</span>
<a id="__codelineno-2-22" name="__codelineno-2-22" href="#__codelineno-2-22"></a>./secubox-tools/secubox-repair.sh
<a id="__codelineno-2-23" name="__codelineno-2-23" href="#__codelineno-2-23"></a>
<a id="__codelineno-2-24" name="__codelineno-2-24" href="#__codelineno-2-24"></a><span class="c1"># Fix permissions on deployed router</span>
<a id="__codelineno-2-25" name="__codelineno-2-25" href="#__codelineno-2-25"></a>./secubox-tools/fix-permissions.sh<span class="w"> </span>--remote
<a id="__codelineno-2-26" name="__codelineno-2-26" href="#__codelineno-2-26"></a>
<a id="__codelineno-2-27" name="__codelineno-2-27" href="#__codelineno-2-27"></a><span class="c1"># Run diagnostics</span>
<a id="__codelineno-2-28" name="__codelineno-2-28" href="#__codelineno-2-28"></a>./secubox-tools/secubox-debug.sh<span class="w"> </span>luci-app-&lt;module-name&gt;
</code></pre></div>
<h3 id="local-build-replicates-github-actions">Local Build (Replicates GitHub Actions)<a class="headerlink" href="#local-build-replicates-github-actions" title="Permanent link">&para;</a></h3>
<p>The <code>local-build.sh</code> script allows you to build and test packages locally, replicating the GitHub Actions workflows:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a><span class="c1"># Validate all packages (syntax, JSON, shell scripts)</span>
<a id="__codelineno-3-2" name="__codelineno-3-2" href="#__codelineno-3-2"></a>./secubox-tools/local-build.sh<span class="w"> </span>validate
<a id="__codelineno-3-3" name="__codelineno-3-3" href="#__codelineno-3-3"></a>
<a id="__codelineno-3-4" name="__codelineno-3-4" href="#__codelineno-3-4"></a><span class="c1"># Build all packages for x86_64</span>
<a id="__codelineno-3-5" name="__codelineno-3-5" href="#__codelineno-3-5"></a>./secubox-tools/local-build.sh<span class="w"> </span>build
<a id="__codelineno-3-6" name="__codelineno-3-6" href="#__codelineno-3-6"></a>
<a id="__codelineno-3-7" name="__codelineno-3-7" href="#__codelineno-3-7"></a><span class="c1"># Build single package</span>
<a id="__codelineno-3-8" name="__codelineno-3-8" href="#__codelineno-3-8"></a>./secubox-tools/local-build.sh<span class="w"> </span>build<span class="w"> </span>luci-app-system-hub
<a id="__codelineno-3-9" name="__codelineno-3-9" href="#__codelineno-3-9"></a>
<a id="__codelineno-3-10" name="__codelineno-3-10" href="#__codelineno-3-10"></a><span class="c1"># Build for specific architecture</span>
<a id="__codelineno-3-11" name="__codelineno-3-11" href="#__codelineno-3-11"></a>./secubox-tools/local-build.sh<span class="w"> </span>build<span class="w"> </span>--arch<span class="w"> </span>aarch64-cortex-a72
<a id="__codelineno-3-12" name="__codelineno-3-12" href="#__codelineno-3-12"></a>
<a id="__codelineno-3-13" name="__codelineno-3-13" href="#__codelineno-3-13"></a><span class="c1"># Full validation + build</span>
<a id="__codelineno-3-14" name="__codelineno-3-14" href="#__codelineno-3-14"></a>./secubox-tools/local-build.sh<span class="w"> </span>full
<a id="__codelineno-3-15" name="__codelineno-3-15" href="#__codelineno-3-15"></a>
<a id="__codelineno-3-16" name="__codelineno-3-16" href="#__codelineno-3-16"></a><span class="c1"># Clean build artifacts</span>
<a id="__codelineno-3-17" name="__codelineno-3-17" href="#__codelineno-3-17"></a>./secubox-tools/local-build.sh<span class="w"> </span>clean
</code></pre></div>
<p>Supported architectures:
- <code>x86-64</code> - PC, VMs (default)
- <code>aarch64-cortex-a53</code> - ARM Cortex-A53 (ESPRESSObin)
- <code>aarch64-cortex-a72</code> - ARM Cortex-A72 (MOCHAbin, RPi4)
- <code>aarch64-generic</code> - Generic ARM64
- <code>mips-24kc</code> - MIPS 24Kc (TP-Link)
- <code>mipsel-24kc</code> - MIPS LE (Xiaomi, GL.iNet)</p>
<p>The script automatically:
- Downloads and caches the OpenWrt SDK
- Configures feeds (packages, luci) with correct branch for version
- Copies your packages to the SDK
- Builds packages (.apk for 25.12+, .ipk for older versions)
- Collects artifacts in <code>build/&lt;arch&gt;/</code></p>
<p><strong>Package Format Support:</strong>
- OpenWrt 25.12+ and SNAPSHOT: <code>.apk</code> format (new Alpine-based package manager)
- OpenWrt 24.10 and earlier: <code>.ipk</code> format (opkg package manager)</p>
<p>Environment variables:
- <code>OPENWRT_VERSION</code> - OpenWrt version (default: 24.10.5, also supports: 25.12.0-rc1, 23.05.5, SNAPSHOT)
- <code>SDK_DIR</code> - SDK directory (default: ./sdk)
- <code>BUILD_DIR</code> - Build output directory (default: ./build)
- <code>CACHE_DIR</code> - Download cache directory (default: ./cache)</p>
<h2 id="architecture">Architecture<a class="headerlink" href="#architecture" title="Permanent link">&para;</a></h2>
<h3 id="luci-package-structure">LuCI Package Structure<a class="headerlink" href="#luci-package-structure" title="Permanent link">&para;</a></h3>
<p>All SecuBox modules follow a standard LuCI application structure:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a>luci-app-&lt;module-name&gt;/
<a id="__codelineno-4-2" name="__codelineno-4-2" href="#__codelineno-4-2"></a>├── Makefile # OpenWrt package definition
<a id="__codelineno-4-3" name="__codelineno-4-3" href="#__codelineno-4-3"></a>├── README.md # Module documentation
<a id="__codelineno-4-4" name="__codelineno-4-4" href="#__codelineno-4-4"></a>├── htdocs/luci-static/resources/
<a id="__codelineno-4-5" name="__codelineno-4-5" href="#__codelineno-4-5"></a>│ ├── view/&lt;module-name&gt;/ # JavaScript UI views
<a id="__codelineno-4-6" name="__codelineno-4-6" href="#__codelineno-4-6"></a>│ │ ├── overview.js # Main dashboard view
<a id="__codelineno-4-7" name="__codelineno-4-7" href="#__codelineno-4-7"></a>│ │ └── *.js # Additional views
<a id="__codelineno-4-8" name="__codelineno-4-8" href="#__codelineno-4-8"></a>│ └── &lt;module-name&gt;/
<a id="__codelineno-4-9" name="__codelineno-4-9" href="#__codelineno-4-9"></a>│ ├── api.js # RPC API client module
<a id="__codelineno-4-10" name="__codelineno-4-10" href="#__codelineno-4-10"></a>│ └── dashboard.css # Module-specific styles
<a id="__codelineno-4-11" name="__codelineno-4-11" href="#__codelineno-4-11"></a>└── root/
<a id="__codelineno-4-12" name="__codelineno-4-12" href="#__codelineno-4-12"></a> ├── etc/config/&lt;module-name&gt; # UCI configuration (optional)
<a id="__codelineno-4-13" name="__codelineno-4-13" href="#__codelineno-4-13"></a> └── usr/
<a id="__codelineno-4-14" name="__codelineno-4-14" href="#__codelineno-4-14"></a> ├── libexec/rpcd/
<a id="__codelineno-4-15" name="__codelineno-4-15" href="#__codelineno-4-15"></a> │ └── luci.&lt;module-name&gt; # RPCD backend script (MUST use luci. prefix!)
<a id="__codelineno-4-16" name="__codelineno-4-16" href="#__codelineno-4-16"></a> └── share/
<a id="__codelineno-4-17" name="__codelineno-4-17" href="#__codelineno-4-17"></a> ├── luci/menu.d/ # Menu JSON definition
<a id="__codelineno-4-18" name="__codelineno-4-18" href="#__codelineno-4-18"></a> │ └── luci-app-&lt;module-name&gt;.json
<a id="__codelineno-4-19" name="__codelineno-4-19" href="#__codelineno-4-19"></a> └── rpcd/acl.d/ # ACL permissions JSON
<a id="__codelineno-4-20" name="__codelineno-4-20" href="#__codelineno-4-20"></a> └── luci-app-&lt;module-name&gt;.json
</code></pre></div>
<h3 id="frontend-backend-communication">Frontend-Backend Communication<a class="headerlink" href="#frontend-backend-communication" title="Permanent link">&para;</a></h3>
<ol>
<li><strong>Frontend (JavaScript)</strong>: Located in <code>htdocs/luci-static/resources/</code></li>
<li>Views use LuCI's <code>form</code> and <code>view</code> classes</li>
<li>API calls via <code>api.js</code> module using <code>L.resolveDefault()</code></li>
<li>
<p>UI components from <code>ui.js</code> (Dropdown, Checkbox, Combobox, etc.)</p>
</li>
<li>
<p><strong>Backend (RPCD)</strong>: Located in <code>root/usr/libexec/rpcd/</code></p>
</li>
<li>Shell scripts that implement RPC methods</li>
<li>Must output JSON to stdout</li>
<li>
<p>Methods are called via ubus: <code>ubus call &lt;module&gt; &lt;method&gt;</code></p>
</li>
<li>
<p><strong>Menu Definition</strong>: <code>root/usr/share/luci/menu.d/luci-app-&lt;module&gt;.json</code></p>
</li>
<li>Defines menu structure and navigation</li>
<li>
<p>Specifies view paths and dependencies</p>
</li>
<li>
<p><strong>ACL Definition</strong>: <code>root/usr/share/rpcd/acl.d/luci-app-&lt;module&gt;.json</code></p>
</li>
<li>Defines access control for ubus methods</li>
<li>Maps read/write permissions to user groups</li>
</ol>
<h3 id="critical-naming-conventions">Critical Naming Conventions<a class="headerlink" href="#critical-naming-conventions" title="Permanent link">&para;</a></h3>
<p><strong>IMPORTANT</strong>: The following naming rules are MANDATORY for modules to work correctly:</p>
<h4 id="1-rpcd-script-must-match-ubus-object-name">1. RPCD Script Must Match ubus Object Name<a class="headerlink" href="#1-rpcd-script-must-match-ubus-object-name" title="Permanent link">&para;</a></h4>
<p>The RPCD script filename MUST exactly match the ubus object name used in JavaScript:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a><span class="c1">// In JavaScript (htdocs/luci-static/resources/view/*/):</span>
<a id="__codelineno-5-2" name="__codelineno-5-2" href="#__codelineno-5-2"></a><span class="kd">var</span><span class="w"> </span><span class="nx">callStatus</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">rpc</span><span class="p">.</span><span class="nx">declare</span><span class="p">({</span>
<a id="__codelineno-5-3" name="__codelineno-5-3" href="#__codelineno-5-3"></a><span class="w"> </span><span class="nx">object</span><span class="o">:</span><span class="w"> </span><span class="s1">&#39;luci.cdn-cache&#39;</span><span class="p">,</span><span class="w"> </span><span class="c1">// ← This object name</span>
<a id="__codelineno-5-4" name="__codelineno-5-4" href="#__codelineno-5-4"></a><span class="w"> </span><span class="nx">method</span><span class="o">:</span><span class="w"> </span><span class="s1">&#39;status&#39;</span>
<a id="__codelineno-5-5" name="__codelineno-5-5" href="#__codelineno-5-5"></a><span class="p">});</span>
</code></pre></div>
<div class="highlight"><pre><span></span><code><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a><span class="c1"># RPCD script filename MUST match:</span>
<a id="__codelineno-6-2" name="__codelineno-6-2" href="#__codelineno-6-2"></a>root/usr/libexec/rpcd/luci.cdn-cache<span class="w"> </span><span class="c1"># ← Must be exactly &#39;luci.cdn-cache&#39;</span>
</code></pre></div>
<p><strong>Common Error</strong>: If the names don't match, you'll get:
- <code>RPC call to luci.cdn-cache/status failed with error -32000: Object not found</code>
- <code>Command failed: Method not found</code></p>
<p><strong>Solution</strong>: All RPCD scripts MUST use the <code>luci.</code> prefix:
- ✅ Correct: <code>luci.cdn-cache</code>, <code>luci.system-hub</code>, <code>luci.wireguard-dashboard</code>
- ❌ Wrong: <code>cdn-cache</code>, <code>system-hub</code>, <code>wireguard-dashboard</code></p>
<h4 id="2-menu-paths-must-match-view-file-locations">2. Menu Paths Must Match View File Locations<a class="headerlink" href="#2-menu-paths-must-match-view-file-locations" title="Permanent link">&para;</a></h4>
<p>Menu JSON path entries MUST correspond to actual view files:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-7-1" name="__codelineno-7-1" href="#__codelineno-7-1"></a><span class="c1">// In menu.d/luci-app-netifyd-dashboard.json:</span>
<a id="__codelineno-7-2" name="__codelineno-7-2" href="#__codelineno-7-2"></a><span class="p">{</span>
<a id="__codelineno-7-3" name="__codelineno-7-3" href="#__codelineno-7-3"></a><span class="w"> </span><span class="nt">&quot;action&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-7-4" name="__codelineno-7-4" href="#__codelineno-7-4"></a><span class="w"> </span><span class="nt">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;view&quot;</span><span class="p">,</span>
<a id="__codelineno-7-5" name="__codelineno-7-5" href="#__codelineno-7-5"></a><span class="w"> </span><span class="nt">&quot;path&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;netifyd-dashboard/overview&quot;</span><span class="w"> </span><span class="c1">// ← Must match file location</span>
<a id="__codelineno-7-6" name="__codelineno-7-6" href="#__codelineno-7-6"></a><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-7-7" name="__codelineno-7-7" href="#__codelineno-7-7"></a><span class="p">}</span>
</code></pre></div>
<div class="highlight"><pre><span></span><code><a id="__codelineno-8-1" name="__codelineno-8-1" href="#__codelineno-8-1"></a><span class="c1"># View file MUST exist at:</span>
<a id="__codelineno-8-2" name="__codelineno-8-2" href="#__codelineno-8-2"></a>htdocs/luci-static/resources/view/netifyd-dashboard/overview.js
<a id="__codelineno-8-3" name="__codelineno-8-3" href="#__codelineno-8-3"></a><span class="c1"># ↑ Same path as menu ↑</span>
</code></pre></div>
<p><strong>Common Error</strong>: If paths don't match:
- <code>HTTP error 404 while loading class file '/luci-static/resources/view/netifyd/overview.js'</code></p>
<p><strong>Solution</strong>: Ensure menu paths match directory structure:
- ✅ Correct: Menu path <code>netifyd-dashboard/overview</code> → file <code>view/netifyd-dashboard/overview.js</code>
- ❌ Wrong: Menu path <code>netifyd/overview</code> → file <code>view/netifyd-dashboard/overview.js</code></p>
<h4 id="3-ubus-object-naming-convention">3. ubus Object Naming Convention<a class="headerlink" href="#3-ubus-object-naming-convention" title="Permanent link">&para;</a></h4>
<p>All ubus objects MUST start with <code>luci.</code> prefix:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-9-1" name="__codelineno-9-1" href="#__codelineno-9-1"></a><span class="c1">// ✅ Correct:</span>
<a id="__codelineno-9-2" name="__codelineno-9-2" href="#__codelineno-9-2"></a><span class="nx">object</span><span class="o">:</span><span class="w"> </span><span class="s1">&#39;luci.cdn-cache&#39;</span>
<a id="__codelineno-9-3" name="__codelineno-9-3" href="#__codelineno-9-3"></a><span class="nx">object</span><span class="o">:</span><span class="w"> </span><span class="s1">&#39;luci.system-hub&#39;</span>
<a id="__codelineno-9-4" name="__codelineno-9-4" href="#__codelineno-9-4"></a><span class="nx">object</span><span class="o">:</span><span class="w"> </span><span class="s1">&#39;luci.wireguard-dashboard&#39;</span>
<a id="__codelineno-9-5" name="__codelineno-9-5" href="#__codelineno-9-5"></a>
<a id="__codelineno-9-6" name="__codelineno-9-6" href="#__codelineno-9-6"></a><span class="c1">// ❌ Wrong:</span>
<a id="__codelineno-9-7" name="__codelineno-9-7" href="#__codelineno-9-7"></a><span class="nx">object</span><span class="o">:</span><span class="w"> </span><span class="s1">&#39;cdn-cache&#39;</span>
<a id="__codelineno-9-8" name="__codelineno-9-8" href="#__codelineno-9-8"></a><span class="nx">object</span><span class="o">:</span><span class="w"> </span><span class="s1">&#39;systemhub&#39;</span>
</code></pre></div>
<h4 id="4-validation-before-deployment">4. Validation Before Deployment<a class="headerlink" href="#4-validation-before-deployment" title="Permanent link">&para;</a></h4>
<p><strong>ALWAYS</strong> run validation before deploying:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-10-1" name="__codelineno-10-1" href="#__codelineno-10-1"></a>./secubox-tools/validate-modules.sh
</code></pre></div>
<p>This script checks:
- RPCD script names match ubus objects
- Menu paths match view file locations
- View files have corresponding menu entries
- RPCD scripts are executable
- JSON files are valid syntax
- ubus objects follow naming convention</p>
<h3 id="makefile-structure">Makefile Structure<a class="headerlink" href="#makefile-structure" title="Permanent link">&para;</a></h3>
<p>Each package Makefile must define:
- <code>PKG_NAME</code>: Package name (must match directory)
- <code>PKG_VERSION</code>: Version number
- <code>PKG_RELEASE</code>: Package release number
- <code>LUCI_TITLE</code>: Display title in LuCI
- <code>LUCI_DEPENDS</code>: Package dependencies (e.g., <code>+luci-base +rpcd</code>)
- <code>LUCI_DESCRIPTION</code>: Brief description
- <code>PKG_MAINTAINER</code>: Maintainer name and email
- <code>PKG_LICENSE</code>: License (typically Apache-2.0)</p>
<p>The Makefile includes <code>luci.mk</code> from the LuCI build system which handles installation.</p>
<h2 id="common-development-patterns">Common Development Patterns<a class="headerlink" href="#common-development-patterns" title="Permanent link">&para;</a></h2>
<h3 id="creating-a-new-module">Creating a New Module<a class="headerlink" href="#creating-a-new-module" title="Permanent link">&para;</a></h3>
<ol>
<li>Copy template: <code>cp -r templates/luci-app-template luci-app-newmodule</code></li>
<li>Update Makefile with new PKG_NAME, LUCI_TITLE, etc.</li>
<li>Create directory structure under <code>htdocs/</code> and <code>root/</code></li>
<li>Implement RPCD backend in shell</li>
<li>Create JavaScript views</li>
<li>Define menu and ACL JSON files</li>
</ol>
<h3 id="rpcd-backend-pattern">RPCD Backend Pattern<a class="headerlink" href="#rpcd-backend-pattern" title="Permanent link">&para;</a></h3>
<p>RPCD backends are shell scripts that:
- Parse <code>$1</code> for the method name
- Output valid JSON using <code>printf</code> or <code>echo</code>
- Use <code>case</code> statements for method routing
- Source UCI config if needed: <code>. /lib/functions.sh</code></p>
<p>Example:
<div class="highlight"><pre><span></span><code><a id="__codelineno-11-1" name="__codelineno-11-1" href="#__codelineno-11-1"></a><span class="ch">#!/bin/sh</span>
<a id="__codelineno-11-2" name="__codelineno-11-2" href="#__codelineno-11-2"></a><span class="k">case</span><span class="w"> </span><span class="s2">&quot;</span><span class="nv">$1</span><span class="s2">&quot;</span><span class="w"> </span><span class="k">in</span>
<a id="__codelineno-11-3" name="__codelineno-11-3" href="#__codelineno-11-3"></a><span class="w"> </span>list<span class="o">)</span>
<a id="__codelineno-11-4" name="__codelineno-11-4" href="#__codelineno-11-4"></a><span class="w"> </span><span class="nb">echo</span><span class="w"> </span><span class="s1">&#39;{ &quot;status&quot;: {}, &quot;stats&quot;: {} }&#39;</span>
<a id="__codelineno-11-5" name="__codelineno-11-5" href="#__codelineno-11-5"></a><span class="w"> </span><span class="p">;;</span>
<a id="__codelineno-11-6" name="__codelineno-11-6" href="#__codelineno-11-6"></a><span class="w"> </span>call<span class="o">)</span>
<a id="__codelineno-11-7" name="__codelineno-11-7" href="#__codelineno-11-7"></a><span class="w"> </span><span class="k">case</span><span class="w"> </span><span class="s2">&quot;</span><span class="nv">$2</span><span class="s2">&quot;</span><span class="w"> </span><span class="k">in</span>
<a id="__codelineno-11-8" name="__codelineno-11-8" href="#__codelineno-11-8"></a><span class="w"> </span>status<span class="o">)</span>
<a id="__codelineno-11-9" name="__codelineno-11-9" href="#__codelineno-11-9"></a><span class="w"> </span><span class="c1"># Output JSON</span>
<a id="__codelineno-11-10" name="__codelineno-11-10" href="#__codelineno-11-10"></a><span class="w"> </span><span class="nb">printf</span><span class="w"> </span><span class="s1">&#39;{&quot;running&quot;: true, &quot;version&quot;: &quot;1.0.0&quot;}\n&#39;</span>
<a id="__codelineno-11-11" name="__codelineno-11-11" href="#__codelineno-11-11"></a><span class="w"> </span><span class="p">;;</span>
<a id="__codelineno-11-12" name="__codelineno-11-12" href="#__codelineno-11-12"></a><span class="w"> </span><span class="k">esac</span>
<a id="__codelineno-11-13" name="__codelineno-11-13" href="#__codelineno-11-13"></a><span class="w"> </span><span class="p">;;</span>
<a id="__codelineno-11-14" name="__codelineno-11-14" href="#__codelineno-11-14"></a><span class="k">esac</span>
</code></pre></div></p>
<h3 id="javascript-view-pattern">JavaScript View Pattern<a class="headerlink" href="#javascript-view-pattern" title="Permanent link">&para;</a></h3>
<p>Views extend <code>L.view</code> and implement <code>load()</code> and <code>render()</code>:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-12-1" name="__codelineno-12-1" href="#__codelineno-12-1"></a><span class="s1">&#39;use strict&#39;</span><span class="p">;</span>
<a id="__codelineno-12-2" name="__codelineno-12-2" href="#__codelineno-12-2"></a><span class="s1">&#39;require view&#39;</span><span class="p">;</span>
<a id="__codelineno-12-3" name="__codelineno-12-3" href="#__codelineno-12-3"></a><span class="s1">&#39;require form&#39;</span><span class="p">;</span>
<a id="__codelineno-12-4" name="__codelineno-12-4" href="#__codelineno-12-4"></a><span class="s1">&#39;require &lt;module&gt;/api as API&#39;</span><span class="p">;</span>
<a id="__codelineno-12-5" name="__codelineno-12-5" href="#__codelineno-12-5"></a>
<a id="__codelineno-12-6" name="__codelineno-12-6" href="#__codelineno-12-6"></a><span class="k">return</span><span class="w"> </span><span class="nx">L</span><span class="p">.</span><span class="nx">view</span><span class="p">.</span><span class="nx">extend</span><span class="p">({</span>
<a id="__codelineno-12-7" name="__codelineno-12-7" href="#__codelineno-12-7"></a><span class="w"> </span><span class="nx">load</span><span class="o">:</span><span class="w"> </span><span class="kd">function</span><span class="p">()</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-12-8" name="__codelineno-12-8" href="#__codelineno-12-8"></a><span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="nb">Promise</span><span class="p">.</span><span class="nx">all</span><span class="p">([</span>
<a id="__codelineno-12-9" name="__codelineno-12-9" href="#__codelineno-12-9"></a><span class="w"> </span><span class="nx">API</span><span class="p">.</span><span class="nx">getStatus</span><span class="p">(),</span>
<a id="__codelineno-12-10" name="__codelineno-12-10" href="#__codelineno-12-10"></a><span class="w"> </span><span class="nx">API</span><span class="p">.</span><span class="nx">getStats</span><span class="p">()</span>
<a id="__codelineno-12-11" name="__codelineno-12-11" href="#__codelineno-12-11"></a><span class="w"> </span><span class="p">]);</span>
<a id="__codelineno-12-12" name="__codelineno-12-12" href="#__codelineno-12-12"></a><span class="w"> </span><span class="p">},</span>
<a id="__codelineno-12-13" name="__codelineno-12-13" href="#__codelineno-12-13"></a>
<a id="__codelineno-12-14" name="__codelineno-12-14" href="#__codelineno-12-14"></a><span class="w"> </span><span class="nx">render</span><span class="o">:</span><span class="w"> </span><span class="kd">function</span><span class="p">(</span><span class="nx">data</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-12-15" name="__codelineno-12-15" href="#__codelineno-12-15"></a><span class="w"> </span><span class="kd">var</span><span class="w"> </span><span class="nx">m</span><span class="p">,</span><span class="w"> </span><span class="nx">s</span><span class="p">,</span><span class="w"> </span><span class="nx">o</span><span class="p">;</span>
<a id="__codelineno-12-16" name="__codelineno-12-16" href="#__codelineno-12-16"></a><span class="w"> </span><span class="nx">m</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="ow">new</span><span class="w"> </span><span class="nx">form</span><span class="p">.</span><span class="nb">Map</span><span class="p">(</span><span class="s1">&#39;config&#39;</span><span class="p">,</span><span class="w"> </span><span class="nx">_</span><span class="p">(</span><span class="s1">&#39;Title&#39;</span><span class="p">));</span>
<a id="__codelineno-12-17" name="__codelineno-12-17" href="#__codelineno-12-17"></a><span class="w"> </span><span class="nx">s</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">m</span><span class="p">.</span><span class="nx">section</span><span class="p">(</span><span class="nx">form</span><span class="p">.</span><span class="nx">TypedSection</span><span class="p">,</span><span class="w"> </span><span class="s1">&#39;section&#39;</span><span class="p">);</span>
<a id="__codelineno-12-18" name="__codelineno-12-18" href="#__codelineno-12-18"></a><span class="w"> </span><span class="c1">// Add form fields...</span>
<a id="__codelineno-12-19" name="__codelineno-12-19" href="#__codelineno-12-19"></a><span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="nx">m</span><span class="p">.</span><span class="nx">render</span><span class="p">();</span>
<a id="__codelineno-12-20" name="__codelineno-12-20" href="#__codelineno-12-20"></a><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-12-21" name="__codelineno-12-21" href="#__codelineno-12-21"></a><span class="p">});</span>
</code></pre></div>
<h2 id="module-categories">Module Categories<a class="headerlink" href="#module-categories" title="Permanent link">&para;</a></h2>
<ol>
<li><strong>Core Control</strong> (2 modules)</li>
<li>luci-app-secubox: Central hub</li>
<li>
<p>luci-app-system-hub: System control center</p>
</li>
<li>
<p><strong>Security &amp; Monitoring</strong> (2 modules)</p>
</li>
<li>luci-app-crowdsec-dashboard: CrowdSec security</li>
<li>
<p>luci-app-netdata-dashboard: System monitoring</p>
</li>
<li>
<p><strong>Network Intelligence</strong> (2 modules)</p>
</li>
<li>luci-app-netifyd-dashboard: Deep packet inspection</li>
<li>
<p>luci-app-network-modes: Network mode configuration</p>
</li>
<li>
<p><strong>VPN &amp; Access Control</strong> (3 modules)</p>
</li>
<li>luci-app-wireguard-dashboard: WireGuard VPN</li>
<li>luci-app-client-guardian: NAC &amp; captive portal</li>
<li>
<p>luci-app-auth-guardian: Authentication system</p>
</li>
<li>
<p><strong>Bandwidth &amp; Traffic</strong> (2 modules)</p>
</li>
<li>luci-app-bandwidth-manager: QoS &amp; quotas</li>
<li>
<p>luci-app-media-flow: Media traffic detection</p>
</li>
<li>
<p><strong>Performance &amp; Services</strong> (2 modules)</p>
</li>
<li>luci-app-cdn-cache: CDN proxy cache</li>
<li>luci-app-vhost-manager: Virtual host manager</li>
</ol>
<h2 id="cicd-integration">CI/CD Integration<a class="headerlink" href="#cicd-integration" title="Permanent link">&para;</a></h2>
<h3 id="github-actions-workflows">GitHub Actions Workflows<a class="headerlink" href="#github-actions-workflows" title="Permanent link">&para;</a></h3>
<ol>
<li><strong>build-openwrt-packages.yml</strong>: Compiles packages for all architectures</li>
<li>Triggers on push, PR, and tags</li>
<li>Matrix build for 13 architectures</li>
<li>
<p>Uploads artifacts per architecture</p>
</li>
<li>
<p><strong>build-secubox-images.yml</strong>: Builds custom OpenWrt images</p>
</li>
<li>
<p>Creates complete firmware images with SecuBox pre-installed</p>
</li>
<li>
<p><strong>test-validate.yml</strong>: Validation and testing</p>
</li>
<li>Validates Makefile structure</li>
<li>Checks JSON syntax</li>
<li>Runs shellcheck on scripts</li>
<li>Verifies file permissions</li>
</ol>
<h3 id="supported-architectures">Supported Architectures<a class="headerlink" href="#supported-architectures" title="Permanent link">&para;</a></h3>
<p>ARM64: aarch64-cortex-a53, aarch64-cortex-a72, aarch64-generic, mediatek-filogic, rockchip-armv8, bcm27xx-bcm2711</p>
<p>ARM32: arm-cortex-a7-neon, arm-cortex-a9-neon, qualcomm-ipq40xx, qualcomm-ipq806x</p>
<p>MIPS: mips-24kc, mipsel-24kc, mipsel-74kc</p>
<p>x86: x86-64, x86-generic</p>
<h2 id="key-files-and-directories">Key Files and Directories<a class="headerlink" href="#key-files-and-directories" title="Permanent link">&para;</a></h2>
<ul>
<li><code>makefiles/</code>: Reference Makefiles for modules (backup/templates)</li>
<li><code>secubox-tools/</code>: Repair and debugging utilities</li>
<li><code>secubox-repair.sh</code>: Auto-fixes Makefile and RPCD issues</li>
<li><code>secubox-debug.sh</code>: Validates package structure</li>
<li><code>templates/</code>: Package templates for creating new modules</li>
<li><code>.github/workflows/</code>: CI/CD automation scripts</li>
</ul>
<h2 id="common-issues-and-solutions">Common Issues and Solutions<a class="headerlink" href="#common-issues-and-solutions" title="Permanent link">&para;</a></h2>
<h3 id="rpc-errors-object-not-found-or-method-not-found">RPC Errors: "Object not found" or "Method not found"<a class="headerlink" href="#rpc-errors-object-not-found-or-method-not-found" title="Permanent link">&para;</a></h3>
<p><strong>Error</strong>: <code>RPC call to luci.cdn-cache/status failed with error -32000: Object not found</code></p>
<p><strong>Cause</strong>: RPCD script name doesn't match ubus object name in JavaScript</p>
<p><strong>Solution</strong>:
1. Check JavaScript files for ubus object name:
<div class="highlight"><pre><span></span><code><a id="__codelineno-13-1" name="__codelineno-13-1" href="#__codelineno-13-1"></a>grep<span class="w"> </span>-r<span class="w"> </span><span class="s2">&quot;object:&quot;</span><span class="w"> </span>luci-app-*/htdocs<span class="w"> </span>--include<span class="o">=</span><span class="s2">&quot;*.js&quot;</span>
</code></pre></div>
2. Rename RPCD script to match exactly (including <code>luci.</code> prefix):
<div class="highlight"><pre><span></span><code><a id="__codelineno-14-1" name="__codelineno-14-1" href="#__codelineno-14-1"></a>mv<span class="w"> </span>root/usr/libexec/rpcd/cdn-cache<span class="w"> </span>root/usr/libexec/rpcd/luci.cdn-cache
</code></pre></div>
3. Restart RPCD on router:
<div class="highlight"><pre><span></span><code><a id="__codelineno-15-1" name="__codelineno-15-1" href="#__codelineno-15-1"></a>/etc/init.d/rpcd<span class="w"> </span>restart
</code></pre></div></p>
<h3 id="http-404-errors-view-files-not-found">HTTP 404 Errors: View Files Not Found<a class="headerlink" href="#http-404-errors-view-files-not-found" title="Permanent link">&para;</a></h3>
<p><strong>Error</strong>: <code>HTTP error 404 while loading class file '/luci-static/resources/view/netifyd/overview.js'</code></p>
<p><strong>Cause</strong>: Menu path doesn't match actual view file location</p>
<p><strong>Solution</strong>:
1. Check menu JSON for path:
<div class="highlight"><pre><span></span><code><a id="__codelineno-16-1" name="__codelineno-16-1" href="#__codelineno-16-1"></a>grep<span class="w"> </span><span class="s1">&#39;&quot;path&quot;:&#39;</span><span class="w"> </span>root/usr/share/luci/menu.d/*.json
</code></pre></div>
2. Verify view file exists at matching location:
<div class="highlight"><pre><span></span><code><a id="__codelineno-17-1" name="__codelineno-17-1" href="#__codelineno-17-1"></a>ls<span class="w"> </span>htdocs/luci-static/resources/view/
</code></pre></div>
3. Update menu path to match file location OR move file to match menu path</p>
<h3 id="rpcd-not-responding">RPCD Not Responding<a class="headerlink" href="#rpcd-not-responding" title="Permanent link">&para;</a></h3>
<p>After installing/updating a package:
<div class="highlight"><pre><span></span><code><a id="__codelineno-18-1" name="__codelineno-18-1" href="#__codelineno-18-1"></a>/etc/init.d/rpcd<span class="w"> </span>restart
<a id="__codelineno-18-2" name="__codelineno-18-2" href="#__codelineno-18-2"></a>/etc/init.d/uhttpd<span class="w"> </span>restart
</code></pre></div></p>
<h3 id="menu-not-appearing">Menu Not Appearing<a class="headerlink" href="#menu-not-appearing" title="Permanent link">&para;</a></h3>
<p>Check that:
1. Menu JSON is valid: <code>jsonlint root/usr/share/luci/menu.d/*.json</code>
2. ACL grants access: Check <code>root/usr/share/rpcd/acl.d/*.json</code>
3. Dependencies are installed: Check Makefile <code>LUCI_DEPENDS</code>
4. Menu path matches view file location (see above)</p>
<h3 id="build-failures">Build Failures<a class="headerlink" href="#build-failures" title="Permanent link">&para;</a></h3>
<p>Common causes:
1. Missing fields in Makefile (PKG_NAME, LUCI_TITLE, etc.)
2. Invalid JSON syntax in menu.d or acl.d
3. RPCD script not executable (chmod +x needed)
4. Wrong include path (should be <code>include ../../luci.mk</code>)
5. RPCD script name doesn't match ubus object (must use <code>luci.</code> prefix)</p>
<p>Use repair tool: <code>./secubox-tools/secubox-repair.sh</code></p>
<h3 id="quick-diagnosis">Quick Diagnosis<a class="headerlink" href="#quick-diagnosis" title="Permanent link">&para;</a></h3>
<p>Run the validation script to check all naming conventions:
<div class="highlight"><pre><span></span><code><a id="__codelineno-19-1" name="__codelineno-19-1" href="#__codelineno-19-1"></a>./secubox-tools/validate-modules.sh
</code></pre></div></p>
<h2 id="development-workflow">Development Workflow<a class="headerlink" href="#development-workflow" title="Permanent link">&para;</a></h2>
<ol>
<li>Make changes to module files</li>
<li><strong>Run validation checks</strong> (CRITICAL):
<div class="highlight"><pre><span></span><code><a id="__codelineno-20-1" name="__codelineno-20-1" href="#__codelineno-20-1"></a>./secubox-tools/validate-modules.sh
<a id="__codelineno-20-2" name="__codelineno-20-2" href="#__codelineno-20-2"></a><span class="c1"># Or use the local build tool:</span>
<a id="__codelineno-20-3" name="__codelineno-20-3" href="#__codelineno-20-3"></a>./secubox-tools/local-build.sh<span class="w"> </span>validate
</code></pre></div></li>
<li>Test JSON syntax: <code>jsonlint &lt;file&gt;.json</code></li>
<li>Test shell scripts: <code>shellcheck &lt;script&gt;</code></li>
<li>Build and test package locally (recommended):
<div class="highlight"><pre><span></span><code><a id="__codelineno-21-1" name="__codelineno-21-1" href="#__codelineno-21-1"></a><span class="c1"># Build single package</span>
<a id="__codelineno-21-2" name="__codelineno-21-2" href="#__codelineno-21-2"></a>./secubox-tools/local-build.sh<span class="w"> </span>build<span class="w"> </span>luci-app-&lt;name&gt;
<a id="__codelineno-21-3" name="__codelineno-21-3" href="#__codelineno-21-3"></a>
<a id="__codelineno-21-4" name="__codelineno-21-4" href="#__codelineno-21-4"></a><span class="c1"># Or build with manual SDK:</span>
<a id="__codelineno-21-5" name="__codelineno-21-5" href="#__codelineno-21-5"></a>make<span class="w"> </span>package/luci-app-&lt;name&gt;/compile<span class="w"> </span><span class="nv">V</span><span class="o">=</span>s
</code></pre></div></li>
<li>Install on test router and verify functionality</li>
<li>Run repair tool if needed: <code>./secubox-tools/secubox-repair.sh</code></li>
<li>Commit changes and push (triggers CI validation)</li>
<li>Create tag for release: <code>git tag -a v1.0.0 -m "Release 1.0.0"</code></li>
</ol>
<h2 id="important-notes">Important Notes<a class="headerlink" href="#important-notes" title="Permanent link">&para;</a></h2>
<ul>
<li><strong>CRITICAL</strong>: RPCD script names MUST match ubus object names (use <code>luci.</code> prefix)</li>
<li><strong>CRITICAL</strong>: Menu paths MUST match view file directory structure</li>
<li><strong>CRITICAL</strong>: Always run <code>./secubox-tools/validate-modules.sh</code> before committing</li>
<li>All modules use Apache-2.0 license</li>
<li>RPCD backends must be executable (chmod +x)</li>
<li>JavaScript files use strict mode: <code>'use strict';</code></li>
<li>Menu entries require proper dependency chain</li>
<li>ACL must grant both ubus call and luci-cgi access</li>
<li>UCI config files are optional (many modules don't need them)</li>
<li>All packages build as architecture <code>all</code> (no compiled code)</li>
</ul>
</article>
</div>
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
</div>
<button type="button" class="md-top md-icon" data-md-component="top" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>
Back to top
</button>
</main>
<footer class="md-footer">
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-copyright">
Made with
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
Material for MkDocs
</a>
</div>
<div class="md-social">
<a href="https://github.com/CyberMind-FR/secubox-openwrt" target="_blank" rel="noopener" title="github.com" class="md-social__link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
</a>
<a href="https://secubox.cybermood.eu" target="_blank" rel="noopener" title="secubox.cybermood.eu" class="md-social__link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M351.9 280H161c2.9 64.5 17.2 123.9 37.5 167.4 11.4 24.5 23.7 41.8 35.1 52.4 11.2 10.5 18.9 12.2 22.9 12.2s11.7-1.7 22.9-12.2c11.4-10.6 23.7-28 35.1-52.4 20.3-43.5 34.6-102.9 37.5-167.4zm-191-48h190.9c-2.8-64.5-17.1-123.9-37.4-167.4-11.4-24.4-23.7-41.8-35.1-52.4C268.1 1.7 260.4 0 256.4 0s-11.7 1.7-22.9 12.2c-11.4 10.6-23.7 28-35.1 52.4-20.3 43.5-34.6 102.9-37.5 167.4m-48 0c3.5-85.6 25.6-165.1 57.9-217.3C78.7 47.3 10.9 131.2 1.5 232zM1.5 280c9.4 100.8 77.2 184.7 169.3 217.3-32.3-52.2-54.4-131.7-57.9-217.3zm398.4 0c-3.5 85.6-25.6 165.1-57.9 217.3 92.1-32.7 159.9-116.5 169.3-217.3zm111.4-48C501.9 131.2 434.1 47.3 342 14.7c32.3 52.2 54.4 131.7 57.9 217.3z"/></svg>
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"annotate": null, "base": "..", "features": ["navigation.instant", "navigation.tracking", "navigation.tabs", "navigation.tabs.sticky", "navigation.sections", "navigation.expand", "navigation.top", "search.suggest", "search.highlight", "content.code.copy", "content.code.annotate"], "search": "../assets/javascripts/workers/search.2c215733.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>
<script src="../assets/javascripts/bundle.79ae519e.min.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink