onyas/ggrok

WebSocket based reverse proxy

Introduction

Usage

Server side

1. Fork and clone this repo
2. Deploy to heroku

   //create app in heroku
   heroku create
   //deploy your app to heroku
   git push heroku main
   

or you can deploy with Heroku with Deploy To Heroku button below:

Client side

Go to the release page to download the installation package. After installation, execute the following command:

ggrok -proxyServer yourProxyServer.herokuapp.com

ggrok -port 3000

Now your local server is exposed to the internet, you can visit it by https://yourProxyServer.herokuapp.com

Useful docs

• Architecture of ggrok
• Introduction about ggrok
• How to run this project locally
• How to debug concurrent issues
• Useful Heroku command
• How to publish a new release