Skip to content

noam09/deluge-telegramer

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Telegramer

Telegramer

GitHub All Releases Deluge Version Deluge Version

Telegramer is a Deluge plugin for sending notifications, adding and viewing torrents using Telegram messenger. It features both a GTK and Web UI.

The plugin runs a Telegram bot on the host machine which listens for commands the user sends, allowing you to list active torrents, download new torrents, and receive notifications when torrents are added to Deluge and when they finish downloading.

Since the bot runs locally and is owned by the same user running it, Telegramer provides the best of both worlds: privacy and security. Only you can execute your bot's commands.

Requirements

Currently Telegramer has been tested mainly on Linux using Deluge 1.3.15. Support for Windows is also available. A beta version of the plugin is available for Deluge 2, tested on v2.0.5. Make sure you have Python setuptools installed in order to build the plugin. The plugin itself works with the python-telegram-bot wrapper, which comes pre-packaged.

Since all necessary modules are now packaged within the Python egg, there are no additional requirements.

Installation

Installing Telegramer is easy:

  • Build or download a plugin egg:
    • Prebuilt plugin eggs can be downloaded from the releases page.
    • If you would rather build a Python egg from source:
      • Either download the source code and extract the archive anywhere, or run git clone https://github.com/noam09/deluge-telegramer.git in a directory of your choosing.
      • Open a Command Prompt or Terminal and navigate to the extracted archive or cloned directory.
      • Run python setup.py bdist_egg to build the plugin. If you have Python 3 installed alongside Python 2, you may need to run python2 setup.py bdist_egg instead.
    • To install the plugin using the Deluge graphical user interface, go to Preferences -> Plugins and click Install Plugin. Locate the plugin egg and select it to install. If you built an egg from source, you should be able to find it in the same directory to which it was extracted or cloned, inside the dist directory.
    • For more detailed installation instructions, see the Deluge wiki.

After installing the plugin, restarting Deluge and the Deluge daemon (deluged) is recommended in order to avoid errors.

Usage

After you've installed and enabled the plugin using the Deluge GTK or Web UI, you will need to configure a bot token and Telegram user ID. In order to do so, send a message to @BotFather and create a new bot according to BotFather's instructions. Once you've created your bot, you will be able to generate a token for your newly created bot. Copy it to the plugin's configuration under "Telegram Bot Token". Before you continue, make sure you initiate a conversation with your new bot by sending it the /start command.

Afterwards, send a message to @MyIDbot and send it the /getid command to receive your Telegram user ID. Copy your user ID to Telegramer's configuration under "Telegram User ID".

You may also add additional comma-separated user IDs in the "Additional IDs" field. Any additional users will have the ability to send downloads to Deluge using the /add command. All other commands and notifications will only be available to and received by the bot owner (specified in "Telegram User ID").

Now, test these settings by clicking the Test button. You should receive a message from your newly created bot. Hooray!

Commands: Send your bot the /help command to see what commands are supported.

  • The /list command will allow you to see a list of all torrents, whereas the /down and /up commands will show you only those downloading or uploading.
  • The /add command allows you to add a torrent to Deluge, using either a magnet link, a torrent file URL, or an actual torrent file!
  • Contact @BotFather again to give your bot a profile photo, change its name, or add quick-access commands to your bot using /setcommands. Adding the /help command to your bot's quick-access list an easy way to receive clickable links to all other commands.

Categories: You may also notice the Category fields in the Telegramer configuration panel. This is an optional feature which allows you to set pairs of Categories and matching Directories to which you would like to move torrent contents upon completion. For example, if you set Category 1 to Music and Directory 1 to C:\Music or /home/user/Music, your bot will prompt you to save in the Music category when you use the /add command to add a new torrent. Now the torrent you download will be moved to the appropriate directory when finished! Make sure the directories you set in the category configuration really exist, or else the categories won't show up as options when adding a new torrent. Alternatively, you may also enter a new or different directory to which you'd like to save files once they're finished downloading. Simply send your bot the directory path in quotes (e.g. "/home/user/NewDirectory/").

Labels: In addition to Categories, you can use the built-in Label plugin to label torrents using existing labels or by creating a new label.

Proxy: The Telegram bot can also direct all traffic through a proxy. Proxy addresses should use the format: protocol://PROXY_HOST:PROXY_PORT, e.g. socks5://127.0.0.1:9051. Proxy settings may also accept optional authentication (username and password).

RSS: If you use the YaRSS2 plugin, you can add new search keywords to any of your existing RSS feeds, using predefined regular expression templates. Simply send /rss, pick one of your predefined RSS feeds, then pick one of your predefined regular expression templates, and send your bot the keyword you'd like YaRSS2 to grab (for an example, see the screenshots below).

Development

Want to contribute? Great!

If you have any suggestions for improvement or new features you think might help others, posting Issues and Pull Requests are always welcome.

If you just want to show your support for the project, star it!

Issues can be reported on the GitHub issue tracker, just make sure to post the issue with a clear title, description and a log snippet if you know how. Remember to close your issue once it's solved, and if you found the solution yourself, please comment so that others benefit from it.

Feature requests can also be posted on the GitHub issue tracker.

Support the project by implementing new features, solving support tickets and providing bug fixes.

Screenshots

GTK UI:

preview thumb

Web UI:

preview thumb

Example bot:

preview thumb

Initiating communication with the new bot:

preview thumb

Typing a slash ("/") brings up the quick-access commands. These can be set by contacting @BotFather and sending /setcommands.

preview thumb

When adding a new torrent, you will first be prompted to pick a category:

preview thumb

Afterwards you may pick an existing label, or create a new one:

preview thumb

Then just pick a type:

preview thumb

You can add a new torrent URL:

preview thumb

Or you can send a .torrent file:

preview thumb

Or add a new magnet link:

preview thumb

You can always list the torrents Deluge is currently downloading:

preview thumb

Once the download is complete, you may choose to receive a Telegram notification. You can then check the status of torrents you are seeding:

preview thumb

You can also add new filters to YaRSS2 to make automatic downloading of torrents from RSS feeds much easier. Telegramer example configuration:

preview thumb

YaRSS2 example configuration:

preview thumb

Adding a new RSS download filter via chat:

preview thumb

Filter added:

preview thumb

Known Issues

  • Currently none, please post any issues you find on the issue tracker.

License

This is free software under the GPL v3 open source license. Feel free to do with it what you wish, but any modification must be open sourced. A copy of the license is included.

About

🌊 A Deluge plugin for receiving notifications, adding and viewing torrents using Telegram messenger

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages