Skip to content

Configuration

Christian Blank edited this page Nov 8, 2024 · 1 revision

Configuration Guide

Initial Setup

After installing Addarr, you'll need to configure it before first use. This guide will walk you through the basic configuration process.

Basic Configuration

Required Configuration File

Create or edit config.ini in your Addarr configuration directory:

  • Docker: /config/config.ini
  • Manual installation: config.ini in the Addarr directory

Minimum Configuration Example

[telegram]
token = YOUR_BOT_TOKEN
admin = YOUR_TELEGRAM_USER_ID

[sonarr]
enabled = true
host = http://localhost:8989
apikey = YOUR_SONARR_API_KEY
quality_profile = HD-1080p
root_folder = /path/to/tv/shows

[radarr]
enabled = true
host = http://localhost:7878
apikey = YOUR_RADARR_API_KEY
quality_profile = HD-1080p
root_folder = /path/to/movies

Step-by-Step Configuration

1. Telegram Setup

  1. Get your bot token:

    • Message @BotFather on Telegram
    • Create new bot with /newbot
    • Copy the provided token
  2. Get your Telegram ID:

    • Message @userinfobot on Telegram
    • Copy your ID number
  3. Configure in config.ini:

[telegram]
token = 123456789:ABCdefGHIjklMNOpqrsTUVwxyz
admin = 123456789

2. Sonarr Setup

  1. Get your Sonarr API key:

    • Open Sonarr web interface
    • Settings → General
    • Copy API Key
  2. Configure in config.ini:

[sonarr]
enabled = true
host = http://localhost:8989
apikey = your_sonarr_api_key
quality_profile = HD-1080p
root_folder = /path/to/tv/shows

3. Radarr Setup

  1. Get your Radarr API key:

    • Open Radarr web interface
    • Settings → General
    • Copy API Key
  2. Configure in config.ini:

[radarr]
enabled = true
host = http://localhost:7878
apikey = your_radarr_api_key
quality_profile = HD-1080p
root_folder = /path/to/movies

Quality Profiles

Setting Up Quality Profiles

  1. Check available profiles in Sonarr/Radarr
  2. Use exact profile names in config.ini
  3. Example profiles:
[sonarr]
quality_profile = HD-1080p

[radarr]
quality_profile = Remux-1080p

Root Folders

Configuring Media Locations

  1. Ensure folders exist and are writable
  2. Use absolute paths
  3. Example structure:
[sonarr]
root_folder = /media/tv

[radarr]
root_folder = /media/movies

Optional Settings

Basic Optional Configuration

[telegram]
# Additional admin users (comma-separated)
additional_admins = 123456789,987654321

# Notifications
notify_on_grab = true
notify_on_import = true

[general]
# Debug logging
debug = false

Docker-Specific Configuration

Path Mapping

When using Docker, ensure paths match between containers:

[sonarr]
root_folder = /tv  # Path inside Sonarr container

[radarr]
root_folder = /movies  # Path inside Radarr container

Testing Your Configuration

  1. Start Addarr
  2. Send /start to your bot
  3. Try basic commands:
    • /ping - Check bot response
    • /tv test - Test Sonarr connection
    • /movie test - Test Radarr connection

Next Steps

After basic configuration:

  1. Check out Advanced Configuration for more options
  2. Review Examples and Use Cases
  3. Learn available Commands

Common Configuration Issues

Troubleshooting

  1. Connection Issues:

    • Verify host URLs are accessible
    • Check API keys are correct
    • Ensure services are running
  2. Permission Issues:

    • Verify Telegram user ID
    • Check folder permissions
    • Confirm API key permissions
  3. Path Issues:

    • Use absolute paths
    • Check Docker volume mappings
    • Verify folder existence

For more detailed configuration options, see the Advanced Configuration guide.

Clone this wiki locally