NaiLink使用文档

NAILINK HANDBOOK

源码与文档维护

获取完整源码,了解验证范围和文档发布方式。

获取完整源码

NaiLink 基于 daed 二次开发,源码和安装集成在同一仓库维护。编译请使用当前版本完整源码归档,或初始化子模块:

git clone --recurse-submodules https://github.com/slobys/NaiLink.git
cd NaiLink

GitHub 的 Download ZIP 不包含后端子模块。后端基于固定提交与主仓库中的可审查补丁构建;不能把只有前端的源码包当成完整发行源码。

构建入口、SDK 及依赖版本以仓库的 OpenWrt 构建说明和 sdk-matrix.json 为准。MIPS 使用准备好的 CGO 静态 SQLite,不能简单改成 CGO_ENABLED=0 交叉编译。

支持与验证范围

普通 Linux / Docker 的构建与运行方式见构建说明。 Docker 仅提供 amd64 / arm64 独立部署,不能替代 LuCI 插件或补齐宿主机内核能力。 发布入口见贡献指南:OpenWrt 全部检查通过后才可创建测试版草稿,已发布版本不覆盖。

项目保留自动回归、交叉构建、协议夹具、QEMU 与内核探针检查。具体环境和结果见验证记录。

  • 协议本地夹具通过,不等于每个服务商公网节点可用。
  • 数据库 / API 启动通过,不等于完整透明代理可用。
  • DNS 模块测试通过,不等于透明 DNS 截获的端到端检查通过。
  • 短时回归不构成所有固件和设备的长期稳定性保证。

维护这份在线文档

文档源码位于 docs/site/,使用 Python 标准库生成静态页面,没有新增 npm / Python 第三方依赖,也不会进入路由器安装包。

  • site.json:版本、页面顺序与导航。
  • content/*.html:各教程正文。
  • template.html、site.css、site.js:布局、主题、搜索和复制。
  • assets/nailink-logo.png:项目 Logo,透明背景。

在仓库根目录构建并预览:

python3 docs/site/build.py
python3 -m http.server 4173 --directory .build/docs-site

Windows 可将 python3 换成 python。打开 http://localhost:4173,不要只双击 HTML 文件,否则浏览器可能阻止搜索索引加载。

构建会校验站内链接、图片、章节锚点和搜索结果目标。提交到默认分支后,GitHub Actions 重新构建并发布到 GitHub Pages。发布只上传生成的文档,不上传工作区、数据库或用户配置。

Logo 与品牌

Logo 用蓝色与青绿色的两段相扣链路组成字母 N,表达 NaiLink 的连接与管理。下载透明 PNG Logo,生成说明见品牌文件。

上游与许可证

感谢 daed、dae-wing 和 dae。NaiLink 为独立维护的衍生项目,并非上游官方发行版。

前端及安装集成遵循 MIT;后端及其修改遵循 AGPL-3.0,保留相关版权声明。

输入功能名称或问题关键词