2012-04-20 13:10:49 +00:00
|
|
|
shadowsocks
|
2012-04-20 14:26:00 +00:00
|
|
|
===========
|
|
|
|
|
|
2013-05-22 03:35:25 +00:00
|
|
|
[](https://travis-ci.org/clowwindy/shadowsocks)
|
2013-06-22 09:30:31 +00:00
|
|
|
Current version: 1.3.0
|
2012-12-30 04:28:23 +00:00
|
|
|
|
2012-04-20 14:26:00 +00:00
|
|
|
shadowsocks is a lightweight tunnel proxy which can help you get through firewalls
|
|
|
|
|
|
2013-01-04 10:13:33 +00:00
|
|
|
Other ports and clients can be found [here](https://github.com/clowwindy/shadowsocks/wiki/Ports-and-Clients).
|
|
|
|
|
|
2013-05-31 15:57:22 +00:00
|
|
|
Usage
|
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
|
|
|
|
2013-06-22 09:30:31 +00:00
|
|
|
pip install shadowsocks
|
|
|
|
|
|
|
|
|
|
Create a file named `config.json`, with the following content.
|
2012-12-30 05:28:51 +00:00
|
|
|
|
2013-06-22 09:30:31 +00:00
|
|
|
{
|
|
|
|
|
"server":"my_server_ip",
|
|
|
|
|
"server_port":8388,
|
|
|
|
|
"local_port":1080,
|
|
|
|
|
"password":"barfoo!",
|
|
|
|
|
"timeout":600,
|
|
|
|
|
"method":null
|
|
|
|
|
}
|
2012-04-20 14:26:00 +00:00
|
|
|
|
2013-06-22 09:30:31 +00:00
|
|
|
Explaination of the fields:
|
|
|
|
|
|
|
|
|
|
server your server IP (IPv4/IPv6), notice that your server will listen to this IP
|
2012-11-02 09:36:57 +00:00
|
|
|
server_port server port
|
|
|
|
|
local_port local port
|
|
|
|
|
password a password used to encrypt transfer
|
2013-06-22 09:30:31 +00:00
|
|
|
timeout in seconds
|
2013-05-22 06:15:08 +00:00
|
|
|
method encryption method, "bf-cfb", "aes-256-cfb", "des-cfb", "rc4", etc. Default is table
|
2013-05-22 06:14:37 +00:00
|
|
|
|
2013-06-22 09:30:31 +00:00
|
|
|
`cd` into the directory of `config.json`. Run `ssserver` on your server. To run it in the background, run
|
|
|
|
|
`nohup ssserver > log &`.
|
2013-05-22 06:14:37 +00:00
|
|
|
|
2013-06-22 09:30:31 +00:00
|
|
|
On your client machine, run `sslocal`.
|
2012-04-20 14:26:00 +00:00
|
|
|
|
2013-05-21 08:52:22 +00:00
|
|
|
Change the proxy setting in your browser into
|
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-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
|
|
|
|
|
|
2013-05-31 15:57:22 +00:00
|
|
|
Encryption
|
2012-12-06 06:39:06 +00:00
|
|
|
------------
|
|
|
|
|
|
2013-05-31 15:57:22 +00:00
|
|
|
If you want to use non-default encryption method like "bf-cfb", please install [M2Crypto](http://chandlerproject.org/Projects/MeTooCrypto).
|
|
|
|
|
|
|
|
|
|
Ubuntu:
|
|
|
|
|
|
|
|
|
|
sudo apt-get install python-m2crypto
|
|
|
|
|
|
|
|
|
|
Others:
|
|
|
|
|
|
|
|
|
|
pip install M2Crypto
|
|
|
|
|
|
|
|
|
|
Performance
|
|
|
|
|
------------
|
|
|
|
|
|
2012-12-30 05:28:51 +00:00
|
|
|
You may want to install gevent for better performance.
|
|
|
|
|
|
2013-01-05 08:26:19 +00:00
|
|
|
$ sudo apt-get install python-gevent
|
2012-12-30 06:01:41 +00:00
|
|
|
|
|
|
|
|
Or:
|
|
|
|
|
|
2013-01-05 08:26:19 +00:00
|
|
|
$ sudo apt-get install libevent-dev python-pip
|
|
|
|
|
$ sudo pip install gevent
|
2012-12-30 06:01:41 +00:00
|
|
|
|
2013-06-18 09:52:01 +00:00
|
|
|
License
|
|
|
|
|
-------
|
|
|
|
|
MIT
|
|
|
|
|
|
|
|
|
|
Bugs and Issues
|
|
|
|
|
----------------
|
|
|
|
|
Please visit [issue tracker](https://github.com/clowwindy/shadowsocks/issues?state=open)
|
2013-06-22 17:32:24 +00:00
|
|
|
|
|
|
|
|
Mailing list: http://groups.google.com/group/shadowsocks
|
2013-06-23 18:38:08 +00:00
|
|
|
|
|
|
|
|
Also see [troubleshooting](https://github.com/clowwindy/shadowsocks/wiki/Troubleshooting)
|
