Python port of ShadowsocksR
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
clowwindy e0189ab1de update readme 10 years ago
debian * still package issue 10 years ago
shadowsocks 2015 10 years ago
tests support color 10 years ago
utils update readme 10 years ago
.gitignore add jenkins 10 years ago
.jenkins.sh fix fastopen and add a new test 10 years ago
.travis.yml fix travis 10 years ago
CHANGES bump 10 years ago
CONTRIBUTING.md Update CONTRIBUTING.md 10 years ago
LICENSE 2015 10 years ago
MANIFEST.in include LICENSE in package tar 11 years ago
README.md update url in readme 10 years ago
README.rst update url 10 years ago
setup.py update project url 10 years ago

README.md

shadowsocks

PyPI version Build Status Coverage Status

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

Bugs and Issues