Skip to content

Latest commit

 

History

History
64 lines (45 loc) · 3.85 KB

README.md

File metadata and controls

64 lines (45 loc) · 3.85 KB

ADDARR

Docker Pulls

This is a Telegram Bot made to add series to Sonarr or movies to Radarr with a couple of commands. You can also communicate with your Transmission/Sabnzbd service to change its download speed. The bot uses the InlineKeyboard to let you select the wanted commands, as you can see in the screenshots.

FEATURES

  • Add series/movies to Sonarr/Radarr
  • Get a list of all the series on Sonarr
  • Change down-/uploadspeed of Transmission (Temporary Speed Limit)
  • Secure bot with a password. New chats first need to authenticate
  • Wrong login attempts are saved in addarr.log
  • Possibility to enable the Transmission-command only for admins
  • Possibility to change the entrypoints of the commands
  • Translated in English (US), Dutch (Belgium), Spanish (Spain), Italian (Italy), Portuguese (Portugal), Polish (Poland), German (Germany) and French (France)
  • Command to give an overview of all the other commands

COMMANDS

These are the default commands:

  • /help: gives an overview of all the commands with their action
  • /auth: authenticate the chat to use this bot
  • /start: start adding a series or movie to Sonarr/Radarr
  • /delete: remove a series or movie from Sonarr/Radarr
  • /movie (en-us) - /film (nl-be, it-it, de-de, fr-fr) - /file (pt-pt) - /Película (es-es): start adding a movie to Radarr
  • /series (en-us) - /serie (nl-be, it-it, pt-pt, es-es, de-de, fr-fr) : start adding a series to Sonarr
  • /allSeries: receive a list of all the series on Sonarr
  • /allMovies: receive a list of all the movies on Radarr
  • /transmission: change the down-/upload speed of Transmission from Temporary Speed Limit to normal or the other way around
  • /sabnzbd: change the down-/upload speed of Sabnzbd to 25%, 50% or 100% of the defined limit.
  • /stop: stops the command you were executing. Can be used at any moment

Every command does also work if you send a message without / and no other words before or after the entrypoint

CONFIG

An example of the config file (config_example.yaml) can be found in this repository. Change it to your configuration. After you've filled in all the necessary fields, rename it to config.yaml.

ADMIN

There is a functionality to only let admins use the transmission command, list or delete series/movies from sonarr/radarr. Before you can use this, you should enable each variable in the config file config.yaml. Then you need to add the admins to admin.txt. You can add the username or id of the user. Every added user should be on a new line to prevent errors.

ALLOWLIST

There is a very restrictive functionality to only reply to already approved users. You can enable it in the config file config.yaml. Then you need to add the users to allowlist.txt. You can add the username or id of the user. Every added user should be on a new line to prevent errors.

INSTALLATION

You can find the installation guides on the wikipage.

SCREENSHOTS

Screenshot 1 Screenshot 2 Screenshot 3