https://github.com/nishanb/piggy-back

Reverse tunnel over web-socket stream to host local services to cloud
https://github.com/nishanb/piggy-back

edge-computing reverse-proxy-server reverse-tunnels sockets tunnel websocket

Last synced: about 1 year ago
JSON representation

Reverse tunnel over web-socket stream to host local services to cloud

• Host: GitHub
• URL: https://github.com/nishanb/piggy-back
• Owner: nishanb
• License: mit
• Created: 2022-08-24T13:23:47.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2024-06-30T17:09:11.000Z (almost 2 years ago)
• Last Synced: 2024-07-03T15:54:52.596Z (almost 2 years ago)
• Topics: edge-computing, reverse-proxy-server, reverse-tunnels, sockets, tunnel, websocket
• Language: JavaScript
• Homepage:
• Size: 101 KB
• Stars: 3
• Watchers: 0
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Piggy Back Tunnel

Piggy Back Tunnel is a reverse TCP tunnel over WebSocket to host local sites in the cloud

## Use Cases

- Make available your local development sites in the cloud.

- Test webhook calls to local sites.

## How it works 

![image](https://user-images.githubusercontent.com/21797317/195246981-b8550e05-bf4c-4d39-a424-42160bd4c2d9.png)

### Demo 

[![Demo](https://img.youtube.com/vi/NZwy95G6xFM/0.jpg)](https://www.youtube.com/watch?v=NZwy95G6xFM)

## Installation

```sh

git clone git@github.com:nishanb/piggy-back.git

npm i

npm i -g

```

## Usage

```sh

# on server side which has public network 

piggyback serve 

# on client side which has private network

piggyback forward -h localhost -p 8090

```

## Contributing

Pull requests are welcome. For significant changes, please open an issue to discuss what you would like to change.