Files
Huntarr.io/docs/index.html
Admin9705 17a17f3eb8 update
2026-02-23 03:31:25 -05:00

533 lines
28 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Huntarr Documentation</title>
<meta name="description"
content="Official documentation for Huntarr — the automated media library manager for Sonarr, Radarr, Lidarr, Readarr, Whisparr, and more.">
<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">
<!-- Fallback layout if main.css fails to load (e.g. GitHub Pages) -->
<style>
.docs-layout {
display: flex;
min-height: 100vh
}
.docs-sidebar {
position: fixed;
top: 0;
left: 0;
bottom: 0;
width: 260px;
display: flex;
flex-direction: column;
z-index: 200;
background: linear-gradient(180deg, #161e2c 0%, #0f1623 100%);
border-right: 1px solid rgba(255, 255, 255, .06)
}
.docs-main {
margin-left: 260px;
flex: 1;
min-height: 100vh;
background: #0f1623
}
.sidebar-brand img {
width: 36px;
height: 36px;
max-width: 36px
}
.docs-mobile-topbar {
display: none
}
@media(max-width:768px) {
.docs-sidebar {
transform: translateX(-100%);
width: 270px
}
.docs-mobile-topbar {
display: flex
}
.docs-main {
margin-left: 0
}
}
</style>
</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" class="active"><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="apps/index.html"><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 &amp;
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 &amp; 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>Welcome to Huntarr</h1>
<!-- Admin message -->
<section class="welcome-admin-section"
style="display:flex;flex-wrap:wrap;align-items:flex-start;gap:24px;margin:24px 0;padding:24px;background:rgba(255,255,255,0.03);border-radius:12px;border:1px solid rgba(255,255,255,0.06);">
<div style="flex-shrink:0;">
<img src="images/admin9705.png" alt="Admin9705" width="120" height="120"
style="border-radius:50%;border:3px solid #3498db;">
</div>
<div style="flex:1;min-width:0;">
<h2 style="margin-top:0;">A Message from Admin9705</h2>
<p>Huntarr started as a simple bash script to solve a real problem: *arr apps don't actively
search for missing content in your existing library. What you see today evolved from that
need, with input from users who discovered they had significant gaps they didn't even
know existed. The best validation? My wife finally cancelled our streaming
subscriptions because our setup actually works.</p>
<p>If you love the program, future donations to my daughter's 529 college fund make her day!
I never profit from this, and actually put a lot into supporting this. Regardless, enjoy
Huntarr and also check out <a href="https://huntarros.com" target="_blank"
rel="noopener">HuntarrOS.com</a> for cool Docker deployment orchestration.</p>
<p style="margin-bottom:0;"><a href="https://plexguide.github.io/Huntarr.io/donate.html"
target="_blank" rel="noopener" class="btn btn-secondary"
style="border-color:rgba(231,76,60,0.3);color:#e74c3c;"><i class="fas fa-heart"></i>
Donate</a></p>
</div>
</section>
<!-- Hero -->
<div class="hero">
<img src="images/huntarr-logo.png" alt="Huntarr" class="hero-logo">
<h2>Huntarr Documentation</h2>
<p class="page-subtitle">The all-in-one media automation platform. Hunt missing content, upgrade
quality, manage requests, and run your entire media library — automatically.</p>
<div class="hero-actions">
<a href="getting-started/installation.html" class="btn btn-primary"><i
class="fas fa-download"></i> Install Huntarr</a>
<a href="getting-started/first-steps.html" class="btn btn-secondary"><i
class="fas fa-rocket"></i> Quick Start</a>
<a href="https://github.com/plexguide/Huntarr.io" target="_blank" class="btn btn-secondary"><i
class="fab fa-github"></i> GitHub</a>
</div>
</div>
<!-- What is Huntarr -->
<h2>What is Huntarr?</h2>
<p>Your *arr apps (Sonarr, Radarr, etc.) monitor RSS feeds for new releases — but they don't go back and
actively search for content already missing from your library. Over time, gaps build up: missing
seasons, movies stuck below your quality cutoff, albums with incomplete tracks. Nobody fixes this
automatically.</p>
<p><strong>Huntarr does.</strong> It systematically scans your entire library, identifies all missing or
below-cutoff content, and searches your indexers in small, safe batches. It pauses when your
download queues are full, respects per-instance API caps, and starts again automatically. Completely
hands-off.</p>
<p>But Huntarr has grown well beyond a missing-content hunter. It now includes its own built-in
<strong>Movie Hunt</strong> and <strong>TV Hunt</strong> modules (standalone alternatives to Radarr
and Sonarr), <strong>Index Master</strong> (a Prowlarr alternative built right in), <strong>NZB
Hunt</strong> (a fully self-contained Usenet download client), and <strong>Requestarr</strong>
(a complete user request and approval system). Use all of them, some of them, or none — your
existing *arr stack always works alongside whatever you choose.
</p>
<!-- New to Huntarr - Step by step -->
<h2>New to Huntarr? Start Here</h2>
<p>If you're installing Huntarr for the first time, follow these steps in order. Most users are up and
running in under 10 minutes.</p>
<div class="card-grid">
<div class="card">
<div class="card-icon icon-blue"><i class="fas fa-download"></i></div>
<h3>1. Install Huntarr</h3>
<p>Run Huntarr via Docker (recommended), Unraid Community Apps, or as a standalone process on
any Linux/macOS/Windows machine. See the <a
href="getting-started/installation.html">Installation Guide</a>.</p>
</div>
<div class="card">
<div class="card-icon icon-gold"><i class="fas fa-magic"></i></div>
<h3>2. Complete Setup Wizard</h3>
<p>Create your admin account, optionally enable 2FA, and link your Plex account for easy user
sign-in. The wizard walks you through it. See <a
href="getting-started/setup-wizard.html">Setup Wizard</a>.</p>
</div>
<div class="card">
<div class="card-icon icon-green"><i class="fas fa-plug"></i></div>
<h3>3. Connect Your *arr Apps</h3>
<p>Go to <strong>Apps</strong> and add your Sonarr, Radarr, Lidarr, Readarr, or Whisparr
instances. Enter the URL and API key — Huntarr will start hunting immediately.</p>
</div>
<div class="card">
<div class="card-icon icon-purple"><i class="fas fa-clock"></i></div>
<h3>4. Customize Schedules</h3>
<p>Visit <strong>Settings → Scheduling</strong> to configure how often Huntarr searches for
missing and below-cutoff content. Start with defaults — they work well for most users.</p>
</div>
</div>
<!-- How It Works -->
<h2>How It Works</h2>
<p>Understanding Huntarr's core concept helps you get the most out of it:</p>
<div class="alert alert-info">
<strong><i class="fas fa-lightbulb"></i> The Core Problem</strong>
<p>Your *arr apps (Sonarr, Radarr, etc.) are great at grabbing <em>new</em> releases from RSS. But
they don't go back and search for content that was <em>already</em> missing when you added it,
or content sitting below your quality cutoff. Over time, your library develops hundreds of
invisible gaps.</p>
</div>
<p><strong>Huntarr solves this.</strong> It works alongside your existing *arr apps — it reads their
libraries, finds every missing episode, movie, album, or book, and triggers searches in small, safe
batches. It respects rate limits, pauses when your download queue is busy, and runs 24/7 on
configurable schedules.</p>
<p>On top of that, Huntarr includes powerful built-in modules like <strong>Movie Hunt</strong> (a
standalone Radarr alternative), <strong>NZB Hunt</strong> (a built-in Usenet client), and
<strong>Requestarr</strong> (a full media request system for your family and friends). Each module
is optional — enable what you need.</p>
<!-- Pro Tips -->
<h2>Pro Tips for New Users</h2>
<div class="alert alert-success">
<strong><i class="fas fa-check-circle"></i> Tip 1: Start with defaults</strong>
<p>Huntarr ships with sensible defaults. Let it run for 24 hours before tweaking schedules — you'll
be surprised how much it finds on its own.</p>
</div>
<div class="alert alert-warning">
<strong><i class="fas fa-exclamation-triangle"></i> Tip 2: Don't search too aggressively</strong>
<p>Setting very short intervals (e.g., every 1 minute) will get your indexer accounts rate-limited
or banned. The default 1530 minute cycles are designed to be safe.</p>
</div>
<div class="alert alert-info">
<strong><i class="fas fa-users"></i> Tip 3: Use Requestarr for your household</strong>
<p>Enable Requestarr and let family members request movies and TV shows through a simple web UI. You
can approve or auto-approve requests, and it broadcasts to all your connected instances at once.
</p>
</div>
<!-- Feature cards -->
<h2>Key Features</h2>
<div class="features-grid">
<div class="feature-card">
<div class="fc-icon icon-blue"><i class="fas fa-search"></i></div>
<h3>Automated Hunting</h3>
<p>Continuously scans for missing TV shows, movies, music, books, and adult content across all
your *arr instances — simultaneously, on independent schedules.</p>
</div>
<div class="feature-card">
<div class="fc-icon icon-green"><i class="fas fa-arrow-up"></i></div>
<h3>Quality Upgrades</h3>
<p>Automatically finds media below your quality cutoff and triggers upgrade searches. 720p in
your library? Huntarr hunts for 1080p without you lifting a finger.</p>
</div>
<div class="feature-card">
<div class="fc-icon icon-gold"><i class="fas fa-clock"></i></div>
<h3>Smart Scheduling</h3>
<p>Per-app, per-instance schedules with configurable intervals and hourly search caps. Never
overload your indexers or get rate-limited again.</p>
</div>
<div class="feature-card">
<div class="fc-icon icon-purple"><i class="fas fa-bell"></i></div>
<h3>Notifications</h3>
<p>Discord, Telegram, Pushover, Email, Apprise, and more. Get notified the moment Huntarr finds
something, grabs something, or hits an error.</p>
</div>
<div class="feature-card">
<div class="fc-icon icon-red"><i class="fas fa-clapperboard"></i></div>
<h3>Movie Hunt &amp; TV Hunt</h3>
<p>Full standalone movie and TV management with discovery UI, quality profiles, root folder
management, and direct disk import. No Radarr or Sonarr required.</p>
</div>
<div class="feature-card">
<div class="fc-icon icon-cyan"><i class="fas fa-newspaper"></i></div>
<h3>NZB Hunt</h3>
<p>A complete Usenet client built right in. Connect NNTP servers, download NZBs, direct-unpack
RARs, and manage your full queue — without SABnzbd or NZBGet.</p>
</div>
<div class="feature-card">
<div class="fc-icon icon-orange"><i class="fas fa-hand-paper"></i></div>
<h3>Requestarr</h3>
<p>Full media request system with user accounts, approval queues, per-user permissions,
auto-approve, and bundles that broadcast a single request to multiple instances
simultaneously.</p>
</div>
<div class="feature-card">
<div class="fc-icon icon-blue"><i class="fas fa-shield-halved"></i></div>
<h3>Secure &amp; Self-Hosted</h3>
<p>Runs entirely on your own hardware. Local auth with bcrypt, optional 2FA with TOTP, and Plex
SSO sign-in for user-friendly access to Requestarr.</p>
</div>
</div>
<!-- Quick links -->
<h2>Quick Links</h2>
<div class="card-grid">
<a href="getting-started/installation.html" class="card">
<div class="card-icon icon-blue"><i class="fas fa-download"></i></div>
<h3>Installation</h3>
<p>Docker, Unraid, Windows, macOS, or Linux — get up and running in minutes.</p>
</a>
<a href="apps/index.html" class="card">
<div class="card-icon icon-green"><i class="fas fa-plug"></i></div>
<h3>Connect Your Apps</h3>
<p>Add your Sonarr, Radarr, Lidarr, Readarr, and Whisparr instances to start hunting.</p>
</a>
<a href="settings/scheduling.html" class="card">
<div class="card-icon icon-gold"><i class="fas fa-clock"></i></div>
<h3>Scheduling</h3>
<p>Configure hunt intervals, search caps, and upgrade cycles per app and instance.</p>
</a>
<a href="help/faq.html" class="card">
<div class="card-icon icon-purple"><i class="fas fa-question-circle"></i></div>
<h3>FAQ &amp; Troubleshooting</h3>
<p>Common questions, known issues, and step-by-step solutions.</p>
</a>
</div>
<!-- Supported Apps -->
<h2>Supported Third-Party Apps</h2>
<p>Huntarr connects to all major *arr apps and works alongside them. Add multiple instances of each —
for example, a 1080p Sonarr and a 4K Sonarr — and Huntarr hunts across all of them independently.
</p>
<table>
<thead>
<tr>
<th>App</th>
<th>Missing Hunt</th>
<th>Quality Upgrade</th>
<th>Notes</th>
</tr>
</thead>
<tbody>
<tr>
<td><strong>Sonarr</strong></td>
<td>✅ Yes</td>
<td>✅ Yes</td>
<td>TV series — episodes and full seasons</td>
</tr>
<tr>
<td><strong>Radarr</strong></td>
<td>✅ Yes</td>
<td>✅ Yes</td>
<td>Movies — any monitored film</td>
</tr>
<tr>
<td><strong>Lidarr</strong></td>
<td>✅ Yes</td>
<td>✅ Yes</td>
<td>Music — albums, tracks, and artists</td>
</tr>
<tr>
<td><strong>Readarr</strong></td>
<td>✅ Yes</td>
<td>✅ Yes</td>
<td>Books and audiobooks</td>
</tr>
<tr>
<td><strong>Whisparr v2</strong></td>
<td>✅ Yes</td>
<td>✅ Yes</td>
<td>Adult content (v2 API)</td>
</tr>
<tr>
<td><strong>Whisparr v3</strong></td>
<td>✅ Yes</td>
<td>✅ Yes</td>
<td>Adult content (v3 API)</td>
</tr>
<tr>
<td><strong>Prowlarr</strong></td>
<td></td>
<td></td>
<td>Indexer management (sync with Huntarr)</td>
</tr>
<tr>
<td><strong>Swaparr</strong></td>
<td></td>
<td></td>
<td>Stalled download management integration</td>
</tr>
</tbody>
</table>
<!-- Built-in Modules -->
<h2>Built-in Modules</h2>
<p>These modules are built directly into Huntarr. They can replace or run alongside their *arr
equivalents.</p>
<table>
<thead>
<tr>
<th>Module</th>
<th>Replaces</th>
<th>Status</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><strong>Movie Hunt</strong></td>
<td>Radarr</td>
<td>Beta</td>
<td>Full movie management with discovery, quality profiles, and library tracking</td>
</tr>
<tr>
<td><strong>TV Hunt</strong></td>
<td>Sonarr</td>
<td>Beta</td>
<td>Full TV/series management with episode and season tracking</td>
</tr>
<tr>
<td><strong>Index Master</strong></td>
<td>Prowlarr</td>
<td>Beta</td>
<td>Manage Usenet and torrent indexers directly inside Huntarr</td>
</tr>
<tr>
<td><strong>NZB Hunt</strong></td>
<td>SABnzbd / NZBGet</td>
<td>Beta</td>
<td>Full Usenet download client with multi-server, queue, and direct unpack</td>
</tr>
<tr>
<td><strong>Requestarr</strong></td>
<td>Overseerr / Jellyseerr</td>
<td>Stable</td>
<td>User request system with approval queue, bundles, and permissions</td>
</tr>
</tbody>
</table>
</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>