Git Product home page Git Product logo

py-port-forwarder's Introduction

Ngrok Port Forwarder

Forward a local port to a public URL using Ngrok.

Overview

This project provides a Python script to forward a local port to a public URL using Ngrok. It allows developers to expose their local development environment to the world with ease.

Features

  • Port Forwarding: Forward a local port to a public URL using Ngrok.
  • Protocol Support: Supports TCP and UDP protocols.
  • Optional Settings: Optional authtoken, region, and binary path settings for customization.
  • Rich Console Interface: Rich console interface for easy use.

TODO:

  • Add Support for Multiple Protocols: Implement support for multiple protocols simultaneously.

Usage

Installation

  1. Clone the repository:
git clone https://github.com/real0x0a1/ngrok-port-forwarder.git
  1. Install dependencies:
pip3 install -r requirements.txt

Usage

  1. Run the script main.py:
python3 main.py
  1. Follow the prompts to enter the port, protocol, and optional settings.

Configuration

You can set the following environment variables to customize the script:

  • NGROK_AUTHTOKEN: your Ngrok authtoken
  • NGROK_REGION: the Ngrok region to use (e.g. us, eu, etc.)
  • NGROK_BINARY_PATH: the path to the Ngrok binary

Acknowledgements

Contributing

Contributions are welcome! Fork the repository and submit a pull request.

Issues

Please open an issue on the GitHub repository for any bugs or feature requests.

Author

real0x0a1 (Ali)


py-port-forwarder's People

Contributors

real0x0a1 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.