https://github.com/dartvauder/ngrokmanager

(Windows/Linux/MacOS) Local GUI for using pyngrok. Translated on 3 languages
https://github.com/dartvauder/ngrokmanager

ngrok ngrok-client ngrok-desktop ngrok-tunnel pyngrok

Last synced: about 2 months ago
JSON representation

(Windows/Linux/MacOS) Local GUI for using pyngrok. Translated on 3 languages

• Host: GitHub
• URL: https://github.com/dartvauder/ngrokmanager
• Owner: Dartvauder
• License: mit
• Created: 2024-11-03T20:53:15.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-11-14T09:19:06.000Z (7 months ago)
• Last Synced: 2025-03-23T22:25:47.305Z (2 months ago)
• Topics: ngrok, ngrok-client, ngrok-desktop, ngrok-tunnel, pyngrok
• Language: Python
• Homepage: https://dartvauder.github.io/NgrokManager/
• Size: 64.5 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md
  • Security: .github/SECURITY.md

Awesome Lists containing this project

README

        
## [Features](/#Features) | [Dependencies](/#Required-Dependencies) | [SystemRequirements](/#Minimum-System-Requirements) | [Install](/#How-to-install) | [Using](/#How-to-use) | [Acknowledgment](/#Acknowledgment-to-developers) 



[![Pylint](https://github.com/Dartvauder/NgrokManager/actions/workflows/pylint.yml/badge.svg)](https://github.com/Dartvauder/NgrokManager/actions/workflows/pylint.yml)

# NgrokManager:



## Description:

A simple interface for easy using pyngrok tunnel port forwarding. Useful if you want to move your localhost to public

## Features:

* Easy installation via install.bat (Windows) or install.sh (Linux & MacOS)

* Available in three languages

* Ngrok settings in Application

* Theme changing

## Required Dependencies:

* [Python](https://www.python.org/downloads/)

* [Git](https://git-scm.com/downloads)

## Minimum System Requirements:

* System: Windows, Linux or MacOS

* GPU: 512MB

* CPU: No requirement

* RAM: 64MB minimum, 128MB recommended

* Disk space: 25MB

* Internet

## How to install:

### Windows

1) First install all [RequiredDependencies](/#Required-Dependencies)

2) `Git clone https://github.com/Dartvauder/NgrokManager.git` to any location

3) Run the `Install.bat` and wait for installation

4) After installation, run `Start.bat`

5) Wait for the application to launch

6) Enjoy!

* To get update, run `Update.bat`

### Linux & MacOS

1) First install all [RequiredDependencies](/#Required-Dependencies)

2) `Git clone https://github.com/Dartvauder/NgrokManager.git` to any location

3) Run the `./Install.sh` and wait for installation

4) After installation, run `./Start.sh`

5) Wait for the application to launch

6) Enjoy!

* To get update, run `./Update.sh`

## How to use:

1) Register using this site [Ngrok](https://ngrok.com)

2) Go to your [dashboard](https://dashboard.ngrok.com/get-started/your-authtoken) and copy your token

3) Paste your token in `ngrok Token`

4) Enter the port you need to tunnel and select your protocol

5) Click `Create Tunnel` button and double-click on the link that appears below

6) To delete a tunnel, select it below and click `Delete Selected Tunnel` button

7) To check the status of your connections, click `Web Inspection Interface` button

### Optional: You can create one free [domain](https://dashboard.ngrok.com/domains) for your tunnel and enter it. For greater security, you can enter your login and password (Not from Ngrok account) to enter your tunnel. You can also choose one of three languages ​​and change the theme and region. Also you can save/load your tunnel config file. 

### If you want to use `SSH Tunnel`:

1. Generate SSH key: `ssh-keygen -t rsa -b 4096 -C "[email protected]"`

2. View your public key: `cat ~/.ssh/id_rsa.pub`

3. Go to [this](https://dashboard.ngrok.com/ssh-keys) and Add New SSH Key

4. Paste your public key and save

5. Now you can use `Create SSH Tunnel` button

## Acknowledgment to developers

#### Many thanks to these projects because thanks to their applications/libraries, i was able to create my application:

First of all, I want to thank the developers of [PyCharm](https://www.jetbrains.com/pycharm/), [GitHub](https://desktop.github.com) and [Ngrok](https://ngrok.com). With the help of their applications, i was able to create and share my code

* `pyngrok` - https://github.com/alexdlaird/pyngrok

* `pyyaml` - https://github.com/yaml/pyyaml/

## Donation

### *If you liked my project and want to donate, here is options to donate. Thank you very much in advance!*

* [!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/Dartvauder)

## Star History

[![Star History Chart](https://api.star-history.com/svg?repos=Dartvauder/NgrokManager&type=Date)](https://star-history.com/#Dartvauder/NgrokManager&Date)