Giter Club home page Giter Club logo

pangolin's Introduction

logo Pangolin

Pangolin is a Go implenmentation of VPN.

  • Support TCP/UDP/PTCP connection. (I suggest PTCP, which has the same performance with UDP and avoid some UDP issues)
  • For PTCP/TCP, it supports multi-user authentication, encryption transmission. For UDP, no authentication.
  • Using Docker/VM, it supports Linux/Windows/Mac.
  • For client, it supports Linux/Windows/Android now.

Server

Pangolin server can only run natively on Linux. But you can use docker to run it on Windows and Mac.

  • Download the latest release package and cd pangolin_linux/

  • Change the environment variables in start.sh to your own.

SERVERIP=0.0.0.0
SERVERPORT=12345
TOKENS='["token01", "token02"]'
ROLE=SERVER
  • Start the pangolin server: bash start.sh

Client

Linux

Same steps with the server. But ROLE=CLIENT.

SERVERIP=your.server.ip.address
SERVERPORT=12345
TOKENS='["token01", "token02"]'
ROLE=CLIENT

Windows

Windows Client

Android

Android Client

Docker

Build

  • cd pangolin/docker
  • Change the variables in pangolin_docker.sh
SOURCE_DIR="../"
SERVERIP="0.0.0.0"
SERVERPORT="12345"
TOKENS='["token01", "token02"]'
ROLE="SERVER"
  • Build: bash pangolin_docker.sh build

Start/Stop

bash pangolin_docker.sh start
bash pangolin_docker.sh stop

Status

This project is still in progress and you can contribute to it. Anything is welcome !

  • Mac/iOS client
  • Improve Android client
  • Add UT/Doc

pangolin's People

Contributors

audibleblink avatar xitongsys avatar

Stargazers

 avatar

Watchers

 avatar  avatar

Forkers

avboy1337

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.