diff --git a/README.rst b/README.rst index 97d1d9f..510b233 100644 --- a/README.rst +++ b/README.rst @@ -5,24 +5,11 @@ shadowsocks A fast tunnel proxy that helps you bypass firewalls. -Install -------- - -You'll have a client on your local side, and setup a server on a remote -server. - -Client -~~~~~~ - -- `Windows `__ - / `OS - X `__ -- `Android `__ - / `iOS `__ -- `OpenWRT `__ - Server -~~~~~~ +------ + +Install +~~~~~~~ Debian / Ubuntu: ^^^^^^^^^^^^^^^^ @@ -32,107 +19,56 @@ Debian / Ubuntu: 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 python-setuptools - easy_install pip + 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 -------------- +See `Install Server on +Windows `__ -On your server create a config file ``/etc/shadowsocks.json``. Example: +Usage +~~~~~ :: - { - "server":"my_server_ip", - "server_port":8388, - "local_address": "127.0.0.1", - "local_port":1080, - "password":"mypassword", - "timeout":300, - "method":"aes-256-cfb", - "fast_open": false - } - -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 | default: "aes-256-cfb", see `Encryption `__ | -+------------------+-----------------------------------------------------------------------------------------------------------+ -| fast\_open | use `TCP\_FASTOPEN `__, true / false | -+------------------+-----------------------------------------------------------------------------------------------------------+ -| workers | number of workers, available on Unix/Linux | -+------------------+-----------------------------------------------------------------------------------------------------------+ - -On your server: - -To run in the foreground: - -:: - - ssserver -c /etc/shadowsocks.json + ssserver -p 8000 -k password -m rc4-md5 To run in the background: :: - ssserver -c /etc/shadowsocks.json -d start - ssserver -c /etc/shadowsocks.json -d stop - -On your client machine, use the same configuration as your server. Check -the README of your client for more information. + ssserver -p 8000 -k password -m rc4-md5 -d start + ssserver -p 8000 -k password -m rc4-md5 -d stop -Command Line Options --------------------- +Check all the options via ``-h``. You can also use a +`Configuration `__ +file instead. -Check the options via ``-h``.You can use args to override settings from -``config.json``. +Client +------ -:: +- `Windows `__ + / `OS + X `__ +- `Android `__ + / `iOS `__ +- `OpenWRT `__ - sslocal -s server_name -p server_port -l local_port -k password -m bf-cfb - ssserver -p server_port -k password -m bf-cfb --workers 2 - ssserver -c /etc/shadowsocks/config.json -d start --pid-file=/tmp/shadowsocks.pid - ssserver -c /etc/shadowsocks/config.json -d stop --pid-file=/tmp/shadowsocks.pid +Use GUI clients on your local PC/phones. Check the README of your client +for more information. Documentation ------------- -You can find all the documentation in the wiki: -https://github.com/shadowsocks/shadowsocks/wiki +You can find all the documentation in the +`Wiki `__. License ------- @@ -145,7 +81,7 @@ Bugs and Issues - `Troubleshooting `__ - `Issue Tracker `__ -- `Mailing list `__ +- `Mailing list `__ .. |PyPI version| image:: https://img.shields.io/pypi/v/shadowsocks.svg?style=flat :target: https://pypi.python.org/pypi/shadowsocks