Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
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_
	   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 18	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, 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) 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) 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

Shadowsocks-libev 3.3.2		  08/10/2020			   SS-LOCAL(1)

NAME | SYNOPSIS | DESCRIPTION | OPTIONS | EXAMPLE | SEE ALSO

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=ss-local&sektion=1&manpath=FreeBSD+12.2-RELEASE+and+Ports>

home | help