Giter Club home page Giter Club logo

paas-vpn's Introduction

PaaS VPN

Easily spin up an ephemeral VPN on Paas via Docker using tailscale under the hood


Disclaimer:

NEITHER me NOR this project shall be in any way held responsible if YOUR ACCOUNT gets banned. It is YOUR sole reponsibility to use this project in whatever way you may want. However I totally recommend AGAINST ABUSING these services with excessive usage.

Prerequisites:

  • Any PaaS with Docker image support (whether building from GitHub repositories or public docker images)
  • Free Tailscale account

Pre Deployment Guide:

  1. Signup on Tailscale.

    1 2

  2. Connect atleast one device following the tailscale Introduction guide.

    3

  3. Go to the Access Controls tab and save the following JSON into Edit file section, replacing email with the email shown in Users tab (if you use GitHub login, then it will be different. Please keep that in mind).

    {
        "acls": [
          { "action": "accept", "src": ["*"], "dst": ["*:*"] },
        ],
        "tagOwners": {
          "tag:vpn": ["email"],
        },
        "autoApprovers": {
          "exitNode": ["tag:vpn"],
        }
    }

    4 7

  4. Go to Keys section in Settings tab and generate an auth key. Paste this key into the auth key variable when asked for. Also save it for future use.

    5 6

Deployment:

  1. Point your PaaS deployment to this GitHub repo (or fork it if needed) or this public docker image paasvpn/paasvpn.
  2. Set these environment variables.

TAILSCALE_AUTHKEY: Your auth key

HOSTNAME: Unique identifier for the VPN instance, do not use any spaces (you can fill some random string here)

PORT (Optional): Port for the front-end web interface. If you're not sure, try not using this first. If it doesn't work, try using 8080 port.

Post Deployment guide:

  1. Open tailscale client on the device you want to use VPN. (Guide shows for android)

    A

  2. Connect your client to tailscale.

  3. Tap Use exit node and select the correct online machine after checking in tailscale dashboard

    B C

  4. VPN should start working.

    D

Notes:

  • Make sure, you have followed the steps as precisely as possible.
  • Tailscale is a great tool in itself with extensive documention, make sure to try it.

Credit:

  • Mishizu for the original repository

paas-vpn's People

Contributors

x0rzavi avatar devolart avatar mrxaravind 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.