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

more work

Browse source
This commit is contained in:
clowwindy 2014-06-01 11:22:57 +08:00
parent c2f6bc369c
commit 9b2a45583e
3 changed files with 34 additions and 74 deletions
Download patch file Download diff file Expand all files Collapse all files

38
README.rst
View file

@ -1,9 +1,13 @@
shadowsocks
===========
shadowsocks is a lightweight tunnel proxy which can help you get through
|Build Status|
shadowsocks is a lightweight tunnel proxy that help you get through
firewalls.
2.0 is currently under development. Please use 1.4.x.
Both TCP CONNECT and UDP ASSOCIATE are implemented.
`中文说明 <https://github.com/clowwindy/shadowsocks/wiki/Shadowsocks-%E4%BD%BF%E7%94%A8%E8%AF%B4%E6%98%8E>`__
@ -25,7 +29,7 @@ Debian / Ubuntu:
::
apt-get install python-pip python-gevent python-m2crypto
apt-get install build-essential python-pip python-m2crypto python-dev
pip install shadowsocks
CentOS:
@ -98,8 +102,8 @@ Explanation of the fields:
+------------------+-----------------------------------------------------------------------------------------------------+
Run ``ssserver -c /etc/shadowsocks.json`` on your server. To run it in
the background, `use
supervisor <https://github.com/clowwindy/shadowsocks/wiki/Configure-Shadowsocks-with-Supervisor>`__.
the background, use
`Supervisor <https://github.com/clowwindy/shadowsocks/wiki/Configure-Shadowsocks-with-Supervisor>`__.
On your client machine, run ``sslocal -c /etc/shadowsocks.json``.
@ -111,9 +115,6 @@ Change the proxy settings in your browser to
hostname: 127.0.0.1
port: your local_port
**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.
@ -128,23 +129,6 @@ 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
Salsa20
-------
Salsa20 is a fast stream cipher.
Use "salsa20-ctr" in shadowsocks.json.
And install these packages:
Debian / Ubuntu:
^^^^^^^^^^^^^^^^
::
apt-get install python-numpy
pip install salsa20
Wiki
----
@ -158,13 +142,13 @@ MIT
Bugs and Issues
---------------
Please visit `issue
tracker <https://github.com/clowwindy/shadowsocks/issues?state=open>`__
Please visit `Issue
Tracker <https://github.com/clowwindy/shadowsocks/issues?state=open>`__
Mailing list: http://groups.google.com/group/shadowsocks
Also see
`troubleshooting <https://github.com/clowwindy/shadowsocks/wiki/Troubleshooting>`__
`Troubleshooting <https://github.com/clowwindy/shadowsocks/wiki/Troubleshooting>`__
.. |Build Status| image:: https://travis-ci.org/clowwindy/shadowsocks.png?branch=master
:target: https://travis-ci.org/clowwindy/shadowsocks