Skip to main content

A fast tunnel proxy that help you get through firewalls

Project description

PyPI version Build Status

A fast tunnel proxy that help you get through firewalls.



You’ll have a client on your local machine, and install a server on a remote server.


Debian / Ubuntu:

apt-get install python-pip python-m2crypto
pip install shadowsocks


yum install m2crypto python-setuptools
easy_install pip
pip install shadowsocks


On your server create a config file /etc/shadowsocks.json. Example:

    "local_address": "",
    "fast_open": false,
    "workers": 1

Explanation of the fields:

Name Explanation
server the address your server listens
server_port server port
local_address the address your local listens
local_port local port
password password used for encryption
timeout in seconds
method encryption method, “aes-256-cfb” is recommended
fast_open use TCP_FASTOPEN, true / false
workers number of workers, available on Unix/Linux

Run ssserver -c /etc/shadowsocks.json on your server. To run it in the background, use Supervisor.

On your client machine, use the same configuration as your server, and start your client.

If you use Chrome, it’s recommended to use SwitchySharp. Change the proxy settings to

protocol: socks5
port:     your local_port

If you can’t install SwitchySharp, you can launch Chrome with the following arguments to force Chrome to use the proxy:

Chrome.exe --proxy-server="socks5://" --host-resolver-rules="MAP * , EXCLUDE localhost"

If you can’t even download Chrome, find a friend to download a Chrome Standalone installer for you.

Command line args

You can use args to override settings from config.json.

sslocal -s server_name -p server_port -l local_port -k password -m bf-cfb
ssserver -p server_port -k password -m bf-cfb --workers 2
ssserver -c /etc/shadowsocks/config.json

List all available args with -h.



Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

shadowsocks-2.4.1.tar.gz (26.3 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page