ss-tunnel(1) ============ NAME ---- ss-tunnel - shadowsocks tools for local port forwarding, libev port SYNOPSIS -------- *ss-tunnel* [-uUv6] [-h|--help] [-s ] [-p ] [-l ] [-k ] [-m ] [-f ] [-t ] [-c ] [-i ] [-b ] [-a ] [-n ] [-L addr:port] [--mtu ] [--mptcp] [--reuse-port] [--no-delay] [--plugin ] [--plugin-opts ] [--key ] 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-tunnel`(1) is a tool for local port forwarding. See 'OPTIONS' section for special option needed by `ss-tunnel`(1). For more information, check out `shadowsocks-libev`(8). OPTIONS ------- -s :: Set the server's hostname or IP. -p :: Set the server's port number. -l :: Set the local port number. -k :: --password :: Set the password. The server and the client should use the same password. --key :: Set the key directly. The key should be encoded with URL-safe Base64. -m :: Set the cipher. + *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 :: Run as a specific user. -f :: Start shadowsocks as a daemon with specific pid file. -t :: Set the socket timeout in seconds. The default value is 60. -c :: Use a configuration file. + Refer to `shadowsocks-libev`(8) 'CONFIG FILE' section for more details. -n :: Specify max number of open files. + Only available on Linux. -i :: 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-tunnel` 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 :: Specify the local address to use while this client is making outbound connections to the server. -u:: Enable UDP relay. -U:: Enable UDP relay and disable TCP relay. -6:: Resovle hostname to IPv6 address first. -L :: Specify destination server address and port for local port forwarding. + Only used and available in tunnel mode. --mtu :: Specify the MTU of your network interface. --mptcp:: Enable Multipath TCP. + Only available with MPTCP enabled Linux kernel. --reuse-port:: Enable port reuse. + Only available with Linux kernel > 3.9.0. --no-delay:: Enable TCP_NODELAY. --plugin :: Enable SIP003 plugin. (Experimental) --plugin-opts :: Set SIP003 plugin options. (Experimental) -v:: Enable verbose mode. -h|--help:: Print help message. SEE ALSO -------- `ss-local`(1), `ss-server`(1), `ss-redir`(1), `ss-manager`(1), `shadowsocks-libev`(8), `iptables`(8), /etc/shadowsocks-libev/config.json