[![PyPI version]][PyPI]

[![Build Status]][Travis CI]

[![Coverage Status]][Coverage]

[中文说明]

A fast tunnel proxy that helps you [bypass firewalls].

Client

* [Windows] / [OS X]

* [Android] / [iOS]

* [OpenWRT]

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

for more information.

Copyright 2015 clowwindy

Licensed under the Apache License, Version 2.0 (the "License"); you may

not use this file except in compliance with the License. You may obtain

a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software

distributed under the License is distributed on an "AS IS" BASIS, WITHOUT

WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the

License for the specific language governing permissions and limitations

under the License.

Bugs and Issues

* [Troubleshooting]

* [Issue Tracker]

* [Mailing list]

[Android]: https://github.com/shadowsocks/shadowsocks-android

[Build Status]: https://img.shields.io/travis/shadowsocks/shadowsocks/master.svg?style=flat

[bypass firewalls]: https://github.com/shadowsocks/shadowsocks/wiki/Objective

[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/PYENV/py34/label/linux/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-csharp

[中文说明]: https://github.com/shadowsocks/shadowsocks/wiki/Shadowsocks-%E4%BD%BF%E7%94%A8%E8%AF%B4%E6%98%8E