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.



Debian / Ubuntu:

apt-get install build-essential python-pip python-m2crypto python-dev
pip install shadowsocks


yum install m2crypto python-setuptools
easy_install pip
pip install shadowsocks


git clone
cd M2Crypto
pip install .
pip install shadowsocks


Choose a GUI client


Create a config file /etc/shadowsocks.json (or put it in other path). 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, run sslocal -c /etc/shadowsocks.json.

Change the proxy settings in your browser to

protocol: socks5
port:     your local_port

It’s recommended to use shadowsocks with AutoProxy or Proxy SwitchySharp.

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



Bugs and Issues

Please visit Issue Tracker

Mailing list:

Also see Troubleshooting

Project details

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.0.tar.gz (18.1 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