dnomd343
/
shadowsocksr
mirror of https://github.com/dnomd343/shadowsocksr
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

update README.rst

auth
clowwindy 10 years ago
parent
a8996b812b
commit
143750f699
1 changed files with 42 additions and 29 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 53
      README.rst

53
README.rst
View File

@ -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.
`中文说明 <https://github.com/clowwindy/shadowsocks/wiki/Shadowsocks-%E4%BD%BF%E7%94%A8%E8%AF%B4%E6%98%8E>`__
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 <https://github.com/clowwindy/shadowsocks/wiki/Ports-and-Clients#windows>`__
/ `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>`__
/
`iOS <https://github.com/clowwindy/shadowsocks/wiki/Ports-and-Clients#ios>`__
/ `iOS <https://github.com/shadowsocks/shadowsocks-iOS/wiki/Help>`__
- `OpenWRT <https://github.com/clowwindy/shadowsocks/wiki/Ports-and-Clients#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 <https://packages.debian.org/unstable/python/shadowsocks>`__ 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 <https://pypi.python.org/pypi/shadowsocks>`__, 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 |
+------------------+-----------------------------------------------------------------------------------------------------+
+------------------+---------------------------------------------------------------------------------------------------------+
| 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 |
+------------------+-----------------------------------------------------------------------------------------------------+
+------------------+---------------------------------------------------------------------------------------------------------+
| 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

Write Preview
Loading…
Cancel
Save