Browse Source

docs: update README.md

master
dnomd343 2 years ago
parent
commit
d63374b2ca
  1. 15
      README.md

15
README.md

@ -25,6 +25,7 @@ A simple program to make the original shadowsocks support SIP003 plugins.
--plugin <name> Enable SIP003 plugin. --plugin <name> Enable SIP003 plugin.
--plugin-opts <options> Set SIP003 plugin options. --plugin-opts <options> Set SIP003 plugin options.
--shadowsocks <shadowsocks> Set shadowsocks local or server program. --shadowsocks <shadowsocks> Set shadowsocks local or server program.
--no-udp Do not use UDP proxy.
-h, --help Print this message. -h, --help Print this message.
``` ```
@ -40,6 +41,7 @@ You can also run via a JSON config file:
"timeout": 300, "timeout": 300,
"method": "aes-256-cfb", "method": "aes-256-cfb",
"fast_open": false, "fast_open": false,
"no_udp": false,
"plugin": "...", "plugin": "...",
"plugin_opts": "...", "plugin_opts": "...",
"shadowsocks": "...", "shadowsocks": "...",
@ -58,9 +60,12 @@ shell> ss-bootstrap-local -s 127.0.0.1 -p 12345 -b 0.0.0.0 -l 1080 -k dnomd343 -
You need to install `gcc` , `make` and `cmake` at first, and also need the `glib2.0` development environment. You need to install `gcc` , `make` and `cmake` at first, and also need the `glib2.0` development environment.
Example on `Alpine`: <details>
<summary>Examples</summary>
```bash ```bash
# Alpine
apk add build-base make cmake git glib-dev apk add build-base make cmake git glib-dev
git clone https://github.com/dnomd343/shadowsocks-bootstrap.git git clone https://github.com/dnomd343/shadowsocks-bootstrap.git
cd shadowsocks-bootstrap/ cd shadowsocks-bootstrap/
@ -69,9 +74,8 @@ cmake .. && make
mv ../bin/* /usr/bin/ mv ../bin/* /usr/bin/
``` ```
Example on `Ubuntu`:
```bash ```bash
# Ubuntu
sudo apt update sudo apt update
sudo apt install build-essential cmake git libglib2.0-dev sudo apt install build-essential cmake git libglib2.0-dev
git clone https://github.com/dnomd343/shadowsocks-bootstrap.git git clone https://github.com/dnomd343/shadowsocks-bootstrap.git
@ -81,9 +85,8 @@ cmake .. && make
sudo mv ../bin/* /usr/local/bin/ sudo mv ../bin/* /usr/local/bin/
``` ```
Example on `CentOS`:
```bash ```bash
# CentOS
sudo yum update sudo yum update
sudo yum groupinstall "Development Tools" sudo yum groupinstall "Development Tools"
sudo yum install cmake libgnomeui-devel sudo yum install cmake libgnomeui-devel
@ -94,6 +97,8 @@ cmake .. && make
sudo mv ../bin/* /usr/local/bin/ sudo mv ../bin/* /usr/local/bin/
``` ```
</details>
### License ### License
MIT ©2022 [@dnomd343](https://github.com/dnomd343) MIT ©2022 [@dnomd343](https://github.com/dnomd343)

Loading…
Cancel
Save