mirror of
https://github.com/plexguide/Huntarr.io.git
synced 2026-02-20 07:44:17 -05:00
5f5275ff50
- Rewrote CSS with glassmorphism dark theme matching the app - Rewrote JS with mobile sidebar, collapsible nav, copy buttons, scroll-to-top - Created 30 HTML pages covering all features: Getting Started, Apps (7), Movie Hunt (4), NZB Hunt, Requestarr, Settings (6), System (3), Help (3) - Removed 13 obsolete files (eros, whisparr-v2/v3, old root pages, stale markdown) - New responsive layout with mobile hamburger drawer - Updated README with new structure map
222 lines
10 KiB
HTML
222 lines
10 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<title>Installation - Huntarr Documentation</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" class="active"><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"><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> Requestarr</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="../help/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="../help/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>Installation</h1>
|
|
<p class="page-subtitle">Get Huntarr running on Docker, Unraid, or from source.</p>
|
|
|
|
<h2>Requirements</h2>
|
|
<ul>
|
|
<li>Docker and Docker Compose (recommended)</li>
|
|
<li>OR Python 3.10+ for source installs</li>
|
|
<li>512MB RAM minimum, 1GB recommended</li>
|
|
<li>Network access to your *arr instances</li>
|
|
</ul>
|
|
|
|
<h2>Docker (Recommended)</h2>
|
|
<p>Create a <code>docker-compose.yml</code> file with the following:</p>
|
|
<pre><code>services:
|
|
huntarr:
|
|
image: huntarr/huntarr:latest
|
|
container_name: huntarr
|
|
ports:
|
|
- "9705:9705"
|
|
volumes:
|
|
- /path/to/huntarr/config:/config
|
|
- /path/to/media:/media
|
|
environment:
|
|
- TZ=America/New_York
|
|
restart: unless-stopped</code></pre>
|
|
<p>Replace <code>/path/to/huntarr/config</code> and <code>/path/to/media</code> with your actual paths, then run:</p>
|
|
<pre><code>docker-compose up -d</code></pre>
|
|
|
|
<h2>Unraid</h2>
|
|
<ul>
|
|
<li>Huntarr is available in <strong>Community Applications</strong></li>
|
|
<li>Search for "Huntarr" in the CA store</li>
|
|
<li>Key settings: port 9705, <code>/config</code> mapping, timezone</li>
|
|
<li>The template auto-fills most settings — adjust paths as needed for your setup</li>
|
|
</ul>
|
|
|
|
<h2>From Source</h2>
|
|
<pre><code>git clone https://github.com/plexguide/Huntarr.io.git
|
|
cd Huntarr.io
|
|
pip install -r requirements.txt
|
|
python main.py</code></pre>
|
|
<p>Access Huntarr at <a href="http://localhost:9705">http://localhost:9705</a></p>
|
|
|
|
<h2>Post-Installation</h2>
|
|
<p>Open <code>http://your-server:9705</code> in your browser. You'll be greeted by the Setup Wizard to configure your instance. See <a href="setup-wizard.html">Setup Wizard</a> for details.</p>
|
|
|
|
<h2>Environment Variables</h2>
|
|
<table>
|
|
<thead>
|
|
<tr><th>Variable</th><th>Default</th><th>Description</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr><td><code>TZ</code></td><td>UTC</td><td>Timezone</td></tr>
|
|
<tr><td><code>HUNTARR_PORT</code></td><td>9705</td><td>Web UI port</td></tr>
|
|
<tr><td><code>HUNTARR_LOG_LEVEL</code></td><td>INFO</td><td>Log verbosity</td></tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
<h2>Common Issues</h2>
|
|
|
|
<div class="alert alert-warning">
|
|
<strong>Port conflict</strong>
|
|
<p>If port 9705 is already in use, change the port mapping in your <code>docker-compose.yml</code> or use a different host port (e.g. <code>9706:9705</code>).</p>
|
|
</div>
|
|
|
|
<div class="alert alert-warning">
|
|
<strong>Permission errors</strong>
|
|
<p>Ensure the <code>/config</code> volume is writable by the container. Check ownership and permissions on the host path.</p>
|
|
</div>
|
|
|
|
<div class="alert alert-warning">
|
|
<strong>Can't reach *arr apps</strong>
|
|
<p>Verify network connectivity between Huntarr and your Sonarr, Radarr, and other *arr instances. When using Docker, ensure they're on the same network or use host networking if needed.</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>
|