entvex / ngrokgui Goto Github PK

View Code? Open in Web Editor NEW

34.0 4.0 7.0 256 KB

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

License: MIT License

C# 100.00%

ngrok-client wpf-application csharp

ngrokgui's Introduction

No longer maintained

NgrokGUI

NgrokGUI is a windows GUI for ngrok

Report Bug · Request Feature

About The Project
Features
Getting Started
- Prerequisites
- Download and use
Usage
Roadmap
Contributing
License
Contact
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

NgrokSharp

Getting Started

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

Prerequisites

Windows 7 or Later
.NET 6.0 x64 or later
Ngrok authtoken

Installation

Go to the releases section.
Download the latest NgrokGUI.exe and place it were you would like to keep it.
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.

Make sure NgrokGUI is started and the First Time Wizard is complete.
Click the File button in the upper left and click New to open the Add New Tunnel window.
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.
Click the Add new tunnel button.
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.

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

ngrokgui's People

Contributors

Stargazers

Watchers

Forkers

wildani31 jfatty 5l1v3r1 pawnstorm0x

ngrokgui's Issues

downloading ngrok not working

the first step ngrok download don't work

Crash without warning, if ngrok account is created but not validated

Describe the bug
THe app crashes without warning, on saving a new connection, if the access token has been entered, from the ngrok website, but the account has not been validated via the link in the email.

To Reproduce
Steps to reproduce the behavior:

install this app
create a ngrok account
do NOT validate the new email address with the ngrok account
add the ngrok access token to this app.
create a connection within this app.

Expected behavior
Not to crash.

Desktop (please complete the following information):

OS: Windows 10, WIndows 11
Version: NgrokGUI 1.0.3

Serialize tunnels, so previously created tunnels, stay in list between restarts.

So previously created tunnels, stay in list between restarts.
This should make it easier for users to reuse tunnels that have been created before.

Installer crash

Today's release, downloaded exe, get attached error on start (normal or RunAs Administrator)

Windows 10
16GB
Ryzen 5

Trigger on tunnel created, for external programs

After a tunnel has been created, there should be some kind of triggering to "tell the external programs, that now a new tunnel has been made". The trigger could be a http post or any kind of triggering could work, so other integrations can be done by simple scripting.

Please see issue #1 for the original feature request.

Easier recreate tunnels with previously entered data.

As a user when you go into the "new tunnel" and fills the information. It would nice that there is a way to save the details. So next time the user want to create the tunnel again with previously entered data, thereby making it easier to create again.

See #1 for the original feature request.

The status bar should display, what data center you are connected to.

Add subdomain option

thank you for nice app.
please add subdomain option like:
ngrok http -subdomain domainName 80

thank you,

Doesn't work anymore

Describe the bug
NgrokGUI Crashes upon creating a new tunnel

To Reproduce
Steps to reproduce the behavior:
Create a new tunnel

Expected behavior
It should work

Desktop

OS: Windows 11
Version 1.0.3

Warn users about the 2 hour limits, if no token

Start NgrokGUI with windows

Make a setting for NgrokGUI, that allows users to run the program on startup.

See #1 for the original feature request.

Allow the user to select tunnel exit country

Allow the user to select tunnel exit country
us - United States (Ohio)
eu - Europe (Frankfurt)
ap - Asia/Pacific (Singapore)
au - Australia (Sydney)
sa - South America (Sao Paulo)
jp - Japan (Tokyo)
in - India (Mumbai)
https://ngrok.com/docs#global-locations
NgrokSharp has support for this, GUI work is only needed

Redesign "first time wizard"

Custom domain support

This is a great tool, but currently of no use to me. I have a paid ngrok account and do not use subdomains, but rather custom domains
i.e. bninding a tunnel to a fully qualified domain name that I control like "web.maydomain.com"

https://ngrok.com/docs/guides/how-to-set-up-a-custom-domain

Please add support for custom domains - its just another command-line switch like "ngrok http[s] -hostname=foo.example.com [port]".

feature request

store port and protocol records
publish generated URL by a restful call
auto start on windows start

Make NgrokGUI cross platform.

I am making NgrokGUI cross platform using avaloniaui. Because there was wishes for this from reddit users. See the V2 and V3 branches.

Starting the GUI from Command Prompt

Describe the bug
Starting ngrokGUI.exe works fine like normal, but when starting it from cmd it throws an error instead. It's the only time it throws this error and doesn't want to open.