Add documentation for simple linux installation

This commit is contained in:
世界 2022-08-03 22:23:40 +08:00
parent 03890151d7
commit 5f566b140f
No known key found for this signature in database
GPG key ID: CD109927C34A63C4
3 changed files with 40 additions and 0 deletions

View file

@ -2,6 +2,7 @@
Configuration examples for sing-box.
* [Linux Server Install](./linux-server-install)
* [Shadowsocks Server](./ss-server)
* [Shadowsocks Client](./ss-client)
* [Shadowsocks Tun](./ss-tun)

View file

@ -0,0 +1,38 @@
# Requirements
* Linux & Systemd
* Git
* Go 1.18.5+
* C compiler environment
#### Install
```shell
git clone https://github.com/SagerNet/sing-box
cd sing-box
./release/local/install.sh
```
Edit configuration file in `/usr/local/etc/sing-box/config.json`
```shell
./release/local/enable.sh
```
#### Update
```shell
./release/local/update.sh
```
#### Other commands
| Operation | Command |
|-----------|-----------------------------------------------|
| Start | `sudo systemctl start sing-box` |
| Stop | `sudo systemctl stop sing-box` |
| Kill | `sudo systemctl kill sing-box` |
| Restart | `sudo systemctl restart sing-box` |
| Logs | `sudo journalctl -u sing-box --output cat -e` |
| New Logs | `sudo journalctl -u sing-box --output cat -f` |
| Uninstall | `./release/local/uninstall.sh` |

View file

@ -71,6 +71,7 @@ nav:
- Multiplex: configuration/shared/multiplex.md
- Examples:
- examples/index.md
- Linux Server Install: examples/linux-server-install.md
- Shadowsocks Server: examples/ss-server.md
- Shadowsocks Client: examples/ss-client.md
- Shadowsocks Tun: examples/ss-tun.md