update readme

2024-05-19 01:33:05 +08:00
parent b7cbef91c5
commit 53e2fca297
8 changed files with 120 additions and 55 deletions
@@ -10,7 +10,9 @@
  
 **Run zerotier in the background after booting!**

-**No conflicts with other android VPN service!**
+**No conflicts with other Android VPN service!**
+
+**Use Android App to control ZeroTier**

 ## Requirements

@@ -24,39 +26,68 @@ AArch64 suppots ARMv8-A and above; Arm version supports ARMv7-A (compiling with

 ## Installation

-1. download release from github.
-2. install with magisk.
-3. modify the config file at `/sdcard/Android/zerotier/network_id.txt` and put your 16-character network id in it.
-4. restart and enjoy.
+1. Download magisk module zip file from github release; install.
+2. Download controller app apk file from github release; install.
+3. Reboot your phone.
+4. Open controller app; enter your 16-character network id; join.
+5. Enjoy 😋

-To restart, execute (in root) `sh /data/adb/zerotier/zerotier.sh restart`; An android application to control zerotier (networkid, restart, ...) has been added to the todo list.
+## Usage

-### Files
+### Controller App
+
+Needs root privilege
+
+| Feature            | Supported? |
+| :----------------- | :--------- |
+| status             | ✅         |
+| start/stop         | ✅         |
+| join/leave network | ✅         |
+| join/leave planet  | ❎         |
+
+<div>
+<img alt="ZeroTier for Magisk Icon" src="https://github.com/eventlOwOp/zerotier-magisk/blob/master/images/app_home.jpg" width="192" />
+<img alt="ZeroTier for Magisk Icon" src="https://github.com/eventlOwOp/zerotier-magisk/blob/master/images/app_network.jpg" width="192" />
+</div>
+
+### Command line tools
+
+Use `zerotier.sh` to start/stop or inspect status.
+
+`Usage: zerotier.sh {start|stop|restart|status}`
+
+Use `zerotier-cli / zerotier-idtool` for ZeroTierOne command line operations.
+
+(`zerotier-one` not copied to `/system/bin`)
+
+## Files

 ```
-/data/adb/zerotier/
- | - run/
- |   | - pipe                   # pipe to service.sh
- |   | - daemon.log             # service.sh log
- |   ` - zerotier.log           # zerotier-one log
- | - home/                      # zerotier-one home directory
- |   ` - ...
- | - lib/
- |   ` - libc++_shared.so       # NDK dynamic library
- | - zerotier.sh                # tool to communicate with service.sh
- | - zerotier-one               # zerotier-one executable
- | - zerotier-cli -> zerotier-one
- ` - zerotier-idtool -> zerotier-one
+/data/adb/zerotier
+├── home                                    # zerotier-one home directory
+│   ├── authtoken.secret                    # zerotier-one http interface authtoken
+│   ├── zerotier-one.pid                    # zerotier-one pid
+│   ├── zerotier-one.port                   # zerotier-one port
+│   └── ...
+├── lib                                     # only in NDK compiled module
+│   └── libc++_shared.so                    # NDK dynamic library
+├── run
+│   ├── daemon.log                          # service.sh log
+│   ├── pipe                                # named pipe to interact with service.sh
+│   ├── zerotier.log                        # zerotier-one log
+│   └── ...
+├── zerotier-cli -> zerotier-one            # zerotier-one command line interface
+├── zerotier-idtool -> zerotier-one         # zerotier-one id tool
+├── zerotier-one                            # zerotier-one executable
+└── zerotier.sh
 ```

-all the scripts and binaries are placed in `/data/adb/zerotier/`.
+all the scripts and binaries are placed in `/data/adb/zerotier/`, and all copied to `/system/bin` (in PATH) to be executed directly (except `zerotier-one`)

-`zerotier.sh` writes commands to the pipe at `run/pipe` and `service.sh` read from it.
-
-`Usage: sh zerotier.sh {start|stop|restart|join|leave}`
+`zerotier.sh` uses named pipe to communicate with `service.sh`, preventing ZeroTier to start as a subprocess of Shell.

 log files are placed in `run`, `daemon.log` for `service.sh` and `zerotier.log` for ZeroTierOne.

-### Build binaries yourself
+## Build binaries yourself

-The binaries are built with Android NDK toolchains on Github Action, see `.github/workflow/build.yml` for detailed information.
+refer to `.github/workflow/build-{gcc|ndk}.yml` for detailed information.