Skip to content
This repository has been archived by the owner on Feb 27, 2024. It is now read-only.

entvex/NgrokGUI

Repository files navigation

No longer maintained

Contributors Forks Stargazers Issues MIT License


Logo

NgrokGUI

NgrokGUI is a windows GUI for ngrok

Report Bug · Request Feature

Table of Contents

  1. About The Project
  2. Features
  3. Getting Started
  4. Usage
  5. Roadmap
  6. Contributing
  7. License
  8. Contact
  9. Acknowledgements

About The Project

NgrokGUI is a windows GUI for ngrok. It helps download ngrok, getting it ready for first time use and managing tunnels. The idea for the project arose due to friends wanting a gui to ngrok that was more user friendly. I later found a Dungeons & Dragons community that uses Foundryvtt to run their games. NgrokGUI allows an easy way for the dungeon master to host the game without spending additional money on hosting or messing with port forwarding.

Features

  • Create tunnels for http https and tcp protocols.
  • Downloads Ngrok automatically.
  • Start and stop tunnels.
  • Remembers previous created tunnels.
  • Support for paid Ngrok account features
    • Create tunnel with subdomain
    • Create tunnels on custom branded domains

Built With

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

Installation

  1. Go to the releases section.
  2. Download the latest NgrokGUI.exe and place it were you would like to keep it.
  3. Run the NgrokGUI.exe and follow the First Time Wizard on screen.

Usage

This example will show how to use NgrokGUI to share a Foundryvtt session.

  1. Make sure NgrokGUI is started and the First Time Wizard is complete.
  2. Click the File button in the upper left and click New to open the Add New Tunnel window.
  3. Enter a name such as Foundryvtt and make sure the Protocol https is selected. Foundryvtts default port is 30000 add that to the Local port field.
  4. Click the Add new tunnel button.
  5. In the main window right click the tunnel with your chosen name and click copy link to share it with the people who need access.

ShowCaseOfStep1to4

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated. But first please read this.

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Project Link: https://github.com/entvex/NgrokGUI

Acknowledgements

Thanks to these

About

NgrokGUI is a windows GUI for ngrok. It helps download ngrok, getting it ready for first time use and managing tunnels.

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Sponsor this project

Languages