Skip to content

panelssh/vpn-gate-api

Repository files navigation

VPN Gate API

Simple access VPN Gate API with heroku/zeit-now/netlfiy and save to firebase firestore.

Deploy with Herku Deploy with ZEIT Now Deploy with Netlify

Prerequisites

Configuration

Installation

yarn

Development

Copy or rename .env.example to .env.

cp .env.example .env

Put your encode base64 text in FIREBASE ENV.

FIREBASE=YOUR_FIREBASE_HAS_ENCODED_WITH_BASE64

Run test with command:

yarn dev

Access with this url localhost:5000

API Endpoint

BASE URL:

  • Heroku: https://[YOUR-HEROKU-APP-NAME].herokuapp.com
  • Zeit Now: https://[YOUR-ZEIT-NOW-APP-NAME].now.sh
  • Netlify: https://[YOUR-NETLIFY-APP-NAME].netlify.com/.netlify/functions
method path query body details
GET / - - count servers and configs.
POST / - - insert or update servers and configs.
DELETE / - - delete servers and configs.
PATCH / - - use delete and insert at once.
GET /insert - - insert or update servers and configs.
GET /delete - - delete servers and configs.
GET /update - - use delete and insert at once.
GET /send-notification title & body - send notification to all users.
POST /send-notification - title & body send notification to all users.

Postman API Docs

Limitations