mirror of
https://github.com/plexguide/Huntarr.io.git
synced 2026-04-20 04:06:51 -04:00
343 lines
19 KiB
HTML
343 lines
19 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<title>Setup Wizard - 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" class="active"><i class="fas fa-magic"></i> Setup Wizard</a>
|
|
<a href="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">Media 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>Setup Wizard</h1>
|
|
<p class="page-subtitle">Huntarr's 6-step setup wizard creates your admin account, secures it with 2FA,
|
|
and configures authentication — all on first launch.</p>
|
|
|
|
<h2>Overview</h2>
|
|
<p>When you first access Huntarr at <code>http://your-server:9705</code>, the setup wizard appears
|
|
automatically. It cannot be skipped — you must complete at least the account creation step before
|
|
using Huntarr. The wizard consists of 6 steps:</p>
|
|
|
|
<ol class="steps">
|
|
<li>
|
|
<h4>Create Admin Account</h4>
|
|
<p>Choose a username and password for the owner account.</p>
|
|
</li>
|
|
<li>
|
|
<h4>Two-Factor Authentication</h4>
|
|
<p>Optionally enable TOTP-based 2FA for extra security.</p>
|
|
</li>
|
|
<li>
|
|
<h4>Link Plex Account</h4>
|
|
<p>Optionally connect your Plex account for SSO login.</p>
|
|
</li>
|
|
<li>
|
|
<h4>Authentication Mode</h4>
|
|
<p>Choose how users access Huntarr (Login, Local Bypass, or No Login).</p>
|
|
</li>
|
|
<li>
|
|
<h4>Recovery Key</h4>
|
|
<p>Save your emergency recovery key — shown only once.</p>
|
|
</li>
|
|
<li>
|
|
<h4>Finish</h4>
|
|
<p>You're done! Head to the dashboard to start configuring.</p>
|
|
</li>
|
|
</ol>
|
|
|
|
<h2>Step 1: Create Admin Account</h2>
|
|
<p>This creates the <strong>owner</strong> account — the primary admin user with full access to all
|
|
Huntarr features.</p>
|
|
<ul>
|
|
<li><strong>Username</strong> — Must be at least 3 characters. This is what you'll type at the login
|
|
screen. Choose something memorable.</li>
|
|
<li><strong>Password</strong> — Must be at least 8 characters. Use a strong, unique password.
|
|
Huntarr stores passwords securely using bcrypt hashing — even if someone accesses the database,
|
|
your password cannot be recovered.</li>
|
|
<li><strong>Confirm Password</strong> — Re-enter to prevent typos.</li>
|
|
</ul>
|
|
<div class="alert alert-info">
|
|
<strong><i class="fas fa-info-circle"></i> Owner vs. User accounts</strong>
|
|
<p>The owner account has full admin access — settings, scheduling, user management, everything.
|
|
Regular user accounts (created later via Requestarr or user management) only see the request
|
|
interface and cannot change settings.</p>
|
|
</div>
|
|
|
|
<h2>Step 2: Two-Factor Authentication (2FA)</h2>
|
|
<p>This step lets you add an extra layer of security using TOTP (Time-based One-Time Password). When
|
|
enabled, logging in requires both your password <em>and</em> a 6-digit code from your authenticator
|
|
app.</p>
|
|
<ul>
|
|
<li><strong>Scan the QR code</strong> — Open your authenticator app and scan the QR code displayed.
|
|
Click the QR code to enlarge it if needed.</li>
|
|
<li><strong>Manual entry</strong> — If scanning doesn't work, copy the secret key and enter it
|
|
manually in your authenticator app.</li>
|
|
<li><strong>Verify</strong> — Enter the 6-digit code your app generates to confirm 2FA is working.
|
|
</li>
|
|
<li><strong>Skip for now</strong> — You can always enable 2FA later from Settings → User Account.
|
|
</li>
|
|
</ul>
|
|
<p><strong>Recommended authenticator apps:</strong> Google Authenticator, Authy, Microsoft
|
|
Authenticator, 1Password, Bitwarden.</p>
|
|
<div class="alert alert-warning">
|
|
<strong><i class="fas fa-exclamation-triangle"></i> Don't lock yourself out</strong>
|
|
<p>If you enable 2FA and then lose access to your authenticator app (phone lost/reset), you'll need
|
|
your recovery key (Step 5) to regain access. Save it before enabling 2FA.</p>
|
|
</div>
|
|
|
|
<h2>Step 3: Link Plex Account</h2>
|
|
<p>This step is <strong>strongly recommended</strong> if you use Plex. Linking your Plex account
|
|
provides:</p>
|
|
<ul>
|
|
<li><strong>Backup login method</strong> — If you forget your Huntarr password, you can still sign
|
|
in with Plex.</li>
|
|
<li><strong>Plex SSO for users</strong> — Once the owner links Plex, regular users can sign into
|
|
Requestarr using their Plex accounts. They don't need separate Huntarr passwords.</li>
|
|
<li><strong>One-click sign-in</strong> — Click "Sign in with Plex" at the login screen instead of
|
|
remembering another password.</li>
|
|
</ul>
|
|
<p>A popup window will open for you to sign into plex.tv. After authenticating, the window closes
|
|
automatically and your account is linked.</p>
|
|
<div class="alert alert-info">
|
|
<strong><i class="fas fa-info-circle"></i> Privacy note</strong>
|
|
<p>Huntarr only stores your Plex authentication token for SSO purposes. It does not access your Plex
|
|
library, viewing history, or any other Plex data.</p>
|
|
</div>
|
|
|
|
<h2>Step 4: Authentication Mode</h2>
|
|
<p>Choose how users will access Huntarr. This can be changed later in Settings → Main.</p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Mode</th>
|
|
<th>Security</th>
|
|
<th>Best for</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><strong>Login Mode</strong></td>
|
|
<td>High</td>
|
|
<td>Any deployment, especially those accessible from the internet. Requires
|
|
username/password for all connections.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><strong>Local Bypass</strong></td>
|
|
<td>Medium</td>
|
|
<td>Home networks where you trust all LAN users. Local IPs skip login; external access still
|
|
requires authentication.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><strong>No Login</strong></td>
|
|
<td>None</td>
|
|
<td>Only behind a secured reverse proxy (Authelia, Authentik, VPN). Anyone who reaches the
|
|
URL has full access.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
<h2>Step 5: Recovery Key</h2>
|
|
<p>This is the most important step. A unique recovery key is generated for your account. This key is the
|
|
<strong>only way</strong> to regain access if you lose your password and 2FA device.</p>
|
|
<ul>
|
|
<li>The key is displayed for a limited time — <strong>copy or screenshot it immediately</strong>
|
|
</li>
|
|
<li>Store it in a password manager, secure note, or printed in a safe location</li>
|
|
<li>The key is <strong>never shown again</strong> after you leave this step</li>
|
|
<li>Huntarr cannot reset your password or help with account recovery — your security is fully
|
|
self-sovereign</li>
|
|
</ul>
|
|
|
|
<div class="alert alert-danger">
|
|
<strong><i class="fas fa-exclamation-triangle"></i> No recovery without this key</strong>
|
|
<p>If you lose both your password and recovery key, there is no way to recover your account. You'll
|
|
need to delete the Huntarr database and run setup again, losing all settings, schedules, and
|
|
history.</p>
|
|
</div>
|
|
|
|
<h2>Step 6: Finish</h2>
|
|
<p>Setup is complete! Click <strong>Go to Dashboard</strong> to start using Huntarr.</p>
|
|
|
|
<h2>After Setup — What to Do Next</h2>
|
|
<p>Now that your account is ready, here's the recommended order for configuring Huntarr:</p>
|
|
<ol>
|
|
<li><strong>Connect your *arr apps</strong> — Go to <strong>Apps</strong> in the sidebar and add
|
|
your Sonarr, Radarr, Lidarr, Readarr, or Whisparr instances. You'll need each app's URL and API
|
|
key (found in the app's Settings → General → Security).</li>
|
|
<li><strong>Configure schedules</strong> — Visit <strong>Settings → Scheduling</strong> to set up
|
|
hunt intervals and caps for each app. Start with the recommended defaults (30 min interval, 5
|
|
missing cap, 3 upgrade cap for Sonarr).</li>
|
|
<li><strong>Set up notifications</strong> — Visit <strong>Settings → Notifications</strong> to get
|
|
alerts via Discord, Telegram, Pushover, Email, or Apprise whenever Huntarr grabs something or
|
|
encounters an error.</li>
|
|
<li><strong>Explore Requestarr</strong> — If you want to let family or friends request media, visit
|
|
the <strong>Requests</strong> section to configure bundles, user permissions, and approval
|
|
workflows.</li>
|
|
<li><strong>Check Movie Hunt</strong> — If you want to try Huntarr's built-in Radarr alternative,
|
|
expand <strong>Movie Hunt</strong> in the sidebar and start building your collection.</li>
|
|
</ol>
|
|
|
|
<div class="alert alert-success">
|
|
<strong><i class="fas fa-lightbulb"></i> Tip: Let it run for 24 hours</strong>
|
|
<p>After connecting your *arr apps and enabling schedules, let Huntarr run for a full day before
|
|
making adjustments. Check the Dashboard and Logs to see what it found and grabbed. Most users
|
|
are surprised by how many gaps existed in their libraries.</p>
|
|
</div>
|
|
|
|
<h2>Re-running Setup</h2>
|
|
<p>If you need to completely start over:</p>
|
|
<ol>
|
|
<li><strong>Back up first</strong> — Go to Settings → Backup & Restore and create a backup</li>
|
|
<li>Stop the Huntarr container or service</li>
|
|
<li>Delete <code>huntarr.db</code> from your <code>/config</code> directory</li>
|
|
<li>Restart Huntarr — the setup wizard will appear again</li>
|
|
</ol>
|
|
<div class="alert alert-danger">
|
|
<strong><i class="fas fa-exclamation-triangle"></i> Database deletion is permanent</strong>
|
|
<p>Deleting the database removes ALL settings, user accounts, schedules, request history, and
|
|
activity logs. Always create a backup first.</p>
|
|
</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> |