selfhost.directory

The index of self-hostable projects — ranked, categorized and served with live updates.
Own your data and stop giving it to big tech.

GitHub
Addarr logo

Self-host Addarr

V0.8

Telegram bot for Sonarr, Radarr, Transmission, Sabnzbd

BetaOpen SourceMIT
Updatedlast year
LanguagePython
Setup difficultyModerate
Stars
284
Docker
waterboy1602/addarr
Install with Docker

What is Addarr?

Addarr is a Telegram bot written in Python that connects to Sonarr v4 and Radarr to add, list, or delete series and movies. It also integrates with Transmission and Sabnzbd to toggle download speed limits. Users authenticate with a password, and admins can restrict sensitive commands. The bot supports eight languages and runs via Docker, bare-metal Linux, Windows, or FreeBSD. It requires external Sonarr, Radarr, Transmission, or Sabnzbd instances to function.

Should you self-host Addarr?

Addarr scores 42/100 on selfhost.directory (how scoring works) and ranks #82 of 110 in Chat. It has 284 GitHub stars.

There was no stable release in the past 12 months, so check the repository's recent activity before you rely on it.

Setup is moderate: expect some configuration beyond a single command. An official Docker image is available. It is MIT-licensed and written mostly in Python.

Its closest alternative on selfhost.directory is Zulip (82/100, 26 127 stars). It scores higher overall, so compare the two before you pick. See Addarr vs Zulip side by side.

Features

  • Add series to Sonarr
  • Admin restrictions
  • Allowlist mode
  • Command help overview
  • Custom command entrypoints
  • Delete series/movies
  • Failed login logging
  • List series from Sonarr
  • Multi-language Support
  • Password Authentication
  • Stop current command

Addarr README

How to install Addarr

Install Addarr with Docker

  • Save a copy of config_example.yaml to your Addarr folder (/var/lib/addarr/config.yaml). Edit the file to add your settings.
  • Create admin.txt and chatid.txt in your Addarr folder (/var/lib/addarr/admin.txt and /var/lib/addarr/chatid.txt).
  • If you are using the admin restriction functionality, paste your admin Telegram chat id(s) in admin.txt, one on each line.
  • You can paste your Telegram chat id(s) in chatid.txt, but you don't need to. You can leave this file empty, and chat ids will be added when they are authorized via password through the bot.
  • If you want the Addarr log file to be saved on your host system, then create a logs folder in your Addarr folder (/var/lib/addarr/logs/). Skip this step if you don't care about the log file, and it will be erased each time the Docker container is stopped.
  • Save a copy of docker-compose.yml to your Addarr folder (/var/lib/addarr/docker-compose.yml).
  • Edit docker-compose.yml and make sure the file/folder mappings are correct for your environment. The default includes mappings for config.yaml, chatid.txt, and admin.txt all being in the same folder as docker-compose.yml. If you also want to map a logs folder, add a line to map that folder as well: - ./logs:/app/logs:rw
  • Make sure your current working directory is your Addarr folder (cd /var/lib/addarr) and run the command docker-compose up -d to create and start a docker container based on the settings in docker-compose.yml.
  • Note: You will need to run all Docker commands as root or using sudo. On Windows you will need to run your command prompt as an admin.
  • To update your docker image to the latest version of Addarr, run the following commands:
  • docker-compose pull (to pull the new version of the image from Docker Hub)
  • docker-compose down (stop and destroy the current container--your config will be safe since you mapped them to persistent files)
  • docker-compose up -d (create and start a new container)

Uses network_mode: host

Addarr releases & version history

More in Download Management

Rate this project

Click to rate — no account needed.

0 comments

Posting as guest
Loading comments…