Frieren：面向安全工具的微框架

描述

Frieren 是一个用于在 OpenWrt 路由器与单板计算机（SBC）上运行安全工具的框架。它提供了一个包含 WiFi 管理、可安装模块、集成终端和包管理器的 Web 面板。技术栈为 PHP 后端 API 加 React 前端，设计轻量以满足嵌入式设备需求，同时通过第三方模块保持可扩展性。

特性

• WiFi 管理 — 创建、编辑和移除无线接口。扫描网络、配置无线电、编辑原始 UCI 配置。
• 网络 — 管理网络接口、查看 DHCP 租约、运行连接诊断。
• 模块系统 — 从远程仓库安装、移除和固定第三方模块。模块以 UMD 包形式动态加载。
• 包管理器 — 直接从 Web 面板安装和移除 opkg 包。
• 集成终端 — 可从面板访问的基于 Web 的终端（ttyd）。
• 系统工具 — 仪表板显示系统统计、USB 设备列表、文件系统使用情况、syslog 查看器、诊断工具以及 init.d 服务控制。
• 设置 — 配置主机名、时区、用户密码和面板主题。
• 可扩展 — 使用 frieren-module-template 构建新模块。每个模块包含 PHP 控制器和 React 前端。

组件

• frieren-back — PHP 微框架。提供包含会话认证、CSRF、UCI 配置集成和迷你 ORM 的 JSON POST API。
• frieren-front — React SPA（基于 Vite、Wouter、Jotai、React Query）。支持动态 UMD 模块加载。
• frieren-module-template — 用于开发第三方模块的脚手架工具，通过 window 全局变量共享依赖。
• frieren-terminal — @frieren/terminal-core，一个集成到前端的 TypeScript/xterm.js 库。提供实时的 ttyd 终端客户端、只读日志查看器以及共享的终端主题。
• tools — 开发辅助工具：开发 API 代理、设备部署脚本、API 测试客户端和 PHP 压缩器。

相关仓库

• Frieren Modules：包含基于 frieren-module-template 开发的社区模块。此仓库是用户通过额外功能扩展 Frieren 安装的资源。
• Frieren Release：托管用于部署预编译 Frieren 版本的安装程序。此仓库适合希望快速轻松安装 Frieren 而无需构建过程的用户。
• Frieren Modules Release：模块目录的构建管道——生成 modules.json 索引以及面板安装所需的每个模块的发布压缩包。

安装

Frieren 运行在 OpenWrt 上（官方构建版本，非分支版本）。可通过自动脚本安装或手动编译。

快速安装

如需快速简便安装，在终端中执行以下命令。此脚本将处理所有必要的配置和设置步骤：

wget -qO- https://raw.githubusercontent.com/xchwarze/frieren-release/master/install/install-openwrt.sh | sh

从这里开始。 如果你不确定 OpenWrt 是什么、如何刷写固件，或者之后如何打开面板，请按照分步的、面向初学者的 安装 FAQ 操作——它会引导你从一台干净的设备一直到登录。

手动编译

Frieren 项目中的每个组件（frieren-back、frieren-front 和 frieren-module-template）都有自己详细的 README.md 文件，包含具体的构建和安装说明。请参考各自目录中的这些文件以获取更详细的指导。

模块开发

使用 frieren-module-template 来搭建新模块的骨架。运行 yarn wizard 设置新模块，开发功能，然后运行 yarn build 编译成 UMD 包。详情请参阅模块模板 README。

许可证

本项目采用 PolyForm 非商业许可证 1.0.0 版。

允许非商业使用。此许可证不允许商业使用。 商业使用需要从作者处单独获取商业许可证。

如需商业许可，请联系：[email protected]

贡献

欢迎贡献——新功能、错误修复或模块。请参阅每个组件的 README 以了解构建说明。

作者

• 首席开发：DSR! - [email protected]

支持项目发展

如果你觉得 Frieren 有用，请考虑支持开发。捐赠用于购买测试硬件和持续工作。可通过币安发送或加入 Patreon 获取独家更新和构建版本。