shadowsocks =========== [![PyPI version]][PyPI] [![Build Status]][Travis CI] [![Coverage Status]][Coverage] A fast tunnel proxy that helps you bypass firewalls. Server ------ ### Install Debian / Ubuntu: apt-get install python-pip pip install shadowsocks CentOS: yum install python-setuptools && easy_install pip pip install shadowsocks Windows: See [Install Server on Windows] ### Usage 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 ------ * [Windows] / [OS X] * [Android] / [iOS] * [OpenWRT] 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]. License ------- MIT Bugs and Issues ---------------- * [Troubleshooting] * [Issue Tracker] * [Mailing list] [Android]: https://github.com/shadowsocks/shadowsocks/wiki/Ports-and-Clients#android [Build Status]: https://img.shields.io/travis/shadowsocks/shadowsocks/master.svg?style=flat [Configuration]: https://github.com/shadowsocks/shadowsocks/wiki/Configuration-via-Config-File [Coverage Status]: https://jenkins.shadowvpn.org/result/shadowsocks [Coverage]: https://jenkins.shadowvpn.org/job/Shadowsocks/ws/htmlcov/index.html [Debian sid]: https://packages.debian.org/unstable/python/shadowsocks [iOS]: https://github.com/shadowsocks/shadowsocks-iOS/wiki/Help [Issue Tracker]: https://github.com/shadowsocks/shadowsocks/issues?state=open [Install Server on Windows]: https://github.com/shadowsocks/shadowsocks/wiki/Install-Shadowsocks-Server-on-Windows [Mailing list]: https://groups.google.com/group/shadowsocks [OpenWRT]: https://github.com/shadowsocks/openwrt-shadowsocks [OS X]: https://github.com/shadowsocks/shadowsocks-iOS/wiki/Shadowsocks-for-OSX-Help [PyPI]: https://pypi.python.org/pypi/shadowsocks [PyPI version]: https://img.shields.io/pypi/v/shadowsocks.svg?style=flat [Travis CI]: https://travis-ci.org/shadowsocks/shadowsocks [Troubleshooting]: https://github.com/shadowsocks/shadowsocks/wiki/Troubleshooting [Wiki]: https://github.com/shadowsocks/shadowsocks/wiki [Windows]: https://github.com/shadowsocks/shadowsocks/wiki/Ports-and-Clients#windows