Add documentation for clash_api

This commit is contained in:
世界
2022-07-20 07:36:06 +08:00
parent 6ac1b395cf
commit 45643fbed1
6 changed files with 72 additions and 10 deletions

View File

@@ -9,9 +9,20 @@ The universal proxy platform.
sing-box requires Golang 1.18 or a higher version.
```bash
go install github.com/sagernet/sing-box/cmd/sing-box@latest
go install -v github.com/sagernet/sing-box/cmd/sing-box@latest
```
Install with options:
```bash
go install -v -tags "with_clash_api,no_gvisor" github.com/sagernet/sing-box/cmd/sing-box@latest
```
| Build Tag | Description |
|------------------|-----------------------------------------------------------------------------------------|
| `with_clash_api` | Build with clash api support, see [Experimental](./configuration/experimental). |
| `no_gvisor` | Build without gVisor, which required by the [Tun](./configuration/inbound/tun) inbound. |
The binary is built under $GOPATH/bin
```bash