Giter Site home page Giter Site logo

shadowsocks-zeit's Introduction

shadowsocks-zeit

shadowsocks-zeit is a lightweight tunnel proxy which can help you get through firewalls. It is a port of shadowsocks, but through a different protocol.

shadowsocks-zeit uses WebSocket instead of raw sockets, so it can be deployed on Zeit.

Notice that the protocol is INCOMPATIBLE with the origin shadowsocks.

fork from Shadowsocks-heroku

Zeit

Requirement

  • zeit account, oss free plan is ok
  • docker (optional, I'm use it for client proxy server)
$ yarn global add now
# or $ npm i -g now

Usage

Prepare secret

# For server
# Add secrets it to now account
$ now secrets add ss-method "aes-128-cfb"
$ now secrets add ss-key "YOUR_PASS"

Push the code to Zeit.

$ now

You will get server_ip from output (it's auto copied to your clipboards)

Run client proxy in docker

# For client, you will also need to change dotenv
$ cp sample.env .env
$ vim .env
...
$ cat .env
KEY=YOUR_PASS
METHOD=aes-128-cfb
SERVER_IP=xx.now.sh

# Build image
$ docker-compose -f client-compose.yml build ss

# Run container in background
$ docker-compose -f client-compose.yml up -d

Or run client in node.js

$ cd src
$ yarn # or npm install
$ node local.js -k YOUR_PASS -m aes-128-cfb -s SERVER_IP -l 1080 -r 443

Optional

shadowsocks-zeit's People

Contributors

bigbagboom avatar clowwindy avatar librehat avatar mrluanma avatar olliecheng avatar youngboy avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.