---
name: "ss-local"
section: "1"
platform: "linux"
package: "shadowsocks-libev"
version: "3.3.5+ds-16"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/ss-local"
---

# ss-local(1)

shadowsocks client as socks5 proxy, libev port

## 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)](/ss-local/1.md) works as a standard socks5 proxy on local machines to proxy TCP traffic. For more information, check out [**shadowsocks-libev**(8)](/shadowsocks-libev/8.md).

## 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\>*, --password *\<password\>*

  Set the password. The server and the client should use the same password.

- \--key *\<key\_in\_base64\>*

  Set the key directly. The key should be encoded with URL-safe Base64.

- \-m *\<encrypt\_method\>*

  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 *\<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)](/shadowsocks-libev/8.md) *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 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.

- \--fast-open

  Enable TCP fast open.

  Only available with Linux kernel \> 3.7.0.

- \--reuse-port

  Enable port reuse.

  Only available with Linux kernel \> 3.9.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.

- \--no-delay

  Enable TCP\_NODELAY.

- \--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)](/ss-local/1.md) 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-server/1.md), [**ss-tunnel**(1)](/ss-tunnel/1.md), [**ss-redir**(1)](/ss-redir/1.md), [**ss-manager**(1)](/ss-manager/1.md), [**shadowsocks-libev**(8)](/shadowsocks-libev/8.md), [**iptables**(8)](/iptables/8.md), /etc/shadowsocks-libev/config.json