shadowsocks/README.md
2015-01-04 23:22:26 +08:00

3 KiB

shadowsocks

PyPI version Build Status Coverage Status

A fast tunnel proxy that helps you bypass firewalls.

中文说明

Install

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:

  1. Install OpenSSL for Windows.
  2. Download the package.
  3. Use python shadowsocks/server.py instead of ssserver command below.

Usage

Server

ssserver -p 8000 -k password -m rc4-md5

To run in the background:

ssserver -p 8000 -k password -m rc4-md5 -d start
ssserver -p 8000 -k password -m rc4-md5 -d stop

Check all the options via -h. You can also use a Configuration file instead.

Client

Use GUI clients on your local PC/phones. Check the README of your client for more information.

Documentation

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

License

MIT

Bugs and Issues