Giter Club home page Giter Club logo

cloudflare-usenet-bot's Introduction

⚠️ Disclaimer: This repository is incomplete and its usage is not yet recommended. ⚠️

Telegram Usenet Bot with Cloudflare Workers

GitHub stars GitHub forks GitHub issues GitHub pull requests GitHub contributors

This Telegram bot facilitates downloading NZB files from Usenet using either SABnzbd or NZBGet, and enables searching across multiple indexers through NZBHydra API. Additionally, it automatically uploads downloaded files to Google Drive. This bot is hosted on Cloudflare Workers using webhooks and utilizes the Telegram RAW API for communication.

Things to Know Before Using This Repo

Before diving into using this repository, here are a few essential points to keep in mind:

Cloudflare Workers Limitations:

  • Workers have limitations:

    • Cloudflare Workers have certain limitations, one of which is the inability to fetch direct IPs.
    • Therefore, it's necessary to connect a domain to your server's IP using proxy services such as Nginx, Apache, etc.
  • Telegram Webhook Limitations

    • add later

Features

  • NZB Downloading: Utilizes SABnzbd or NZBGet to download NZB files from Usenet.
  • Indexer Search: Integrated with NZBHydra API to search across multiple indexers simultaneously.
  • Google Drive Upload: Automatically uploads downloaded files to Google Drive for convenient access.
  • Cloudflare Workers Hosting: Hosted on Cloudflare Workers, ensuring reliable performance and scalability.
  • Telegram RAW API: Employs Telegram RAW API for efficient communication with Telegram users.

Setup Instructions

  1. Cloudflare Workers Setup

    • Clone this repository.
    • Configure your Cloudflare Workers account and set up a new worker.
    • Deploy the code to your Cloudflare Worker.
  2. Telegram Bot Setup

    • Create a new Telegram bot using BotFather.
    • Set up a webhook for the bot using Cloudflare Workers URL.
    • Obtain the bot token.
  3. Configuration

    • Configure the bot settings including Usenet download client (SABnzbd/NZBGet), NZBHydra API key, Google Drive credentials, etc., in the config.js file.
  4. Deployment

    • Deploy the updated code to your Cloudflare Worker.
  5. Usage

    • Start using the bot by interacting with it in your Telegram account.
    • Use commands to search for NZB files, initiate downloads, and manage files.

Commands

  • /search [query]: Search for NZB files across all indexers.
  • /grab [NZB ID]: Add an NZB file for download.
  • /grab [Reply to a NZB File]: Add an NZB file for download.
  • /status: List current downloads.
  • /cancel [NZB ID]: Cancel a download.
  • /status [download_id]: Get the status of a download.
  • /help: Display help information.

Contributors

License

This project is licensed under the MIT License.

Disclaimer

This project is provided as-is without any warranties or guarantees. Use at your own risk.

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.