A fast tunnel proxy that helps you bypass firewalls. regulation cause this repo to get truncated, but there is still some history there. And tags.

Go to file

mengskysama 34851fbcb3 readme		2015-10-26 10:48:52 +08:00
debian	* still package issue	2014-08-25 12:30:23 +08:00
shadowsocks	fix memory leak!	2015-10-26 09:45:02 +08:00
tests	skip graceful restart test on Jenkins	2015-08-02 17:33:13 +08:00
utils	Add fail2ban filter.	2015-06-21 00:56:55 +08:00
.gitignore	update .gitignore	2015-01-28 17:17:05 +08:00
.travis.yml	add udp source port test	2015-07-10 15:56:27 +08:00
CHANGES	update CHANGES	2015-08-10 12:37:42 +08:00
CONTRIBUTING.md	Update CONTRIBUTING.md	2015-08-06 17:24:51 +08:00
LICENSE	license under Apache License v2.0	2015-02-03 14:10:36 +08:00
MANIFEST.in	fix MANIFEST.in	2015-01-21 14:32:55 +08:00
README.md	readme	2015-10-26 10:48:52 +08:00
README.rst	readme	2015-10-26 10:48:52 +08:00
setup.py	update CHANGES	2015-08-10 12:37:42 +08:00

README.md

About shadowsocks-rm

This project is https://github.com/shadowsocks/shadowsocks clone. I JUST fix bug on the original code. Unless it is necessary to have additional features.

shadowsocks

A fast tunnel proxy that helps you bypass firewalls.

Features:

TCP & UDP support
User management API
TCP Fast Open
Workers and graceful restart
Destination IP blacklist

Server

Install

Debian / Ubuntu:

apt-get install python-pip
pip install shadowsocks

CentOS:

yum install python-setuptools && easy_install pip
pip install shadowsocks

Windows:

See Install Server on Windows

Usage

ssserver -p 443 -k password -m aes-256-cfb

To run in the background:

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

Check all the options via -h. You can also use a Configuration file instead.

Client

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.

License

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.