BreakWa11 1ee344220a merge manyuser 2.6.13 2 years ago
debian * still package issue 3 years ago
shadowsocks merge manyuser 2.6.13 2 years ago
tests refine tests 2 years ago
utils Add fail2ban filter. 2 years ago
.gitignore update .gitignore 3 years ago
.travis.yml add udp source port test 2 years ago
CHANGES merge manyuser 2.6.13 2 years ago
CONTRIBUTING.md Update CONTRIBUTING.md 3 years ago
LICENSE license under Apache License v2.0 3 years ago
MANIFEST.in fix MANIFEST.in 3 years ago
README.md Use AES in the Usage example instead of RC4. 3 years ago
README.rst license under Apache License v2.0 3 years ago
setup.py bump 2 years ago

README.md

shadowsocks

PyPI version Build Status Coverage Status

A fast tunnel proxy that helps you bypass firewalls.

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

Copyright 2015 clowwindy

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.

Bugs and Issues