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
Shell.Xu e332ec93e9 use list instead of string, prevent injection attack. (#1009)
* fix issue:
https://github.com/shadowsocks/shadowsocks/issues/995
Command Execution

use list instead of string, prevent injection attack.
2018-02-19 10:42:32 +08:00
debian new debian package (#659) 2016-11-20 15:29:11 +08:00
shadowsocks update run_method() (#1161) 2018-02-19 01:08:52 +08:00
tests update run_method() (#1161) 2018-02-19 01:08:52 +08:00
utils use list instead of string, prevent injection attack. (#1009) 2018-02-19 10:42:32 +08:00
.gitignore Add AEAD ciphers support (#775) 2017-03-04 14:37:29 +08:00
.travis.yml Update .travis.yml 2017-09-06 15:19:45 +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
Dockerfile Dockfile add libsodium (#601) 2016-08-23 22:00:32 +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 Update README.md (#1042) 2018-02-19 01:22:57 +08:00
README.rst readme 2015-10-26 10:48:52 +08:00
config.json.example Add mbedtls wrapper, custom crypto lib path, test files (#803) 2017-04-29 14:27:55 +08:00
setup.py Add AEAD ciphers support (#775) 2017-03-04 14:37:29 +08:00
snapcraft.yaml Add new file snapcraft.yaml for building snap package (#932) 2017-09-06 15:13:39 +08:00

README.md

shadowsocks

PyPI version Build Status

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 git+https://github.com/shadowsocks/shadowsocks.git@master

CentOS:

yum install python-setuptools && easy_install pip
pip install git+https://github.com/shadowsocks/shadowsocks.git@master

For CentOS 7, if you need AEAD ciphers, you need install libsodium

dnf install libsodium python34-pip
pip3 install  git+https://github.com/shadowsocks/shadowsocks.git@master

Linux distributions with snap:

snap install shadowsocks

Windows:

See Install Shadowsocks 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.

If you installed the snap package, you have to prefix the commands with shadowsocks., like this:

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

Usage with Config File

Create configuration file and run

To start:

ssserver -c /etc/shadowsocks.json

Documentation

You can find all the documentation in the Wiki.

License

Apache License