diff --git a/README.rst b/README.rst index 983a375..19d5b2a 100644 --- a/README.rst +++ b/README.rst @@ -3,25 +3,24 @@ shadowsocks |PyPI version| |Build Status| -A fast tunnel proxy that help you get through firewalls. +A fast tunnel proxy that helps you bypass firewalls. `中文说明 `__ Install ------- -You'll have a client on your local machine, and install a server on a -remote server. +You'll have a client on your local side, and setup a server on a remote +server. Client ~~~~~~ - `Windows `__ / `OS - X `__ + X `__ - `Android `__ - / - `iOS `__ + / `iOS `__ - `OpenWRT `__ Server @@ -32,18 +31,31 @@ Debian / Ubuntu: :: - apt-get install python-pip python-m2crypto + apt-get install python-pip pip install shadowsocks +Or simply ``apt-get install shadowsocks`` if you have `Debian +sid `__ in your +source list. + CentOS: ^^^^^^^ :: - yum install m2crypto python-setuptools + yum install python-setuptools easy_install pip pip install shadowsocks +Windows: +^^^^^^^^ + +Download OpenSSL for Windows and install. Then install shadowsocks via +easy\_install and pip as Linux. If you don't know how to use them, you +can directly download `the +package `__, and use +``python shadowsocks/server.py`` instead of ``ssserver`` command below. + Configuration ------------- @@ -65,27 +77,27 @@ On your server create a config file ``/etc/shadowsocks.json``. Example: Explanation of the fields: -+------------------+-----------------------------------------------------------------------------------------------------+ -| Name | Explanation | -+==================+=====================================================================================================+ -| server | the address your server listens | -+------------------+-----------------------------------------------------------------------------------------------------+ -| server\_port | server port | -+------------------+-----------------------------------------------------------------------------------------------------+ -| local\_address | the address your local listens | -+------------------+-----------------------------------------------------------------------------------------------------+ -| local\_port | local port | -+------------------+-----------------------------------------------------------------------------------------------------+ -| password | password used for encryption | -+------------------+-----------------------------------------------------------------------------------------------------+ -| timeout | in seconds | -+------------------+-----------------------------------------------------------------------------------------------------+ -| method | encryption method, "aes-256-cfb" is recommended | -+------------------+-----------------------------------------------------------------------------------------------------+ -| fast\_open | use `TCP\_FASTOPEN `__, true / false | -+------------------+-----------------------------------------------------------------------------------------------------+ -| workers | number of workers, available on Unix/Linux | -+------------------+-----------------------------------------------------------------------------------------------------+ ++------------------+---------------------------------------------------------------------------------------------------------+ +| Name | Explanation | ++==================+=========================================================================================================+ +| server | the address your server listens | ++------------------+---------------------------------------------------------------------------------------------------------+ +| server\_port | server port | ++------------------+---------------------------------------------------------------------------------------------------------+ +| local\_address | the address your local listens | ++------------------+---------------------------------------------------------------------------------------------------------+ +| local\_port | local port | ++------------------+---------------------------------------------------------------------------------------------------------+ +| password | password used for encryption | ++------------------+---------------------------------------------------------------------------------------------------------+ +| timeout | in seconds | ++------------------+---------------------------------------------------------------------------------------------------------+ +| method | default: "aes-256-cfb", see `Encryption `__ | ++------------------+---------------------------------------------------------------------------------------------------------+ +| fast\_open | use `TCP\_FASTOPEN `__, true / false | ++------------------+---------------------------------------------------------------------------------------------------------+ +| workers | number of workers, available on Unix/Linux | ++------------------+---------------------------------------------------------------------------------------------------------+ Run ``ssserver -c /etc/shadowsocks.json`` on your server. To run it in the background, use @@ -133,6 +145,7 @@ List all available args with ``-h``. Wiki ---- +You can find all the documentation in the wiki: https://github.com/clowwindy/shadowsocks/wiki License