Skip to content

Configuration Examples

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

Configuration Examples

Basic Configuration File (config.yaml)

telegram:
  token: "YOUR_BOT_TOKEN"
  admin: "YOUR_TELEGRAM_ID"
  additional_admins:
    - "ANOTHER_ADMIN_ID"
    - "YET_ANOTHER_ADMIN_ID"

sonarr:
  enabled: true
  host: "http://localhost:8989"
  apikey: "YOUR_SONARR_API_KEY"
  quality_profile: "HD-1080p"
  language_profile: "English"
  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"

lidarr:
  enabled: false
  host: "http://localhost:8686"
  apikey: "YOUR_LIDARR_API_KEY"
  quality_profile: "FLAC"
  root_folder: "/path/to/music"

general:
  debug: false
  language: "en-us"

Advanced Configuration Examples

Full Configuration with All Options

telegram:
  token: "YOUR_BOT_TOKEN"
  admin: "YOUR_TELEGRAM_ID"
  additional_admins:
    - "ADMIN_ID_1"
    - "ADMIN_ID_2"
  notifications:
    on_grab: true
    on_import: true
    on_upgrade: true
    on_health_issue: true

sonarr:
  enabled: true
  host: "http://localhost:8989"
  apikey: "YOUR_SONARR_API_KEY"
  quality_profile: "HD-1080p"
  language_profile: "English"
  root_folder: "/path/to/tv/shows"
  season_folders: true
  monitored: true
  search_series: true
  tags:
    - "telegram"
    - "automated"

radarr:
  enabled: true
  host: "http://localhost:7878"
  apikey: "YOUR_RADARR_API_KEY"
  quality_profile: "HD-1080p"
  root_folder: "/path/to/movies"
  minimum_availability: "released"
  monitored: true
  search_movies: true
  tags:
    - "telegram"
    - "automated"

lidarr:
  enabled: false
  host: "http://localhost:8686"
  apikey: "YOUR_LIDARR_API_KEY"
  quality_profile: "FLAC"
  root_folder: "/path/to/music"
  metadata_profile: "Standard"
  album_folder: true
  monitored: true
  search_music: true
  tags:
    - "telegram"
    - "automated"

general:
  debug: false
  language: "en-us"
  log_level: "INFO"
  log_file: "/path/to/addarr.log"
  backup_on_update: true
  check_for_updates: true

security:
  verify_ssl: true
  allowed_networks:
    - "192.168.1.0/24"
    - "10.0.0.0/8"

health_monitoring:
  enabled: true
  interval: 15
  notify_on_issues: true

Docker Environment Configuration

telegram:
  token: "${TELEGRAM_TOKEN}"
  admin: "${TELEGRAM_ADMIN_ID}"

sonarr:
  enabled: true
  host: "http://sonarr:8989"
  apikey: "${SONARR_API_KEY}"
  root_folder: "/tv"

radarr:
  enabled: true
  host: "http://radarr:7878"
  apikey: "${RADARR_API_KEY}"
  root_folder: "/movies"

general:
  debug: false
  language: "en-us"

Minimal Configuration

telegram:
  token: "YOUR_BOT_TOKEN"
  admin: "YOUR_TELEGRAM_ID"

sonarr:
  enabled: true
  host: "http://localhost:8989"
  apikey: "YOUR_SONARR_API_KEY"
  root_folder: "/tv"

radarr:
  enabled: true
  host: "http://localhost:7878"
  apikey: "YOUR_RADARR_API_KEY"
  root_folder: "/movies"

Environment Variables Support

You can use environment variables in your configuration:

telegram:
  token: "${TELEGRAM_BOT_TOKEN}"
  admin: "${TELEGRAM_ADMIN_ID}"

sonarr:
  enabled: true
  host: "${SONARR_HOST}"
  apikey: "${SONARR_API_KEY}"

Then set your environment variables:

export TELEGRAM_BOT_TOKEN="your-bot-token"
export TELEGRAM_ADMIN_ID="your-admin-id"
export SONARR_HOST="http://localhost:8989"
export SONARR_API_KEY="your-sonarr-api-key"

Clone this wiki locally