2012-04-20 13:10:49 +00:00
|
|
|
shadowsocks
|
2012-04-20 14:26:00 +00:00
|
|
|
===========
|
|
|
|
|
|
2016-01-12 06:22:10 +00:00
|
|
|
[![PyPI version]][PyPI]
|
|
|
|
|
[![Build Status]][Travis CI]
|
|
|
|
|
[![Coverage Status]][Coverage]
|
2016-01-12 04:17:11 +00:00
|
|
|
|
2014-08-03 01:40:12 +00:00
|
|
|
A fast tunnel proxy that helps you bypass firewalls.
|
2012-04-20 14:26:00 +00:00
|
|
|
|
2015-08-08 17:33:27 +00:00
|
|
|
Features:
|
|
|
|
|
- TCP & UDP support
|
|
|
|
|
- User management API
|
|
|
|
|
- TCP Fast Open
|
|
|
|
|
- Workers and graceful restart
|
|
|
|
|
- Destination IP blacklist
|
|
|
|
|
|
2015-01-04 15:27:58 +00:00
|
|
|
Server
|
|
|
|
|
------
|
2012-04-20 14:26:00 +00:00
|
|
|
|
2015-01-04 15:27:58 +00:00
|
|
|
### Install
|
2014-06-15 16:52:29 +00:00
|
|
|
|
2015-01-16 09:06:48 +00:00
|
|
|
Debian / Ubuntu:
|
2014-05-03 00:19:05 +00:00
|
|
|
|
2014-10-11 04:42:59 +00:00
|
|
|
apt-get install python-pip
|
2017-03-02 13:28:16 +00:00
|
|
|
pip install git+https://github.com/shadowsocks/shadowsocks.git@master
|
2014-05-03 00:19:05 +00:00
|
|
|
|
2015-01-16 09:06:48 +00:00
|
|
|
CentOS:
|
2014-05-03 00:19:05 +00:00
|
|
|
|
2015-01-04 15:27:58 +00:00
|
|
|
yum install python-setuptools && easy_install pip
|
2017-03-02 13:28:16 +00:00
|
|
|
pip install git+https://github.com/shadowsocks/shadowsocks.git@master
|
2014-05-03 00:19:05 +00:00
|
|
|
|
2015-01-16 09:06:48 +00:00
|
|
|
Windows:
|
2014-10-08 13:07:05 +00:00
|
|
|
|
2017-01-02 06:56:25 +00:00
|
|
|
See [Install Shadowsocks Server on Windows](https://github.com/shadowsocks/shadowsocks/wiki/Install-Shadowsocks-Server-on-Windows).
|
2013-05-22 06:14:37 +00:00
|
|
|
|
2015-01-04 15:27:58 +00:00
|
|
|
### Usage
|
2013-05-22 06:14:37 +00:00
|
|
|
|
2015-02-15 04:33:40 +00:00
|
|
|
ssserver -p 443 -k password -m aes-256-cfb
|
2012-04-20 14:26:00 +00:00
|
|
|
|
2014-12-21 06:06:28 +00:00
|
|
|
To run in the background:
|
2012-12-12 07:19:51 +00:00
|
|
|
|
2015-02-15 04:33:40 +00:00
|
|
|
sudo ssserver -p 443 -k password -m aes-256-cfb --user nobody -d start
|
2015-02-02 07:46:22 +00:00
|
|
|
|
|
|
|
|
To stop:
|
|
|
|
|
|
|
|
|
|
sudo ssserver -d stop
|
|
|
|
|
|
|
|
|
|
To check the log:
|
|
|
|
|
|
|
|
|
|
sudo less /var/log/shadowsocks.log
|
2014-06-15 18:14:49 +00:00
|
|
|
|
2015-01-04 15:22:26 +00:00
|
|
|
Check all the options via `-h`. You can also use a [Configuration] file
|
|
|
|
|
instead.
|
|
|
|
|
|
2016-11-20 07:22:17 +00:00
|
|
|
### Usage with Config File
|
|
|
|
|
|
|
|
|
|
[Create configeration file and run](https://github.com/shadowsocks/shadowsocks/wiki/Configuration-via-Config-File)
|
|
|
|
|
|
|
|
|
|
To start:
|
|
|
|
|
|
|
|
|
|
ssserver -c /etc/shadowsocks.json
|
|
|
|
|
|
|
|
|
|
|
2014-12-21 06:06:28 +00:00
|
|
|
Documentation
|
|
|
|
|
-------------
|
2012-12-30 06:01:41 +00:00
|
|
|
|
2017-01-02 06:56:25 +00:00
|
|
|
You can find all the documentation in the [Wiki](https://github.com/shadowsocks/shadowsocks/wiki).
|
2012-12-30 06:01:41 +00:00
|
|
|
|
2013-06-18 09:52:01 +00:00
|
|
|
License
|
|
|
|
|
-------
|
2015-02-03 06:10:36 +00:00
|
|
|
|
2015-08-20 10:52:42 +00:00
|
|
|
Apache License
|
2016-01-12 06:38:10 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
[Build Status]: https://img.shields.io/travis/shadowsocks/shadowsocks/master.svg?style=flat
|
|
|
|
|
[Coverage Status]: https://jenkins.shadowvpn.org/result/shadowsocks
|
|
|
|
|
[Coverage]: https://jenkins.shadowvpn.org/job/Shadowsocks/ws/PYENV/py34/label/linux/htmlcov/index.html
|
|
|
|
|
[PyPI]: https://pypi.python.org/pypi/shadowsocks
|
|
|
|
|
[PyPI version]: https://img.shields.io/pypi/v/shadowsocks.svg?style=flat
|
|
|
|
|
[Travis CI]: https://travis-ci.org/shadowsocks/shadowsocks
|
|
|
|
|
|
