SS-LOCAL(1) | Shadowsocks-libev Manual | SS-LOCAL(1) |
NAME¶
ss-local - shadowsocks client as socks5 proxy, libev port
SYNOPSIS¶
ss-local [-uv6] [-h|--help] [-s <server_host>] [-p <server_port>] [-l <local_port>] [-k <password>] [-m <encrypt_method>] [-f <pid_file>] [-t <timeout>] [-c <config_file>] [-i <interface>] [-a <user_name>] [-b <local_address>] [-n <nofile>] [--fast-open] [--reuse-port] [--acl <acl_config>] [--mtu <MTU>] [--no-delay] [--plugin <plugin_name>] [--plugin-opts <plugin_options>] [--password <password>] [--key <key_in_base64>]
DESCRIPTION¶
Shadowsocks-libev is a lightweight and secure socks5 proxy. It is a port of the original shadowsocks created by clowwindy. Shadowsocks-libev is written in pure C and takes advantage of libev to achieve both high performance and low resource consumption.
Shadowsocks-libev consists of five components. ss-local(1) works as a standard socks5 proxy on local machines to proxy TCP traffic. For more information, check out shadowsocks-libev(8).
OPTIONS¶
-s <server_host>
-p <server_port>
-l <local_port>
-k <password>, --password <password>
--key <key_in_base64>
-m <encrypt_method>
Shadowsocks-libev accepts 19 different ciphers:
aes-128-gcm, aes-192-gcm, aes-256-gcm, rc4-md5, aes-128-cfb, aes-192-cfb, aes-256-cfb, aes-128-ctr, aes-192-ctr, aes-256-ctr, bf-cfb, camellia-128-cfb, camellia-192-cfb, camellia-256-cfb, chacha20-ietf-poly1305, xchacha20-ietf-poly1305, salsa20, chacha20 and chacha20-ietf.
The default cipher is chacha20-ietf-poly1305.
If built with PolarSSL or custom OpenSSL libraries, some of these ciphers may not work.
-a <user_name>
-f <pid_file>
-t <timeout>
-c <config_file>
Refer to shadowsocks-libev(8) CONFIG FILE section for more details.
-n <number>
Only available on Linux.
-i <interface>
For example, there are three interfaces in your device, which is lo (127.0.0.1), eth0 (192.168.0.1) and eth1 (192.168.0.2). Meanwhile, you configure ss-local to listen on 0.0.0.0:8388 and bind to eth1. That results the traffic go out through eth1, but not lo nor eth0. This option is useful to control traffic in multi-interface environment.
-b <local_address>
-u
-U
-6
--fast-open
Only available with Linux kernel > 3.7.0.
--reuse-port
Only available with Linux kernel > 3.9.0.
--acl <acl_config>
--mtu <MTU>
--mptcp
Only available with MPTCP enabled Linux kernel.
--no-delay
--plugin <plugin_name>
--plugin-opts <plugin_options>
-v
-h|--help
EXAMPLE¶
ss-local(1) can be started from command line and run in foreground. Here is an example:
# Start ss-local with given parameters ss-local -s example.com -p 12345 -l 1080 -k foobar -m aes-256-cfb
SEE ALSO¶
ss-server(1), ss-tunnel(1), ss-redir(1), ss-manager(1), shadowsocks-libev(8), iptables(8), /etc/shadowsocks-libev/config.json
12/13/2023 | Shadowsocks-libev 3.3.5 |