vbatts/shadowsocks

Fork 0

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.

Find a file

clowwindy 98f73e44d0 bump		2015-01-03 13:56:19 +08:00
debian	* still package issue	2014-08-25 12:30:23 +08:00
shadowsocks	2015	2015-01-03 13:24:40 +08:00
tests	support color	2014-12-28 15:24:38 +08:00
utils	update readme	2015-01-03 13:50:08 +08:00
.gitignore	add jenkins	2014-12-22 16:33:23 +08:00
.jenkins.sh	fix fastopen and add a new test	2014-12-25 16:20:15 +08:00
.travis.yml	fix travis	2014-12-24 18:23:35 +08:00
CHANGES	bump	2014-12-26 20:58:22 +08:00
CONTRIBUTING.md	Update CONTRIBUTING.md	2014-12-15 00:14:04 +08:00
LICENSE	2015	2015-01-03 13:24:40 +08:00
MANIFEST.in	include LICENSE in package tar	2014-07-12 11:11:28 +08:00
README.md	update url in readme	2014-12-27 23:29:07 +08:00
README.rst	update url	2014-12-27 23:36:09 +08:00
setup.py	bump	2015-01-03 13:56:19 +08:00

README.md

shadowsocks

A fast tunnel proxy that helps you bypass firewalls.

中文说明

Install

You'll have a client on your local side, and setup a server on a remote server.

Client

Server

Debian / Ubuntu:

apt-get install python-pip
pip install shadowsocks

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

CentOS:

yum install python-setuptools
easy_install pip
pip install shadowsocks

Windows:

Download OpenSSL for Windows and install. Then install shadowsocks via easy_install and pip as Linux. If you don't know how to use them, you can directly download the package, and use python shadowsocks/server.py instead of ssserver command below.

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
}

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

On your server:

To run in the foreground:

ssserver -c /etc/shadowsocks.json

To run in the background:

ssserver -c /etc/shadowsocks.json -d start
ssserver -c /etc/shadowsocks.json -d stop

On your client machine, use the same configuration as your server. Check the README of your client for more information.

Command Line Options

Check the options via -h.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 -d start --pid-file=/tmp/shadowsocks.pid
ssserver -c /etc/shadowsocks/config.json -d stop --pid-file=/tmp/shadowsocks.pid

Documentation

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

License

MIT