Skip to content

How to use

0xp0is0n edited this page Jan 15, 2023 · 1 revision

Dynamic Ngrok is a command line interface that ensure your port forwarding will up and work without an issue.

  • It ensure that ngrok generated url always pointed to your custom alias.
  • It ensure that it will recover from any intermittent failures like connectivity issues.
  • It ensure reliability of system.
  • Lot of service can be build on top of this.

First time installation:

  • Set up ngrok manually. It can be done using python3 main.py --ngrok_auth_token <auth-token>
  • Get api key from cut.ly. Because we are using cut.ly for our purposes.
  • Generate Ngrok API secret. NOTE: NGROK API secret is different from NGROK AUTH-TOKEN. NGROK API secret is use to authenticate api and NGROK auth-token is used to access establish a successful tunnel/port forwarding on behealf of particular user account.

Configurations: (path: /properties/config.ini)

NGROK_API_SECRET = <NGROK API SECRET>
NGROK_TUNNEL_ENDPOINT = https://api.ngrok.com/tunnels # it's tunnel
CUTTLY_SECRET = <CUTTLY API SECRET>
CUTTLY_API_ENDPOINT = http://cutt.ly/api/api.php
CUTTLY_DOMAIN = https://cutt.ly/
ALIAS = test123  # <Custom alias: it will look like -> https://cutt.ly/test123>
BINARY_PATH = ./ngrok
PROTOCOL_PORT = ["http","456"] # set your protocol and port you want to forward. Protocol is always tcp or http.

Installation:

git clone ... url...
pip3 install -r requirements.txt
python3 main.py