shadowsocks =========== Current version: 2.0 [![Build Status]][Travis CI] shadowsocks is a lightweight tunnel proxy that help you get through firewalls. 2.0 is currently under development. Please use 1.4.x. Both TCP CONNECT and UDP ASSOCIATE are implemented. [中文说明] Install ------- First, make sure you have Python 2.6 or 2.7. $ python --version Python 2.6.8 Install Shadowsocks. #### 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] [Build Status]: https://travis-ci.org/clowwindy/shadowsocks.png?branch=2.0 [Travis CI]: https://travis-ci.org/clowwindy/shadowsocks [TCP_FASTOPEN]: https://github.com/clowwindy/shadowsocks/wiki/TCP-Fast-Open [Issue Tracker]: https://github.com/clowwindy/shadowsocks/issues?state=open [GUI client]: https://github.com/clowwindy/shadowsocks/wiki/Ports-and-Clients [Supervisor]: https://github.com/clowwindy/shadowsocks/wiki/Configure-Shadowsocks-with-Supervisor [Troubleshooting]: https://github.com/clowwindy/shadowsocks/wiki/Troubleshooting [中文说明]: https://github.com/clowwindy/shadowsocks/wiki/Shadowsocks-%E4%BD%BF%E7%94%A8%E8%AF%B4%E6%98%8E