mirror of
https://github.com/plexguide/Huntarr.io.git
synced 2026-02-19 23:37:26 -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
234 lines
11 KiB
HTML
234 lines
11 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<title>App Connections - 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="../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="index.html" class="active"><i class="fas fa-th-large"></i> Overview</a>
|
|
<a href="sonarr.html"><i class="fas fa-tv"></i> Sonarr</a>
|
|
<a href="radarr.html"><i class="fas fa-film"></i> Radarr</a>
|
|
<a href="lidarr.html"><i class="fas fa-music"></i> Lidarr</a>
|
|
<a href="readarr.html"><i class="fas fa-book"></i> Readarr</a>
|
|
<a href="whisparr.html"><i class="fas fa-mask"></i> Whisparr</a>
|
|
<a href="prowlarr.html"><i class="fas fa-search"></i> Prowlarr</a>
|
|
<a href="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>App Connections</h1>
|
|
<p class="page-subtitle">Connect and manage your *arr instances with Huntarr.</p>
|
|
|
|
<h2>How App Connections Work</h2>
|
|
<ul>
|
|
<li>Huntarr communicates with each *arr app via its API</li>
|
|
<li>You provide the app URL and API key</li>
|
|
<li>Huntarr monitors missing/upgradeable media and triggers searches</li>
|
|
<li>Each instance is managed independently with its own settings</li>
|
|
</ul>
|
|
|
|
<h2>Adding an Instance</h2>
|
|
<ol class="steps">
|
|
<li>Navigate to the Apps page from the sidebar</li>
|
|
<li>Select the app type (Sonarr, Radarr, etc.)</li>
|
|
<li>Click "Add Instance"</li>
|
|
<li>Enter a friendly name, the app URL, and API key</li>
|
|
<li>Click "Test Connection" to verify</li>
|
|
<li>Save the instance</li>
|
|
</ol>
|
|
|
|
<div class="alert alert-info">
|
|
<strong>Your API key</strong> is found in each *arr app under Settings > General > Security.
|
|
</div>
|
|
|
|
<h2>Managing Instances</h2>
|
|
<ul>
|
|
<li>Edit instance settings (URL, API key, name)</li>
|
|
<li>Enable/disable specific instances without deleting</li>
|
|
<li>Configure per-instance hunt settings</li>
|
|
<li>Delete instances you no longer need</li>
|
|
</ul>
|
|
|
|
<h2>Supported App Grid</h2>
|
|
<div class="card-grid">
|
|
<a href="sonarr.html" class="card">
|
|
<div class="card-icon icon-blue"><i class="fas fa-tv"></i></div>
|
|
<h3>Sonarr</h3>
|
|
<p>TV series — hunt missing episodes and upgrade quality.</p>
|
|
</a>
|
|
<a href="radarr.html" class="card">
|
|
<div class="card-icon icon-gold"><i class="fas fa-film"></i></div>
|
|
<h3>Radarr</h3>
|
|
<p>Movies — hunt missing films and upgrade quality.</p>
|
|
</a>
|
|
<a href="lidarr.html" class="card">
|
|
<div class="card-icon icon-green"><i class="fas fa-music"></i></div>
|
|
<h3>Lidarr</h3>
|
|
<p>Music — hunt missing albums and tracks.</p>
|
|
</a>
|
|
<a href="readarr.html" class="card">
|
|
<div class="card-icon icon-red"><i class="fas fa-book"></i></div>
|
|
<h3>Readarr</h3>
|
|
<p>Books and audiobooks — hunt missing content.</p>
|
|
</a>
|
|
<a href="whisparr.html" class="card">
|
|
<div class="card-icon icon-purple"><i class="fas fa-mask"></i></div>
|
|
<h3>Whisparr</h3>
|
|
<p>Adult content — hunt missing and upgrade.</p>
|
|
</a>
|
|
<a href="prowlarr.html" class="card">
|
|
<div class="card-icon icon-orange"><i class="fas fa-search"></i></div>
|
|
<h3>Prowlarr</h3>
|
|
<p>Indexer management — sync with Huntarr.</p>
|
|
</a>
|
|
<a href="swaparr.html" class="card">
|
|
<div class="card-icon icon-cyan"><i class="fas fa-exchange-alt"></i></div>
|
|
<h3>Swaparr</h3>
|
|
<p>Stalled download management and swap-outs.</p>
|
|
</a>
|
|
</div>
|
|
|
|
<h2>Instance Settings</h2>
|
|
<table>
|
|
<thead>
|
|
<tr><th>Setting</th><th>Description</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr><td><strong>Name</strong></td><td>A friendly label for this instance</td></tr>
|
|
<tr><td><strong>URL</strong></td><td>Full URL including port (e.g., http://localhost:8989)</td></tr>
|
|
<tr><td><strong>API Key</strong></td><td>Found in Settings > General of the app</td></tr>
|
|
<tr><td><strong>Enabled</strong></td><td>Toggle hunting for this instance on/off</td></tr>
|
|
<tr><td><strong>Hunt Missing</strong></td><td>Search for missing media</td></tr>
|
|
<tr><td><strong>Hunt Upgrades</strong></td><td>Search for quality upgrades</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>
|