|
1 | | -# 📦 Box 模块 |
| 1 | +# Box for Root |
2 | 2 |
|
3 | | -本项目深受 [CHIZI-0618/box4magisk](https://github.com/CHIZI-0618/box4magisk) 和 [taamarin/box_for_magisk](https://github.com/taamarin/box_for_magisk) 的启发和影响,在此向原作者们表示衷心的感谢! |
| 3 | +`Box for Root` 是一个面向 Android Root 环境(Magisk / KernelSU / APatch)的透明代理工具箱模块。 |
4 | 4 |
|
5 | | ---- |
| 5 | +项目深受以下仓库启发并在其基础上持续演进: |
| 6 | +- [CHIZI-0618/box4magisk](https://github.com/CHIZI-0618/box4magisk) |
| 7 | +- [taamarin/box_for_magisk](https://github.com/taamarin/box_for_magisk) |
6 | 8 |
|
7 | | -## 📋 目录 |
| 9 | +## 项目定位 |
8 | 10 |
|
9 | | -- [目录结构](#-目录结构) |
10 | | -- [必要依赖](#-必要依赖) |
11 | | -- [下载、安装与配置](#-下载安装与配置) |
12 | | -- [核心脚本指令](#-核心脚本指令) |
13 | | -- [配套管理APP](#-配套管理app) |
14 | | -- [致谢](#-致谢) |
| 11 | +本仓库主要提供: |
| 12 | +- 统一的代理核心运行管理(mihomo / sing-box / xray / v2fly / hysteria) |
| 13 | +- 多网络模式下的透明代理规则编排(TProxy / Redirect / Tun / Mixed / Enhance) |
| 14 | +- 订阅、Geo 资源、核心二进制与 WebUI 的统一维护脚本 |
| 15 | +- 适配 Android Root 生态的模块化目录与服务生命周期管理 |
15 | 16 |
|
16 | | ---- |
| 17 | +## 主要目录 |
17 | 18 |
|
18 | | -## 📁 目录结构 |
| 19 | +模块工作目录:`/data/adb/box/` |
19 | 20 |
|
20 | | -模块刷入后,主要工作目录位于 `/data/adb/box/`。结构如下: |
21 | | - |
22 | | -``` |
| 21 | +```text |
23 | 22 | /data/adb/box/ |
24 | | -├── bin/ # 存放 clash, sing-box 等代理核心的可执行文件 |
25 | | -│ |
26 | | -├── hysteria/ # Hysteria 核心的配置文件目录 (e.g., config.yaml) |
27 | | -├── mihomo/ # Mihomo 核心的配置文件目录 (e.g., config.yaml) |
28 | | -├── sing-box/ # Sing-box 核心的配置文件目录 (e.g., config.json) |
29 | | -├── v2fly/ # V2Fly 核心的配置文件目录 (e.g., config.json) |
30 | | -├── xray/ # Xray 核心的配置文件目录 (e.g., config.json) |
31 | | -│ |
32 | | -├── scripts/ # 存放模块的核心脚本 |
33 | | -│ ├── box.service # 主要服务管理脚本 |
34 | | -│ ├── box.iptables # 防火墙规则管理脚本 |
35 | | -│ └── box.tool # 实用工具箱脚本 |
36 | | -│ |
37 | | -├── run/ # 运行时目录,用于存放日志、PID等临时文件 |
38 | | -│ |
39 | | -├── ap.list.cfg # [可配置] 应用列表配置 |
40 | | -├── crontab.cfg # [可配置] 定时任务配置 |
41 | | -├── package.list.cfg # [可配置] 包列表配置 |
42 | | -└── settings.ini # [重要] 模块总配置文件,你的主要配置区域! |
43 | | -``` |
44 | | - |
45 | | -> **注意**: `run/` 目录可能在模块首次运行时自动创建。 |
46 | | -
|
47 | | ---- |
48 | | - |
49 | | -## 🔧 必要依赖 |
50 | | - |
51 | | -为了确保模块所有功能正常运行,系统环境中必须包含以下两个组件: |
52 | | - |
53 | | -- **`yq`**: 一个轻量级的命令行 YAML, JSON, XML 处理器,用于解析和修改配置文件。 |
54 | | -- **`curl`**: 一个强大的网络数据传输工具,用于下载订阅、更新资源等。 |
55 | | - |
56 | | -> **请注意**: 缺少以上任一依赖都可能导致模块无法启动或功能异常。 |
57 | | -
|
58 | | ---- |
59 | | - |
60 | | -## 🚀 下载、安装与配置 |
61 | | - |
62 | | -有关详细的下载、安装和配置指南,请参阅: |
63 | | -➡️ **[Wiki](https://github.com/boxproxy/box/wiki)** |
64 | | - |
65 | | ---- |
66 | | - |
67 | | -## ⚙️ 核心脚本指令 |
68 | | - |
69 | | -可使用 `su` 获取 root 权限后执行以下命令,来管理模块的运行状态。 |
70 | | - |
71 | | -### `box.service` |
72 | | - |
73 | | -模块的主服务控制脚本,用于管理代理核心的生命周期和定时任务。 |
74 | | - |
75 | | -```bash |
76 | | -# 用法: su -c /data/adb/box/scripts/box.service {start|stop|restart|status|cron|kcron} |
77 | | -``` |
78 | | - |
79 | | -### `box.iptables` |
80 | | - |
81 | | -专门用于管理透明代理所依赖的 `iptables` 防火墙规则。 |
82 | | - |
83 | | -```bash |
84 | | -# 用法: su -c /data/adb/box/scripts/box.iptables {enable|disable|renew} |
| 23 | +├── bin/ # 代理核心与工具二进制 |
| 24 | +├── mihomo/ # mihomo 配置目录 |
| 25 | +├── sing-box/ # sing-box 配置目录 |
| 26 | +├── xray/ # xray 配置目录 |
| 27 | +├── v2fly/ # v2fly 配置目录 |
| 28 | +├── hysteria/ # hysteria 配置目录 |
| 29 | +├── scripts/ # 核心脚本 |
| 30 | +│ ├── box.service # 服务生命周期管理 |
| 31 | +│ ├── box.iptables # 透明代理规则管理 |
| 32 | +│ └── box.tool # 更新与维护工具集 |
| 33 | +├── run/ # 运行时状态与日志 |
| 34 | +└── settings.ini # 全局配置文件 |
85 | 35 | ``` |
86 | 36 |
|
87 | | -### `box.tool` |
88 | | - |
89 | | -一个多功能的工具箱,集成了多种实用功能,如更新订阅、检查配置、下载核心等。 |
90 | | - |
91 | | -```bash |
92 | | -# 用法: su -c /data/adb/box/scripts/box.tool {check|memcg|cpuset|blkio|geosub|geox|subs|upkernel [name]|upkernels [name...]|upgeox_all|upxui|upyq|upcurl|reload|webroot|bond0|bond1|all} |
93 | | -``` |
94 | | - |
95 | | ---- |
96 | | - |
97 | | -## 📱 配套管理APP |
98 | | - |
99 | | -可通过图形化界面轻松完成切换代理、查看日志、修改配置等操作。 |
| 37 | +## 核心脚本 |
100 | 38 |
|
101 | | -**获取方式**: |
102 | | -请访问以下 Telegram 频道获取最新版本的APP: |
103 | | -➡️ **[RE](https://t.me/zero_o0)** |
| 39 | +- `box.service`: 启停、重启、状态与定时任务控制 |
| 40 | +- `box.iptables`: 透明代理规则启用、重建、清理 |
| 41 | +- `box.tool`: 订阅更新、Geo 更新、核心更新、配置检查、WebUI 相关维护 |
104 | 42 |
|
105 | | ---- |
| 43 | +## 文档与社区 |
106 | 44 |
|
107 | | -## 🙏 致谢 |
| 45 | +- Wiki: <https://github.com/boxproxy/box/wiki> |
| 46 | +- 更新日志: [CHANGELOG.md](./CHANGELOG.md) |
| 47 | +- 配套 APP / 通知频道: <https://t.me/zero_o0> |
108 | 48 |
|
109 | | -本项目的诞生离不开以下优秀项目的启发和参考,它们为 `Box for Android` 提供了坚实的基础和宝贵的灵感。 |
| 49 | +## 致谢 |
110 | 50 |
|
111 | | -- **[CHIZI-0618/box4magisk](https://github.com/CHIZI-0618/box4magisk)**: 一个功能全面的 Magisk 代理模块,提供了诸多核心功能的实现思路。 |
112 | | -- **[taamarin/box_for_magisk](https://github.com/taamarin/box_for_magisk)**: 同样是一个优秀的代理模块项目,为本项目提供了重要的参考。 |
| 51 | +感谢开源社区与上述项目作者提供的设计思路与实现参考。 |
0 commit comments