2012-04-20 13:10:49 +00:00
|
|
|
shadowsocks
|
2012-04-20 14:26:00 +00:00
|
|
|
===========
|
|
|
|
|
|
2014-12-24 08:47:14 +00:00
|
|
|
[![PyPI version]][PyPI]
|
|
|
|
|
[![Build Status]][Travis CI]
|
|
|
|
|
[![Coverage Status]][Coverage]
|
2014-06-04 10:04:41 +00:00
|
|
|
|
2014-08-03 01:40:12 +00:00
|
|
|
A fast tunnel proxy that helps you bypass firewalls.
|
2012-04-20 14:26:00 +00:00
|
|
|
|
2014-06-04 10:32:58 +00:00
|
|
|
[中文说明][Chinese Readme]
|
2013-06-26 18:58:51 +00:00
|
|
|
|
2014-05-03 00:19:05 +00:00
|
|
|
Install
|
|
|
|
|
-------
|
2012-04-20 14:26:00 +00:00
|
|
|
|
2014-06-15 17:13:54 +00:00
|
|
|
### Server
|
2014-06-15 16:52:29 +00:00
|
|
|
|
2014-05-03 00:19:05 +00:00
|
|
|
#### Debian / Ubuntu:
|
|
|
|
|
|
2014-10-11 04:42:59 +00:00
|
|
|
apt-get install python-pip
|
2014-06-01 03:22:57 +00:00
|
|
|
pip install shadowsocks
|
2014-05-03 00:19:05 +00:00
|
|
|
|
2014-09-06 12:58:56 +00:00
|
|
|
Or simply `apt-get install shadowsocks` if you have [Debian sid] in your
|
|
|
|
|
source list.
|
|
|
|
|
|
2014-05-03 00:19:05 +00:00
|
|
|
#### CentOS:
|
|
|
|
|
|
2014-10-11 04:42:59 +00:00
|
|
|
yum install python-setuptools
|
2014-05-03 00:19:05 +00:00
|
|
|
easy_install pip
|
2013-06-22 09:30:31 +00:00
|
|
|
pip install shadowsocks
|
2014-05-03 00:19:05 +00:00
|
|
|
|
2014-10-08 13:07:05 +00:00
|
|
|
#### Windows:
|
|
|
|
|
|
2015-01-04 15:22:26 +00:00
|
|
|
1. Install [OpenSSL for Windows].
|
|
|
|
|
2. Download [the package].
|
|
|
|
|
3. Use `python shadowsocks/server.py` instead of `ssserver` command below.
|
2014-10-08 13:07:05 +00:00
|
|
|
|
2015-01-04 15:17:01 +00:00
|
|
|
Usage
|
|
|
|
|
-----
|
2013-05-22 06:14:37 +00:00
|
|
|
|
2015-01-04 15:22:26 +00:00
|
|
|
### Server
|
2013-05-22 06:14:37 +00:00
|
|
|
|
2015-01-04 15:17:01 +00:00
|
|
|
ssserver -p 8000 -k password -m rc4-md5
|
2012-04-20 14:26:00 +00:00
|
|
|
|
2014-12-21 06:06:28 +00:00
|
|
|
To run in the background:
|
2012-12-12 07:19:51 +00:00
|
|
|
|
2015-01-04 15:17:01 +00:00
|
|
|
ssserver -p 8000 -k password -m rc4-md5 -d start
|
|
|
|
|
ssserver -p 8000 -k password -m rc4-md5 -d stop
|
2014-06-15 18:14:49 +00:00
|
|
|
|
2015-01-04 15:22:26 +00:00
|
|
|
Check all the options via `-h`. You can also use a [Configuration] file
|
|
|
|
|
instead.
|
|
|
|
|
|
|
|
|
|
### Client
|
|
|
|
|
|
|
|
|
|
* [Windows] / [OS X]
|
|
|
|
|
* [Android] / [iOS]
|
|
|
|
|
* [OpenWRT]
|
2013-06-26 18:58:51 +00:00
|
|
|
|
2015-01-04 15:22:26 +00:00
|
|
|
Use GUI clients on your local PC/phones. Check the README of your client
|
|
|
|
|
for more information.
|
2013-06-22 09:30:31 +00:00
|
|
|
|
2014-12-21 06:06:28 +00:00
|
|
|
Documentation
|
|
|
|
|
-------------
|
2012-12-30 06:01:41 +00:00
|
|
|
|
2014-09-18 01:20:57 +00:00
|
|
|
You can find all the documentation in the wiki:
|
2014-12-27 15:29:07 +00:00
|
|
|
https://github.com/shadowsocks/shadowsocks/wiki
|
2012-12-30 06:01:41 +00:00
|
|
|
|
2013-06-18 09:52:01 +00:00
|
|
|
License
|
|
|
|
|
-------
|
|
|
|
|
MIT
|
|
|
|
|
|
|
|
|
|
Bugs and Issues
|
|
|
|
|
----------------
|
2013-06-22 17:32:24 +00:00
|
|
|
|
2014-06-23 09:12:16 +00:00
|
|
|
* [Troubleshooting]
|
|
|
|
|
* [Issue Tracker]
|
|
|
|
|
* [Mailing list]
|
2014-06-01 03:22:57 +00:00
|
|
|
|
|
|
|
|
|
2014-12-27 15:29:07 +00:00
|
|
|
[Android]: https://github.com/shadowsocks/shadowsocks/wiki/Ports-and-Clients#android
|
|
|
|
|
[Build Status]: https://img.shields.io/travis/shadowsocks/shadowsocks/master.svg?style=flat
|
|
|
|
|
[Chinese Readme]: https://github.com/shadowsocks/shadowsocks/wiki/Shadowsocks-%E4%BD%BF%E7%94%A8%E8%AF%B4%E6%98%8E
|
2015-01-04 15:17:01 +00:00
|
|
|
[Configuration]: https://github.com/shadowsocks/shadowsocks/wiki/Configuration-via-Config-File
|
2015-01-03 08:48:05 +00:00
|
|
|
[Coverage Status]: https://jenkins.shadowvpn.org/result/shadowsocks
|
|
|
|
|
[Coverage]: https://jenkins.shadowvpn.org/job/Shadowsocks/ws/htmlcov/index.html
|
2014-09-06 12:58:56 +00:00
|
|
|
[Debian sid]: https://packages.debian.org/unstable/python/shadowsocks
|
2014-10-11 04:42:59 +00:00
|
|
|
[the package]: https://pypi.python.org/pypi/shadowsocks
|
2014-12-27 15:29:07 +00:00
|
|
|
[Encryption]: https://github.com/shadowsocks/shadowsocks/wiki/Encryption
|
2014-07-27 16:26:30 +00:00
|
|
|
[iOS]: https://github.com/shadowsocks/shadowsocks-iOS/wiki/Help
|
2014-12-27 15:29:07 +00:00
|
|
|
[Issue Tracker]: https://github.com/shadowsocks/shadowsocks/issues?state=open
|
2015-01-04 04:46:07 +00:00
|
|
|
[Mailing list]: https://groups.google.com/group/shadowsocks
|
|
|
|
|
[OpenSSL for Windows]: https://slproweb.com/products/Win32OpenSSL.html
|
2014-12-27 15:29:07 +00:00
|
|
|
[OpenWRT]: https://github.com/shadowsocks/shadowsocks/wiki/Ports-and-Clients#openwrt
|
2014-07-27 16:26:30 +00:00
|
|
|
[OS X]: https://github.com/shadowsocks/shadowsocks-iOS/wiki/Shadowsocks-for-OSX-Help
|
2014-06-15 18:29:06 +00:00
|
|
|
[PyPI]: https://pypi.python.org/pypi/shadowsocks
|
2014-06-21 03:18:33 +00:00
|
|
|
[PyPI version]: https://img.shields.io/pypi/v/shadowsocks.svg?style=flat
|
2014-12-27 15:29:07 +00:00
|
|
|
[TCP_FASTOPEN]: https://github.com/shadowsocks/shadowsocks/wiki/TCP-Fast-Open
|
|
|
|
|
[Travis CI]: https://travis-ci.org/shadowsocks/shadowsocks
|
|
|
|
|
[Troubleshooting]: https://github.com/shadowsocks/shadowsocks/wiki/Troubleshooting
|
|
|
|
|
[Windows]: https://github.com/shadowsocks/shadowsocks/wiki/Ports-and-Clients#windows
|
