Skip to content

Latest commit

 

History

History
139 lines (85 loc) · 4.22 KB

README.md

File metadata and controls

139 lines (85 loc) · 4.22 KB
Raw

Lite HTTP Tunnel

A tunnel tool to help you expose local web (HTTP/WebSocket) server behind a NAT or firewall to the internet. Inspired by Ngrok and node-http-proxy.

http tunnel

How it work

The tunnel is based on WebSocket. We have a WebSocket connection between the client and server to stream HTTP/WebSocket requests from public server to your local server.

Usage

Deploy at public server

Firstly please deploy this project to your own web host with public internet access. The project is just a Node.js web server based on Express.js. So just deploy as what you do for deploying Node.js web server.

Deploy to Heroku with following button

Deploy To Heroku

Deploy to Render with following button

Deploy to Render

JWT Token generator environment variables

In first deployment, you need to provide JWT_GENERATOR_USERNAME and JWT_GENERATOR_PASSWORD environment variables. We will use those values to auth and get JWT token at client side. After you get JWT Token, you can remove JWT_GENERATOR_USERNAME and JWT_GENERATOR_PASSWORD environment variables to keep safe.

Setup Client

Install client

Please install lite-http-tunnel client in your local computer where it can access your local HTTP server.

$ npm i -g lite-http-tunnel
$ lite-http-tunnel -h

Config remote public server address:

$ lite-http-tunnel config server https://your_web_host_domain

Auth with server:

$ lite-http-tunnel auth $JWT_GENERATOR_USERNAME $JWT_GENERATOR_PASSWORD

Replace $JWT_GENERATOR_USERNAME and $JWT_GENERATOR_PASSWORD with values that you provide at tunnel server

Or With specified profile

$ lite-http-tunnel config server https://your_web_host_domain -p profile1
$ lite-http-tunnel auth $JWT_GENERATOR_USERNAME $JWT_GENERATOR_PASSWORD -p profile1

Start client

$ lite-http-tunnel start your_local_server_port

Please replace your_local_server_port with your local HTTP server port, eg: 8080.

After that you can access your local HTTP server by access your_public_server_domain.

Start with specified profile:

$ lite-http-tunnel start your_local_server_port -p profile1

Change origin to local server:

$ lite-http-tunnel start your_local_server_port -o localhost:5000

Change local server host:

$ lite-http-tunnel start your_local_server_port -h localhost1

Multiple Clients

Use different domains for public server

The server steams web request to WebSocket connection which has same host value in request headers.

So if you have multiple domains for the proxy server, you can have multiple clients based on different domain.

For example, you have https://app1.test.com and https://app2.test.com for this proxy server.

In client 1:

$ lite-http-tunnel config server https://app1.test.com -p profile1
$ lite-http-tunnel start your_local_server_port -p profile1

In client 2:

$ lite-http-tunnel config server https://app2.test.com -p profile2
$ lite-http-tunnel start your_local_server_port -p profile2

Use path prefix

From 0.2.0, it supports to have multiple clients with different path prefix.

In client 1:

$ lite-http-tunnel config path /api_v1
$ lite-http-tunnel start your_local_server_port

In client 2:

$ lite-http-tunnel config path /api_v2
$ lite-http-tunnel start your_local_server_port

With that, requests with path prefix /api_v1 will be streamed to client 1, requests with path prefix /api_v2 will be streamed to client 2

Related

A introduce article: Building a HTTP Tunnel with WebSocket and Node.JS

TODO

  • Add tests