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

update url

Browse source
This commit is contained in:
clowwindy 2014-12-27 23:36:09 +08:00
parent 7f19c31640
commit 5a5158b33f
1 changed files with 33 additions and 31 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

64
README.rst
View file

@ -1,11 +1,11 @@
shadowsocks shadowsocks
=========== ===========
|PyPI version| |Build Status| |PyPI version| |Build Status| |Coverage Status|
A fast tunnel proxy that helps you bypass firewalls. A fast tunnel proxy that helps you bypass firewalls.
`中文说明 <https://github.com/clowwindy/shadowsocks/wiki/Shadowsocks-%E4%BD%BF%E7%94%A8%E8%AF%B4%E6%98%8E>`__ `中文说明 <https://github.com/shadowsocks/shadowsocks/wiki/Shadowsocks-%E4%BD%BF%E7%94%A8%E8%AF%B4%E6%98%8E>`__
Install Install
------- -------
@ -16,12 +16,12 @@ server.
Client Client
~~~~~~ ~~~~~~
- `Windows <https://github.com/clowwindy/shadowsocks/wiki/Ports-and-Clients#windows>`__ - `Windows <https://github.com/shadowsocks/shadowsocks/wiki/Ports-and-Clients#windows>`__
/ `OS / `OS
X <https://github.com/shadowsocks/shadowsocks-iOS/wiki/Shadowsocks-for-OSX-Help>`__ X <https://github.com/shadowsocks/shadowsocks-iOS/wiki/Shadowsocks-for-OSX-Help>`__
- `Android <https://github.com/clowwindy/shadowsocks/wiki/Ports-and-Clients#android>`__ - `Android <https://github.com/shadowsocks/shadowsocks/wiki/Ports-and-Clients#android>`__
/ `iOS <https://github.com/shadowsocks/shadowsocks-iOS/wiki/Help>`__ / `iOS <https://github.com/shadowsocks/shadowsocks-iOS/wiki/Help>`__
- `OpenWRT <https://github.com/clowwindy/shadowsocks/wiki/Ports-and-Clients#openwrt>`__ - `OpenWRT <https://github.com/shadowsocks/shadowsocks/wiki/Ports-and-Clients#openwrt>`__
Server Server
~~~~~~ ~~~~~~
@ -77,27 +77,27 @@ On your server create a config file ``/etc/shadowsocks.json``. Example:
Explanation of the fields: Explanation of the fields:
+------------------+---------------------------------------------------------------------------------------------------------+ +------------------+-----------------------------------------------------------------------------------------------------------+
| Name | Explanation | | Name | Explanation |
+==================+=========================================================================================================+ +==================+===========================================================================================================+
| server | the address your server listens | | server | the address your server listens |
+------------------+---------------------------------------------------------------------------------------------------------+ +------------------+-----------------------------------------------------------------------------------------------------------+
| server\_port | server port | | server\_port | server port |
+------------------+---------------------------------------------------------------------------------------------------------+ +------------------+-----------------------------------------------------------------------------------------------------------+
| local\_address | the address your local listens | | local\_address | the address your local listens |
+------------------+---------------------------------------------------------------------------------------------------------+ +------------------+-----------------------------------------------------------------------------------------------------------+
| local\_port | local port | | local\_port | local port |
+------------------+---------------------------------------------------------------------------------------------------------+ +------------------+-----------------------------------------------------------------------------------------------------------+
| password | password used for encryption | | password | password used for encryption |
+------------------+---------------------------------------------------------------------------------------------------------+ +------------------+-----------------------------------------------------------------------------------------------------------+
| timeout | in seconds | | timeout | in seconds |
+------------------+---------------------------------------------------------------------------------------------------------+ +------------------+-----------------------------------------------------------------------------------------------------------+
| method | default: "aes-256-cfb", see `Encryption <https://github.com/clowwindy/shadowsocks/wiki/Encryption>`__ | | method | default: "aes-256-cfb", see `Encryption <https://github.com/shadowsocks/shadowsocks/wiki/Encryption>`__ |
+------------------+---------------------------------------------------------------------------------------------------------+ +------------------+-----------------------------------------------------------------------------------------------------------+
| fast\_open | use `TCP\_FASTOPEN <https://github.com/clowwindy/shadowsocks/wiki/TCP-Fast-Open>`__, true / false | | fast\_open | use `TCP\_FASTOPEN <https://github.com/shadowsocks/shadowsocks/wiki/TCP-Fast-Open>`__, true / false |
+------------------+---------------------------------------------------------------------------------------------------------+ +------------------+-----------------------------------------------------------------------------------------------------------+
| workers | number of workers, available on Unix/Linux | | workers | number of workers, available on Unix/Linux |
+------------------+---------------------------------------------------------------------------------------------------------+ +------------------+-----------------------------------------------------------------------------------------------------------+
On your server: On your server:
@ -134,7 +134,7 @@ Documentation
------------- -------------
You can find all the documentation in the wiki: You can find all the documentation in the wiki:
https://github.com/clowwindy/shadowsocks/wiki https://github.com/shadowsocks/shadowsocks/wiki
License License
------- -------
@ -144,12 +144,14 @@ MIT
Bugs and Issues Bugs and Issues
--------------- ---------------
- `Troubleshooting <https://github.com/clowwindy/shadowsocks/wiki/Troubleshooting>`__ - `Troubleshooting <https://github.com/shadowsocks/shadowsocks/wiki/Troubleshooting>`__
- `Issue - `Issue
Tracker <https://github.com/clowwindy/shadowsocks/issues?state=open>`__ Tracker <https://github.com/shadowsocks/shadowsocks/issues?state=open>`__
- `Mailing list <http://groups.google.com/group/shadowsocks>`__ - `Mailing list <http://groups.google.com/group/shadowsocks>`__
.. |PyPI version| image:: https://img.shields.io/pypi/v/shadowsocks.svg?style=flat .. |PyPI version| image:: https://img.shields.io/pypi/v/shadowsocks.svg?style=flat
:target: https://pypi.python.org/pypi/shadowsocks :target: https://pypi.python.org/pypi/shadowsocks
.. |Build Status| image:: https://img.shields.io/travis/clowwindy/shadowsocks/master.svg?style=flat .. |Build Status| image:: https://img.shields.io/travis/shadowsocks/shadowsocks/master.svg?style=flat
:target: https://travis-ci.org/clowwindy/shadowsocks :target: https://travis-ci.org/shadowsocks/shadowsocks
.. |Coverage Status| image:: http://192.81.132.184/result/shadowsocks
:target: http://192.81.132.184/job/Shadowsocks/ws/htmlcov/index.html