https://github.com/Waterboy1602/Addarr

Telegram Bot for adding series/movies to Sonarr/Radarr or for changing the download speed of Transmission/Sabnzbd
https://github.com/Waterboy1602/Addarr

bot radarr sabnzbd sonarr telegrambot transmission

Last synced: 7 days ago
JSON representation

Telegram Bot for adding series/movies to Sonarr/Radarr or for changing the download speed of Transmission/Sabnzbd

• Host: GitHub
• URL: https://github.com/Waterboy1602/Addarr
• Owner: Waterboy1602
• License: mit
• Created: 2019-12-17T16:33:24.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-10-16T20:49:12.000Z (23 days ago)
• Last Synced: 2024-10-19T07:11:53.868Z (21 days ago)
• Topics: bot, radarr, sabnzbd, sonarr, telegrambot, transmission
• Language: Python
• Homepage:
• Size: 236 KB
• Stars: 232
• Watchers: 12
• Forks: 56
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• awesome-arr - Addarr - Telegram Bot for adding series/movies to Sonarr/Radarr or for changing the download speed of Transmission/Sabnzbd. (Bots)

README

        
# ADDARR

[![Docker Pulls](https://img.shields.io/docker/pulls/waterboy1602/addarr)](https://hub.docker.com/r/waterboy1602/addarr)

This is a Telegram Bot made to add series to [Sonarr](https://github.com/Sonarr/Sonarr) or movies to [Radarr](https://github.com/Radarr/Radarr) with a couple of commands. You can also communicate with your [Transmission](https://transmissionbt.com/)/[Sabnzbd](https://sabnzbd.org/) 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](#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

> [!IMPORTANT]  

> Addarr only works with Sonarr V4, because of some breaking API changes between V3 and V4.

## 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](https://github.com/Waterboy1602/Addarr/wiki).

- [FreeBSD](https://github.com/Waterboy1602/Addarr/wiki/Installation-on-FreeBSD)

- [Docker](https://github.com/Waterboy1602/Addarr/wiki/Installation-on-Docker)

- [Windows](https://github.com/Waterboy1602/Addarr/wiki/Installation-on-Windows)

- [Linux](https://github.com/Waterboy1602/Addarr/wiki/Installation-on-Linux)

## SCREENSHOTS