Skip to content

Telegram Bot

You can add new torrents via Telegram bot.

Register bot

  1. Register your bot with BotFather as described at https://core.telegram.org/bots#6-botfather

!!! note If you have already configured notifications with Telegram you don't need to create a new bot. Use an existing one.

  1. Install python-telegram-bot library to your python environment with

    1
    pip install python-telegram-bot

    You may install torrt with required dependencies with:

    1
    pip install torrt[telegram]

  2. Configure torrt to use the bot:

    1
    torrt configure_bot telegram token=YOUR_TOKEN

    Restrict users (comma-separated) talking to the bot with option allowed_users:

    1
    torrt configure_bot telegram token=YOUR_TOKEN allowed_users=user1,user2

  3. Create a new Telegram group and add the bot.

Listen to commands

Start listening to user commands:

1
torrt run_bots

Now your bot is ready to accept messages and fully functional.

Note

It is recommended to start run_bots process using a process management system (see supervisord or systemd configuration example below).

Talking to the bot

Bot supports a number of commands.

  1. To start new conversation with bot use command:

    1
    /start

    and follow further instructions. You can add new, list or remove already registered torrents.

    Note

    If you want to cancel current operation use /cancel command.

  2. Add a torrent using /add command (torrent is downloaded to a default directory.):

    1
    /add https://rutracker.org/forum/viewtopic.php?t=1234567

  3. All registered torrents can be viewed with:

    1
    /list

  4. To remove torrent use command:

    1
    /remove

  5. To show all available commands use:

    1
    /help

Supervisor configuration

Here described how to configure and start torrt's Telegram bot with supervisord.

  1. Install supervisord on your host as described at http://supervisord.org/installing.html

  2. Create configuration file torrt.conf at /etc/supervisor/conf.d/:

    1
2
3
4
5
6
    [program:torrt]
directory=/tmp
command=PATH_TO_TORRT_SCRIPT run_bots
user=USER_ON_HOST
autostart=true
autorestart=true

    Replace PATH_TO_TORRT_SCRIPT with a location of torrt executable file and USER_ON_HOST with a user starting a process.

  3. Start process with following commands:

    1
2
3
    supervisorctl reread
supervisorctl reload
supervisorctl start torrt

Systemd user service

If you are running basically any modern Linux distribution you can run Telegram bot under your user with systemd, without having to deal with global system configuration.

  1. Mark your user as the one allowed to 'linger'

    1
    sudo loginctl enable-linger "$(whoami)"

  2. Create service definition in your home directory:

    1
    mkdir -p ~/.config/systemd/user/

    Create ~/.config/systemd/user/torrt.service (for example with a text editor) with:

    1
2
3
4
5
6
7
8
    [Unit]
Description=torrt bot

[Install]
WantedBy=default.target

[Service]
ExecStart=PATH_TO_TORRT_SCRIPT run_bots

    Replace PATH_TO_TORRT_SCRIPT with a location of torrt executable file

  3. Start Service

    1
2
    systemctl --user daemon-reload
systemctl --user start torrt

  4. (Optional) Enable service autostart

    1
    systemctl --user enable torrt