vbatts/shadowsocks
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
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.
424 commits 2 branches 18 tags 2.6 MiB
Python 91.5%
Shell 8.3%
Dockerfile 0.2%
Find a file
clowwindy 0b64f7670f add help for Windows
2014-10-08 21:07:05 +08:00
debian * still package issue 2014-08-25 12:30:23 +08:00
shadowsocks does not require M2Crypto anymore 2014-10-08 21:03:01 +08:00
tests do not mix config of client and server for server-multi-passwd 2014-09-20 18:40:35 +08:00
.gitignore add nodelay 2014-05-01 11:44:36 +08:00
.travis.yml do not mix config of client and server for server-multi-passwd 2014-09-20 18:40:35 +08:00
CHANGES update changes 2014-09-23 13:52:52 +08:00
CONTRIBUTING.md Update CONTRIBUTING.md 2014-07-03 23:59:33 +03:00
LICENSE bump year 2014-07-12 21:53:51 +08:00
MANIFEST.in include LICENSE in package tar 2014-07-12 11:11:28 +08:00
README.md add help for Windows 2014-10-08 21:07:05 +08:00
README.rst bump 2014-07-06 18:44:33 +03:00
setup.py does not require M2Crypto anymore 2014-10-08 21:03:01 +08:00

README.md

shadowsocks

PyPI version Build Status

A fast tunnel proxy that helps you bypass firewalls.

中文说明

Install

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

Client

Server

Debian / Ubuntu:

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

Or simply apt-get install shadowsocks if you have Debian sid in your source list.

CentOS:

yum install m2crypto python-setuptools
easy_install pip
pip install shadowsocks

Windows:

Download OpenSSL for Windows and install. Then

pip install shadowsocks

Configuration

On your server create a config file /etc/shadowsocks.json. 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 default: "aes-256-cfb", see Encryption
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
hostname: 127.0.0.1
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://127.0.0.1:1080" --host-resolver-rules="MAP * 0.0.0.0 , 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.

Wiki

You can find all the documentation in the wiki: https://github.com/clowwindy/shadowsocks/wiki

License

MIT

Bugs and Issues