Files
shadowsocks/README.md

64 lines
984 B
Markdown
Raw Normal View History

2012-04-20 06:10:49 -07:00
shadowsocks
2012-04-20 22:26:00 +08:00
===========
2016-01-12 14:22:10 +08:00
[![PyPI version]][PyPI]
[![Build Status]][Travis CI]
[![Coverage Status]][Coverage]
2016-01-12 12:17:11 +08:00
2014-08-03 09:40:12 +08:00
A fast tunnel proxy that helps you bypass firewalls.
2012-04-20 22:26:00 +08:00
2015-08-09 01:33:27 +08:00
Features:
- TCP & UDP support
- User management API
- TCP Fast Open
- Workers and graceful restart
- Destination IP blacklist
2015-01-04 23:27:58 +08:00
Server
------
2012-04-20 22:26:00 +08:00
2015-01-04 23:27:58 +08:00
### Install
2014-06-16 00:52:29 +08:00
2015-01-16 17:06:48 +08:00
Debian / Ubuntu:
2014-05-03 08:19:05 +08:00
2014-10-11 12:42:59 +08:00
apt-get install python-pip
2014-06-01 11:22:57 +08:00
pip install shadowsocks
2014-05-03 08:19:05 +08:00
2015-01-16 17:06:48 +08:00
CentOS:
2014-05-03 08:19:05 +08:00
2015-01-04 23:27:58 +08:00
yum install python-setuptools && easy_install pip
2013-06-22 17:30:31 +08:00
pip install shadowsocks
2014-05-03 08:19:05 +08:00
2015-01-16 17:06:48 +08:00
Windows:
2014-10-08 21:07:05 +08:00
2015-01-04 23:27:58 +08:00
See [Install Server on Windows]
2013-05-22 14:14:37 +08:00
2015-01-04 23:27:58 +08:00
### Usage
2013-05-22 14:14:37 +08:00
ssserver -p 443 -k password -m aes-256-cfb
2012-04-20 22:26:00 +08:00
2014-12-21 14:06:28 +08:00
To run in the background:
2012-12-12 15:19:51 +08:00
sudo ssserver -p 443 -k password -m aes-256-cfb --user nobody -d start
To stop:
sudo ssserver -d stop
To check the log:
sudo less /var/log/shadowsocks.log
2014-06-16 02:14:49 +08:00
2015-01-04 23:22:26 +08:00
Check all the options via `-h`. You can also use a [Configuration] file
instead.
2014-12-21 14:06:28 +08:00
Documentation
-------------
2012-12-30 14:01:41 +08:00
2015-01-04 23:30:29 +08:00
You can find all the documentation in the [Wiki].
2012-12-30 14:01:41 +08:00
2013-06-18 18:52:01 +09:00
License
-------
2015-02-03 14:10:36 +08:00
2015-08-20 18:52:42 +08:00
Apache License