Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/taamarin/box_for_magisk
Transparent Proxy for Android(root)
https://github.com/taamarin/box_for_magisk
android clash magisk-module shell-scripts sing-box v2ray xray
Last synced: 6 days ago
JSON representation
Transparent Proxy for Android(root)
- Host: GitHub
- URL: https://github.com/taamarin/box_for_magisk
- Owner: taamarin
- License: gpl-3.0
- Created: 2022-11-04T18:17:34.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-12-25T10:33:50.000Z (28 days ago)
- Last Synced: 2025-01-09T14:21:59.737Z (13 days ago)
- Topics: android, clash, magisk-module, shell-scripts, sing-box, v2ray, xray
- Language: Shell
- Homepage:
- Size: 17.3 MB
- Stars: 1,398
- Watchers: 7
- Forks: 137
- Open Issues: 61
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Box for Root
[](docs/index_id.md) [](docs/index_en.md) [](docs/index_cn.md)
BOX
Transparent Proxy for Android (Root)
## Introduction
`Box for Root` (BFR) is a [Magisk](https://github.com/topjohnwu/Magisk), [KernelSU](https://github.com/tiann/KernelSU), [APatch](https://github.com/bmax121/APatch), module that provides a suite of proxy tools, including `clash`, `sing-box`, `v2ray`, `hysteria` and `xray`. It allows you to configure a transparent proxy on Android devices with root access.
## Features
- Support for multiple proxy tools: `clash`, `sing-box`, `v2ray`, `hysteria`, and `xray`.
- Transparent proxy for Android with root access.
- Seamless integration with Magisk, KernelSU, and APatch.
- Manage proxy services with ease.
## Apk Manager
You can use the **BFR Manager** app (optional) to manage Box for Root on your device.
[Download BFR Manager](https://github.com/taamarin/box.manager)
> **Note**: If you receive continuous notifications, open Magisk Manager, navigate to SuperUser, search for `BoxForRoot`, and disable logs and notifications.
## Module Directory
The core files of the module are stored in the following directories:
- `MODDIR=/data/adb/box`
- `MODLOG=/data/adb/box/run`
- `SETTINGS=/data/adb/box/settings.ini`
> **Note**: Before editing the `settings.ini` file located at `/data/adb/box/settings.ini`, ensure that BFR is turned off to avoid configuration issues.
## Manage Service Start/Stop
The following core services are collectively referred to as **BFR**. By default, the BFR service auto-starts after a system boot. You can manage the service through Magisk/KernelSU Manager App, with the service start taking a few seconds, and stopping it taking effect immediately.
### To start the service:
```bash
su -c /data/adb/box/scripts/box.service start && su -c /data/adb/box/scripts/box.iptables enable
```
### To stop the service:
```bash
su -c /data/adb/box/scripts/box.iptables disable && su -c /data/adb/box/scripts/box.service stop
```
## Here are some additional instructions:
- When modifying any of the core configuration files, ensure that the tproxy-related configurations match the definitions in the **/data/adb/box/settings.ini** file.
- If your device has a public IP address, you can add that IP address to the internal network in the **/data/adb/box/scripts/box.iptables** file to prevent loopback traffic.
- The logs for the BFM service can be found in the directory **/data/adb/box/run**.
- Please note that modifying these files requires appropriate permissions. Make sure to carefully follow the instructions and validate any changes made to the configuration files.
You can run the following command to get other related operating instructions:
```bash
su -c /data/adb/box/scripts/box.tool
# usage: {check|geosub|geox|subs|upkernel|upxui|upyq|upcurl|reload|all}
su -c /data/adb/box/scripts/box.service
# usage: $0 {start|stop|restart|status|cron|kcron}
su -c /data/adb/box/scripts/box.iptables
# usage: $0 {enable|disable|renew}
```
## Uninstall
Remove the module from `Magisk/KernelSU/APatch Manager` and run the following command to wipe the data:
```bash
su -c rm -rf /data/adb/box
su -c rm -rf /data/adb/service.d/box_service.sh
su -c rm -rf /data/adb/modules/box_for_root
```
## Credits
- [CHIZI-0618/box4magisk](https://github.com/CHIZI-0618/box4magisk) for the original Box for Magisk module.
## License
This project is licensed under the GPL-3.0 license - see the [LICENSE](https://github.com/taamarin/box_for_magisk/blob/master/LICENSE) file for details.