Archived

This project has been archived by its maintainers, and is no longer receiving any updates.

shadowsocks

A fast tunnel proxy that help you get through firewalls.

Install

Debian / Ubuntu:

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

CentOS:

yum install m2crypto python-setuptools
easy_install pip
pip install shadowsocks

OS X:

git clone https://github.com/clowwindy/M2Crypto.git
cd M2Crypto
pip install .
pip install shadowsocks

Windows:

Choose a GUI client

Usage

Create a config file /etc/shadowsocks.json (or put it in other path). Example:

{
    "server":"my_server_ip",
    "server_port":8388,
    "local_address": "127.0.0.1",
    "local_port":1080,
    "password":"mypassword",
    "timeout":300,
    "method":"aes-256-cfb",
    "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
hostname: 127.0.0.1
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

Wiki

https://github.com/clowwindy/shadowsocks/wiki

License

MIT

Bugs and Issues

Please visit Issue Tracker

Mailing list: http://groups.google.com/group/shadowsocks

Also see Troubleshooting

Metadata

Release files for shadowsocks 2.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for shadowsocks 2.0.1
File	Size	Uploaded
shadowsocks-2.0.1.tar.gz	18.2 kB	Jun 6, 2014	Details

Release files / shadowsocks-2.0.1.tar.gz

Download URL	shadowsocks-2.0.1.tar.gz
Size	18.2 kB
Tags	Source
SHA-256 checksum How to use checksums	`2df5d0273861978c749eb8b9a4b4262753dfd963777454bc431b0b8edcf33108`
BLAKE2b-256 checksum How to use checksums	`204706d4ffdd05fcdf6965b3350e47cf4c7abec6d46ac187a9956814fc2e7026`
Upload date	Jun 6, 2014
Uploaded using Trusted Publishing? What is trusted publishing?	No