Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/homarr-labs/homarr/llms.txt

Use this file to discover all available pages before exploring further.

Download client integrations enable real-time monitoring of torrents and Usenet downloads, with controls to pause, resume, and manage your downloads directly from Homarr.

​
Supported Download Clients

Torrent Clients

qBittorrent, Transmission, Deluge, Aria2, Slskd

Usenet Clients

SABnzbd, NZBGet

​
qBittorrent

The most popular torrent client with a comprehensive API.

​
Configuration

​
url
string
required
Base URL of qBittorrent Web UI (e.g., http://qbittorrent.local:8080)
​
username
string
required
Web UI username (default: admin)
​
password
string
required
Web UI password

​
Setup Guide

1

Enable Web UI

In qBittorrent, go to Tools → Options → Web UI
  • Check “Enable the Web User Interface”
  • Set your preferred port (default: 8080)
  • Configure authentication credentials
2

Network Access

Configure IP address binding:
  • Set to 0.0.0.0 to allow access from Homarr
  • Or add Homarr’s IP to the whitelist
3

Add to Homarr

Create a new integration in Homarr with your Web UI credentials

​
Available Features

Real-time download statistics:
  • Active torrents list with progress
  • Download and upload speeds
  • Individual torrent status (leeching, seeding, paused)
  • Time remaining estimates
  • Total uploaded/downloaded
  • Torrent categories
  • Queue priority
Data provided: Jobs list, upload/download rates, pause status
Manage your downloads:
  • Pause/resume all torrents
  • Pause/resume individual torrents
  • Delete torrents (with or without data)
  • View torrent categories
Actions: pauseQueue, resumeQueue, pauseItem, resumeItem, deleteItem

​
Torrent States

The integration maps qBittorrent states:
  • Leeching: downloading, forcedDL, metaDL, allocating, queuedDL, checkingDL
  • Seeding: uploading, forcedUP, stalledUP, queuedUP, checkingUP
  • Paused: pausedDL, pausedUP
  • Stalled: stalledDL
  • Unknown: error, missingFiles, moving

​
Example Configuration

{
  "name": "qBittorrent",
  "url": "http://192.168.1.100:8080",
  "secrets": {
    "username": "admin",
    "password": "your-password"
  }
}

​
Transmission

Lightweight and efficient torrent client.

​
Configuration

​
url
string
required
Base URL including RPC path (e.g., http://transmission.local:9091/transmission/rpc)
​
username
string
RPC username (if authentication enabled)
​
password
string
RPC password (if authentication enabled)

​
Setup Guide

1

Enable RPC

Edit Transmission’s settings.json:
{
  "rpc-enabled": true,
  "rpc-port": 9091,
  "rpc-whitelist-enabled": false,
  "rpc-authentication-required": true,
  "rpc-username": "admin",
  "rpc-password": "password"
}
2

Restart Service

Restart Transmission to apply changes
3

Verify Access

Test RPC endpoint: http://your-server:9091/transmission/rpc
The URL must include /transmission/rpc at the end to work properly.

​
Available Features

  • Monitor active torrents and transfer rates
  • Pause/resume queue and individual torrents
  • Delete torrents with data management
  • View torrent progress and ETA

​
Deluge

Feature-rich torrent client with plugin support.

​
Configuration

​
url
string
required
Base URL of Deluge Web UI (e.g., http://deluge.local:8112)
​
password
string
required
Web UI password (default: deluge)

​
Setup Guide

1

Install Web UI Plugin

Ensure the WebUI plugin is enabled in Deluge preferences
2

Configure Access

Set Web UI port (default: 8112) and password in Deluge settings
3

Network Settings

Allow connections from Homarr’s IP address
Change the default password from deluge to something secure!

​
Available Features

  • Monitor torrents and download statistics
  • Control download queue
  • View seeding status and ratios
  • Manage individual torrents

​
SABnzbd

Powerful Usenet binary newsreader.

​
Configuration

​
url
string
required
Base URL of SABnzbd (e.g., http://sabnzbd.local:8080)
​
apiKey
string
required
SABnzbd API key

​
Finding Your API Key

1

Open SABnzbd

Navigate to the SABnzbd web interface
2

Go to Config

Click the Config icon (gear)
3

General Settings

Select General from the menu
4

Copy API Key

Find “API Key” in the Security section and copy it

​
Available Features

Monitor Usenet downloads:
  • Active NZB downloads with progress
  • Download speed and ETA
  • Queue order and priority
  • Post-processing status
  • History with verification status
  • Disk space remaining
Widget: Download Client Widget
Control your downloads:
  • Pause/resume queue
  • Pause/resume individual items
  • Delete items from queue
  • Adjust priority
Actions: Standard download client controls

​
Example Configuration

{
  "name": "SABnzbd",
  "url": "http://192.168.1.100:8080",
  "secrets": {
    "apiKey": "your-sabnzbd-api-key"
  }
}

​
NZBGet

Efficient Usenet downloader with low resource usage.

​
Configuration

​
url
string
required
Base URL of NZBGet (e.g., http://nzbget.local:6789)
​
username
string
required
NZBGet username (default: nzbget)
​
password
string
required
NZBGet password (default: tegbzn6789)

​
Setup Guide

1

Access Web Interface

Navigate to NZBGet at http://your-server:6789
2

Settings

Go to Settings → Security
3

Change Credentials

Update default username and password
4

Enable Control

Ensure “ControlIP” allows connections from Homarr
Always change the default credentials for security!

​
Available Features

  • Monitor NZB downloads and queue
  • View download speeds and progress
  • Control queue (pause/resume/delete)
  • Post-processing status

​
Aria2

Universal download manager supporting multiple protocols.

​
Configuration

​
url
string
required
Aria2 RPC URL (e.g., http://aria2.local:6800/jsonrpc)
​
secret
string
RPC secret token (if configured)

​
Setup Guide

1

Enable RPC

Start Aria2 with RPC enabled:
aria2c --enable-rpc --rpc-listen-all=true --rpc-secret=your-secret
2

Configure Persistence

Add to Aria2 config file (aria2.conf):
enable-rpc=true
rpc-listen-port=6800
rpc-secret=your-secret-token
rpc-listen-all=true

​
Available Features

  • Monitor HTTP, FTP, BitTorrent, and Metalink downloads
  • Control multi-protocol download queue
  • View transfer statistics
  • Manage download priorities

​
Slskd

Soulseek daemon for peer-to-peer file sharing.

​
Configuration

​
url
string
required
Slskd Web UI URL (e.g., http://slskd.local:5030)
​
apiKey
string
required
Slskd API key or authentication token

​
Available Features

  • Monitor Soulseek downloads and uploads
  • Track peer-to-peer transfer statistics
  • View queue and shared files

​
Comparison

ClientTypeAuth MethodQueue ControlCategories
qBittorrentTorrentUser/Pass✅✅
TransmissionTorrentUser/Pass✅❌
DelugeTorrentPassword✅✅
SABnzbdUsenetAPI Key✅✅
NZBGetUsenetUser/Pass✅✅
Aria2UniversalSecret✅❌
SlskdP2PAPI Key✅❌

​
Common Widget: Download Client

All download clients share the same widget interface:
1

Add Widget

Edit Mode → Add Widget → Download Client
2

Select Integration

Choose your configured download client
3

Configure Display

Set limit, sort order, and visibility options
4

Save

Widget shows active downloads with controls

​
Widget Features

  • Real-time progress bars
  • Download/upload speed indicators
  • Pause/resume buttons
  • Delete with confirmation
  • Category badges (when supported)
  • Time remaining estimates
  • Total size and transferred data

​
Docker Networking Tips

When running in Docker: 
# docker-compose.yml
services:
  homarr:
    networks:
      - media
  
  qbittorrent:
    networks:
      - media
    ports:
      - "8080:8080"

networks:
  media:
    driver: bridge
Use container names as hostnames:
  • ✅ http://qbittorrent:8080
  • ❌ http://localhost:8080

​
Next Steps

Media Organizers

Automate downloads with Sonarr and Radarr

Widgets

Customize your download client widget

Build docs developers (and LLMs) love

Get started for freeTalk to us