|
|
@ -1,13 +1,15 @@ |
|
|
shadowsocks |
|
|
shadowsocks |
|
|
=========== |
|
|
=========== |
|
|
|
|
|
|
|
|
Current version: 1.4.5 [![Build Status][1]][0] |
|
|
Current version: 2.0 [![Build Status][]][Shadowsocks] |
|
|
|
|
|
|
|
|
shadowsocks is a lightweight tunnel proxy which can help you get through firewalls. |
|
|
shadowsocks is a lightweight tunnel proxy that help you get through firewalls. |
|
|
|
|
|
|
|
|
|
|
|
2.0 is currently under development. Please use 1.4.x. |
|
|
|
|
|
|
|
|
Both TCP CONNECT and UDP ASSOCIATE are implemented. |
|
|
Both TCP CONNECT and UDP ASSOCIATE are implemented. |
|
|
|
|
|
|
|
|
[中文说明][3] |
|
|
[中文说明] |
|
|
|
|
|
|
|
|
Install |
|
|
Install |
|
|
------- |
|
|
------- |
|
|
@ -22,7 +24,7 @@ Install Shadowsocks. |
|
|
#### Debian / Ubuntu: |
|
|
#### Debian / Ubuntu: |
|
|
|
|
|
|
|
|
apt-get install build-essential python-pip python-m2crypto python-dev |
|
|
apt-get install build-essential python-pip python-m2crypto python-dev |
|
|
pip install gevent shadowsocks |
|
|
pip install shadowsocks |
|
|
|
|
|
|
|
|
#### CentOS: |
|
|
#### CentOS: |
|
|
|
|
|
|
|
|
@ -39,7 +41,7 @@ Install Shadowsocks. |
|
|
|
|
|
|
|
|
#### Windows: |
|
|
#### Windows: |
|
|
|
|
|
|
|
|
Choose a [GUI client][7] |
|
|
Choose a [GUI client] |
|
|
|
|
|
|
|
|
Usage |
|
|
Usage |
|
|
----- |
|
|
----- |
|
|
@ -70,11 +72,11 @@ Explanation of the fields: |
|
|
| password | password used for encryption | |
|
|
| password | password used for encryption | |
|
|
| timeout | in seconds | |
|
|
| timeout | in seconds | |
|
|
| method | encryption method, "aes-256-cfb" is recommended | |
|
|
| method | encryption method, "aes-256-cfb" is recommended | |
|
|
| fast_open | use [TCP_FASTOPEN][2], true / false | |
|
|
| fast_open | use [TCP_FASTOPEN], true / false | |
|
|
| workers | number of workers, available on Unix/Linux | |
|
|
| workers | number of workers, available on Unix/Linux | |
|
|
|
|
|
|
|
|
Run `ssserver -c /etc/shadowsocks.json` on your server. To run it in the background, |
|
|
Run `ssserver -c /etc/shadowsocks.json` on your server. To run it in the |
|
|
[use supervisor][8]. |
|
|
background, use [Supervisor]. |
|
|
|
|
|
|
|
|
On your client machine, run `sslocal -c /etc/shadowsocks.json`. |
|
|
On your client machine, run `sslocal -c /etc/shadowsocks.json`. |
|
|
|
|
|
|
|
|
@ -84,9 +86,6 @@ Change the proxy settings in your browser to |
|
|
hostname: 127.0.0.1 |
|
|
hostname: 127.0.0.1 |
|
|
port: your local_port |
|
|
port: your local_port |
|
|
|
|
|
|
|
|
**Notice: If you want to use encryption methods other than "table", please |
|
|
|
|
|
install M2Crypto (See Encryption Section).** |
|
|
|
|
|
|
|
|
|
|
|
It's recommended to use shadowsocks with AutoProxy or Proxy SwitchySharp. |
|
|
It's recommended to use shadowsocks with AutoProxy or Proxy SwitchySharp. |
|
|
|
|
|
|
|
|
Command line args |
|
|
Command line args |
|
|
@ -98,29 +97,6 @@ You can use args to override settings from `config.json`. |
|
|
ssserver -p server_port -k password -m bf-cfb --workers 2 |
|
|
ssserver -p server_port -k password -m bf-cfb --workers 2 |
|
|
ssserver -c /etc/shadowsocks/config.json |
|
|
ssserver -c /etc/shadowsocks/config.json |
|
|
|
|
|
|
|
|
gevent |
|
|
|
|
|
------ |
|
|
|
|
|
|
|
|
|
|
|
If you suffer from any strange problem when you have installed gevent 0.9.x, |
|
|
|
|
|
install a new version. |
|
|
|
|
|
|
|
|
|
|
|
pip install gevent --upgrade |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Salsa20 |
|
|
|
|
|
------- |
|
|
|
|
|
|
|
|
|
|
|
Salsa20 is a fast stream cipher. |
|
|
|
|
|
|
|
|
|
|
|
Use "salsa20-ctr" in shadowsocks.json. |
|
|
|
|
|
|
|
|
|
|
|
And install these packages: |
|
|
|
|
|
|
|
|
|
|
|
#### Debian / Ubuntu: |
|
|
|
|
|
|
|
|
|
|
|
apt-get install python-numpy |
|
|
|
|
|
pip install salsa20 |
|
|
|
|
|
|
|
|
|
|
|
Wiki |
|
|
Wiki |
|
|
---- |
|
|
---- |
|
|
|
|
|
|
|
|
@ -132,18 +108,18 @@ MIT |
|
|
|
|
|
|
|
|
Bugs and Issues |
|
|
Bugs and Issues |
|
|
---------------- |
|
|
---------------- |
|
|
Please visit [issue tracker][5] |
|
|
Please visit [Issue Tracker] |
|
|
|
|
|
|
|
|
Mailing list: http://groups.google.com/group/shadowsocks |
|
|
Mailing list: http://groups.google.com/group/shadowsocks |
|
|
|
|
|
|
|
|
Also see [troubleshooting][6] |
|
|
Also see [Troubleshooting] |
|
|
|
|
|
|
|
|
[0]: https://travis-ci.org/clowwindy/shadowsocks |
|
|
|
|
|
[1]: https://travis-ci.org/clowwindy/shadowsocks.png?branch=master |
|
|
[Shadowsocks]: https://travis-ci.org/clowwindy/shadowsocks |
|
|
[2]: https://github.com/clowwindy/shadowsocks/wiki/TCP-Fast-Open |
|
|
[Build Status]: https://travis-ci.org/clowwindy/shadowsocks.png?branch=2.0 |
|
|
[3]: https://github.com/clowwindy/shadowsocks/wiki/Shadowsocks-%E4%BD%BF%E7%94%A8%E8%AF%B4%E6%98%8E |
|
|
[TCP_FASTOPEN]: https://github.com/clowwindy/shadowsocks/wiki/TCP-Fast-Open |
|
|
[4]: http://chandlerproject.org/Projects/MeTooCrypto |
|
|
[Issue Tracker]: https://github.com/clowwindy/shadowsocks/issues?state=open |
|
|
[5]: https://github.com/clowwindy/shadowsocks/issues?state=open |
|
|
[GUI client]: https://github.com/clowwindy/shadowsocks/wiki/Ports-and-Clients |
|
|
[6]: https://github.com/clowwindy/shadowsocks/wiki/Troubleshooting |
|
|
[Supervisor]: https://github.com/clowwindy/shadowsocks/wiki/Configure-Shadowsocks-with-Supervisor |
|
|
[7]: https://github.com/clowwindy/shadowsocks/wiki/Ports-and-Clients |
|
|
[Troubleshooting]: https://github.com/clowwindy/shadowsocks/wiki/Troubleshooting |
|
|
[8]: https://github.com/clowwindy/shadowsocks/wiki/Configure-Shadowsocks-with-Supervisor |
|
|
[中文说明]: https://github.com/clowwindy/shadowsocks/wiki/Shadowsocks-%E4%BD%BF%E7%94%A8%E8%AF%B4%E6%98%8E |
|
|
|
clowwindy
12 years ago