Skip to content

Commit 6e2591a

Browse files
authored
Update README.md
1 parent aafaae3 commit 6e2591a

File tree

1 file changed

+22
-2
lines changed

1 file changed

+22
-2
lines changed

README.md

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,19 @@
1+
## [Features](/#Features) | [Dependencies](/#Required-Dependencies) | [SystemRequirements](/#Minimum-System-Requirements) | [Install](/#How-to-install) | [Using](/#How-to-use) | [Acknowledgment](/#Acknowledgment-to-developers)
2+
13
# NgrokManager:
24

35
<img width="236" alt="1" src="https://github.com/user-attachments/assets/bfb1a52d-16c4-4f51-9cf8-b468e615c25b">
46

57
## Description:
68

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

911
## Features:
1012

1113
* Easy installation via install.bat (Windows) or install.sh (Linux & MacOS)
14+
* Available in three languages
15+
* Ngrok settings in Application
16+
* Theme changing
1217

1318
## Required Dependencies:
1419

@@ -18,6 +23,10 @@ A simple interface for using pyngrok
1823
## Minimum System Requirements:
1924

2025
* System: Windows, Linux or MacOS
26+
* GPU: 512MB
27+
* CPU: No requirement
28+
* RAM: 64MB minimum, 128MB recommended
29+
* Disk space: 25MB
2130
* Internet
2231

2332
## How to install:
@@ -44,11 +53,22 @@ A simple interface for using pyngrok
4453

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

56+
## How to use:
57+
58+
1) Register using this site [Ngrok](https://ngrok.com)
59+
2) Go to your [dashboard](https://dashboard.ngrok.com/get-started/your-authtoken) and copy your token
60+
3) Paste your token in `ngrok Token`
61+
4) Enter the port you need to tunnel and select your protocol
62+
5) Click `Create Tunnel` button and double-click on the link that appears below
63+
6) To delete a tunnel, select it below and click `Delete Selected Tunnel` button
64+
65+
### 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 to enter your tunnel. You can also choose one of three languages ​​and change the theme
66+
4767
## Acknowledgment to developers
4868

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

51-
First of all, I want to thank the developers of [PyCharm](https://www.jetbrains.com/pycharm/) and [GitHub](https://desktop.github.com). With the help of their applications, i was able to create and share my code
71+
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
5272

5373
* `pyngrok` - https://github.com/alexdlaird/pyngrok
5474
* `pyyaml` - https://github.com/yaml/pyyaml/

0 commit comments

Comments
 (0)