Scroll to navigation

SS-LOCAL(1) Shadowsocks-libev Manual SS-LOCAL(1)

NAME

ss-local - shadowsocks client as socks5 proxy, libev port

SYNOPSIS

ss-local [-Auv6] [-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] [--acl <acl_config>] [--mtu <MTU>] [--plugin <plugin_name>] [--plugin_opts <plugin_options>]

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>
Set the server’s hostname or IP.
-p <server_port>
Set the server’s port number.
-l <local_port>
Set the local port number.
-k <password>
Set the password. The server and the client should use the same password.
-m <encrypt_method>
Set the cipher.
Shadowsocks-libev accepts 21 different ciphers:
table, rc4, 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, cast5-cfb, des-cfb, idea-cfb, rc2-cfb, seed-cfb, salsa20, chacha20 and chacha20-ietf.
The default cipher is rc4-md5.
If built with PolarSSL or custom OpenSSL libraries, some of these ciphers may not work.
-a <user_name>
Run as a specific user.
-f <pid_file>
Start shadowsocks as a daemon with specific pid file.
-t <timeout>
Set the socket timeout in seconds. The default value is 60.
-c <config_file>
Use a configuration file.
Refer to shadowsocks-libev(8) CONFIG FILE section for more details.
-n <number>
Specify max number of open files.
Only available on Linux.
-i <interface>
Send traffic through specific network 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>
Specify local address to bind.
-u
Enable UDP relay.
-U
Enable UDP relay and disable TCP relay.
-A
Enable onetime authentication.
-6
Resovle hostname to IPv6 address first.
--fast-open
Enable TCP fast open.
Only available with Linux kernel > 3.7.0.
--acl <acl_config>
Enable ACL (Access Control List) and specify config file.
--mtu <MTU>
Specify the MTU of your network interface.
--mptcp
Enable Multipath TCP.
Only available with MPTCP enabled Linux kernel.
--plugin <plugin_name>
Enable SIP003 plugin. (Experimental)
--plugin_opts <plugin_options>
Set SIP003 plugin options. (Experimental)
-v
Enable verbose mode.
-h|--help
Print help message.

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/04/2017 Shadowsocks-libev 2.6.3