2012-04-20 13:10:49 +00:00
|
|
|
shadowsocks
|
2012-04-20 14:26:00 +00:00
|
|
|
===========
|
|
|
|
|
|
2014-05-02 06:22:37 +00:00
|
|
|
Current version: 1.4.0 [![Build Status][1]][0]
|
2012-12-30 04:28:23 +00:00
|
|
|
|
2013-09-16 05:20:30 +00:00
|
|
|
shadowsocks is a lightweight tunnel proxy which can help you get through firewalls.
|
2012-04-20 14:26:00 +00:00
|
|
|
|
2014-05-02 06:06:13 +00:00
|
|
|
Both TCP CONNECT and UDP ASSOCIATE are implemented.
|
2013-01-04 10:13:33 +00:00
|
|
|
|
2014-05-02 06:22:37 +00:00
|
|
|
[中文说明][3]
|
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
|
|
|
|
2012-12-10 06:39:22 +00:00
|
|
|
First, make sure you have Python 2.6 or 2.7.
|
|
|
|
|
|
|
|
|
|
$ python --version
|
|
|
|
|
Python 2.6.8
|
2013-06-22 09:30:31 +00:00
|
|
|
|
|
|
|
|
Install Shadowsocks.
|
2012-12-10 06:39:22 +00:00
|
|
|
|
2014-05-03 00:19:05 +00:00
|
|
|
#### Debian / Ubuntu:
|
|
|
|
|
|
|
|
|
|
apt-get install python-gevent python-m2crypto
|
|
|
|
|
pip install shadowsocks
|
|
|
|
|
|
|
|
|
|
#### CentOS:
|
|
|
|
|
|
|
|
|
|
yum install m2crypto python-setuptools
|
|
|
|
|
easy_install pip
|
2013-06-22 09:30:31 +00:00
|
|
|
pip install shadowsocks
|
2014-05-03 00:19:05 +00:00
|
|
|
|
|
|
|
|
#### Windows / OS X:
|
|
|
|
|
|
|
|
|
|
Choose a [GUI client][7]
|
|
|
|
|
|
|
|
|
|
Usage
|
|
|
|
|
-----
|
|
|
|
|
|
|
|
|
|
Create a config file `/etc/shadowsocks.json` (or put it in other path).
|
|
|
|
|
Example:
|
2012-12-30 05:28:51 +00:00
|
|
|
|
2013-06-22 09:30:31 +00:00
|
|
|
{
|
|
|
|
|
"server":"my_server_ip",
|
|
|
|
|
"server_port":8388,
|
2014-05-03 00:19:05 +00:00
|
|
|
"local_address": "127.0.0.1",
|
2013-06-22 09:30:31 +00:00
|
|
|
"local_port":1080,
|
2014-05-03 00:19:05 +00:00
|
|
|
"password":"mypassword",
|
|
|
|
|
"timeout":300,
|
|
|
|
|
"method":"aes-256-cfb",
|
|
|
|
|
"fast_open": false
|
2013-06-22 09:30:31 +00:00
|
|
|
}
|
2012-04-20 14:26:00 +00:00
|
|
|
|
2013-09-16 05:20:30 +00:00
|
|
|
Explanation of the fields:
|
2013-06-22 09:30:31 +00:00
|
|
|
|
2014-05-02 06:22:37 +00:00
|
|
|
| Name | Explanation |
|
|
|
|
|
| ----------- | ----------------------------------------------- |
|
|
|
|
|
| server | the your server listens |
|
|
|
|
|
| server_port | server port |
|
|
|
|
|
| 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][2], true / false |
|
2013-05-22 06:14:37 +00:00
|
|
|
|
2014-05-03 00:19:05 +00:00
|
|
|
Run `ssserver -c /etc/shadowsocks.json` on your server. To run it in the background, [use supervisor][8].
|
2013-05-22 06:14:37 +00:00
|
|
|
|
2014-05-03 00:19:05 +00:00
|
|
|
On your client machine, run `sslocal -c /etc/shadowsocks.json`.
|
2012-04-20 14:26:00 +00:00
|
|
|
|
2013-09-16 05:20:30 +00:00
|
|
|
Change the proxy settings in your browser to
|
2012-04-20 14:26:00 +00:00
|
|
|
|
2013-05-21 08:52:22 +00:00
|
|
|
protocol: socks5
|
|
|
|
|
hostname: 127.0.0.1
|
|
|
|
|
port: your local_port
|
2012-12-12 07:19:51 +00:00
|
|
|
|
2013-09-16 05:20:30 +00:00
|
|
|
**Notice: If you want to use encryption methods other than "table", please install M2Crypto (See Encryption Section).**
|
2013-07-03 14:56:21 +00:00
|
|
|
|
2013-06-26 18:58:51 +00:00
|
|
|
It's recommended to use shadowsocks with AutoProxy or Proxy SwitchySharp.
|
|
|
|
|
|
2013-06-22 09:30:31 +00:00
|
|
|
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
|
|
|
|
|
ssserver -c /etc/shadowsocks/config.json
|
|
|
|
|
|
2014-05-03 00:19:05 +00:00
|
|
|
Wiki
|
|
|
|
|
----
|
2012-12-30 06:01:41 +00:00
|
|
|
|
2014-05-03 00:19:05 +00:00
|
|
|
https://github.com/clowwindy/shadowsocks/wiki
|
2012-12-30 06:01:41 +00:00
|
|
|
|
2013-06-18 09:52:01 +00:00
|
|
|
License
|
|
|
|
|
-------
|
|
|
|
|
MIT
|
|
|
|
|
|
|
|
|
|
Bugs and Issues
|
|
|
|
|
----------------
|
2014-05-02 06:22:37 +00:00
|
|
|
Please visit [issue tracker][5]
|
2013-06-22 17:32:24 +00:00
|
|
|
|
|
|
|
|
Mailing list: http://groups.google.com/group/shadowsocks
|
2013-06-23 18:38:08 +00:00
|
|
|
|
2014-05-02 06:22:37 +00:00
|
|
|
Also see [troubleshooting][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
|
2014-05-03 00:19:05 +00:00
|
|
|
[7]: https://github.com/clowwindy/shadowsocks/wiki/Ports-and-Clients
|
|
|
|
|
[8]: https://github.com/clowwindy/shadowsocks/wiki/Configure-Shadowsocks-with-Supervisor
|
