mirror of
https://github.com/caiwx86/small-packages.git
synced 2026-11-05 18:44:06 +08:00
112 lines
5.5 KiB
Markdown
112 lines
5.5 KiB
Markdown
# luci-app-oxidns
|
||
|
||
语言：中文 | [English](./README.en.md)
|
||
|
||
`luci-app-oxidns` 是 OxiDNS 的 OpenWrt / LuCI 管理插件。安装后，LuCI 会出现 `Services -> OxiDNS` 页面，用来安装 OxiDNS 内核二进制、管理 OpenWrt 服务、编辑配置和查看日志。
|
||
|
||
本仓库仅提供用于安装和管理 OxiDNS 的简单实现。欢迎其他开发者在此基础上扩展，或重新实现覆盖现有功能、提供更多功能的 LuCI 插件。
|
||
|
||
## 你需要安装什么
|
||
|
||
- `luci-app-oxidns`：LuCI 管理页面、rpcd 后端和 OpenWrt init 服务脚本。
|
||
- `luci-i18n-oxidns-zh-cn`：可选简体中文语言包。
|
||
|
||
## 安装 LuCI 插件
|
||
|
||
推荐在 OpenWrt 上以 root 用户执行官方安装脚本：
|
||
|
||
```sh
|
||
curl -fsSL https://oxidns.org/install.sh | sh
|
||
```
|
||
|
||
如果系统没有 `curl`，也可以使用 `wget`：
|
||
|
||
```sh
|
||
wget -O- https://oxidns.org/install.sh | sh
|
||
```
|
||
|
||
脚本会检测 OpenWrt 包管理器，从 `luci-app-oxidns` Releases 读取最新包，按系统选择 `.ipk` 或 `.apk`，安装 `luci-app-oxidns` 和可选简体中文语言包，并自动重启 `rpcd`。更多脚本选项见 <https://oxidns.org/openwrt>。
|
||
|
||
也可以从本仓库 Release 下载对应的 LuCI 包后手动安装：
|
||
|
||
```sh
|
||
opkg install ./luci-app-oxidns_0.1.0-r1_all.ipk
|
||
opkg install ./luci-i18n-oxidns-zh-cn_0.1.0-r1_all.ipk
|
||
```
|
||
|
||
在使用 `apk` 的 OpenWrt 系统上：
|
||
|
||
```sh
|
||
apk add --allow-untrusted --no-network ./luci-app-oxidns_0.1.0-r1_all.apk
|
||
apk add --allow-untrusted --no-network ./luci-i18n-oxidns-zh-cn_0.1.0-r1_all.apk
|
||
```
|
||
|
||
如果安装后菜单没有出现，重启 `rpcd`：
|
||
|
||
```sh
|
||
/etc/init.d/rpcd restart
|
||
```
|
||
|
||
然后打开 LuCI：`Services -> OxiDNS`。
|
||
|
||
## 安装 OxiDNS 内核
|
||
|
||
如果你是从旧的 OpenWrt `oxidns` 包模式迁移，先停止服务并移除旧内核包，避免它继续拥有 `/usr/bin/oxidns` 或 `/etc/init.d/oxidns`：
|
||
|
||
```sh
|
||
/etc/init.d/oxidns stop
|
||
opkg remove oxidns
|
||
```
|
||
|
||
如果系统使用 `apk`，对应执行：
|
||
|
||
```sh
|
||
/etc/init.d/oxidns stop
|
||
apk del oxidns
|
||
```
|
||
|
||
1. 打开 `Services -> OxiDNS -> Settings`，确认 `Core repository` 为 `svenshi/oxidns`，`Core bundle` 为 `full`。
|
||
2. 打开 `Services -> OxiDNS -> Core`，点击 `Install Core`；离线环境也可以点击 `Upload Core` 上传官方 `.tar.gz` archive 或单个 `oxidns` 二进制。
|
||
3. 安装成功后，到 `Overview` 启动并启用服务。
|
||
|
||
LuCI 会按当前设备 CPU 架构选择 OxiDNS Linux musl release archive，例如 `oxidns-x86_64-unknown-linux-musl.tar.gz`。安装时会校验 GitHub release asset 的 SHA256 digest。
|
||
|
||
如果内核已经安装，`Core` 页面提供 `Repair Reinstall` 和 `Upload Core`，用于重新下载当前已安装版本或用上传文件修复二进制 / WebUI 文件；它不会安装 latest，也不会作为升级入口。
|
||
|
||
## 常用页面
|
||
|
||
- `Overview`：查看内核状态、服务状态、WebUI 入口、配置路径和日志状态。
|
||
- `Core`：首次安装、上传安装、修复重装或删除 OxiDNS 内核二进制。
|
||
- `Configuration`：查看、保存和校验配置文件。
|
||
- `Logs`：查看运行日志，支持刷新和暂停。
|
||
- `Settings`：设置 core repository、bundle、代理、配置路径和工作目录。
|
||
|
||
## 默认路径
|
||
|
||
- 二进制：`/usr/bin/oxidns`
|
||
- WebUI：`/usr/share/oxidns/webui`
|
||
- 配置：`/etc/oxidns/config.yaml`
|
||
- 工作目录：`/var/lib/oxidns`
|
||
- 服务脚本：`/etc/init.d/oxidns`
|
||
|
||
## 升级与删除
|
||
|
||
升级 OxiDNS 内核时，请使用 OxiDNS 自带的升级功能，例如内核 WebUI / API / CLI 中的升级能力。LuCI 不提供内核升级入口。
|
||
|
||
升级 LuCI 插件时，下载新版本 `luci-app-oxidns` 包并重新安装即可。LuCI 页面内不提供自升级。
|
||
|
||
删除 OxiDNS 内核可以在 LuCI 的 `Core` 页面点击 `Remove Core`。该操作会停止并禁用服务，删除 `/usr/bin/oxidns` 和 `/usr/share/oxidns/webui`，但保留 `/etc/oxidns/config.yaml` 和 `/var/lib/oxidns`。
|
||
|
||
## 私有仓库与下载
|
||
|
||
路由器需要能直接访问 GitHub Releases 和 release archive。私有仓库或受限网络环境可以在 `Settings` 中配置 GitHub token 或下载代理。Token 和代理值保存后不会在 LuCI 页面中回显，需要清除时请勾选对应清除选项。配置下载代理时需要安装 `curl`，否则 LuCI 会返回明确错误；也可以在 `Core` 页面手动上传 release archive 或二进制进行离线安装。
|
||
|
||
## 已知限制
|
||
|
||
- 目前只支持 OxiDNS 已发布的 Linux musl release target。
|
||
- `Core` 页面只负责首次安装、上传安装和修复重装，不负责版本升级。
|
||
- `Overview` 的 WebUI 入口根据配置文件中的 HTTP listen 地址生成；如果监听 `127.0.0.1`，LuCI 会保留链接并提示需要本机访问或 SSH 隧道。
|
||
- 日志页读取 OpenWrt `logread` 中的 OxiDNS 服务 stdout/stderr 输出。
|
||
- 可在 `Settings` 中关闭“写入系统日志”（默认开启），保存后需重启 OxiDNS 才会生效。LuCI 会停止服务，等待旧 procd 实例被移除（最多 10 秒），再启动新实例，以应用 stdout/stderr 设置。状态查询失败或停止超时时，重启会中止。替换正在运行的内核前也会执行相同的停止等待。
|
||
- `Overview` 上的服务操作（Start / Stop / Restart / Enable / Disable）始终会向系统日志写入一条以 `luci-app-oxidns` 为 tag 的审计记录，包含动作和成功或失败结果。内核未安装、init 脚本缺失或操作失败时同样会记录。这些记录可在 `logread` 原始输出和 LuCI 系统日志页看到；由于日志页只显示 `oxidns[PID]:` 格式的内核输出，审计记录不会出现在 OxiDNS 日志页。
|