Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/Long-live-shadowsocks/shadowsocks

Last synced: 5 days ago
JSON representation

Host: GitHub
URL: https://github.com/Long-live-shadowsocks/shadowsocks
Owner: Long-live-shadowsocks
License: apache-2.0
Fork: true (shadowsocks-backup/shadowsocks)
Created: 2015-08-22T04:33:46.000Z (about 9 years ago)
Default Branch: master
Last Pushed: 2015-09-08T09:59:44.000Z (about 9 years ago)
Last Synced: 2024-08-02T22:22:16.377Z (3 months ago)
Language: Python
Homepage:
Size: 1.15 MB
Stars: 725
Watchers: 64
Forks: 553
Open Issues: 1
Metadata Files:
- Readme: README.md
- Changelog: CHANGES
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

README

        shadowsocks

===========

[![PyPI version]][PyPI]

[![Build Status]][Travis CI]

[![Coverage Status]][Coverage]

[中文说明]

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

------

* [Windows] / [OS X]

* [Android] / [iOS]

* [OpenWRT]

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

----------------

* [Troubleshooting]

* [Issue Tracker]

* [Mailing list]

[Android]:           https://github.com/Long-live-shadowsocks/shadowsocks-android

[Build Status]:      https://img.shields.io/travis/shadowsocks/shadowsocks/master.svg?style=flat

[bypass firewalls]:  https://github.com/Long-live-shadowsocks/shadowsocks/wiki/Objective

[Configuration]:     https://github.com/Long-live-shadowsocks/shadowsocks/wiki/Configuration-via-Config-File

[Coverage Status]:   https://jenkins.shadowvpn.org/result/shadowsocks

[Coverage]:          https://jenkins.shadowvpn.org/job/Shadowsocks/ws/PYENV/py34/label/linux/htmlcov/index.html

[Debian sid]:        https://packages.debian.org/unstable/python/shadowsocks

[iOS]:               https://github.com/Long-live-shadowsocks/shadowsocks-iOS

[Issue Tracker]:     https://github.com/Long-live-shadowsocks/shadowsocks/issues?state=open

[Install Server on Windows]: https://github.com/Long-live-shadowsocks/shadowsocks/wiki/Install-Shadowsocks-Server-on-Windows

[Mailing list]:      https://groups.google.com/group/shadowsocks

[OpenWRT]:           https://github.com/Long-live-shadowsocks/openwrt-shadowsocks

[OS X]:              https://github.com/Long-live-shadowsocks/shadowsocks-iOS

[PyPI]:              https://pypi.python.org/pypi/shadowsocks

[PyPI version]:      https://img.shields.io/pypi/v/shadowsocks.svg?style=flat

[Travis CI]:         https://travis-ci.org/shadowsocks/shadowsocks

[Troubleshooting]:   https://github.com/Long-live-shadowsocks/shadowsocks/wiki/Troubleshooting

[Wiki]:              https://github.com/Long-live-shadowsocks/shadowsocks/wiki

[Windows]:           https://github.com/Long-live-shadowsocks/shadowsocks-windows

[中文说明]:          https://github.com/Long-live-shadowsocks/shadowsocks/wiki/Shadowsocks-%E4%BD%BF%E7%94%A8%E8%AF%B4%E6%98%8E