mirror of
https://github.com/plexguide/Huntarr.io.git
synced 2026-04-20 00:26:51 -04:00
75a7fd0d41
Replace sonarr.html, radarr.html, lidarr.html, readarr.html, whisparr.html, prowlarr.html, and swaparr.html with a comprehensive apps/index.html covering all apps with shared concepts and per-app detail sections.
472 lines
31 KiB
HTML
472 lines
31 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<title>3rd Party Apps - Huntarr Docs</title>
|
|
<link rel="icon" type="image/png" href="../images/huntarr-logo.png">
|
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.5.1/css/all.min.css">
|
|
<link rel="stylesheet" href="../css/main.css">
|
|
</head>
|
|
<body>
|
|
|
|
<!-- Mobile Topbar -->
|
|
<div class="docs-mobile-topbar">
|
|
<button class="mob-hamburger" aria-label="Open navigation"><span></span><span></span><span></span></button>
|
|
<img src="../images/huntarr-logo.png" alt="Huntarr" class="mob-logo">
|
|
<span class="mob-title">Documentation</span>
|
|
</div>
|
|
|
|
<!-- Sidebar Backdrop (mobile) -->
|
|
<div class="docs-sidebar-backdrop"></div>
|
|
|
|
<div class="docs-layout">
|
|
|
|
<!-- ===== SIDEBAR ===== -->
|
|
<nav class="docs-sidebar" aria-label="Documentation navigation">
|
|
<a href="../index.html" class="sidebar-brand">
|
|
<img src="../images/huntarr-logo.png" alt="Huntarr">
|
|
<span>Huntarr</span>
|
|
</a>
|
|
|
|
<div class="sidebar-scroll">
|
|
<a href="https://plexguide.github.io/Huntarr.io/donate.html" target="_blank" rel="noopener" class="sidebar-donate-link"><i class="fas fa-heart"></i> Donate</a>
|
|
|
|
<!-- Getting Started -->
|
|
<div class="nav-group">
|
|
<div class="nav-group-title">Getting Started</div>
|
|
<div class="nav-group-items">
|
|
<a href="../index.html"><i class="fas fa-home"></i> Welcome</a>
|
|
<a href="../getting-started/installation.html"><i class="fas fa-download"></i> Installation</a>
|
|
<a href="../getting-started/setup-wizard.html"><i class="fas fa-magic"></i> Setup Wizard</a>
|
|
<a href="../getting-started/first-steps.html"><i class="fas fa-rocket"></i> First Steps</a>
|
|
</div>
|
|
</div>
|
|
|
|
<!-- Apps -->
|
|
<div class="nav-group">
|
|
<div class="nav-group-title">Apps</div>
|
|
<div class="nav-group-items">
|
|
<a href="index.html" class="active"><i class="fas fa-plug"></i> 3rd Party Apps</a>
|
|
</div>
|
|
</div>
|
|
|
|
<!-- Movie Hunt -->
|
|
<div class="nav-group">
|
|
<div class="nav-group-title">Movie Hunt</div>
|
|
<div class="nav-group-items">
|
|
<a href="../movie-hunt/index.html"><i class="fas fa-clapperboard"></i> Overview <span class="nav-badge nav-badge-beta">Beta</span></a>
|
|
<a href="../movie-hunt/media-collection.html"><i class="fas fa-photo-film"></i> Media Collection</a>
|
|
<a href="../movie-hunt/indexers-clients.html"><i class="fas fa-server"></i> Indexers & Clients</a>
|
|
<a href="../movie-hunt/profiles.html"><i class="fas fa-sliders"></i> Profiles</a>
|
|
</div>
|
|
</div>
|
|
|
|
<!-- NZB Hunt -->
|
|
<div class="nav-group">
|
|
<div class="nav-group-title">NZB Hunt</div>
|
|
<div class="nav-group-items">
|
|
<a href="../nzb-hunt/index.html"><i class="fas fa-newspaper"></i> Overview <span class="nav-badge nav-badge-beta">Beta</span></a>
|
|
</div>
|
|
</div>
|
|
|
|
<!-- Requestarr -->
|
|
<div class="nav-group">
|
|
<div class="nav-group-title">Requests</div>
|
|
<div class="nav-group-items">
|
|
<a href="../requestarr/index.html"><i class="fas fa-hand-paper"></i> Requests</a>
|
|
</div>
|
|
</div>
|
|
|
|
<!-- Settings -->
|
|
<div class="nav-group">
|
|
<div class="nav-group-title">Settings</div>
|
|
<div class="nav-group-items">
|
|
<a href="../settings/index.html"><i class="fas fa-cog"></i> Main Settings</a>
|
|
<a href="../settings/scheduling.html"><i class="fas fa-clock"></i> Scheduling</a>
|
|
<a href="../settings/notifications.html"><i class="fas fa-bell"></i> Notifications</a>
|
|
<a href="../settings/backup-restore.html"><i class="fas fa-database"></i> Backup & Restore</a>
|
|
<a href="../settings/log-settings.html"><i class="fas fa-file-alt"></i> Log Settings</a>
|
|
<a href="../settings/user-account.html"><i class="fas fa-user-shield"></i> User Account</a>
|
|
</div>
|
|
</div>
|
|
|
|
<!-- System -->
|
|
<div class="nav-group">
|
|
<div class="nav-group-title">System</div>
|
|
<div class="nav-group-items">
|
|
<a href="../system/hunt-manager.html"><i class="fas fa-tasks"></i> Hunt Manager</a>
|
|
<a href="../system/logs.html"><i class="fas fa-scroll"></i> Logs</a>
|
|
<a href="../system/api.html"><i class="fas fa-code"></i> API Reference</a>
|
|
</div>
|
|
</div>
|
|
|
|
<!-- Help -->
|
|
<div class="nav-group">
|
|
<div class="nav-group-title">Help</div>
|
|
<div class="nav-group-items">
|
|
<a href="../help/faq.html"><i class="fas fa-question-circle"></i> FAQ</a>
|
|
<a href="../help/community.html"><i class="fas fa-users"></i> Community</a>
|
|
<a href="https://plexguide.github.io/Huntarr.io/donate.html"><i class="fas fa-heart"></i> Donate</a>
|
|
</div>
|
|
</div>
|
|
|
|
</div><!-- /sidebar-scroll -->
|
|
|
|
<div class="sidebar-footer">
|
|
<a href="https://discord.com/invite/PGJJjR5Cww" target="_blank" class="sf-discord" title="Discord"><i class="fab fa-discord"></i></a>
|
|
<a href="https://www.reddit.com/r/huntarr/" target="_blank" class="sf-reddit" title="Reddit"><i class="fab fa-reddit-alien"></i></a>
|
|
<a href="https://github.com/plexguide/Huntarr.io" target="_blank" class="sf-github" title="GitHub"><i class="fab fa-github"></i></a>
|
|
<a href="https://plexguide.github.io/Huntarr.io/donate.html" class="sf-heart" title="Donate"><i class="fas fa-heart"></i></a>
|
|
</div>
|
|
</nav>
|
|
|
|
<!-- ===== MAIN ===== -->
|
|
<main class="docs-main">
|
|
<div class="docs-content">
|
|
|
|
<h1>3rd Party Apps</h1>
|
|
<p class="page-subtitle">Connect your *arr instances to Huntarr for automated media hunting, quality upgrades, and download management.</p>
|
|
|
|
<!-- ══════════════════════════════════════════════ -->
|
|
<h2>How App Connections Work</h2>
|
|
<p>Huntarr communicates with each *arr application through its REST API. You provide the app's URL and API key, and Huntarr takes care of the rest — monitoring your library for missing media, identifying files that can be upgraded, and triggering searches automatically on a schedule you control.</p>
|
|
<ul>
|
|
<li><strong>API-driven:</strong> Huntarr never modifies your *arr databases directly. It uses the same API endpoints the apps' own UI uses.</li>
|
|
<li><strong>Independent instances:</strong> Each connection is managed separately with its own hunt settings, cycle counts, and schedules.</li>
|
|
<li><strong>Multiple instances:</strong> You can add multiple instances of the same app (e.g., a 1080p Radarr and a 4K Radarr) and configure each independently.</li>
|
|
<li><strong>Non-destructive:</strong> Huntarr only triggers searches. Your *arr apps handle the actual downloading, importing, and file management.</li>
|
|
</ul>
|
|
|
|
<!-- ══════════════════════════════════════════════ -->
|
|
<h2>Adding an Instance</h2>
|
|
<ol class="steps">
|
|
<li>Navigate to the <strong>Apps</strong> section from the Huntarr sidebar.</li>
|
|
<li>Select the app type you want to connect (Sonarr, Radarr, etc.).</li>
|
|
<li>Click <strong>"Add Instance"</strong>.</li>
|
|
<li>Enter a friendly name (e.g., "Movies-4K" or "TV-Anime").</li>
|
|
<li>Enter the full URL of your *arr instance, including the port (e.g., <code>http://192.168.1.100:7878</code>).</li>
|
|
<li>Paste the API key from your *arr app (found under <em>Settings > General > Security</em> in each app).</li>
|
|
<li>Click <strong>"Test Connection"</strong> to verify Huntarr can reach the app.</li>
|
|
<li>Save the instance.</li>
|
|
</ol>
|
|
|
|
<div class="alert alert-info">
|
|
<strong>Finding your API key:</strong> In any *arr app, go to <em>Settings > General > Security</em>. The API key is displayed there. Copy it and paste it into Huntarr.
|
|
</div>
|
|
|
|
<!-- ══════════════════════════════════════════════ -->
|
|
<h2>Common Instance Settings</h2>
|
|
<p>These settings are shared across all huntable apps (Sonarr, Radarr, Lidarr, Readarr, Whisparr):</p>
|
|
<table>
|
|
<thead>
|
|
<tr><th>Setting</th><th>Default</th><th>Description</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr><td><strong>Name</strong></td><td>—</td><td>A friendly label to identify this instance (e.g., "TV-1080p")</td></tr>
|
|
<tr><td><strong>URL</strong></td><td>—</td><td>Full URL including port (e.g., <code>http://localhost:8989</code>)</td></tr>
|
|
<tr><td><strong>API Key</strong></td><td>—</td><td>Found in the app under Settings > General > Security</td></tr>
|
|
<tr><td><strong>Enabled</strong></td><td>Yes</td><td>Toggle hunting on/off for this instance without deleting it</td></tr>
|
|
<tr><td><strong>Hunt Missing</strong></td><td>Enabled</td><td>Search for media that has no file on disk</td></tr>
|
|
<tr><td><strong>Hunt Upgrades</strong></td><td>Enabled</td><td>Search for better-quality versions of existing files</td></tr>
|
|
<tr><td><strong>Missing Items per Cycle</strong></td><td>1</td><td>How many missing items to search for each hunt cycle</td></tr>
|
|
<tr><td><strong>Upgrade Items per Cycle</strong></td><td>1</td><td>How many upgrades to attempt each cycle</td></tr>
|
|
<tr><td><strong>Monitored Only</strong></td><td>Enabled</td><td>Only hunt items you've marked as monitored in the *arr app</td></tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
<div class="alert alert-warning">
|
|
<strong>Start low:</strong> Begin with 1–3 items per cycle to avoid overwhelming your indexers. You can increase later once you're confident everything is working well.
|
|
</div>
|
|
|
|
<!-- ══════════════════════════════════════════════ -->
|
|
<h2>How Hunting Works</h2>
|
|
<p>The hunt cycle follows the same pattern for all apps:</p>
|
|
<ol>
|
|
<li><strong>Query:</strong> Huntarr calls the *arr app's API to get a list of missing or upgradeable items.</li>
|
|
<li><strong>Filter:</strong> Results are filtered by monitored status, availability, and your configured caps.</li>
|
|
<li><strong>Search:</strong> Huntarr sends a search command back to the *arr app for each selected item.</li>
|
|
<li><strong>Download:</strong> The *arr app handles the search results, selects the best release, and sends it to your download client.</li>
|
|
<li><strong>Repeat:</strong> After the configured interval, the cycle starts again.</li>
|
|
</ol>
|
|
|
|
<!-- ══════════════════════════════════════════════ -->
|
|
<h2>Supported Apps at a Glance</h2>
|
|
<table>
|
|
<thead>
|
|
<tr><th>App</th><th>Media Type</th><th>Hunt Missing</th><th>Hunt Upgrades</th><th>Notes</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr><td><strong><a href="#sonarr">Sonarr</a></strong></td><td>TV Series</td><td>Yes</td><td>Yes</td><td>Episodes and seasons</td></tr>
|
|
<tr><td><strong><a href="#radarr">Radarr</a></strong></td><td>Movies</td><td>Yes</td><td>Yes</td><td>Includes Minimum Availability filtering</td></tr>
|
|
<tr><td><strong><a href="#lidarr">Lidarr</a></strong></td><td>Music</td><td>Yes</td><td>Yes</td><td>Albums and tracks</td></tr>
|
|
<tr><td><strong><a href="#readarr">Readarr</a></strong></td><td>Books</td><td>Yes</td><td>Yes</td><td>eBooks and audiobooks</td></tr>
|
|
<tr><td><strong><a href="#whisparr">Whisparr</a></strong></td><td>Adult</td><td>Yes</td><td>Yes</td><td>Supports v2 and v3</td></tr>
|
|
<tr><td><strong><a href="#prowlarr">Prowlarr</a></strong></td><td>Indexers</td><td>—</td><td>—</td><td>Indexer management (no hunting)</td></tr>
|
|
<tr><td><strong><a href="#swaparr">Swaparr</a></strong></td><td>Downloads</td><td>—</td><td>—</td><td>Stalled download management</td></tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
<!-- ══════════════════════════════════════════════ -->
|
|
<!-- SONARR -->
|
|
<!-- ══════════════════════════════════════════════ -->
|
|
<h2 id="sonarr"><i class="fas fa-tv" style="color: #60a5fa; margin-right: 8px;"></i>Sonarr</h2>
|
|
<p class="page-subtitle">TV series — hunt missing episodes and upgrade quality.</p>
|
|
|
|
<ul>
|
|
<li>Sonarr manages TV series. Huntarr connects to it to find missing episodes and upgrade existing ones to better quality.</li>
|
|
<li>Compatible with <strong>Sonarr v3 and v4</strong>.</li>
|
|
<li>Ideal use case: you have a large TV library with hundreds of missing episodes that Sonarr's RSS feed will never find on its own.</li>
|
|
<li>Multiple instances let you maintain separate libraries (e.g., 1080p anime vs 4K live-action).</li>
|
|
</ul>
|
|
|
|
<h3>Sonarr-Specific Behavior</h3>
|
|
<ul>
|
|
<li>Huntarr searches at the <strong>episode level</strong>, not the series level. This means it can target individual missing episodes within a series.</li>
|
|
<li>Upgrade hunts check each episode's current quality against the quality cutoff defined in your Sonarr quality profile.</li>
|
|
<li>Huntarr skips unaired episodes and respects series monitoring settings.</li>
|
|
</ul>
|
|
|
|
<h3>Tips for Sonarr</h3>
|
|
<ul>
|
|
<li>Start with 1–3 episodes per cycle to avoid indexer rate limits.</li>
|
|
<li>If you have a large backlog (500+ missing episodes), consider increasing the cycle rate gradually over a few days.</li>
|
|
<li>Check Sonarr's <em>Activity > Queue</em> if searches seem slow — downloads may be queued.</li>
|
|
<li>Make sure Sonarr's indexers are healthy before enabling hunts.</li>
|
|
</ul>
|
|
|
|
<div class="alert alert-warning">
|
|
<strong>Huntarr triggers searches through Sonarr</strong> — make sure Sonarr has working indexers and a download client configured before enabling hunts.
|
|
</div>
|
|
|
|
<!-- ══════════════════════════════════════════════ -->
|
|
<!-- RADARR -->
|
|
<!-- ══════════════════════════════════════════════ -->
|
|
<h2 id="radarr"><i class="fas fa-film" style="color: #fbbf24; margin-right: 8px;"></i>Radarr</h2>
|
|
<p class="page-subtitle">Movies — hunt missing films and upgrade quality.</p>
|
|
|
|
<ul>
|
|
<li>Radarr manages movies. Huntarr connects to find missing films and upgrade quality.</li>
|
|
<li>Compatible with <strong>Radarr v3+</strong>.</li>
|
|
<li>Multiple instances supported (e.g., one for 1080p, one for 4K, one for kids' movies).</li>
|
|
</ul>
|
|
|
|
<h3>Radarr-Specific Settings</h3>
|
|
<table>
|
|
<thead>
|
|
<tr><th>Setting</th><th>Default</th><th>Description</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr><td><strong>Minimum Availability</strong></td><td>Announced</td><td>When a movie becomes searchable: <em>Announced</em>, <em>In Cinemas</em>, or <em>Released</em>. Controls whether Huntarr will attempt to search for a movie based on its release status.</td></tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
<h3>Tips for Radarr</h3>
|
|
<ul>
|
|
<li><strong>Minimum Availability matters:</strong> Searching for "Announced" movies rarely finds results. Use "Released" for the best hit rate.</li>
|
|
<li>Radarr's custom formats can help you target specific qualities and codecs.</li>
|
|
<li>If movies aren't being found, verify that Radarr's Minimum Availability matches your expectations — a movie marked "Announced" likely has no releases yet.</li>
|
|
<li>Multiple instances let you maintain separate quality libraries (e.g., a 1080p library and a 4K HDR library).</li>
|
|
</ul>
|
|
|
|
<!-- ══════════════════════════════════════════════ -->
|
|
<!-- LIDARR -->
|
|
<!-- ══════════════════════════════════════════════ -->
|
|
<h2 id="lidarr"><i class="fas fa-music" style="color: #34d399; margin-right: 8px;"></i>Lidarr</h2>
|
|
<p class="page-subtitle">Music — hunt missing albums and upgrade audio quality.</p>
|
|
|
|
<ul>
|
|
<li>Lidarr manages music — albums, tracks, and artists.</li>
|
|
<li>Compatible with <strong>Lidarr v1+</strong>.</li>
|
|
<li>Multiple instances supported (e.g., FLAC lossless library vs MP3 portable library).</li>
|
|
</ul>
|
|
|
|
<h3>Lidarr-Specific Behavior</h3>
|
|
<ul>
|
|
<li>Huntarr searches at the <strong>album level</strong>. Lidarr handles individual track matching.</li>
|
|
<li>Album searches often return full discographies; Lidarr filters to the correct album automatically.</li>
|
|
<li>Music indexers can be more inconsistent than video indexers — patience and multiple indexers help.</li>
|
|
</ul>
|
|
|
|
<h3>Tips for Lidarr</h3>
|
|
<ul>
|
|
<li>Start with very low caps (1 album per cycle) since music indexers are often rate-limited.</li>
|
|
<li>Use quality profiles in Lidarr to control FLAC vs MP3 preference.</li>
|
|
<li>If missing albums aren't found, verify Lidarr has at least one healthy music indexer configured.</li>
|
|
<li>Separate instances for FLAC and MP3 libraries is a common and recommended setup.</li>
|
|
</ul>
|
|
|
|
<!-- ══════════════════════════════════════════════ -->
|
|
<!-- READARR -->
|
|
<!-- ══════════════════════════════════════════════ -->
|
|
<h2 id="readarr"><i class="fas fa-book" style="color: #f87171; margin-right: 8px;"></i>Readarr</h2>
|
|
<p class="page-subtitle">Books — hunt missing eBooks and audiobooks automatically.</p>
|
|
|
|
<ul>
|
|
<li>Readarr manages books and audiobooks.</li>
|
|
<li>Compatible with <strong>Readarr v0.1+</strong>.</li>
|
|
<li>Multiple instances supported (e.g., one for eBooks, one for audiobooks).</li>
|
|
</ul>
|
|
|
|
<h3>Readarr-Specific Behavior</h3>
|
|
<ul>
|
|
<li>Huntarr searches at the <strong>book level</strong> (individual titles).</li>
|
|
<li>Audiobook searches may require specialized indexers that carry audio content.</li>
|
|
<li>Book indexers can be limited compared to video — results may take longer to appear.</li>
|
|
</ul>
|
|
|
|
<h3>Tips for Readarr</h3>
|
|
<ul>
|
|
<li>Separate instances for eBooks and audiobooks is strongly recommended since they use different indexers and quality profiles.</li>
|
|
<li>Book indexers are niche — make sure you have at least one dedicated book indexer in your setup.</li>
|
|
<li>Be patient with search results; book content is less widely available than TV or movies.</li>
|
|
<li>Check Readarr's <em>Activity</em> queue for search progress.</li>
|
|
</ul>
|
|
|
|
<!-- ══════════════════════════════════════════════ -->
|
|
<!-- WHISPARR -->
|
|
<!-- ══════════════════════════════════════════════ -->
|
|
<h2 id="whisparr"><i class="fas fa-mask" style="color: #a78bfa; margin-right: 8px;"></i>Whisparr</h2>
|
|
<p class="page-subtitle">Adult content — automated hunting and quality upgrades.</p>
|
|
|
|
<ul>
|
|
<li>Whisparr manages adult content.</li>
|
|
<li>Compatible with <strong>Whisparr v2 and v3</strong>.</li>
|
|
<li>Multiple instances supported.</li>
|
|
</ul>
|
|
|
|
<h3>Whisparr-Specific Behavior</h3>
|
|
<ul>
|
|
<li>Huntarr uses the same hunt pattern as other *arr apps: query API, filter, trigger searches.</li>
|
|
<li>Specialized indexers may be required for this content type.</li>
|
|
<li>Quality profiles in Whisparr control resolution and format preferences.</li>
|
|
</ul>
|
|
|
|
<h3>Tips for Whisparr</h3>
|
|
<ul>
|
|
<li><strong>Whisparr v3 is recommended</strong> for the best API compatibility with Huntarr.</li>
|
|
<li>If you're running v2, consider upgrading — v3 has better API support and stability.</li>
|
|
<li>Use Huntarr's scheduling to keep indexer hit rates reasonable.</li>
|
|
</ul>
|
|
|
|
<div class="alert alert-info">
|
|
<strong>Version note:</strong> Huntarr supports both Whisparr v2 and v3. If you encounter API issues with v2, upgrading to v3 typically resolves them.
|
|
</div>
|
|
|
|
<!-- ══════════════════════════════════════════════ -->
|
|
<!-- PROWLARR -->
|
|
<!-- ══════════════════════════════════════════════ -->
|
|
<h2 id="prowlarr"><i class="fas fa-search" style="color: #fb923c; margin-right: 8px;"></i>Prowlarr</h2>
|
|
<p class="page-subtitle">Centralized indexer management for all your *arr apps.</p>
|
|
|
|
<p>Prowlarr is different from the other apps listed here. It does <strong>not</strong> hunt for media — instead, it manages the indexers that all your other *arr apps use for searching.</p>
|
|
|
|
<h3>What Huntarr Does with Prowlarr</h3>
|
|
<ul>
|
|
<li>Monitors indexer health and status from the Huntarr dashboard.</li>
|
|
<li>Provides visibility into which indexers are online, offline, or rate-limited.</li>
|
|
<li>Allows you to view Prowlarr configuration from within Huntarr's interface.</li>
|
|
</ul>
|
|
|
|
<h3>Prowlarr Settings</h3>
|
|
<table>
|
|
<thead>
|
|
<tr><th>Setting</th><th>Default</th><th>Description</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr><td><strong>URL</strong></td><td>—</td><td>Your Prowlarr instance URL (e.g., <code>http://localhost:9696</code>)</td></tr>
|
|
<tr><td><strong>API Key</strong></td><td>—</td><td>Found in Prowlarr > Settings > General</td></tr>
|
|
<tr><td><strong>Enabled</strong></td><td>Yes</td><td>Monitor this Prowlarr instance</td></tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
<div class="alert alert-info">
|
|
<strong>Prowlarr doesn't have hunt capabilities.</strong> It manages indexers that Sonarr, Radarr, and other apps use. Keep Prowlarr healthy — it directly affects every other app's ability to find content.
|
|
</div>
|
|
|
|
<h3>Tips for Prowlarr</h3>
|
|
<ul>
|
|
<li>Configure all your indexers in Prowlarr rather than in individual *arr apps — Prowlarr syncs them automatically.</li>
|
|
<li>Huntarr will warn you if Prowlarr reports unhealthy or failing indexers.</li>
|
|
<li>Regularly check indexer health to ensure your hunting is effective across all apps.</li>
|
|
</ul>
|
|
|
|
<!-- ══════════════════════════════════════════════ -->
|
|
<!-- SWAPARR -->
|
|
<!-- ══════════════════════════════════════════════ -->
|
|
<h2 id="swaparr"><i class="fas fa-exchange-alt" style="color: #22d3ee; margin-right: 8px;"></i>Swaparr</h2>
|
|
<p class="page-subtitle">Automatically manage stalled and slow downloads.</p>
|
|
|
|
<p>Swaparr is a download management feature built into Huntarr. It monitors your download clients for stalled or slow downloads and automatically swaps them for better alternatives — reducing the need for manual queue management.</p>
|
|
|
|
<h3>How Swaparr Works</h3>
|
|
<ol>
|
|
<li>Swaparr monitors active downloads in your configured clients.</li>
|
|
<li>Downloads that are stalled, extremely slow, or stuck receive a <strong>strike</strong>.</li>
|
|
<li>After reaching the configured strike count, the problematic download is removed.</li>
|
|
<li>A new search is triggered through the appropriate *arr app to find an alternative release.</li>
|
|
<li>A new, hopefully better, download begins automatically.</li>
|
|
</ol>
|
|
|
|
<h3>Swaparr Settings</h3>
|
|
<table>
|
|
<thead>
|
|
<tr><th>Setting</th><th>Default</th><th>Description</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr><td><strong>Enabled</strong></td><td>Yes</td><td>Enable Swaparr monitoring for this instance</td></tr>
|
|
<tr><td><strong>Strike Count</strong></td><td>3</td><td>Number of strikes before a download is swapped</td></tr>
|
|
<tr><td><strong>Strike Interval</strong></td><td>5 minutes</td><td>Time between strike checks</td></tr>
|
|
<tr><td><strong>Max Download Speed</strong></td><td>—</td><td>Downloads below this speed (KB/s) receive strikes</td></tr>
|
|
<tr><td><strong>Ignore Categories</strong></td><td>—</td><td>Comma-separated download categories to exclude from monitoring</td></tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
<h3>Dashboard Stats</h3>
|
|
<p>Huntarr displays Swaparr statistics on the home page:</p>
|
|
<ul>
|
|
<li>Total swaps performed</li>
|
|
<li>Active strikes on current downloads</li>
|
|
<li>Number of downloads being monitored</li>
|
|
<li>Overall success rate</li>
|
|
</ul>
|
|
|
|
<h3>Tips for Swaparr</h3>
|
|
<ul>
|
|
<li>Set the strike count to <strong>3 or higher</strong> to avoid swapping downloads that are only temporarily slow.</li>
|
|
<li>Use ignore categories for large downloads that are expected to be slow (e.g., 4K remuxes).</li>
|
|
<li>Monitor the Swaparr stats on the dashboard to see if your settings need tuning.</li>
|
|
<li>Works best with torrent clients (qBittorrent, Deluge, Transmission).</li>
|
|
</ul>
|
|
|
|
<div class="alert alert-warning">
|
|
<strong>Swaparr removes and re-searches downloads.</strong> Make sure your *arr apps have good indexer coverage so alternative downloads can be found when a swap occurs.
|
|
</div>
|
|
|
|
<!-- ══════════════════════════════════════════════ -->
|
|
<!-- GENERAL TIPS -->
|
|
<!-- ══════════════════════════════════════════════ -->
|
|
<h2>General Tips</h2>
|
|
<ul>
|
|
<li><strong>Test connections first:</strong> Always test your connection before saving an instance. If the test fails, Huntarr can't hunt.</li>
|
|
<li><strong>Start conservative:</strong> Begin with 1 item per cycle for each app. You can always increase later.</li>
|
|
<li><strong>Check your indexers:</strong> Huntarr is only as good as the indexers configured in your *arr apps. No indexers = no results.</li>
|
|
<li><strong>Use scheduling wisely:</strong> Stagger your hunt cycles across apps to spread out indexer load.</li>
|
|
<li><strong>Multiple instances:</strong> Don't be afraid to use multiple instances of the same app for different quality levels or content categories.</li>
|
|
<li><strong>Monitor the dashboard:</strong> Huntarr's home page shows real-time hunt status, connection health, and activity across all your instances.</li>
|
|
</ul>
|
|
|
|
</div><!-- /docs-content -->
|
|
|
|
<footer class="docs-footer">
|
|
<p>Huntarr is open source. <a href="https://github.com/plexguide/Huntarr.io" target="_blank">GitHub</a> · <a href="https://discord.com/invite/PGJJjR5Cww" target="_blank">Discord</a> · <a href="https://www.reddit.com/r/huntarr/" target="_blank">Reddit</a></p>
|
|
</footer>
|
|
</main>
|
|
|
|
</div><!-- /docs-layout -->
|
|
|
|
<button class="back-to-top" aria-label="Back to top"><i class="fas fa-arrow-up"></i></button>
|
|
<script src="../js/main.js"></script>
|
|
</body>
|
|
</html>
|