update README.rst
This commit is contained in:
clowwindy
parent
a8996b812b
commit
143750f699
1 changed files with 42 additions and 29 deletions
71
README.rst
71
README.rst
|
|
@ -3,25 +3,24 @@ shadowsocks
|
||||||
|
|
||||||
|PyPI version| |Build Status|
|
|PyPI version| |Build Status|
|
||||||
|
|
||||||
A fast tunnel proxy that help you get through 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/clowwindy/shadowsocks/wiki/Shadowsocks-%E4%BD%BF%E7%94%A8%E8%AF%B4%E6%98%8E>`__
|
||||||
|
|
||||||
Install
|
Install
|
||||||
-------
|
-------
|
||||||
|
|
||||||
You'll have a client on your local machine, and install a server on a
|
You'll have a client on your local side, and setup a server on a remote
|
||||||
remote server.
|
server.
|
||||||
|
|
||||||
Client
|
Client
|
||||||
~~~~~~
|
~~~~~~
|
||||||
|
|
||||||
- `Windows <https://github.com/clowwindy/shadowsocks/wiki/Ports-and-Clients#windows>`__
|
- `Windows <https://github.com/clowwindy/shadowsocks/wiki/Ports-and-Clients#windows>`__
|
||||||
/ `OS
|
/ `OS
|
||||||
X <https://github.com/clowwindy/shadowsocks/wiki/Ports-and-Clients#os-x>`__
|
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/clowwindy/shadowsocks/wiki/Ports-and-Clients#android>`__
|
||||||
/
|
/ `iOS <https://github.com/shadowsocks/shadowsocks-iOS/wiki/Help>`__
|
||||||
`iOS <https://github.com/clowwindy/shadowsocks/wiki/Ports-and-Clients#ios>`__
|
|
||||||
- `OpenWRT <https://github.com/clowwindy/shadowsocks/wiki/Ports-and-Clients#openwrt>`__
|
- `OpenWRT <https://github.com/clowwindy/shadowsocks/wiki/Ports-and-Clients#openwrt>`__
|
||||||
|
|
||||||
Server
|
Server
|
||||||
|
|
@ -32,18 +31,31 @@ Debian / Ubuntu:
|
||||||
|
|
||||||
::
|
::
|
||||||
|
|
||||||
apt-get install python-pip python-m2crypto
|
apt-get install python-pip
|
||||||
pip install shadowsocks
|
pip install shadowsocks
|
||||||
|
|
||||||
|
Or simply ``apt-get install shadowsocks`` if you have `Debian
|
||||||
|
sid <https://packages.debian.org/unstable/python/shadowsocks>`__ in your
|
||||||
|
source list.
|
||||||
|
|
||||||
CentOS:
|
CentOS:
|
||||||
^^^^^^^
|
^^^^^^^
|
||||||
|
|
||||||
::
|
::
|
||||||
|
|
||||||
yum install m2crypto python-setuptools
|
yum install python-setuptools
|
||||||
easy_install pip
|
easy_install pip
|
||||||
pip install shadowsocks
|
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 <https://pypi.python.org/pypi/shadowsocks>`__, and use
|
||||||
|
``python shadowsocks/server.py`` instead of ``ssserver`` command below.
|
||||||
|
|
||||||
Configuration
|
Configuration
|
||||||
-------------
|
-------------
|
||||||
|
|
||||||
|
|
@ -65,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 | encryption method, "aes-256-cfb" is recommended |
|
| method | default: "aes-256-cfb", see `Encryption <https://github.com/clowwindy/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/clowwindy/shadowsocks/wiki/TCP-Fast-Open>`__, true / false |
|
||||||
+------------------+-----------------------------------------------------------------------------------------------------+
|
+------------------+---------------------------------------------------------------------------------------------------------+
|
||||||
| workers | number of workers, available on Unix/Linux |
|
| workers | number of workers, available on Unix/Linux |
|
||||||
+------------------+-----------------------------------------------------------------------------------------------------+
|
+------------------+---------------------------------------------------------------------------------------------------------+
|
||||||
|
|
||||||
Run ``ssserver -c /etc/shadowsocks.json`` on your server. To run it in
|
Run ``ssserver -c /etc/shadowsocks.json`` on your server. To run it in
|
||||||
the background, use
|
the background, use
|
||||||
|
|
@ -133,6 +145,7 @@ List all available args with ``-h``.
|
||||||
Wiki
|
Wiki
|
||||||
----
|
----
|
||||||
|
|
||||||
|
You can find all the documentation in the wiki:
|
||||||
https://github.com/clowwindy/shadowsocks/wiki
|
https://github.com/clowwindy/shadowsocks/wiki
|
||||||
|
|
||||||
License
|
License
|
||||||
|
|
|
||||||
Loading…
Add table
Reference in a new issue