Tgrok

A tunneling service written in TypeScript.

Installation

$ npm i https://github.com/tgrok/tgrok.git

Usage

const { Tgrok } = require("tgrok")

const tgrok = new Tgrok()

tgrok.context = {
  family: 4, // you can speed up your local network connection
  rejectUnauthorized: false, // required if your server is using a self-signed certificate
}

// show debug info
// tgrok.debug = true

// set your ngrok server
tgrok.host = "t.iganxi.net"

// start tgrok on a random subdomain with default port 80
tgrok.start()

// or spcified local port
// tgrok.start(8080)

// or spcified subdomain
// tgrok.start("test")

// or spcified both
// tgrok.start(8080, "test")

Development

$ git clone https://github.com/tgrok/tgrok.git && cd tgrok

# install dependencies
$ npm i

# start development
$ npm run dev

# build
$ npm run build

Todo

• [ ] add tests
• [ ] tcp support
• [ ] https support
• [ ] logging system