Code Monkey home page Code Monkey logo

jackett2telegram's Introduction

Jackett RSS to Telegram Bot logo

GitHub release (latest by date) Build License Docker Pulls

Tip Me via PayPal Sponsor Me via GitHub

Jackett RSS to Telegram Bot

A self-hosted Telegram Python Bot that dumps posts from Jackett RSS feeds to a Telegram chat. Based on RSS to Telegram bot by BoKKeR (Thanks for your effort).

Image of the chat

Requirements

A Telegram Bot is needed that the script will connect to.

You could use this post to create your own with the BotFather Telegram Bot.

Warning! Without chatID the bot wont be able to send automated messages and will only be able to respond to messages.

Docker Installation

$ docker create \
  --name=jackett2telegram \
  -e DELAY=600 \
  -e TOKEN=<your_telegram_bot_token> \
  -e CHATID=<your_telegram_bot_chatid> \
  -v </path/to/host/config>:/app/config \
  -v </path/to/host/blackhole>:/app/blackhole \
  --restart unless-stopped \
  danimart1991/jackett2telegram

You could include -e LOG_LEVEL=<log_level> where <log_level> must be critical, error, warning, info (default) or debug.

Manual Installation

Python 3.X

  1. Clone the script

  2. Install depedencies with:

    pip install -r requirements.txt
  3. Replace your ChatID and Token on the top of the script.

  4. Edit the delay (seconds).

  5. Run the script with:

    python jackett2telegram.py

Usage

Send /help command to the bot to get this message:

Jackett2Telegram (Jackett RSS to Telegram Bot)

After successfully adding a Jackett RSS link, the bot starts fetching the feed every 600 seconds. (This can be set)

Titles are used to easily manage RSS feeds and should contain only one word and are case sensitive.

Commands:

  • /help Posts this help message. ๐Ÿ˜‘
  • /add TITLE JACKETT_RSS_FEED_URL - Adds new Jackett RSS Feed (overwrited if title previously exist).
  • /remove TITLE - Removes the RSS link.
  • /list Lists all the titles and the asociated Jackett RSS links from the DB.
  • /test JACKETT_RSS_FEED_URL - Inbuilt command that fetches a post (usually latest) from a Jackett RSS.

In order to use Blackhole, your Torrent client must support it and be configured to point to Jackett2Telegram Blackhole folder.

If you like the project, star it on GitHub.

How to add a new Indexer

You could get the Jackett RSS Feed Url using the action button in Indexers list:

Jackett RSS Feed Button

Then paste the Url in the chat like /add AnyTitle Pasted_RSSFeedURL and send the message. The bot will reply with the result.

How to use Blackhole

Blackhole folder is a monitored folder that your Torrent client checks to look for .torrent files and then download them automatically.

First, you must read the documentation of the Torrent client to make sure is supported and simply configure it to point to the blackhole folder created by Jackett2Telegram.

When a new release is showed in Telegram, a Blackhole button could be pressed and download the .torrent file locally, then Torrent client use it.

If you use the Docker installation, make a bind between folders.

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.