clowwindy
35bfa56eaf
|
11 years ago | |
---|---|---|
packaging/py2exe | 12 years ago | |
shadowsocks | 11 years ago | |
tests | 11 years ago | |
.gitignore | 11 years ago | |
.travis.yml | 11 years ago | |
CHANGES | 11 years ago | |
CONTRIBUTING.md | 11 years ago | |
LICENSE | 12 years ago | |
README.md | 11 years ago | |
README.rst | 11 years ago | |
config.json | 11 years ago | |
setup.py | 11 years ago | |
test.py | 11 years ago | |
test_latency.py | 11 years ago |
README.md
shadowsocks
A fast tunnel proxy that help you get through firewalls.
Install
You'll have a client on your local machine, and install a server on a remote server.
Client
Server
Debian / Ubuntu:
apt-get install python-pip python-m2crypto
pip install shadowsocks
CentOS:
yum install m2crypto python-setuptools
easy_install pip
pip install shadowsocks
Configuration
On your server create a config file /etc/shadowsocks.json
.
Example:
{
"server":"my_server_ip",
"server_port":8388,
"local_address": "127.0.0.1",
"local_port":1080,
"password":"mypassword",
"timeout":300,
"method":"aes-256-cfb",
"fast_open": false,
"workers": 1
}
Explanation of the fields:
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 |
fast_open | use TCP_FASTOPEN, true / false |
workers | number of workers, available on Unix/Linux |
Run ssserver -c /etc/shadowsocks.json
on your server. To run it in the
background, use Supervisor.
On your client machine, use the same configuration as your server, and start your client.
If you use Chrome, it's recommended to use SwitchySharp. Change the proxy settings to
protocol: socks5
hostname: 127.0.0.1
port: your local_port
If you can't install SwitchySharp, you can launch Chrome with the following arguments to force Chrome to use the proxy:
Chrome.exe --proxy-server="socks5://127.0.0.1:1080" --host-resolver-rules="MAP * 0.0.0.0 , EXCLUDE localhost"
If you can't even download Chrome, find a friend to download a Chrome Standalone installer for you.
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 --workers 2
ssserver -c /etc/shadowsocks/config.json
List all available args with -h
.
Wiki
https://github.com/clowwindy/shadowsocks/wiki
License
MIT
Bugs and Issues
Please visit Issue Tracker
Mailing list: http://groups.google.com/group/shadowsocks
Also see Troubleshooting