vbatts/shadowsocks
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Updated Shadowsocks 使用说明 (markdown)

clowwindy 2014-06-13 20:17:18 -07:00
parent 9bb31fc58f
commit ab20959a58
1 changed files with 21 additions and 32 deletions
Download patch file Download diff file Expand all files Collapse all files

53
Shadowsocks-使用说明.md

@ -1,20 +1,13 @@
[![当前状态][1]][0]
[![PyPI 版本]][PyPI] [![构建状态]][Travis CI]
shadowsocks 是一个可穿透防火墙的轻量代理。
一个可穿透防火墙的轻量代理。
安装方法
-------
确保你装了 Python 2.6 或者 2.7。
$ python --version
Python 2.6.8
安装 Shadowsocks.
#### Debian / Ubuntu:
apt-get install build-essential python-pip python-m2crypto python-dev
apt-get install python-pip python-m2crypto
pip install gevent shadowsocks
#### CentOS:
@ -25,6 +18,7 @@ shadowsocks 是一个可穿透防火墙的轻量代理。
#### OS X:
brew install swig
git clone https://github.com/clowwindy/M2Crypto.git
cd M2Crypto
pip install .
@ -32,7 +26,7 @@ shadowsocks 是一个可穿透防火墙的轻量代理。
#### Windows:
选一个 [图形客户端][7]。
选一个 [图形客户端]。
使用方法
-------
@ -63,11 +57,11 @@ shadowsocks 是一个可穿透防火墙的轻量代理。
| password | 用于加密的密码 |
| timeout | 超时时间，单位秒 |
| method | 加密方法，推荐 "aes-256-cfb" |
| fast_open | 是否使用 [TCP_FASTOPEN][2], true / false |
| fast_open | 是否使用 [TCP_FASTOPEN], true / false |
| workers | worker 数量，Unix/Linux 可用，如果不理解含义请不要改 |
在服务器上运行 `ssserver -c /etc/shadowsocks.json`。如果要在后台运行，
[请使用 supervisor][8].
[请使用 supervisor].
在本地运行 `sslocal -c /etc/shadowsocks.json`。
@ -77,7 +71,7 @@ shadowsocks 是一个可穿透防火墙的轻量代理。
地址: 127.0.0.1
端口: 你填的 local_port
推荐配合 AutoProxy 或者 Proxy SwitchySharp 使用 Shadowsocks。
推荐配合 [SwitchySharp] 使用 Shadowsocks。
命令行参数
---------
@ -88,13 +82,6 @@ shadowsocks 是一个可穿透防火墙的轻量代理。
ssserver -p server_port -k password -m bf-cfb --workers 2
ssserver -c /etc/shadowsocks/config.json
gevent
------
如果你遇到一些奇怪的问题，如果你装的是 gevent 0.9.x, 更新到最新版，或者卸掉 gevent。
pip install gevent --upgrade
Wiki
----
@ -106,18 +93,20 @@ MIT
问题反馈
--------
请访问 [issue tracker][5]
请访问 [Issue Tracker]
邮件列表： http://groups.google.com/group/shadowsocks
[常见问题][6]
[常见问题]
[0]: https://travis-ci.org/clowwindy/shadowsocks
[1]: https://travis-ci.org/clowwindy/shadowsocks.png?branch=master
[2]: https://github.com/clowwindy/shadowsocks/wiki/TCP-Fast-Open
[3]: https://github.com/clowwindy/shadowsocks/wiki/Shadowsocks-%E4%BD%BF%E7%94%A8%E8%AF%B4%E6%98%8E
[4]: http://chandlerproject.org/Projects/MeTooCrypto
[5]: https://github.com/clowwindy/shadowsocks/issues?state=open
[6]: https://github.com/clowwindy/shadowsocks/wiki/Troubleshooting
[7]: https://github.com/clowwindy/shadowsocks/wiki/Ports-and-Clients
[8]: https://github.com/clowwindy/shadowsocks/wiki/Configure-Shadowsocks-with-Supervisor
[构建状态]: https://img.shields.io/travis/clowwindy/shadowsocks/master.svg?style=flat
[图形客户端]: https://github.com/clowwindy/shadowsocks/wiki/Ports-and-Clients
[Issue Tracker]: https://github.com/clowwindy/shadowsocks/issues?state=open
[PyPI]: https://pypi.python.org/pypi/shadowsocks
[PyPI 版本]: https://img.shields.io/pypi/v/shadowsocks.svg?style=flat
[Supervisor]: https://github.com/clowwindy/shadowsocks/wiki/Configure-Shadowsocks-with-Supervisor
[TCP_FASTOPEN]: https://github.com/clowwindy/shadowsocks/wiki/TCP-Fast-Open
[Travis CI]: https://travis-ci.org/clowwindy/shadowsocks
[常见问题]: https://github.com/clowwindy/shadowsocks/wiki/Troubleshooting
[SwitchySharp]: https://chrome.google.com/webstore/detail/proxy-switchysharp/dpplabbmogkhghncfbfdeeokoefdjegm