Metadata-Version: 1.1
Name: nbsocks
Version: 2.9.1
Summary: A fast tunnel proxy that help you get through firewalls
Home-page: https://github.com/shadowsocks/shadowsocks
Author: clowwindy
Author-email: clowwindy42@gmail.com
License: http://www.apache.org/licenses/LICENSE-2.0
Description: 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

        ===========

        

        |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 <https://github.com/shadowsocks/shadowsocks/wiki/Install-Shadowsocks-Server-on-Windows>`__

        

        Usage

        ~~~~~

        

        ::

        

            ssserver -p 443 -k password -m rc4-md5

        

        To run in the background:

        

        ::

        

            sudo ssserver -p 443 -k password -m rc4-md5 --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 <https://github.com/shadowsocks/shadowsocks/wiki/Configuration-via-Config-File>`__

        file instead.

        

        Client

        ------

        

        -  `Windows <https://github.com/shadowsocks/shadowsocks/wiki/Ports-and-Clients#windows>`__

           / `OS

           X <https://github.com/shadowsocks/shadowsocks-iOS/wiki/Shadowsocks-for-OSX-Help>`__

        -  `Android <https://github.com/shadowsocks/shadowsocks/wiki/Ports-and-Clients#android>`__

           / `iOS <https://github.com/shadowsocks/shadowsocks-iOS/wiki/Help>`__

        -  `OpenWRT <https://github.com/shadowsocks/openwrt-shadowsocks>`__

        

        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 <https://github.com/shadowsocks/shadowsocks/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 <https://github.com/shadowsocks/shadowsocks/wiki/Troubleshooting>`__

        -  `Issue

           Tracker <https://github.com/shadowsocks/shadowsocks/issues?state=open>`__

        -  `Mailing list <https://groups.google.com/group/shadowsocks>`__

        

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

           :target: https://pypi.python.org/pypi/shadowsocks

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

           :target: https://travis-ci.org/shadowsocks/shadowsocks

        .. |Coverage Status| image:: https://jenkins.shadowvpn.org/result/shadowsocks

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

        
Platform: UNKNOWN
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Internet :: Proxy Servers
