2012-04-20 06:10:49 -07:00
|
|
|
shadowsocks
|
2012-04-20 22:26:00 +08:00
|
|
|
===========
|
|
|
|
|
|
2014-06-02 17:17:36 +08:00
|
|
|
Current version: 2.0-pre [![Build Status]][Travis CI]
|
2012-12-30 12:28:23 +08:00
|
|
|
|
2014-06-01 11:22:57 +08:00
|
|
|
shadowsocks is a lightweight tunnel proxy that help you get through firewalls.
|
|
|
|
|
|
2014-06-02 18:18:57 +08:00
|
|
|
2.0-pre is currently experimental. Please use [1.4.x].
|
2012-04-20 22:26:00 +08:00
|
|
|
|
2014-06-01 11:22:57 +08:00
|
|
|
[中文说明]
|
2013-06-27 02:58:51 +08:00
|
|
|
|
2014-05-03 08:19:05 +08:00
|
|
|
Install
|
|
|
|
|
-------
|
2012-04-20 22:26:00 +08:00
|
|
|
|
2014-05-03 08:19:05 +08:00
|
|
|
#### Debian / Ubuntu:
|
|
|
|
|
|
2014-05-30 13:10:37 +08:00
|
|
|
apt-get install build-essential python-pip python-m2crypto python-dev
|
2014-06-01 11:22:57 +08:00
|
|
|
pip install shadowsocks
|
2014-05-03 08:19:05 +08:00
|
|
|
|
|
|
|
|
#### CentOS:
|
|
|
|
|
|
|
|
|
|
yum install m2crypto python-setuptools
|
|
|
|
|
easy_install pip
|
2013-06-22 17:30:31 +08:00
|
|
|
pip install shadowsocks
|
2014-05-03 08:19:05 +08:00
|
|
|
|
2014-05-03 11:37:45 +08:00
|
|
|
#### OS X:
|
|
|
|
|
|
|
|
|
|
git clone https://github.com/clowwindy/M2Crypto.git
|
|
|
|
|
cd M2Crypto
|
|
|
|
|
pip install .
|
|
|
|
|
pip install shadowsocks
|
|
|
|
|
|
|
|
|
|
#### Windows:
|
2014-05-03 08:19:05 +08:00
|
|
|
|
2014-06-01 11:22:57 +08:00
|
|
|
Choose a [GUI client]
|
2014-05-03 08:19:05 +08:00
|
|
|
|
|
|
|
|
Usage
|
|
|
|
|
-----
|
|
|
|
|
|
|
|
|
|
Create a config file `/etc/shadowsocks.json` (or put it in other path).
|
|
|
|
|
Example:
|
2012-12-30 13:28:51 +08:00
|
|
|
|
2013-06-22 17:30:31 +08:00
|
|
|
{
|
|
|
|
|
"server":"my_server_ip",
|
|
|
|
|
"server_port":8388,
|
2014-05-03 08:19:05 +08:00
|
|
|
"local_address": "127.0.0.1",
|
2013-06-22 17:30:31 +08:00
|
|
|
"local_port":1080,
|
2014-05-03 08:19:05 +08:00
|
|
|
"password":"mypassword",
|
|
|
|
|
"timeout":300,
|
|
|
|
|
"method":"aes-256-cfb",
|
2014-05-17 13:54:28 +08:00
|
|
|
"fast_open": false,
|
|
|
|
|
"workers": 1
|
2013-06-22 17:30:31 +08:00
|
|
|
}
|
2012-04-20 22:26:00 +08:00
|
|
|
|
2013-09-15 23:20:30 -06:00
|
|
|
Explanation of the fields:
|
2013-06-22 17:30:31 +08:00
|
|
|
|
2014-05-03 08:23:47 +08:00
|
|
|
| Name | Explanation |
|
|
|
|
|
| ------------- | ----------------------------------------------- |
|
|
|
|
|
| server | the address your server listens |
|
|
|
|
|
| server_port | server port |
|
|
|
|
|
| local_address | the address your local listens |
|
|
|
|
|
| local_port | local port |
|
|
|
|
|
| password | password used for encryption |
|
|
|
|
|
| timeout | in seconds |
|
|
|
|
|
| method | encryption method, "aes-256-cfb" is recommended |
|
2014-06-01 11:22:57 +08:00
|
|
|
| fast_open | use [TCP_FASTOPEN], true / false |
|
2014-05-17 13:54:28 +08:00
|
|
|
| workers | number of workers, available on Unix/Linux |
|
2013-05-22 14:14:37 +08:00
|
|
|
|
2014-06-01 11:22:57 +08:00
|
|
|
Run `ssserver -c /etc/shadowsocks.json` on your server. To run it in the
|
|
|
|
|
background, use [Supervisor].
|
2013-05-22 14:14:37 +08:00
|
|
|
|
2014-05-03 08:19:05 +08:00
|
|
|
On your client machine, run `sslocal -c /etc/shadowsocks.json`.
|
2012-04-20 22:26:00 +08:00
|
|
|
|
2013-09-15 23:20:30 -06:00
|
|
|
Change the proxy settings in your browser to
|
2012-04-20 22:26:00 +08:00
|
|
|
|
2013-05-21 16:52:22 +08:00
|
|
|
protocol: socks5
|
|
|
|
|
hostname: 127.0.0.1
|
|
|
|
|
port: your local_port
|
2012-12-12 15:19:51 +08:00
|
|
|
|
2013-06-27 02:58:51 +08:00
|
|
|
It's recommended to use shadowsocks with AutoProxy or Proxy SwitchySharp.
|
|
|
|
|
|
2013-06-22 17:30:31 +08: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
|
2014-05-17 13:54:28 +08:00
|
|
|
ssserver -p server_port -k password -m bf-cfb --workers 2
|
2013-06-22 17:30:31 +08:00
|
|
|
ssserver -c /etc/shadowsocks/config.json
|
|
|
|
|
|
2014-05-03 08:19:05 +08:00
|
|
|
Wiki
|
|
|
|
|
----
|
2012-12-30 14:01:41 +08:00
|
|
|
|
2014-05-03 08:19:05 +08:00
|
|
|
https://github.com/clowwindy/shadowsocks/wiki
|
2012-12-30 14:01:41 +08:00
|
|
|
|
2013-06-18 18:52:01 +09:00
|
|
|
License
|
|
|
|
|
-------
|
|
|
|
|
MIT
|
|
|
|
|
|
|
|
|
|
Bugs and Issues
|
|
|
|
|
----------------
|
2014-06-01 11:22:57 +08:00
|
|
|
Please visit [Issue Tracker]
|
2013-06-23 01:32:24 +08:00
|
|
|
|
|
|
|
|
Mailing list: http://groups.google.com/group/shadowsocks
|
2013-06-24 02:38:08 +08:00
|
|
|
|
2014-06-01 11:22:57 +08:00
|
|
|
Also see [Troubleshooting]
|
|
|
|
|
|
|
|
|
|
|
2014-06-02 18:18:57 +08:00
|
|
|
[1.4.x]: https://github.com/clowwindy/shadowsocks/tree/1.4
|
2014-06-02 18:40:03 +08:00
|
|
|
[Build Status]: https://travis-ci.org/clowwindy/shadowsocks.png?branch=master
|
2014-06-01 11:26:19 +08:00
|
|
|
[Travis CI]: https://travis-ci.org/clowwindy/shadowsocks
|
2014-06-01 11:22:57 +08:00
|
|
|
[TCP_FASTOPEN]: https://github.com/clowwindy/shadowsocks/wiki/TCP-Fast-Open
|
|
|
|
|
[Issue Tracker]: https://github.com/clowwindy/shadowsocks/issues?state=open
|
|
|
|
|
[GUI client]: https://github.com/clowwindy/shadowsocks/wiki/Ports-and-Clients
|
|
|
|
|
[Supervisor]: https://github.com/clowwindy/shadowsocks/wiki/Configure-Shadowsocks-with-Supervisor
|
|
|
|
|
[Troubleshooting]: https://github.com/clowwindy/shadowsocks/wiki/Troubleshooting
|
|
|
|
|
[中文说明]: https://github.com/clowwindy/shadowsocks/wiki/Shadowsocks-%E4%BD%BF%E7%94%A8%E8%AF%B4%E6%98%8E
|
