mirror of
https://github.com/plexguide/Huntarr.io.git
synced 2026-02-20 07:44:17 -05:00
2997382d37
- Move donate page from help/donate.html to donate.html (URL: .../donate.html) - Update all doc links and README to new donate URL - Sidebar Donate link: red border, left accent, subtle red glow and background - Applies to all doc pages via shared main.css
247 lines
12 KiB
HTML
247 lines
12 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 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">
|
|
|
|
<!-- 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-th-large"></i> Overview</a>
|
|
<a href="../apps/sonarr.html"><i class="fas fa-tv"></i> Sonarr</a>
|
|
<a href="../apps/radarr.html"><i class="fas fa-film"></i> Radarr</a>
|
|
<a href="../apps/lidarr.html"><i class="fas fa-music"></i> Lidarr</a>
|
|
<a href="../apps/readarr.html"><i class="fas fa-book"></i> Readarr</a>
|
|
<a href="../apps/whisparr.html"><i class="fas fa-mask"></i> Whisparr</a>
|
|
<a href="../apps/prowlarr.html"><i class="fas fa-search"></i> Prowlarr</a>
|
|
<a href="../apps/swaparr.html"><i class="fas fa-exchange-alt"></i> Swaparr</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">You've installed Huntarr and completed setup. Here's what to do next.</p>
|
|
|
|
<h2>Your Dashboard</h2>
|
|
<ul>
|
|
<li>The home page shows all connected apps and their hunt status</li>
|
|
<li>Grid view shows app cards with stats (missing, upgrading, completed)</li>
|
|
<li>List view shows detailed hunt activity entries</li>
|
|
<li>Toggle between views with the icons in the top-right of the Hunt Activities section</li>
|
|
</ul>
|
|
|
|
<h2>Connect All Your Apps</h2>
|
|
<p>If you only connected one app during setup, add the rest now:</p>
|
|
<ol>
|
|
<li>Click on "Apps" in the sidebar</li>
|
|
<li>Select the app type (Sonarr, Radarr, Lidarr, etc.)</li>
|
|
<li>Click "Add Instance"</li>
|
|
<li>Fill in the URL and API key</li>
|
|
<li>Test and save</li>
|
|
</ol>
|
|
|
|
<div class="alert alert-info">
|
|
<strong>Multiple instances</strong>
|
|
<p>Huntarr supports multiple instances of the same app. For example, you can have separate Sonarr instances for 1080p and 4K libraries.</p>
|
|
</div>
|
|
|
|
<h2>Configure Schedules</h2>
|
|
<p>By default, Huntarr checks all apps on a regular cycle. Customize this:</p>
|
|
<ol>
|
|
<li>Go to Settings > Scheduling</li>
|
|
<li>Select the app and instance</li>
|
|
<li>Set the cycle interval (how often to hunt)</li>
|
|
<li>Set caps (max items per cycle) to avoid overloading indexers</li>
|
|
</ol>
|
|
|
|
<p>Recommended starting configuration:</p>
|
|
<table>
|
|
<thead>
|
|
<tr><th>Setting</th><th>Recommended</th><th>Description</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr><td>Hunt Interval</td><td>30 minutes</td><td>Time between hunt cycles</td></tr>
|
|
<tr><td>Missing Items per Cycle</td><td>5</td><td>How many missing items to search per cycle</td></tr>
|
|
<tr><td>Upgrade Items per Cycle</td><td>3</td><td>How many items to attempt upgrading per cycle</td></tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
<h2>Set Up Notifications</h2>
|
|
<ol>
|
|
<li>Go to Settings > Notifications</li>
|
|
<li>Click "Add Connection"</li>
|
|
<li>Choose your provider (Discord, Telegram, etc.)</li>
|
|
<li>Configure credentials</li>
|
|
<li>Send a test notification</li>
|
|
<li>Choose which apps/instances trigger this notification</li>
|
|
</ol>
|
|
|
|
<h2>Explore Movie Hunt (Optional)</h2>
|
|
<p>Movie Hunt is Huntarr's standalone movie grabber — it works independently of Radarr:</p>
|
|
<ol>
|
|
<li>Navigate to Movie Hunt in the sidebar</li>
|
|
<li>Add indexers (NZB or Torrent)</li>
|
|
<li>Add a download client (SABnzbd, qBittorrent, etc.)</li>
|
|
<li>Browse, search, and grab movies directly</li>
|
|
</ol>
|
|
|
|
<h2>Tips for Success</h2>
|
|
<ul>
|
|
<li><strong>Start small</strong>: Begin with low caps (3-5 items per cycle) and increase gradually</li>
|
|
<li><strong>Check logs</strong>: If hunts aren't working, check Settings > Logs for detailed output</li>
|
|
<li><strong>Multiple instances</strong>: Use separate schedules for different instances to spread the load</li>
|
|
<li><strong>Backup regularly</strong>: Enable automatic backups under Settings > Backup & Restore</li>
|
|
</ul>
|
|
|
|
<h2>Next Steps</h2>
|
|
<p>Explore the rest of the documentation:</p>
|
|
|
|
<div class="card-grid">
|
|
<a href="../apps/index.html" class="card">
|
|
<div class="card-icon icon-green"><i class="fas fa-th-large"></i></div>
|
|
<h3>Apps</h3>
|
|
<p>Learn how to configure each app</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</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 your hunt schedules</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 and troubleshooting</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>
|