Merge branch 'master' into dev
This commit is contained in:
clowwindy
commit
f19fb4ed8e
1 changed files with 44 additions and 29 deletions
73
README.md
73
README.md
|
|
@ -10,6 +10,17 @@ A fast tunnel proxy that help you get through firewalls.
|
||||||
Install
|
Install
|
||||||
-------
|
-------
|
||||||
|
|
||||||
|
You'll have a client on your local machine, and install a server on a
|
||||||
|
remote server.
|
||||||
|
|
||||||
|
### Client
|
||||||
|
|
||||||
|
* [Windows] / [OS X]
|
||||||
|
* [Android] / [iOS]
|
||||||
|
* [OpenWRT]
|
||||||
|
|
||||||
|
### Server
|
||||||
|
|
||||||
#### Debian / Ubuntu:
|
#### Debian / Ubuntu:
|
||||||
|
|
||||||
apt-get install python-pip python-m2crypto
|
apt-get install python-pip python-m2crypto
|
||||||
|
|
@ -21,22 +32,10 @@ Install
|
||||||
easy_install pip
|
easy_install pip
|
||||||
pip install shadowsocks
|
pip install shadowsocks
|
||||||
|
|
||||||
#### OS X:
|
Configuration
|
||||||
|
-------------
|
||||||
|
|
||||||
brew install swig
|
On your server create a config file `/etc/shadowsocks.json`.
|
||||||
git clone https://github.com/clowwindy/M2Crypto.git
|
|
||||||
cd M2Crypto
|
|
||||||
pip install .
|
|
||||||
pip install shadowsocks
|
|
||||||
|
|
||||||
#### Windows:
|
|
||||||
|
|
||||||
Choose a [GUI client]
|
|
||||||
|
|
||||||
Usage
|
|
||||||
-----
|
|
||||||
|
|
||||||
Create a config file `/etc/shadowsocks.json` (or put it in other path).
|
|
||||||
Example:
|
Example:
|
||||||
|
|
||||||
{
|
{
|
||||||
|
|
@ -68,15 +67,23 @@ Explanation of the fields:
|
||||||
Run `ssserver -c /etc/shadowsocks.json` on your server. To run it in the
|
Run `ssserver -c /etc/shadowsocks.json` on your server. To run it in the
|
||||||
background, use [Supervisor].
|
background, use [Supervisor].
|
||||||
|
|
||||||
On your client machine, run `sslocal -c /etc/shadowsocks.json`.
|
On your client machine, use the same configuration as your server, and
|
||||||
|
start your client.
|
||||||
|
|
||||||
Change the proxy settings in your browser to
|
If you use Chrome, it's recommended to use [SwitchySharp]. Change the proxy
|
||||||
|
settings to
|
||||||
|
|
||||||
protocol: socks5
|
protocol: socks5
|
||||||
hostname: 127.0.0.1
|
hostname: 127.0.0.1
|
||||||
port: your local_port
|
port: your local_port
|
||||||
|
|
||||||
It's recommended to use shadowsocks with AutoProxy or Proxy SwitchySharp.
|
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
|
Command line args
|
||||||
------------------
|
------------------
|
||||||
|
|
@ -87,6 +94,8 @@ 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
|
||||||
|
|
||||||
|
List all available args with `-h`.
|
||||||
|
|
||||||
Wiki
|
Wiki
|
||||||
----
|
----
|
||||||
|
|
||||||
|
|
@ -105,14 +114,20 @@ Mailing list: http://groups.google.com/group/shadowsocks
|
||||||
Also see [Troubleshooting]
|
Also see [Troubleshooting]
|
||||||
|
|
||||||
|
|
||||||
[1.4.x]: https://github.com/clowwindy/shadowsocks/tree/1.4
|
[Android]: https://github.com/clowwindy/shadowsocks/wiki/Ports-and-Clients#android
|
||||||
[Build Status]: https://img.shields.io/travis/clowwindy/shadowsocks/master.svg?style=flat
|
[Build Status]: https://img.shields.io/travis/clowwindy/shadowsocks/master.svg?style=flat
|
||||||
[Chinese Readme]: https://github.com/clowwindy/shadowsocks/wiki/Shadowsocks-%E4%BD%BF%E7%94%A8%E8%AF%B4%E6%98%8E
|
[Chinese Readme]: https://github.com/clowwindy/shadowsocks/wiki/Shadowsocks-%E4%BD%BF%E7%94%A8%E8%AF%B4%E6%98%8E
|
||||||
[GUI client]: https://github.com/clowwindy/shadowsocks/wiki/Ports-and-Clients
|
[Chrome Standalone]: https://support.google.com/installer/answer/126299
|
||||||
[Issue Tracker]: https://github.com/clowwindy/shadowsocks/issues?state=open
|
[GUI client]: https://github.com/clowwindy/shadowsocks/wiki/Ports-and-Clients
|
||||||
[PyPI]: https://pypi.python.org/pypi/shadowsocks
|
[iOS]: https://github.com/clowwindy/shadowsocks/wiki/Ports-and-Clients#ios
|
||||||
[PyPI version]: https://img.shields.io/pypi/v/shadowsocks.svg?style=flat
|
[Issue Tracker]: https://github.com/clowwindy/shadowsocks/issues?state=open
|
||||||
[Supervisor]: https://github.com/clowwindy/shadowsocks/wiki/Configure-Shadowsocks-with-Supervisor
|
[OpenWRT]: https://github.com/clowwindy/shadowsocks/wiki/Ports-and-Clients#openwrt
|
||||||
[TCP_FASTOPEN]: https://github.com/clowwindy/shadowsocks/wiki/TCP-Fast-Open
|
[OS X]: https://github.com/clowwindy/shadowsocks/wiki/Ports-and-Clients#os-x
|
||||||
[Travis CI]: https://travis-ci.org/clowwindy/shadowsocks
|
[PyPI]: https://pypi.python.org/pypi/shadowsocks
|
||||||
[Troubleshooting]: https://github.com/clowwindy/shadowsocks/wiki/Troubleshooting
|
[PyPI version]: https://img.shields.io/pypi/v/shadowsocks.svg?style=flat
|
||||||
|
[Supervisor]: https://github.com/clowwindy/shadowsocks/wiki/Configure-Shadowsocks-with-Supervisor
|
||||||
|
[TCP_FASTOPEN]: https://github.com/clowwindy/shadowsocks/wiki/TCP-Fast-Open
|
||||||
|
[Travis CI]: https://travis-ci.org/clowwindy/shadowsocks
|
||||||
|
[Troubleshooting]: https://github.com/clowwindy/shadowsocks/wiki/Troubleshooting
|
||||||
|
[SwitchySharp]: https://chrome.google.com/webstore/detail/proxy-switchysharp/dpplabbmogkhghncfbfdeeokoefdjegm
|
||||||
|
[Windows]: https://github.com/clowwindy/shadowsocks/wiki/Ports-and-Clients#windows
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue