From 1fc226594df52e3a6546a61f4d95ec9deffb887d Mon Sep 17 00:00:00 2001 From: zonyitoo Date: Fri, 21 May 2021 10:14:57 +0800 Subject: [PATCH] update README client command line options, fixes #532 --- README.md | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index c69d358b..a7d2930c 100644 --- a/README.md +++ b/README.md @@ -201,7 +201,7 @@ sslocal -b "127.0.0.1:1080" --server-url "ss://YWVzLTI1Ni1nY206cGFzc3dvcmQ@127.0 ```bash # Read local client configuration from file -sslocal -c /path/to/shadowsocks.json --protocol http +sslocal -b "127.0.0.1:3128" --protocol http -s "[::1]:8388" -m "aes-256-gcm" -k "hello-kitty" ``` All parameters are the same as Socks5 client, except `--protocol http`. @@ -211,23 +211,30 @@ All parameters are the same as Socks5 client, except `--protocol http`. ```bash # Read local client configuration from file # Set 127.0.0.1:8080 as the target for forwarding to -sslocal -c /path/to/shadowsocks.json -f "127.0.0.1:8080" --protocol tunnel +sslocal --protocol tunnel -b "127.0.0.1:3128" --protocol tunnel -f "127.0.0.1:8080" -s "[::1]:8388" -m "aes-256-gcm" -k "hello-kitty" ``` +* `--protocol tunnel` enables local client Tunnel mode +* `-f "127.0.0.1:8080` sets the tunnel target address + ### Transparent Proxy Local client -**NOTE**: This is currently only supports +**NOTE**: It currently only supports * Linux (with `iptables` targets `REDIRECT` and `TPROXY`) * BSDs (with `pf`), such as OS X 10.10+, FreeBSD, ... ```bash # Read local client configuration from file -sslocal -c /path/to/shadowsocks.json --protocol redir +sslocal -b "127.0.0.1:60080" --protocol redir -s "[::1]:8388" -m "aes-256-gcm" -k "hello-kitty" --tcp-redir "redirect" --udp-redir "tproxy" ``` Redirects connections with `iptables` configurations to the port that `sslocal` is listening on. +* `--protocol redir` enables local client Redir mode +* (optional) `--tcp-redir` sets TCP mode to `REDIRECT` (Linux) +* (optional) `--udp-redir` sets UDP mode to `TPROXY` (Linux) + ### Server ```bash