Metadata-Version: 2.1
Name: ng-bot
Version: 1.0.1
Summary: Bot Integrations with various platforms to send latest ngork links
License: MIT
Author: Dhrumil Mistry
Author-email: 56185972+dmdhrumilmistry@users.noreply.github.com
Requires-Python: >=3.8,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: prettytable (>=3.6.0,<4.0.0)
Requires-Dist: pyngrok (>=5.2.1,<6.0.0)
Requires-Dist: pytelegrambotapi (>=4.10.0,<5.0.0)
Requires-Dist: requests (>=2.28.2,<3.0.0)
Description-Content-Type: text/markdown

# Ng-Bot

Ngrok Bot (Ng-Bot) publishes updated ngrok URLs to telegram chat ids and restricts other users to access the bot or on discord using webhook url.

> `Note`: This bot may be used for malicious purposes too. Its upto users how they use this tool/bot. Author is not responsible for user's action in any manner.

## Installation

- Clone repo

  ```bash
  git clone --depth=1 https://github.com/dmdhrumilmistry/ng_bot.git
  ```

- Change directory

  ```bash
  cd ng_bot
  ```

- Install requirements

  ```bash
  python3 -m pip install -r requirements.txt
  ```

## Usage

- Create Ngrok account

- Complete Sign Up process

- Add new AUTH TOKEN from [dashboard](https://dashboard.ngrok.com/get-started/your-authtoken)

- Store variables in `.env` file

  ```bash
  NGROK_AUTH_TOKEN='your_auth_token'
  TELE_BOT_TOKEN='telegram_bot_token'
  ALLOWED_USER_IDS=tele_user_id1, tele_user_id2, tele_user_id3
  DISCORD_WEBHOOK_URL='webhook-url' 
  ```

  > Above variables can also be stored in environment variables

- Start application

  ```bash
  # for telegram
  python3 -m ng_bot --http 8080 --tcp 22 4444 --platform telegram

  # for discord
  python3 -m ng_bot --tcp 22 --platform discord
  ```

