vbatts/shadowsocks
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Merge pull request #68 from jlund/doc-cleanup

Browse source 
Fixed a few typos in the documentation
This commit is contained in:
clowwindy 2013-09-15 22:25:48 -07:00
commit 2994e40e31
3 changed files with 11 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
CHANGES
View file

@ -24,10 +24,10 @@
- Use random iv, we finally have strong encryption - Use random iv, we finally have strong encryption
1.1.1 2013-05-21 1.1.1 2013-05-21
- Add encryption, AES, blowfish, etc - Add encryption, AES, blowfish, etc.
1.1 2013-05-16 1.1 2013-05-16
- Support IPv6 address (type 4) - Support IPv6 addresses (type 4)
- Drop Python 2.5 support - Drop Python 2.5 support
1.0 2013-04-03 1.0 2013-04-03
@ -66,4 +66,4 @@
- Fix socket.error - Fix socket.error
0.1 2012-04-20 0.1 2012-04-20
- Initial verion - Initial version

8
README.md
View file

@ -4,7 +4,7 @@ shadowsocks
[![Build Status](https://travis-ci.org/clowwindy/shadowsocks.png)](https://travis-ci.org/clowwindy/shadowsocks) [![Build Status](https://travis-ci.org/clowwindy/shadowsocks.png)](https://travis-ci.org/clowwindy/shadowsocks)
Current version: 1.3.3 Current version: 1.3.3
shadowsocks is a lightweight tunnel proxy which can help you get through firewalls shadowsocks is a lightweight tunnel proxy which can help you get through firewalls.
Other ports and clients can be found [here](https://github.com/clowwindy/shadowsocks/wiki/Ports-and-Clients). Other ports and clients can be found [here](https://github.com/clowwindy/shadowsocks/wiki/Ports-and-Clients).
@ -33,7 +33,7 @@ Create a file named `config.json`, with the following content.
"method":"table" "method":"table"
} }
Explaination of the fields: Explanation of the fields:
server your server IP (IPv4/IPv6), notice that your server will listen to this IP server your server IP (IPv4/IPv6), notice that your server will listen to this IP
server_port server port server_port server port
@ -47,13 +47,13 @@ Explaination of the fields:
On your client machine, run `sslocal`. On your client machine, run `sslocal`.
Change the proxy setting in your browser into Change the proxy settings in your browser to
protocol: socks5 protocol: socks5
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 method other than "table", please install M2Crypto (See Encryption Section).** **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.

8
README.rst
View file

@ -19,7 +19,7 @@ First, make sure you have Python 2.6 or 2.7.
$ python --version $ python --version
Python 2.6.8 Python 2.6.8
Install Shadowsocks. Install shadowsocks.
:: ::
@ -38,7 +38,7 @@ Create a file named ``config.json``, with the following content.
"method":null "method":null
} }
Explaination of the fields: Explanation of the fields:
:: ::
@ -54,7 +54,7 @@ server. To run it in the background, run ``nohup ssserver > log &``.
On your client machine, run ``sslocal``. On your client machine, run ``sslocal``.
Change the proxy setting in your browser into Change the proxy settings in your browser to
:: ::
@ -76,7 +76,7 @@ You can use args to override settings from ``config.json``.
Encryption Encryption
---------- ----------
If you want to use non-default encryption method like "bf-cfb", please If you want to use non-default encryption methods like "bf-cfb", please
install `M2Crypto <http://chandlerproject.org/Projects/MeTooCrypto>`__. install `M2Crypto <http://chandlerproject.org/Projects/MeTooCrypto>`__.
Ubuntu: Ubuntu: