Skip to content

Commit 15b8eb5

Browse files
Update README
1 parent b5a8075 commit 15b8eb5

File tree

2 files changed

+36
-26
lines changed

2 files changed

+36
-26
lines changed

README.CN.md

Lines changed: 19 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,33 +4,37 @@
44

55
## 功能特点
66

7-
- 支持管理 AdGuard Home 的服务端口
8-
- 在 LuCI 界面中下载/更新核心(支持自定义 URL 下载)
9-
- 对于 `.tar.gz` 文件,其文件结构需要与官方保持一致
10-
- 或者直接使用主程序二进制文件
11-
- 使用 `upx` 压缩核心(依赖 `xz`,脚本会自动下载,如果 `opkg` 源无法连接,请在编译时包含此软件包)
7+
- 支持管理 AdGuard Home 的服务端口、用户名和密码
8+
- 支持在 LuCI 界面中下载/更新核心(支持自定义 URL 下载)
9+
- 使用 `upx` 压缩核心,减少存储空间占用
1210
- DNS 重定向方式:
13-
- 作为 `dnsmasq` 的上游(AdGuard Home 统计中 IP 会显示为 `127.0.0.1`,无法跟踪客户端并相应调整设置)
1411
- 将 53 端口重定向到 AdGuard Home(直接使用系统防火墙设置,对 nftables 兼容更好,且支持 IPv6 重定向)
15-
- 用 53 端口替换 `dnsmasq`(需设置 AdGuard Home 参数 `dnsip``0.0.0.0``dnsmasq` 和 AdGuard Home 的端口将被交换)
12+
- 作为 `dnsmasq` 的上游(AdGuard Home 统计中 IP 会显示为 `127.0.0.1`,无法跟踪客户端并相应调整设置)
13+
- 用 53 端口替换 `dnsmasq``dnsmasq` 和 AdGuard Home 的端口将被交换,AdGuard Home 使用 53 端口)
1614
- 自定义选项:
1715
- 自定义可执行文件路径(支持 `/tmp`,重启后自动重新下载)
1816
- 自定义配置文件路径
1917
- 自定义工作目录
2018
- 自定义运行日志路径
2119
- GFWList 查询特定 DNS 服务器。另可参考 [luci-app-autoipsetadder](https://github.com/rufengsuixing/luci-app-autoipsetadder)
22-
- 支持修改 AdGuard Home 服务登录密码
2320
- 正序/倒序查看/删除/备份每 3 秒更新的运行日志 + 本地浏览器时区转换
2421
- 支持手动修改 AdGuard Home 配置:
2522
- 支持 YAML 编辑器
2623
- 提供快速配置模板
27-
- 系统升级时保留勾选文件
24+
- 系统升级时自动保留选定的文件
2825
- 开机启动后等待网络连接自动重启 AdGuard Home(3 分钟超时,主要防止过滤器更新失败)
29-
- 关机时备份勾选的工作目录中的文件(注意:IPK 更新时也会触发备份)
26+
- 关机时备份选定的工作目录中的文件(注意:IPK 更新时也会触发备份)
3027
- 计划任务(以下为默认值,时间和参数可在计划任务中调整):
3128
- 自动更新 IPv6 主机并重启 AdGuard Home(每小时,无更新则不重启)
3229
- 自动更新 GFW 列表并重启 AdGuard Home(每天 `3:30`,无更新则不重启)
3330

31+
## 依赖
32+
33+
- `wget``curl`(用于下载核心)
34+
- `upx``xz`(可选,用于核心压缩)
35+
36+
注意:插件会自动安装缺失的依赖,但如果你的发行版没有 `opkg` 源可用,请在 OpenWrt 编译时包含这些软件包。
37+
3438
## 已知问题
3539

3640
- `db` 数据库不能放在不支持 `mmap` 的文件系统,如 `jffs2``data-stk-oo`,请修改工作目录;若检测到 `jffs2`,本插件会自动将数据库软链接到 `/tmp`,但重启后将丢失 DNS 数据库
@@ -49,10 +53,11 @@
4953

5054
## OpenClash 组合方法
5155

52-
1. **GFW 代理**:DNS 重定向 - 作为 `dnsmasq` 的上游服务器
53-
2. **GFW 代理**:手动设置 AdGuard Home 上游 DNS 为 `127.0.0.1:[监听端口]`,然后使用 DNS 重定向 - 用 53 端口替换 `dnsmasq`(端口交换后,`dnsmasq` 成为上游)
54-
3. **国外 IP 代理**:任何重定向方法 - 将 GFW 列表添加到 AdGuard Home,启用计划任务定期更新 GFW
55-
4. **GFW 代理**:DNS 重定向 - 将 53 端口重定向到 AdGuard Home,设置 AdGuard Home 上游 DNS 为 `127.0.0.1:53`
56+
OpenClash 和 passwall 等代理插件通常也包含了 DNS 重定向功能,与 AdGuard Home 结合使用时,需要谨慎设置,否则可能出现冲突或导致 DNS 查询异常。以下是推荐的组合方法:
57+
1. 关闭代理插件的 DNS 重定向功能,避免其修改 dnsmasq 设置或设置防火墙规则导致冲突。
58+
2. 记录代理插件提供的 DNS 服务器地址和端口,例如,OpenClash 的默认端口为 7874。
59+
3. 将 AdGuard Home 的上游 DNS 设置为代理插件提供的 DNS 服务器地址和端口,例如 `127.0.0.1:7874`
60+
4. 在 AdGuard Home 插件设置中启用 DNS 重定向功能,将 53 端口重定向到 AdGuard Home。
5661

5762
## 截图
5863

README.md

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,22 +8,19 @@ Download `.ipk` and `.apk` from [Releases](https://github.com/stevenjoezhang/luc
88

99
## Features
1010

11-
- AdGuard Home service port management
12-
- Download/update core in LuCI interface (supports custom URL download)
13-
- For `.tar.gz` files, the file structure must match the official one
14-
- Or directly use the main program binary
15-
- Compress core with `upx` (`xz` dependency, the script will auto download if needed. If `opkg` source can't connect, please include this package during compilation)
11+
- AdGuard Home service port, username and password management
12+
- Download/update core in LuCI interface (supports custom download URL)
13+
- Compress core with `upx`, reducing storage space usage
1614
- DNS redirection methods:
17-
- As the upstream of `dnsmasq` (IP in AdGuard Home statistics will show as `127.0.0.1`, unable to track clients and adjust settings accordingly)
1815
- Redirect port 53 to AdGuard Home (Directly using the system firewall settings, offers better compatibility with `nftables` and also supports IPv6 redirection)
19-
- Replace `dnsmasq` with port 53 (needs AdGuard Home configuration with `dnsip=0.0.0.0`, ports of `dnsmasq` and AdGuard Home will be exchanged)
16+
- As the upstream of `dnsmasq` (IP in AdGuard Home statistics will show as `127.0.0.1`, unable to track clients and adjust settings accordingly)
17+
- Replace `dnsmasq` with port 53 (Ports of `dnsmasq` and AdGuard Home will be exchanged, AdGuard Home will use port 53)
2018
- Customization options:
2119
- Customize executable file path (supports `/tmp`, auto redownload after reboot)
2220
- Customize config file path
2321
- Customize work directory
2422
- Customize runtime log path
2523
- GFWList query to specific DNS server. Also check out [luci-app-autoipsetadder](https://github.com/rufengsuixing/luci-app-autoipsetadder)
26-
- Modify AdGuard Home login password
2724
- View/delete/backup runtime log in positive/reverse order with 3-second updates + local browser timezone conversion
2825
- Manual configuration:
2926
- YAML editor support
@@ -35,6 +32,13 @@ Download `.ipk` and `.apk` from [Releases](https://github.com/stevenjoezhang/luc
3532
- Auto update IPv6 hosts and restart AdGuard Home (hourly, no restart if no updates)
3633
- Auto update GFW list and restart AdGuard Home (`3:30/day`, no restart if no updates)
3734

35+
## Dependencies
36+
37+
- `wget` or `curl` (for downloading core)
38+
- `upx` and `xz` (optional, for core compression)
39+
40+
Note: the plugin will install dependencies with `opkg` automatically if not present. However, if the `opkg` source is not available in your distribution, you need to include these packages during OpenWrt compilation.
41+
3842
## Known Issues
3943

4044
- Database doesn't support filesystems that don't support `mmap` (such as `jffs2` and `data-stk-oo`). Please modify work directory; if `jffs2` is detected, the app will automatically create soft links (`ln`) for the databases to `/tmp`, but DNS database will be lost after reboot
@@ -53,10 +57,11 @@ Also, compression trades RAM for ROM space, which consumes more memory during ru
5357

5458
## OpenClash Combination Methods
5559

56-
1. **GFW Proxy**: DNS redirect - as `dnsmasq`'s upstream server
57-
2. **GFW Proxy**: Manually set AdGuard Home upstream DNS to `127.0.0.1:[your listening port]`, then use DNS redirect - use port 53 to replace `dnsmasq` (after port exchange, `dnsmasq` becomes the upstream)
58-
3. **Foreign IP Proxy**: Any redirect method - add GFW list to AdGuard Home, enable scheduled task to update GFW regularly
59-
4. **GFW Proxy**: DNS redirect - redirect port 53 to AdGuard Home, set AdGuard Home upstream DNS to `127.0.0.1:53`
60+
OpenClash and other proxy plugins often include DNS redirection features. When used with AdGuard Home, careful configuration is needed to avoid conflicts or DNS query issues. Here are recommended combination methods:
61+
1. Disable DNS redirection in the proxy plugin to avoid modifying `dnsmasq` settings or setting firewall rules that may conflict.
62+
2. Record the DNS server address and port provided by the proxy plugin, e.g., OpenClash's default port is 7874.
63+
3. Set AdGuard Home's upstream DNS to the proxy plugin's DNS server address and port, e.g., `1127.0.0.1:7874`.
64+
4. Enable DNS redirection in AdGuard Home plugin settings to redirect port 53 to AdGuard Home.
6065

6166
## Screenshots
6267

0 commit comments

Comments
 (0)