A fast tunnel proxy that helps you bypass firewalls. regulation cause this repo to get truncated, but there is still some history there. And tags.

Go to file

clowwindy 5d022e2828 fix None		2014-06-02 18:11:38 +08:00
packaging/py2exe	add bind address	2013-06-14 12:22:24 +08:00
shadowsocks	fix None	2014-06-02 18:11:38 +08:00
tests	rename tests	2014-06-01 19:12:15 +08:00
.gitignore	add nodelay	2014-05-01 11:44:36 +08:00
.travis.yml	rename tests	2014-06-01 19:12:15 +08:00
CHANGES	update log	2014-06-02 18:08:22 +08:00
LICENSE	move to pypi	2013-06-22 17:30:31 +08:00
README.md	update readme	2014-06-02 17:17:36 +08:00
README.rst	update readme python version now checked by utils	2014-06-01 19:13:55 +08:00
config.json	add test	2014-05-03 23:04:49 +08:00
setup.py	more work	2014-06-01 11:22:57 +08:00
test.py	add salsa20 test	2014-06-01 17:35:32 +08:00
test_latency.py	add latency test	2014-05-02 10:27:57 +08:00

README.md

shadowsocks

Current version: 2.0-pre

shadowsocks is a lightweight tunnel proxy that help you get through firewalls.

2.0 is currently experimental. Please use 1.4.x.

中文说明

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