Installation

Installation Guide

System Requirements

Supported Operating Systems

• Windows 10/11
• Linux (Ubuntu 20.04+, Debian 10+, CentOS 8+)
• macOS (10.15 Catalina or newer)

Prerequisites

• Python 3.9 or higher
• pip (Python package installer)
• At least one of: Radarr, Sonarr, or Lidarr instance(s)
• Telegram Bot Token (from @BotFather)

Python Installation

Windows

1. Download Python from python.org
2. Run the installer (make sure to check "Add Python to PATH")
3. Verify installation:

   python --version
   pip --version

Linux (Debian/Ubuntu)

# Update package list
sudo apt update

# Install Python and pip
sudo apt install python3 python3-pip

# Verify installation
python3 --version
pip3 --version

macOS

1. Install Homebrew if not already installed:

   /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

2. Install Python:

   brew install python

3. Verify installation:

   python3 --version
   pip3 --version

Installation Methods

Option 1: Install Script (Recommended)

Linux/macOS

Using curl:

curl -sSL https://raw.githubusercontent.com/cyneric/addarr/main/install.sh | bash

Or using wget:

wget -qO- https://raw.githubusercontent.com/cyneric/addarr/main/install.sh | bash

The installer will:

• Create a dedicated installation directory at ~/.addarr
• Set up a Python virtual environment
• Install all required dependencies
• Create the addarr command for easy access
• Back up any existing installation

Windows

Open PowerShell as Administrator and run:

Set-ExecutionPolicy Bypass -Scope Process -Force; [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072; iex ((New-Object System.Net.WebClient).DownloadString('https://raw.githubusercontent.com/cyneric/addarr/main/install.ps1'))

The installer will:

• Create a dedicated installation directory at C:\Users\<username>\AppData\Local\Addarr
• Set up a Python virtual environment
• Install all required dependencies
• Create the addarr command for easy access
• Back up any existing installation

Option 2: Git Clone (Advanced)

1. Clone the repository:

git clone https://github.com/Cyneric/Addarr.git
cd addarr

2. Install dependencies:

pip install -r requirements.txt

3. Start the bot:

python run.py

The bot will automatically start the setup wizard if no configuration file is found.

Option 3: Manual Installation from Zip File (Advanced)

(Windows)

1. Download the zip file from here
2. Extract the zip file and change into the Addarr directory
3. Copy or rename config_example.yaml to config.yaml
4. Edit config.yaml with your settings
5. Run configuration check:

   python run.py --check

6. Start the bot:

   python run.py

Option 4: Docker Installation

Using Docker Compose (Recommended)

1. Create a docker-compose.yml file:

version: '3'
services:
  addarr:
    image: cyneric/addarr
    container_name: addarr
    volumes:
      - /path/to/config:/config
    environment:
      - TZ=Your/Timezone
      - PUID=1000
      - PGID=1000
    restart: unless-stopped
    networks:
      - media-network

2. Start the container:

docker-compose up -d

Using Docker Standalone

docker run -d \
  --name=addarr \
  -v /path/to/config:/config \
  -e TZ=Your/Timezone \
  -e PUID=1000 \
  -e PGID=1000 \
  --restart unless-stopped \
  cyneric/addarr

Service Installation

Windows Service

1. Open PowerShell as Administrator
2. Navigate to scripts directory:

cd C:\Users\<username>\AppData\Local\Addarr\scripts

3. Install service:

.\addarr.service.ps1

4. Manage service:

Start-Service AddarrBot
Stop-Service AddarrBot
Restart-Service AddarrBot
Get-Service AddarrBot

Linux Systemd Service

1. Create user service directory:

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

2. Copy service file:

cp ~/.addarr/scripts/addarr.service ~/.config/systemd/user/

3. Enable and start service:

systemctl --user daemon-reload
systemctl --user enable addarr
systemctl --user start addarr
loginctl enable-linger $USER

Command Line Options

The bot can be controlled through various command-line options:

# Normal startup
python run.py

# Run the interactive setup wizard
python run.py --setup

# Reset the configuration and start from scratch
python run.py --reset

# Create a backup of the current configuration
python run.py --backup

# Check current configuration and service status
python run.py --check

# Show version information
python run.py --version

# Validate translation files
python run.py --validate-i18n

# Show help message and available commands
python run.py --help

Updating Addarr

Script Installation

addarr --update

Docker Update

docker pull cyneric/addarr
docker-compose up -d

Git Installation

git pull
pip install -r requirements.txt

Next Steps

After installation:

1. Run addarr --setup to configure the bot
2. Create a Telegram bot through @BotFather
3. Configure your Sonarr/Radarr/Lidarr connection details
4. Start using the bot!