Skip to main content

A fast tunnel proxy that help you get through firewalls

This project has been archived.

The maintainers of this project have marked this project as archived. No new releases are expected.

Project description

PyPI version Build Status

A fast tunnel proxy that help you get through firewalls.

中文说明

Install

Debian / Ubuntu:

apt-get install python-pip python-m2crypto
pip install shadowsocks

CentOS:

yum install m2crypto python-setuptools
easy_install pip
pip install shadowsocks

OS X:

brew install swig
git clone https://github.com/clowwindy/M2Crypto.git
cd M2Crypto
pip install .
pip install shadowsocks

Windows:

Choose a GUI client

Usage

Create a config file /etc/shadowsocks.json (or put it in other path). Example:

{
    "server":"my_server_ip",
    "server_port":8388,
    "local_address": "127.0.0.1",
    "local_port":1080,
    "password":"mypassword",
    "timeout":300,
    "method":"aes-256-cfb",
    "fast_open": false,
    "workers": 1
}

Explanation of the fields:

Name

Explanation

server

the address your server listens

server_port

server port

local_address

the address your local listens

local_port

local port

password

password used for encryption

timeout

in seconds

method

encryption method, “aes-256-cfb” is recommended

fast_open

use TCP_FASTOPEN, true / false

workers

number of workers, available on Unix/Linux

Run ssserver -c /etc/shadowsocks.json on your server. To run it in the background, use Supervisor.

On your client machine, run sslocal -c /etc/shadowsocks.json.

Change the proxy settings in your browser to

protocol: socks5
hostname: 127.0.0.1
port:     your local_port

It’s recommended to use shadowsocks with AutoProxy or Proxy SwitchySharp.

Command line args

You can use args to override settings from config.json.

sslocal -s server_name -p server_port -l local_port -k password -m bf-cfb
ssserver -p server_port -k password -m bf-cfb --workers 2
ssserver -c /etc/shadowsocks/config.json

Wiki

https://github.com/clowwindy/shadowsocks/wiki

License

MIT

Bugs and Issues

Please visit Issue Tracker

Mailing list: http://groups.google.com/group/shadowsocks

Also see Troubleshooting

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

shadowsocks-2.0.5.tar.gz (21.9 kB view details)

Uploaded Source

File details

Details for the file shadowsocks-2.0.5.tar.gz.

File metadata

  • Download URL: shadowsocks-2.0.5.tar.gz
  • Upload date:
  • Size: 21.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for shadowsocks-2.0.5.tar.gz
Algorithm Hash digest
SHA256 a188e3512fc85ad1c75d4b7000562ccdd5e7b8b517c52cddccd3a4da8e10f7fe
MD5 2da718286dd9a96b00b923aedfd50042
BLAKE2b-256 15af59aa40d7ecefe51918fd6d88f7c8cbf1099a619baffc7cab81ac22b9e0f3

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page