mirror of
https://github.com/plexguide/Huntarr.io.git
synced 2026-04-19 22:19:08 -04:00
393 lines
22 KiB
HTML
393 lines
22 KiB
HTML
<!DOCTYPE html>
|
||
<html lang="en">
|
||
|
||
<head>
|
||
<meta charset="UTF-8">
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||
<title>First Steps - Huntarr Documentation</title>
|
||
<meta name="description"
|
||
content="What to do after installing Huntarr — connect apps, configure schedules, set up notifications, and start your first hunt.">
|
||
<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="installation.html"><i class="fas fa-download"></i> Installation</a>
|
||
<a href="setup-wizard.html"><i class="fas fa-magic"></i> Setup Wizard</a>
|
||
<a href="first-steps.html" class="active"><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 &
|
||
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>First Steps</h1>
|
||
<p class="page-subtitle">Huntarr is installed and running. Here's how to get it working properly — from
|
||
connecting your apps to your first successful hunt.</p>
|
||
|
||
<!-- Step 1 -->
|
||
<h2>Step 1 — Connect Your Apps</h2>
|
||
<p>Huntarr can't hunt anything until it knows where to look. Start by connecting your existing *arr
|
||
apps.</p>
|
||
<ol>
|
||
<li>Open the sidebar and click <strong>Apps</strong> → <strong>3rd Party Apps</strong>.</li>
|
||
<li>Select the app type you want to add (Sonarr, Radarr, Lidarr, Readarr, or Whisparr).</li>
|
||
<li>Click <strong>Add Instance</strong>.</li>
|
||
<li>Enter a name, the URL (e.g., <code>http://192.168.1.100:8989</code>), and the API key from your
|
||
app's settings.</li>
|
||
<li>Click <strong>Test Connection</strong> to verify, then <strong>Save</strong>.</li>
|
||
</ol>
|
||
|
||
<div class="alert alert-info">
|
||
<strong>Multiple instances supported.</strong> You can add multiple instances of the same app. For
|
||
example, a 1080p Sonarr and a separate 4K Sonarr. Each gets its own independent schedule and search
|
||
caps.
|
||
</div>
|
||
<div class="alert alert-info">
|
||
<strong>Docker networking tip.</strong> If Huntarr and your *arr apps are on the same Docker
|
||
network, use the container name as the hostname (e.g., <code>http://sonarr:8989</code>). If they're
|
||
on separate networks or the host, use the server's LAN IP. Never use <code>localhost</code> — inside
|
||
Huntarr's container that refers to itself, not your host.
|
||
</div>
|
||
|
||
<!-- Step 2 -->
|
||
<h2>Step 2 — Understand Your Dashboard</h2>
|
||
<p>The Huntarr home page is your control center. Here's what you'll see:</p>
|
||
<ul>
|
||
<li><strong>App cards</strong> — each connected *arr instance appears as a card showing its hunt
|
||
status, last run time, and statistics (missing items found, upgrades triggered, completed this
|
||
cycle)</li>
|
||
<li><strong>Grid view / List view</strong> — toggle between a visual card layout and a detailed
|
||
activity log using the icons in the top-right of the Hunt Activities section</li>
|
||
<li><strong>Hunt status indicator</strong> — each card shows whether Huntarr is currently hunting,
|
||
waiting for the next cycle, or paused</li>
|
||
<li><strong>Recent activity</strong> — a running log of what Huntarr searched for and whether it
|
||
found anything</li>
|
||
</ul>
|
||
|
||
<!-- Step 3 -->
|
||
<h2>Step 3 — Configure Schedules</h2>
|
||
<p>By default, Huntarr runs on a basic schedule. Tuning this properly is the most important step for
|
||
long-term success — too aggressive and your indexers will rate-limit you; too conservative and your
|
||
library fills slowly.</p>
|
||
<ol>
|
||
<li>Go to <strong>Settings → Scheduling</strong>.</li>
|
||
<li>Select the app and instance you want to configure.</li>
|
||
<li>Set the <strong>hunt interval</strong> — how often Huntarr checks this instance (in minutes).
|
||
</li>
|
||
<li>Set the <strong>missing items cap</strong> — maximum number of missing items to search per
|
||
cycle.</li>
|
||
<li>Set the <strong>upgrade items cap</strong> — maximum quality upgrades to attempt per cycle.</li>
|
||
<li>Save and repeat for each connected app/instance.</li>
|
||
</ol>
|
||
|
||
<p><strong>Recommended starting settings:</strong></p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Setting</th>
|
||
<th>Recommended Start</th>
|
||
<th>Why</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>Hunt Interval</td>
|
||
<td>30 – 60 minutes</td>
|
||
<td>Frequent enough to be useful; not so frequent indexers complain</td>
|
||
</tr>
|
||
<tr>
|
||
<td>Missing Items per Cycle</td>
|
||
<td>3 – 5</td>
|
||
<td>Small batches are polite to indexers; you can increase once things are stable</td>
|
||
</tr>
|
||
<tr>
|
||
<td>Upgrade Items per Cycle</td>
|
||
<td>1 – 3</td>
|
||
<td>Upgrades generate more API calls; start conservative</td>
|
||
</tr>
|
||
<tr>
|
||
<td>Queue Full Pause</td>
|
||
<td>Enabled</td>
|
||
<td>Huntarr pauses when your download queue is full — avoids piling up searches you can't
|
||
download yet</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
|
||
<div class="alert alert-info">
|
||
<strong>Start small and scale up.</strong> It's much better to start with conservative caps and
|
||
increase them gradually than to start aggressive and get rate-limited by your indexer. Most indexers
|
||
allow 100–200 API calls per day per user.
|
||
</div>
|
||
|
||
<!-- Step 4 -->
|
||
<h2>Step 4 — Set Up Notifications</h2>
|
||
<p>Huntarr can notify you whenever it grabs something, completes a cycle, or hits an error. This is
|
||
optional but highly recommended — you'll know immediately when something new lands in your library.
|
||
</p>
|
||
<ol>
|
||
<li>Go to <strong>Settings → Notifications</strong>.</li>
|
||
<li>Click <strong>Add Connection</strong>.</li>
|
||
<li>Choose your provider (Discord, Telegram, Pushover, Email, Apprise, and more).</li>
|
||
<li>Configure the required credentials (webhook URL, bot token, etc.).</li>
|
||
<li>Click <strong>Test</strong> to send a test notification and confirm it works.</li>
|
||
<li>Choose which apps and instances trigger this notification — you can have different notification
|
||
channels for different apps.</li>
|
||
</ol>
|
||
|
||
<!-- Step 5 -->
|
||
<h2>Step 5 — Set Up Backups</h2>
|
||
<p>Huntarr stores all its configuration, database, and state in <code>/config</code>. Enable automatic
|
||
backups so you don't lose your setup if something goes wrong.</p>
|
||
<ol>
|
||
<li>Go to <strong>Settings → Backup & Restore</strong>.</li>
|
||
<li>Enable <strong>Automatic Backups</strong>.</li>
|
||
<li>Set your preferred backup frequency.</li>
|
||
<li>Optionally configure a backup retention limit.</li>
|
||
</ol>
|
||
<p>Backups are stored inside <code>/config/backups/</code> and can be downloaded or restored from the
|
||
same page.</p>
|
||
|
||
<!-- Step 6 -->
|
||
<h2>Step 6 — Watch Your First Hunt</h2>
|
||
<p>Once you've connected apps and set a schedule, Huntarr will run its first hunt automatically. You can
|
||
also trigger one manually:</p>
|
||
<ol>
|
||
<li>Go to <strong>System → Hunt Manager</strong>.</li>
|
||
<li>Find the app instance you want to test.</li>
|
||
<li>Click <strong>Run Now</strong> to trigger an immediate hunt cycle.</li>
|
||
<li>Switch back to the home page or go to <strong>System → Logs</strong> to watch what Huntarr does
|
||
in real time.</li>
|
||
</ol>
|
||
|
||
<!-- Step 7 — Optional modules -->
|
||
<h2>Step 7 — Explore Optional Modules (Optional)</h2>
|
||
|
||
<h3>Movie Hunt & TV Hunt</h3>
|
||
<p>If you want to manage movies or TV shows independently of Radarr and Sonarr, Movie Hunt and TV Hunt
|
||
are built-in alternatives. They include their own indexer configuration, download client support,
|
||
and a visual library browser.</p>
|
||
<ol>
|
||
<li>Navigate to <strong>Movie Hunt</strong> or <strong>TV Hunt</strong> in the sidebar.</li>
|
||
<li>Configure <strong>Indexers</strong> — add your Usenet or torrent indexers via <strong>Index
|
||
Master</strong>.</li>
|
||
<li>Configure <strong>Download Clients</strong> — add SABnzbd, NZBGet, qBittorrent, NZB Hunt, or
|
||
others.</li>
|
||
<li>Set up a <strong>Root Folder</strong> — where downloaded media lands on disk.</li>
|
||
<li>Create a <strong>Quality Profile</strong> — define preferred formats and cutoffs.</li>
|
||
<li>Start browsing and adding movies or shows to your library.</li>
|
||
</ol>
|
||
|
||
<h3>NZB Hunt (Built-in Usenet Client)</h3>
|
||
<p>NZB Hunt replaces SABnzbd or NZBGet with a fully built-in Usenet downloader.</p>
|
||
<ol>
|
||
<li>Navigate to <strong>NZB Hunt</strong> in the sidebar.</li>
|
||
<li>Go to <strong>Settings → Servers</strong> and add your NNTP server credentials (host, port, SSL,
|
||
username, password, connection count).</li>
|
||
<li>Configure your download folder under <strong>Settings → Folders</strong>.</li>
|
||
<li>Tune advanced settings like <strong>Direct Unpack</strong> (on by default for new installs) and
|
||
the <strong>encrypted RAR action</strong> (abort by default).</li>
|
||
<li>Connect NZB Hunt as a download client in Movie Hunt or TV Hunt under <strong>Indexers &
|
||
Clients</strong>.</li>
|
||
</ol>
|
||
|
||
<h3>Requestarr (Media Requests)</h3>
|
||
<p>Requestarr lets users discover and request movies and TV shows, which flow through an approval queue
|
||
you control.</p>
|
||
<ol>
|
||
<li>Navigate to <strong>Requests</strong> in the sidebar.</li>
|
||
<li>Configure which instances and apps receive approved requests.</li>
|
||
<li>Optionally invite other users with limited permissions — they can browse and request, but can't
|
||
manage instances or settings.</li>
|
||
<li>Enable <strong>auto-approve</strong> for trusted users to skip the queue entirely.</li>
|
||
</ol>
|
||
|
||
<!-- Tips -->
|
||
<h2>Tips for a Healthy Setup</h2>
|
||
<ul>
|
||
<li><strong>Start conservative with caps</strong> — begin at 3–5 items per cycle and increase
|
||
gradually once you confirm your indexer handles it without complaint</li>
|
||
<li><strong>Check the logs</strong> — if hunts aren't finding anything or are erroring, go to
|
||
<strong>System → Logs</strong> for detailed output that usually tells you exactly what's wrong
|
||
</li>
|
||
<li><strong>Use separate schedules</strong> — if you have multiple instances (e.g., 1080p Sonarr and
|
||
4K Sonarr), stagger their schedules by 15–30 minutes to avoid simultaneous indexer load</li>
|
||
<li><strong>Enable the queue full pause</strong> — this prevents Huntarr from searching for more
|
||
content when your downloader is already at capacity</li>
|
||
<li><strong>Back up regularly</strong> — enable automatic backups in Settings → Backup & Restore
|
||
before making major changes</li>
|
||
<li><strong>Use Docker volumes</strong> — if running via Docker, always map <code>/config</code> to
|
||
a persistent host path, never use an anonymous Docker volume</li>
|
||
</ul>
|
||
|
||
<!-- Next steps -->
|
||
<h2>Where to Go Next</h2>
|
||
<div class="card-grid">
|
||
<a href="../apps/index.html" class="card">
|
||
<div class="card-icon icon-green"><i class="fas fa-plug"></i></div>
|
||
<h3>3rd Party Apps</h3>
|
||
<p>Learn how to configure each *arr app connection in detail</p>
|
||
</a>
|
||
<a href="../movie-hunt/index.html" class="card">
|
||
<div class="card-icon icon-red"><i class="fas fa-clapperboard"></i></div>
|
||
<h3>Movie Hunt</h3>
|
||
<p>Set up the standalone movie grabber with indexers and download clients</p>
|
||
</a>
|
||
<a href="../nzb-hunt/index.html" class="card">
|
||
<div class="card-icon icon-cyan"><i class="fas fa-newspaper"></i></div>
|
||
<h3>NZB Hunt</h3>
|
||
<p>Configure the built-in Usenet download client and connect your NNTP servers</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>Fine-tune hunt intervals, caps, and cycle settings per app and instance</p>
|
||
</a>
|
||
<a href="../requestarr/index.html" class="card">
|
||
<div class="card-icon icon-orange"><i class="fas fa-hand-paper"></i></div>
|
||
<h3>Requestarr</h3>
|
||
<p>Set up user request management with approval queues and bundles</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</h3>
|
||
<p>Common questions, issues, and step-by-step solutions</p>
|
||
</a>
|
||
</div>
|
||
|
||
</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> |