From ed5888387bb7fda10d6cd94c4da52eeefe255bf6 Mon Sep 17 00:00:00 2001 From: clowwindy Date: Sat, 14 Jun 2014 11:11:07 +0800 Subject: [PATCH 1/7] Update README.md --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index e63b870..7fad7e6 100644 --- a/README.md +++ b/README.md @@ -105,7 +105,6 @@ Mailing list: http://groups.google.com/group/shadowsocks Also see [Troubleshooting] -[1.4.x]: https://github.com/clowwindy/shadowsocks/tree/1.4 [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 [GUI client]: https://github.com/clowwindy/shadowsocks/wiki/Ports-and-Clients From a68b9a052057913e15384b05c50fd8c085aa7f40 Mon Sep 17 00:00:00 2001 From: clowwindy Date: Sat, 14 Jun 2014 11:17:13 +0800 Subject: [PATCH 2/7] Update README.md --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7fad7e6..2224665 100644 --- a/README.md +++ b/README.md @@ -76,7 +76,7 @@ Change the proxy settings in your browser to hostname: 127.0.0.1 port: your local_port -It's recommended to use shadowsocks with AutoProxy or Proxy SwitchySharp. +It's recommended to use shadowsocks with [SwitchySharp]. Command line args ------------------ @@ -115,3 +115,4 @@ Also see [Troubleshooting] [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 From 71b4d34ce4d0f76ab0076ce7dd7478b7fef70fa5 Mon Sep 17 00:00:00 2001 From: clowwindy Date: Mon, 16 Jun 2014 00:52:29 +0800 Subject: [PATCH 3/7] Update README.md --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2224665..6b0b706 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,11 @@ 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. + +For client, find any [GUI client]. For server: + #### Debian / Ubuntu: apt-get install python-pip python-m2crypto @@ -31,7 +36,8 @@ Install #### Windows: -Choose a [GUI client] +Since installing M2Crypto on Windows is a bit frustrating, use +[node.js version] instead. Usage ----- @@ -109,6 +115,7 @@ Also see [Troubleshooting] [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 [Issue Tracker]: https://github.com/clowwindy/shadowsocks/issues?state=open +[node.js version]: https://github.com/clowwindy/shadowsocks-nodejs [PyPI]: https://pypi.python.org/pypi/shadowsocks [PyPI version]: https://img.shields.io/pypi/v/shadowsocks.svg?style=flat [Supervisor]: https://github.com/clowwindy/shadowsocks/wiki/Configure-Shadowsocks-with-Supervisor From c1a6dc4c9e96b1526895fd5625ba5525b2b8d84b Mon Sep 17 00:00:00 2001 From: clowwindy Date: Mon, 16 Jun 2014 01:13:54 +0800 Subject: [PATCH 4/7] Update README.md --- README.md | 36 +++++++++++++++++------------------- 1 file changed, 17 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 6b0b706..5666d1e 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,13 @@ Install You'll have a client on your local machine, and install a server on a remote server. -For client, find any [GUI client]. For server: +### Client + +* [Windows] / [OS X] +* [Android] / [iOS] +* [OpenWRT] + +### Server #### Debian / Ubuntu: @@ -26,23 +32,10 @@ For client, find any [GUI client]. For server: easy_install pip pip install shadowsocks -#### OS X: - - brew install swig - git clone https://github.com/clowwindy/M2Crypto.git - cd M2Crypto - pip install . - pip install shadowsocks - -#### Windows: - -Since installing M2Crypto on Windows is a bit frustrating, use -[node.js version] instead. - -Usage ------ +Configuration +------------- -Create a config file `/etc/shadowsocks.json` (or put it in other path). +On your server create a config file `/etc/shadowsocks.json` (or put it in other path). Example: { @@ -74,7 +67,8 @@ Explanation of the fields: Run `ssserver -c /etc/shadowsocks.json` on your server. To run it in the 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 @@ -111,11 +105,14 @@ Mailing list: http://groups.google.com/group/shadowsocks Also see [Troubleshooting] +[Android]: https://github.com/clowwindy/shadowsocks/wiki/Ports-and-Clients#android [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 [GUI client]: https://github.com/clowwindy/shadowsocks/wiki/Ports-and-Clients +[iOS]: https://github.com/clowwindy/shadowsocks/wiki/Ports-and-Clients#ios [Issue Tracker]: https://github.com/clowwindy/shadowsocks/issues?state=open -[node.js version]: https://github.com/clowwindy/shadowsocks-nodejs +[OpenWRT]: https://github.com/clowwindy/shadowsocks/wiki/Ports-and-Clients#openwrt +[OS X]: https://github.com/clowwindy/shadowsocks/wiki/Ports-and-Clients#os-x [PyPI]: https://pypi.python.org/pypi/shadowsocks [PyPI version]: https://img.shields.io/pypi/v/shadowsocks.svg?style=flat [Supervisor]: https://github.com/clowwindy/shadowsocks/wiki/Configure-Shadowsocks-with-Supervisor @@ -123,3 +120,4 @@ Also see [Troubleshooting] [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 From 3c0024cef0d638f461b1ed9341a6b7042d34ad24 Mon Sep 17 00:00:00 2001 From: clowwindy Date: Mon, 16 Jun 2014 01:26:57 +0800 Subject: [PATCH 5/7] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 5666d1e..715a52e 100644 --- a/README.md +++ b/README.md @@ -87,6 +87,8 @@ You can use args to override settings from `config.json`. ssserver -p server_port -k password -m bf-cfb --workers 2 ssserver -c /etc/shadowsocks/config.json +List all available args with `-h`. + Wiki ---- From eeda2c258d693660730c703f9b1956b1958cea44 Mon Sep 17 00:00:00 2001 From: clowwindy Date: Mon, 16 Jun 2014 02:14:49 +0800 Subject: [PATCH 6/7] Update README.md --- README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 715a52e..0d5e4f5 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,7 @@ remote server. Configuration ------------- -On your server create a config file `/etc/shadowsocks.json` (or put it in other path). +On your server create a config file `/etc/shadowsocks.json`. Example: { @@ -70,13 +70,17 @@ background, use [Supervisor]. 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 hostname: 127.0.0.1 port: your local_port -It's recommended to use shadowsocks with [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" Command line args ------------------ From 1c847a9a58d9fed0a6d1f18fcf281d937fc666f9 Mon Sep 17 00:00:00 2001 From: clowwindy Date: Mon, 16 Jun 2014 02:29:06 +0800 Subject: [PATCH 7/7] Update README.md --- README.md | 36 ++++++++++++++++++++---------------- 1 file changed, 20 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 0d5e4f5..102b2b7 100644 --- a/README.md +++ b/README.md @@ -82,6 +82,9 @@ 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 ------------------ @@ -111,19 +114,20 @@ Mailing list: http://groups.google.com/group/shadowsocks Also see [Troubleshooting] -[Android]: https://github.com/clowwindy/shadowsocks/wiki/Ports-and-Clients#android -[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 -[GUI client]: https://github.com/clowwindy/shadowsocks/wiki/Ports-and-Clients -[iOS]: https://github.com/clowwindy/shadowsocks/wiki/Ports-and-Clients#ios -[Issue Tracker]: https://github.com/clowwindy/shadowsocks/issues?state=open -[OpenWRT]: https://github.com/clowwindy/shadowsocks/wiki/Ports-and-Clients#openwrt -[OS X]: https://github.com/clowwindy/shadowsocks/wiki/Ports-and-Clients#os-x -[PyPI]: https://pypi.python.org/pypi/shadowsocks -[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 +[Android]: https://github.com/clowwindy/shadowsocks/wiki/Ports-and-Clients#android +[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 +[Chrome Standalone]: https://support.google.com/installer/answer/126299 +[GUI client]: https://github.com/clowwindy/shadowsocks/wiki/Ports-and-Clients +[iOS]: https://github.com/clowwindy/shadowsocks/wiki/Ports-and-Clients#ios +[Issue Tracker]: https://github.com/clowwindy/shadowsocks/issues?state=open +[OpenWRT]: https://github.com/clowwindy/shadowsocks/wiki/Ports-and-Clients#openwrt +[OS X]: https://github.com/clowwindy/shadowsocks/wiki/Ports-and-Clients#os-x +[PyPI]: https://pypi.python.org/pypi/shadowsocks +[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