Skip to Content
Sonarr

Sonarr

Smart PVR for automated TV series management and quality upgrades

Sonarr is a PVR (Personal Video Recorder) for Usenet and BitTorrent users. It monitors multiple RSS feeds for new episodes of your favorite shows and automatically grabs, sorts, and renames them. Sonarr can also be configured to automatically upgrade the quality of files already downloaded when a better quality format becomes available.

Automatic Series Monitoring

Track your favorite TV shows and automatically download new episodes as they become available

Quality Management

Define preferred quality profiles and automatically upgrade existing episodes to better quality versions

Calendar Integration

Visual calendar showing upcoming and aired episodes with at-a-glance schedule overview

TheTVDB Integration

Search and add new series from TheTVDB with comprehensive metadata and episode information

Automatic Organization

Rename and organize files with customizable naming patterns for consistent library structure

Download Client Support

Works with qBittorrent, Deluge, SABnzbd, NZBGet, rTorrent, and Transmission

Notification System

Get notified when episodes are grabbed, downloaded, or upgraded via Discord, Slack, Email, and more

Custom Scripts

Run custom scripts on grab, download, rename, or import events for advanced automation


Installation

Install from the Dashboard

Open App Dashboard → Package Management (/dashboard?mode=packages), find Sonarr in the catalog (browse Media Management or search), and click Install. The dashboard streams the install log live and Sonarr appears in your Application Control panel when it finishes. Reinstall, Update, and Remove are available from the same panel.

In the install dialog you can pick the release channel — Stable (default) or Nightly for the develop builds. Switching the channel later and updating moves Sonarr to that channel’s latest build. See Channels & Versions for how channels work.

For a dedicated 4K library, install Sonarr4K — a separate instance with its own port, configuration directory (~/.config/Sonarr4K), and quality profiles, so your standard and 4K libraries never conflict. It appears as its own catalog entry in Package Management; on the CLI it is the --4k flag on qb install sonarr (see below).

What you see and can manage is gated by your account: admins manage any user’s apps; regular users manage their own. For the full package flow see App Management.

Install and manage from the CLI

The CLI runs the same scripts as the Dashboard and is the full power-user/automation surface. Install Sonarr v4 (stable) for a specific user:

bash
qb install sonarr -u username

The complete command set:

CommandDescription
qb install sonarr -u username
Install Sonarr v4 (stable) with automatic configuration
qb install sonarr -u username --nightly
Install nightly build (develop branch) for latest features
qb install sonarr -u username --4k
Install a separate 4K instance (Sonarr4K) for high-resolution content
qb install sonarr -u username --nightly --4k
Install the 4K instance on the nightly branch
qb reinstall sonarr -u username
Reinstall Sonarr (preserves configuration and database)
qb update sonarr -u username
Update to latest version (auto-detects branch)
qb update sonarr -u username --v4
Upgrade an existing v3 installation to v4 (v3 users only)
qb remove sonarr -u username
Remove the standard installation
qb remove sonarr -u username --4k
Remove the 4K instance
qb help sonarr
Display comprehensive help information
OptionDescriptionExample
-u, --usernameRequired

Specify the user for installation

-u john
-u john
--nightly

Install develop branch (nightly builds) for cutting-edge features

--4k

Install a dedicated 4K instance (Sonarr4K) with its own config and port

--v4

Upgrade an existing v3 to v4 (update command only — not for new installs)

How the 4K instance works
Note

--4k is a flag on the base Sonarr package — it installs a dedicated Sonarr4K instance with its own port, install directory (/opt/username/Sonarr4K), configuration (~/.config/Sonarr4K), and quality profiles, so your standard and 4K libraries never conflict. There is no separate sonarr4k install command — you pass --4k to qb install sonarr. In the Dashboard, Sonarr4K appears as its own catalog entry you can install the same way.

Update branch handling
Tip

When you run qb update sonarr -u username, QuickBox automatically detects your current branch (main or develop) from config.xml and updates accordingly. You don’t need to specify --nightly unless you want to switch branches.

Full flag reference: CLI Reference.


Directory Structure

Path
Description
/home/username
.config/
Sonarr/
Sonarr configuration directory
sonarr.db
Main database - backup regularly!
config.xml
Core configuration (ports, URL base, branch)
logs/
Application logs
Sonarr4K/
4K instance configuration (if --4k flag used)
sonarr.db
4K instance database
config.xml
4K instance configuration
Media/
Recommended media storage location
TV/
TV shows root folder
TV-4K/
4K TV shows (if using --4k)

Configuration Details

Standard instance:

  • Install location: /opt/username/Sonarr/
  • Config directory: ~/.config/Sonarr/
  • Database: ~/.config/Sonarr/sonarr.db
  • Service: sonarr@username.service
  • Default port: 8989 (auto-generated if in use)
  • SSL port: 9898 (auto-generated if in use)

4K instance (—4k flag):

  • Install location: /opt/username/Sonarr4K/
  • Config directory: ~/.config/Sonarr4K/
  • Database: ~/.config/Sonarr4K/sonarr.db
  • Service: sonarr4k@username.service
  • Ports: Auto-generated (typically 8990+)

Upgrading from v3 to v4

Important Migration Information
Warning

If you have an existing Sonarr v3 installation, you must upgrade to v4 using the --v4 flag. This is a one-time migration that updates your database schema.

Upgrade Command

bash
qb update sonarr -u username --v4

Pre-Upgrade Checklist

Before Upgrading

  • Backup your database: ~/.config/Sonarr/sonarr.db
  • Stop any manual searches or active downloads
  • Note your current configuration (ports, API key, indexers)
  • Verify you have sufficient disk space

Upgrade Process

  • Service is stopped automatically
  • Latest v4 package is downloaded and installed
  • Database schema is migrated to v4 format
  • Configuration and settings are preserved
  • Service restarts automatically with v4
Database Backup
Tip

Always backup before upgrading: cp ~/.config/Sonarr/sonarr.db ~/.config/Sonarr/sonarr.db.v3-backup


Accessing Sonarr

After installation, Sonarr is accessible through QuickBox’s nginx reverse proxy with SSL:

Instance TypeAccess URL
Standardhttps://your-server-ip/username/sonarr
4K Instancehttps://your-server-ip/username/sonarr4k
QuickBox Dashboard Integration
Tip

Sonarr is automatically integrated into your QuickBox dashboard. Find it on the App Dashboard (the default control view), expand its row for port, API key, and status, and click Open to launch the web interface. To install or remove applications, use the Package Management tab instead.

Network Configuration

QuickBox automatically configures:

  • URL Base: /username/sonarr (or /username/sonarr4k)
  • Bind Address: 127.0.0.1 (local only - proxied through nginx)
  • Port: Auto-assigned (typically 8989 for standard, 8990+ for 4K)
  • SSL: Handled by nginx reverse proxy (port 443)
  • Authentication: Initially set to None (configure on first access)

Initial Configuration

1. Set up Authentication

Security First
Warning

Configure authentication immediately after installation if your server is accessible from the internet.

  1. Navigate to Settings → General
  2. Under Security, configure:
    • Authentication Method: Forms (recommended) or Basic
    • Username: Your chosen username
    • Password: Strong password

2. Configure Download Client

Sonarr needs a download client to grab releases. QuickBox configures clients with SSL through nginx.

Steps:

  1. Go to Settings → Download Clients
  2. Click Add (+) button
  3. Select your client (qBittorrent, Deluge, rTorrent, etc.)
  4. Enable Show Advanced to access URL Base field
  5. Enter connection details from the table below

Download Client Configuration

QuickBox-specific connection details for common download clients

All configurations use SSL (port 443) through nginx reverse proxy

Deluge

HTTPS
Hostlocalhost or server IP
Port443
URL Base/username/deluge
AuthPassword (from Deluge connection manager)

Flood

HTTPS
Hostlocalhost or server IP
Port443
URL Base/username/flood
AuthUsername & Password (Flood credentials)

NZBGet

HTTPS
Hostlocalhost or server IP
Port443
URL Base/username/nzbget
AuthUsername & Password (NZBGet credentials)

qBittorrent

HTTPS
Hostlocalhost or server IP
Port443
URL Base/qbittorrent
AuthUsername & Password (qBittorrent credentials)

rTorrent

HTTPS
Hostlocalhost or server IP
Port443
URL Path/username (SCGI routed by QuickBox)
AuthUsername & Password (ruTorrent credentials)

SABnzbd

HTTPS
Hostlocalhost or server IP
Port443
URL Base/username/sabnzbd
AuthAPI Key (from SABnzbd settings) and Username & Password (SABnzbd credentials)

Transmission

HTTPS
Hostlocalhost or server IP
Port443
URL Base/username/transmission
AuthUsername & Password (Transmission credentials)
  1. Click Test to verify connection
  2. Click Save if test succeeds
Download Client Categories
Tip

Configure categories in your download client (e.g., tv-sonarr) to isolate Sonarr downloads and set specific paths automatically.

Prowlarr provides centralized indexer management across all *arr applications:

  1. Install Prowlarr: qb install prowlarr -u username
  2. In Prowlarr, navigate to Settings → Apps
  3. Click Add (+) and select Sonarr
  4. Enter:
    • Sonarr URL: http://localhost:8989/username/sonarr
    • API Key: Found in Sonarr → Settings → General → Security
  5. Click Test then Save
  6. Add indexers in Prowlarr—they automatically sync to Sonarr
Why Prowlarr over Jackett?
Tip

Prowlarr is the modern successor to Jackett. When you add or remove indexers in Prowlarr, they automatically sync to Sonarr, Radarr, Lidarr, and other *arr apps. This centralized management saves time and ensures consistency.

Alternative: Manual indexers

  • Go to Settings → Indexers → Add (+)
  • Add trackers/usenet indexers individually

4. Set Root Folder

Define where Sonarr should store TV shows:

  1. Navigate to Settings → Media Management
  2. Click Root Folders
  3. Click Add Root Folder
  4. Enter path (e.g., /home/username/Media/TV)
  5. Click OK

Recommended structure:

  • Standard instance: /home/username/Media/TV
  • 4K instance: /home/username/Media/TV-4K

5. Quality Profiles & Upgrades

Configure quality preferences and automatic upgrades:

  1. Navigate to Settings → Profiles
  2. Edit existing profile or create new one
  3. Configure:
    • Upgrade Until: Maximum quality (e.g., Bluray-1080p)
    • Upgrades Allowed: ✓ Enabled
    • Cutoff: When to stop upgrading
  4. Click Save

Example workflow:

  • Episode airs → Download HDTV 720p
  • Web release available → Upgrade to WEBDL 1080p
  • Blu-ray released → Upgrade to Bluray 1080p (cutoff reached, stop upgrading)
Smart Upgrading Strategy
Tip

Set upgrade cutoffs to prevent endless upgrading. For example, setting cutoff to Bluray-1080p prevents automatic upgrades to massive 4K remuxes unless you specifically want them. This saves bandwidth and storage space.


File Naming Configuration

Recommended settings for consistent library organization:

Navigate to Settings → Media Management → File Management:

SettingRecommended Configuration
Rename Episodes✓ Enabled - Ensures consistent naming across your library
Replace Illegal Characters✓ Enabled - Removes filesystem-incompatible characters
Standard Episode Format{Series Title} - S{season:00}E{episode:00} - {Episode Title} {Quality Full}
Daily Episode Format{Series Title} - {Air-Date} - {Episode Title} {Quality Full}
Anime Episode Format{Series Title} - S{season:00}E{episode:00} - {absolute:000} - {Episode Title} {Quality Full}
Series Folder Format{Series Title} ({Series Year})

Example output:

  • Standard: The Office - S02E05 - Halloween WEBDL-1080p.mkv
  • Daily: The Daily Show - 2024-12-24 - Holiday Special HDTV-720p.mkv
  • Anime: Attack on Titan - S01E13 - 013 - Primal Desire Bluray-1080p.mkv

Adding TV Series

  1. Click Series in the main navigation
  2. Click Add New button
  3. Search for your show by name
  4. Select the series from search results
  5. Configure options:
    • Root Folder: Where to save the show
    • Quality Profile: Desired quality settings
    • Monitor: Which episodes to track (see below)
    • Series Type: Standard, Daily, or Anime
  6. Click Add Series

Monitoring Options

Monitoring OptionBehavior
All EpisodesMonitor and download all episodes (past and future) - ideal for completing a full series
Future EpisodesOnly monitor new episodes from now on - perfect for ongoing shows you're caught up on
Missing EpisodesDownload missing episodes from existing seasons - useful for filling gaps
Existing EpisodesDon't search for old episodes - monitors only what you already have
First SeasonOnly monitor season 1 - great for testing new shows
Latest SeasonOnly monitor the most recent season - conserve bandwidth on long-running shows
Smart Monitoring
Tip

Use Future Episodes for ongoing shows you’re already caught up on to avoid re-downloading existing episodes. For new shows or filling gaps, use Missing Episodes or All Episodes.


Service Management

Sonarr runs as a systemd service for reliability and automatic startup.

Service Commands

CommandDescription
systemctl status sonarr@usernameCheck service status and health
systemctl restart sonarr@usernameRestart the service
systemctl stop sonarr@usernameStop the service
systemctl start sonarr@usernameStart the service
journalctl -u sonarr@username -fView live logs (follow mode)
journalctl -u sonarr@username --since todayView logs from today

4K instance commands:

Replace sonarr with sonarr4k in all commands above:

bash
systemctl status sonarr4k@username
systemctl restart sonarr4k@username
journalctl -u sonarr4k@username -f
Auto-Start on Boot
Info

QuickBox automatically enables Sonarr to start on boot. You don’t need to run systemctl enable manually unless you’ve previously disabled it.


Troubleshooting

Sonarr Won’t Start

Check These First

  • Check service logs: journalctl -u sonarr@username -f
  • Verify port availability: grep -E '<Port>' ~/.config/Sonarr/config.xml
  • Check for database corruption
  • Ensure config directory permissions are correct

Solutions

  • Restart the service: systemctl restart sonarr@username
  • Fix permissions: qb fix permissions -u username
  • Restore database backup if corrupted
  • Check for conflicting port usage with other services

View detailed logs:

bash
journalctl -u sonarr@username --since "10 minutes ago" --no-pager

Downloads Not Appearing

Common Issues

  • No releases found in manual search
  • Episodes not automatically downloading
  • Download client connection errors (qBittorrent, Deluge, etc.)
  • Series shows as monitored but nothing happens

How to Fix

  • Verify indexers: Settings → Indexers → Test or check Prowlarr
  • Test download client: Settings → Download Clients → Test
  • Ensure series/episodes are monitored (blue icons on series page)
  • Try manual search: Click episode → Manual Search icon
  • Check quality profile cutoffs haven't been reached

Permission Issues

If Sonarr can’t access files or directories:

bash
# Fix all user permissions
qb fix permissions -u username
 
# Restart Sonarr
systemctl restart sonarr@username
 
# Verify ownership
ls -la ~/.config/Sonarr/
Common Permission Problems
Tip

Permission issues often occur after manually moving files or changing directory ownership. The qb fix permissions command resets ownership recursively for all user directories.

Database Corruption

Symptoms

  • Sonarr won't start with database errors in logs
  • Series or episodes disappearing randomly
  • Settings not saving properly
  • Constant crashes or unexpected behavior

Recovery Steps

  • Stop service: systemctl stop sonarr@username
  • Backup current DB: cp ~/.config/Sonarr/sonarr.db ~/.config/Sonarr/sonarr.db.corrupt
  • Restore from backup if available
  • Or reinstall: qb reinstall sonarr -u username (preserves DB)
  • Last resort: Delete DB and reconfigure from scratch

Check database integrity:

bash
sqlite3 ~/.config/Sonarr/sonarr.db "PRAGMA integrity_check;"

Indexer Rate Limiting

If you’re getting rate limit errors from indexers:

  1. Reduce RSS sync interval: Settings → Indexers → Options → RSS Sync Interval (increase to 30-60 minutes)
  2. Use Prowlarr for centralized rate limit management
  3. Remove duplicate or redundant indexers
  4. Consider premium/VIP indexer accounts for higher limits

Best Practices

Do

  • Use Prowlarr for centralized indexer management across all *arr apps
  • Set reasonable quality profiles—avoid unnecessary 4K downloads if you don't need them
  • Monitor only shows you actually want to prevent excessive bandwidth usage
  • Configure proper file naming (Settings → Media Management) for consistent library organization
  • Set up automatic backups of your Sonarr database (~/.config/Sonarr/sonarr.db)
  • Use download client categories (e.g., tv-sonarr) to separate Sonarr downloads
  • Set upgrade cutoffs (e.g., Bluray-1080p) to prevent endless quality chasing
  • Enable notifications (Discord, Telegram, etc.) to track downloads and failed grabs
  • Use separate 4K instance (--4k flag) for 4K content management

Don't

  • Don't monitor every episode of every show—be selective to save bandwidth and storage
  • Don't set upgrade cutoff too high (4K remuxes are 50-100GB+ and may not be necessary)
  • Don't use too many indexers—causes rate limits and excessive API hits
  • Don't download to system drive—use dedicated media storage (/home/username/Media/TV)
  • Don't ignore failed download warnings—investigate and resolve issues promptly
  • Don't mix standard and 4K content in same instance—use separate 4K instance
  • Don't disable authentication if Sonarr is accessible from the internet
  • Don't ignore database backups—corruption can happen and cause permanent data loss
  • Don't use Jackett if Prowlarr is available—Prowlarr is the modern replacement

Sonarr integrates seamlessly with the QuickBox ecosystem:


Additional Resources


Join the Community

Media server operators sharing configs, getting support, and shaping the future of QuickBox Pro.

  • Dedicated Support
  • Feature Previews
  • Community Configs
  • Active Discussions
Join Discord Server
Last updated on