mirror of
https://github.com/plexguide/Huntarr.git
synced 2026-01-27 21:58:54 -06:00
Add comprehensive documentation for all supported apps - Created detailed Radarr, Lidarr, Readarr, Whisparr V2/V3 docs with icons, anchor IDs, and troubleshooting sections
This commit is contained in:
242
docs/apps/lidarr.html
Normal file
242
docs/apps/lidarr.html
Normal file
@@ -0,0 +1,242 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>Lidarr Documentation - Huntarr.io</title>
|
||||
<link rel="stylesheet" href="../css/main.css">
|
||||
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.0/css/all.min.css">
|
||||
<script src="../js/main.js" defer></script>
|
||||
</head>
|
||||
<body>
|
||||
<div class="sidebar">
|
||||
<div class="sidebar-logo">
|
||||
<img src="../images/huntarr-logo.png" alt="Huntarr Logo">
|
||||
<h2>Huntarr.io</h2>
|
||||
</div>
|
||||
|
||||
<nav class="sidebar-nav">
|
||||
<div class="sidebar-section">
|
||||
<h3 class="sidebar-section-title">Getting Started</h3>
|
||||
<ul>
|
||||
<li><a href="../getting-started/installation.html"><svg class="svg-icon" viewBox="0 0 24 24" fill="currentColor"><path d="M19 9h-4V3H9v6H5l7 7 7-7zM5 18v2h14v-2H5z"></path></svg> Installation</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="sidebar-section">
|
||||
<h3 class="sidebar-section-title">Core</h3>
|
||||
<ul>
|
||||
<li><a href="../index.html"><svg class="svg-icon" viewBox="0 0 24 24" fill="currentColor"><path d="M10 20v-6h4v6h5v-8h3L12 3 2 12h3v8z"></path></svg> Home</a></li>
|
||||
<li class="active"><a href="index.html"><svg class="svg-icon" viewBox="0 0 24 24" fill="currentColor"><path d="M4 8h4V4H4v4zm6 12h4v-4h-4v4zm-6 0h4v-4H4v4zm0-6h4v-4H4v4zm6 0h4v-4h-4v4zm6-10v4h4V4h-4zm-6 4h4V4h-4v4zm6 6h4v-4h-4v4zm0 6h4v-4h-4v4z"></path></svg> Apps</a></li>
|
||||
<li><a href="../settings/settings.html"><svg class="svg-icon" viewBox="0 0 24 24" fill="currentColor"><path d="M19.14 12.94c.04-.3.06-.61.06-.94 0-.32-.02-.64-.07-.94l2.03-1.58c.18-.14.23-.41.12-.61l-1.92-3.32c-.12-.22-.37-.29-.59-.22l-2.39.96c-.5-.38-1.03-.7-1.62-.94l-.36-2.54c-.04-.24-.24-.41-.48-.41h-3.84c-.24 0-.43.17-.47.41l-.36 2.54c-.59.24-1.13.57-1.62.94l-2.39-.96c-.22-.08-.47 0-.59.22L2.74 8.87c-.12.21-.08.47.12.61l2.03 1.58c-.05.3-.09.63-.09.94s.02.64.07.94l-2.03 1.58c-.18.14-.23.41-.12.61l1.92 3.32c.12.22.37.29.59.22l2.39-.96c.5.38 1.03.7 1.62.94l.36 2.54c.05.24.24.41.48.41h3.84c.24 0 .44-.17.47-.41l.36-2.54c.59-.24 1.13-.56 1.62-.94l2.39.96c.22.08.47 0 .59-.22l1.92-3.32c.12-.22.07-.47-.12-.61l-2.01-1.58zM12 15.6c-1.98 0-3.6-1.62-3.6-3.6s1.62-3.6 3.6-3.6 3.6 1.62 3.6 3.6-1.62 3.6-3.6 3.6z"></path></svg> Settings</a></li>
|
||||
<li><a href="../features/index.html"><i class="fas fa-star" style="width: 24px; height: 24px; margin-right: 8px; display: inline-flex; align-items: center; justify-content: center;"></i> Features</a></li>
|
||||
<li><a href="../faq.html"><i class="fas fa-question-circle" style="width: 24px; height: 24px; margin-right: 8px; display: inline-flex; align-items: center; justify-content: center;"></i> FAQ</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="sidebar-section">
|
||||
<h3 class="sidebar-section-title">Resources</h3>
|
||||
<ul>
|
||||
<li><a href="https://github.com/plexguide/Huntarr.io" target="_blank"><svg class="svg-icon" viewBox="0 0 24 24" fill="currentColor"><path d="M12 0c-6.626 0-12 5.373-12 12 0 5.302 3.438 9.8 8.207 11.387.599.111.793-.261.793-.577v-2.234c-3.338.726-4.033-1.416-4.033-1.416-.546-1.387-1.333-1.756-1.333-1.756-1.089-.745.083-.729.083-.729 1.205.084 1.839 1.237 1.839 1.237 1.07 1.834 2.807 1.304 3.492.997.107-.775.418-1.305.762-1.604-2.665-.305-5.467-1.334-5.467-5.931 0-1.311.469-2.381 1.236-3.221-.124-.303-.535-1.524.117-3.176 0 0 1.008-.322 3.301 1.23.957-.266 1.983-.399 3.003-.404 1.02.005 2.047.138 3.006.404 2.291-1.552 3.297-1.23 3.297-1.23.653 1.653.242 2.874.118 3.176.77.84 1.235 1.911 1.235 3.221 0 4.609-2.807 5.624-5.479 5.921.43.372.823 1.102.823 2.222v3.293c0 .319.192.694.801.576 4.765-1.589 8.199-6.086 8.199-11.386 0-6.627-5.373-12-12-12z"></path></svg> GitHub</a></li>
|
||||
<li><a href="https://discord.com/invite/PGJJjR5Cww" target="_blank"><i class="fab fa-discord" style="color: #5865F2; font-size: 18px; width: 24px; height: 24px; margin-right: 8px; display: inline-flex; align-items: center; justify-content: center;"></i> Discord</a></li>
|
||||
<li><a href="https://www.reddit.com/r/huntarr/" target="_blank"><i class="fab fa-reddit-alien" style="color: #FF4500; font-size: 18px; width: 24px; height: 24px; margin-right: 8px; display: inline-flex; align-items: center; justify-content: center;"></i> Reddit</a></li>
|
||||
<li><a href="https://donate.plex.one" target="_blank"><i class="fas fa-heart" style="color: #e91e63; font-size: 18px; width: 24px; height: 24px; margin-right: 8px; display: inline-flex; align-items: center; justify-content: center;"></i> Donate</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</nav>
|
||||
</div>
|
||||
|
||||
<div class="main-content">
|
||||
<div class="container">
|
||||
<h1>Lidarr Documentation</h1>
|
||||
|
||||
<div style="text-align: center; margin: 20px auto;">
|
||||
<img src="../images/arrs/lidarr.png" alt="Lidarr Logo" style="width: 80px; height: 80px; object-fit: contain;">
|
||||
</div>
|
||||
|
||||
<p>Lidarr is an automated music downloading and management application. Huntarr integrates with your existing Lidarr instance to automatically search for missing albums, tracks, and quality upgrades that Lidarr doesn't actively hunt for.</p>
|
||||
|
||||
<h2 id="lidarr-instance-setup">Lidarr Instance Setup</h2>
|
||||
|
||||
<h3>Adding Your Lidarr Instance</h3>
|
||||
<p>To connect your existing Lidarr instance to Huntarr:</p>
|
||||
<ol>
|
||||
<li>Navigate to the Lidarr section in Huntarr</li>
|
||||
<li>Click "Add Lidarr Instance" if you don't have one configured</li>
|
||||
<li>Fill in your Lidarr connection details</li>
|
||||
<li>Test the connection to ensure Huntarr can communicate with Lidarr</li>
|
||||
</ol>
|
||||
|
||||
<h3 id="connection-settings">Connection Settings</h3>
|
||||
<p>Configure these settings to connect Huntarr to your Lidarr instance:</p>
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<th>Setting</th>
|
||||
<th>Description</th>
|
||||
<th>Example</th>
|
||||
<th>Notes</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Name</td>
|
||||
<td>Friendly name for this Lidarr instance</td>
|
||||
<td>Default, Music-FLAC, Podcasts</td>
|
||||
<td>Useful when running multiple Lidarr instances</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>URL</td>
|
||||
<td>Base URL for your Lidarr instance</td>
|
||||
<td>http://10.0.0.10:8686</td>
|
||||
<td>Include protocol (http/https) and port</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>API Key</td>
|
||||
<td>Lidarr API key for authentication</td>
|
||||
<td>c15f98d8403e6df5b7c9a86e4f2b580</td>
|
||||
<td>Found in Lidarr Settings > General > Security</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Enabled</td>
|
||||
<td>Whether Huntarr should process this instance</td>
|
||||
<td>On/Off toggle</td>
|
||||
<td>Disable to temporarily stop processing</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<h2 id="search-settings">Search Settings</h2>
|
||||
|
||||
<p>Configure how Huntarr searches for missing music and upgrades in your Lidarr instance. These settings control Huntarr's behavior when processing your music library.</p>
|
||||
|
||||
<h3 id="missing-search-mode"><i class="fas fa-search" style="margin-right: 10px; color: #2ecc71;"></i>Missing Search Mode</h3>
|
||||
<p>Determines how Huntarr searches for missing music:</p>
|
||||
<ul>
|
||||
<li><strong>Albums:</strong> Searches for complete albums. Recommended for most music collections</li>
|
||||
<li><strong>Tracks:</strong> Searches for individual tracks. Useful for compilation albums or singles</li>
|
||||
<li><strong>Artists:</strong> Searches at the artist level for discographies</li>
|
||||
</ul>
|
||||
|
||||
<h3 id="upgrade-mode"><i class="fas fa-arrow-up" style="margin-right: 10px; color: #2ecc71;"></i>Upgrade Mode</h3>
|
||||
<p>Controls how Huntarr handles quality upgrades:</p>
|
||||
<ul>
|
||||
<li><strong>Albums:</strong> Upgrades entire albums when better quality becomes available</li>
|
||||
<li><strong>Tracks:</strong> Upgrades individual tracks for better quality</li>
|
||||
<li><strong>Artists:</strong> Upgrades at the artist level for consistent quality across discography</li>
|
||||
</ul>
|
||||
|
||||
<h3 id="search-limits"><i class="fas fa-sliders-h" style="margin-right: 10px; color: #f39c12;"></i>Search Limits</h3>
|
||||
<p>Control how many items Huntarr processes per cycle to avoid overwhelming your indexers:</p>
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<th>Setting</th>
|
||||
<th>Description</th>
|
||||
<th>Recommended</th>
|
||||
<th>Notes</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Missing Search</td>
|
||||
<td>Number of missing albums/tracks to search per cycle</td>
|
||||
<td>2-4</td>
|
||||
<td>Set to 0 to disable missing searches</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Upgrade Search</td>
|
||||
<td>Number of items to upgrade per cycle</td>
|
||||
<td>1-2</td>
|
||||
<td>Set to 0 to disable upgrade searches</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Sleep Duration</td>
|
||||
<td>Time in seconds between processing cycles</td>
|
||||
<td>1800 (30 min)</td>
|
||||
<td>Music indexers often have stricter limits</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>API Cap - Hourly</td>
|
||||
<td>Maximum API requests per hour</td>
|
||||
<td>200 or less</td>
|
||||
<td>Music indexers typically have lower limits</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<div class="alert alert-warning">
|
||||
<strong>Important:</strong> Music indexers often have stricter rate limits than movie/TV indexers. Use conservative settings to avoid being banned.
|
||||
</div>
|
||||
|
||||
<h3 id="additional-options"><i class="fas fa-cogs" style="margin-right: 10px; color: #9b59b6;"></i>Additional Options</h3>
|
||||
<p>Fine-tune Huntarr's behavior with these additional settings:</p>
|
||||
|
||||
<h4><i class="fas fa-eye" style="margin-right: 8px; color: #2ecc71;"></i>Monitored Only</h4>
|
||||
<p>When enabled, Huntarr will only search for music that is marked as "Monitored" in Lidarr. This prevents searches for artists or albums you've intentionally unmonitored.</p>
|
||||
|
||||
<h4><i class="fas fa-calendar" style="margin-right: 8px; color: #e74c3c;"></i>Skip Future Releases</h4>
|
||||
<p>When enabled, Huntarr will skip albums with future release dates. This prevents unnecessary searches for content that hasn't been released yet.</p>
|
||||
|
||||
<h4><i class="fas fa-music" style="margin-right: 8px; color: #f39c12;"></i>Quality Profiles</h4>
|
||||
<p>Respects Lidarr's quality profile settings. Huntarr will only search for music that meets your configured quality requirements (MP3, FLAC, etc.).</p>
|
||||
|
||||
<h4><i class="fas fa-microphone" style="margin-right: 8px; color: #9b59b6;"></i>Artist Monitoring</h4>
|
||||
<p>When enabled, Huntarr will respect your artist monitoring settings in Lidarr, only searching for albums from artists you're actively monitoring.</p>
|
||||
|
||||
<h2 id="troubleshooting">Troubleshooting</h2>
|
||||
|
||||
<h3>Common Issues</h3>
|
||||
|
||||
<h4>Connection Failed</h4>
|
||||
<p>If Huntarr can't connect to your Lidarr instance:</p>
|
||||
<ul>
|
||||
<li>Verify the URL is correct and includes the protocol (http/https)</li>
|
||||
<li>Check that the port number is correct (default: 8686)</li>
|
||||
<li>Ensure the API key is copied correctly from Lidarr Settings > General > Security</li>
|
||||
<li>Confirm Lidarr is running and accessible from Huntarr's network</li>
|
||||
<li>Check firewall settings if Huntarr and Lidarr are on different machines</li>
|
||||
</ul>
|
||||
|
||||
<h4>No Missing Music Found</h4>
|
||||
<p>If Huntarr reports no missing music but you know there are gaps:</p>
|
||||
<ul>
|
||||
<li>Ensure "Monitored Only" is configured correctly for your needs</li>
|
||||
<li>Check that artists and albums are marked as "Monitored" in Lidarr</li>
|
||||
<li>Verify "Skip Future Releases" isn't preventing searches for available content</li>
|
||||
<li>Review your quality profile settings in both Lidarr and Huntarr</li>
|
||||
</ul>
|
||||
|
||||
<h4>Music Indexer Rate Limiting</h4>
|
||||
<p>If you're getting rate limited by music indexers:</p>
|
||||
<ul>
|
||||
<li>Reduce the "API Cap - Hourly" setting significantly (try 100-200)</li>
|
||||
<li>Increase the "Sleep Duration" to 30+ minutes between cycles</li>
|
||||
<li>Lower the "Missing Search" and "Upgrade Search" limits to 1-2</li>
|
||||
<li>Music indexers are typically more restrictive than movie/TV indexers</li>
|
||||
</ul>
|
||||
|
||||
<h4>Metadata Issues</h4>
|
||||
<p>If Huntarr isn't finding the right music:</p>
|
||||
<ul>
|
||||
<li>Verify your metadata provider settings in Lidarr (MusicBrainz, etc.)</li>
|
||||
<li>Check that album and artist names are correctly matched</li>
|
||||
<li>Review release group settings for proper album identification</li>
|
||||
<li>Consider adjusting search criteria for international releases</li>
|
||||
</ul>
|
||||
|
||||
<h4>Quality and Format Issues</h4>
|
||||
<p>If Huntarr isn't finding the right audio quality:</p>
|
||||
<ul>
|
||||
<li>Verify your quality profiles support the formats you want (FLAC, MP3, etc.)</li>
|
||||
<li>Check that your indexers have the quality levels you're seeking</li>
|
||||
<li>Review cutoff settings to ensure upgrades are allowed</li>
|
||||
<li>Consider separate instances for different quality requirements</li>
|
||||
</ul>
|
||||
|
||||
<div class="section-nav">
|
||||
<a href="radarr.html">← Radarr Documentation</a>
|
||||
<a href="readarr.html">Readarr Documentation →</a>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
Huntarr.io | Lidarr Documentation | Thanks 4 Using Huntarr - Admin9705
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
228
docs/apps/radarr.html
Normal file
228
docs/apps/radarr.html
Normal file
@@ -0,0 +1,228 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>Radarr Documentation - Huntarr.io</title>
|
||||
<link rel="stylesheet" href="../css/main.css">
|
||||
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.0/css/all.min.css">
|
||||
<script src="../js/main.js" defer></script>
|
||||
</head>
|
||||
<body>
|
||||
<div class="sidebar">
|
||||
<div class="sidebar-logo">
|
||||
<img src="../images/huntarr-logo.png" alt="Huntarr Logo">
|
||||
<h2>Huntarr.io</h2>
|
||||
</div>
|
||||
|
||||
<nav class="sidebar-nav">
|
||||
<div class="sidebar-section">
|
||||
<h3 class="sidebar-section-title">Getting Started</h3>
|
||||
<ul>
|
||||
<li><a href="../getting-started/installation.html"><svg class="svg-icon" viewBox="0 0 24 24" fill="currentColor"><path d="M19 9h-4V3H9v6H5l7 7 7-7zM5 18v2h14v-2H5z"></path></svg> Installation</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="sidebar-section">
|
||||
<h3 class="sidebar-section-title">Core</h3>
|
||||
<ul>
|
||||
<li><a href="../index.html"><svg class="svg-icon" viewBox="0 0 24 24" fill="currentColor"><path d="M10 20v-6h4v6h5v-8h3L12 3 2 12h3v8z"></path></svg> Home</a></li>
|
||||
<li class="active"><a href="index.html"><svg class="svg-icon" viewBox="0 0 24 24" fill="currentColor"><path d="M4 8h4V4H4v4zm6 12h4v-4h-4v4zm-6 0h4v-4H4v4zm0-6h4v-4H4v4zm6 0h4v-4h-4v4zm6-10v4h4V4h-4zm-6 4h4V4h-4v4zm6 6h4v-4h-4v4zm0 6h4v-4h-4v4z"></path></svg> Apps</a></li>
|
||||
<li><a href="../settings/settings.html"><svg class="svg-icon" viewBox="0 0 24 24" fill="currentColor"><path d="M19.14 12.94c.04-.3.06-.61.06-.94 0-.32-.02-.64-.07-.94l2.03-1.58c.18-.14.23-.41.12-.61l-1.92-3.32c-.12-.22-.37-.29-.59-.22l-2.39.96c-.5-.38-1.03-.7-1.62-.94l-.36-2.54c-.04-.24-.24-.41-.48-.41h-3.84c-.24 0-.43.17-.47.41l-.36 2.54c-.59.24-1.13.57-1.62.94l-2.39-.96c-.22-.08-.47 0-.59.22L2.74 8.87c-.12.21-.08.47.12.61l2.03 1.58c-.05.3-.09.63-.09.94s.02.64.07.94l-2.03 1.58c-.18.14-.23.41-.12.61l1.92 3.32c.12.22.37.29.59.22l2.39-.96c.5.38 1.03.7 1.62.94l.36 2.54c.05.24.24.41.48.41h3.84c.24 0 .44-.17.47-.41l.36-2.54c.59-.24 1.13-.56 1.62-.94l2.39.96c.22.08.47 0 .59-.22l1.92-3.32c.12-.22.07-.47-.12-.61l-2.01-1.58zM12 15.6c-1.98 0-3.6-1.62-3.6-3.6s1.62-3.6 3.6-3.6 3.6 1.62 3.6 3.6-1.62 3.6-3.6 3.6z"></path></svg> Settings</a></li>
|
||||
<li><a href="../features/index.html"><i class="fas fa-star" style="width: 24px; height: 24px; margin-right: 8px; display: inline-flex; align-items: center; justify-content: center;"></i> Features</a></li>
|
||||
<li><a href="../faq.html"><i class="fas fa-question-circle" style="width: 24px; height: 24px; margin-right: 8px; display: inline-flex; align-items: center; justify-content: center;"></i> FAQ</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="sidebar-section">
|
||||
<h3 class="sidebar-section-title">Resources</h3>
|
||||
<ul>
|
||||
<li><a href="https://github.com/plexguide/Huntarr.io" target="_blank"><svg class="svg-icon" viewBox="0 0 24 24" fill="currentColor"><path d="M12 0c-6.626 0-12 5.373-12 12 0 5.302 3.438 9.8 8.207 11.387.599.111.793-.261.793-.577v-2.234c-3.338.726-4.033-1.416-4.033-1.416-.546-1.387-1.333-1.756-1.333-1.756-1.089-.745.083-.729.083-.729 1.205.084 1.839 1.237 1.839 1.237 1.07 1.834 2.807 1.304 3.492.997.107-.775.418-1.305.762-1.604-2.665-.305-5.467-1.334-5.467-5.931 0-1.311.469-2.381 1.236-3.221-.124-.303-.535-1.524.117-3.176 0 0 1.008-.322 3.301 1.23.957-.266 1.983-.399 3.003-.404 1.02.005 2.047.138 3.006.404 2.291-1.552 3.297-1.23 3.297-1.23.653 1.653.242 2.874.118 3.176.77.84 1.235 1.911 1.235 3.221 0 4.609-2.807 5.624-5.479 5.921.43.372.823 1.102.823 2.222v3.293c0 .319.192.694.801.576 4.765-1.589 8.199-6.086 8.199-11.386 0-6.627-5.373-12-12-12z"></path></svg> GitHub</a></li>
|
||||
<li><a href="https://discord.com/invite/PGJJjR5Cww" target="_blank"><i class="fab fa-discord" style="color: #5865F2; font-size: 18px; width: 24px; height: 24px; margin-right: 8px; display: inline-flex; align-items: center; justify-content: center;"></i> Discord</a></li>
|
||||
<li><a href="https://www.reddit.com/r/huntarr/" target="_blank"><i class="fab fa-reddit-alien" style="color: #FF4500; font-size: 18px; width: 24px; height: 24px; margin-right: 8px; display: inline-flex; align-items: center; justify-content: center;"></i> Reddit</a></li>
|
||||
<li><a href="https://donate.plex.one" target="_blank"><i class="fas fa-heart" style="color: #e91e63; font-size: 18px; width: 24px; height: 24px; margin-right: 8px; display: inline-flex; align-items: center; justify-content: center;"></i> Donate</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</nav>
|
||||
</div>
|
||||
|
||||
<div class="main-content">
|
||||
<div class="container">
|
||||
<h1>Radarr Documentation</h1>
|
||||
|
||||
<div style="text-align: center; margin: 20px auto;">
|
||||
<img src="../images/arrs/radarr.png" alt="Radarr Logo" style="width: 80px; height: 80px; object-fit: contain;">
|
||||
</div>
|
||||
|
||||
<p>Radarr is an automated movie downloading and management application. Huntarr integrates with your existing Radarr instance to automatically search for missing movies and quality upgrades that Radarr doesn't actively hunt for.</p>
|
||||
|
||||
<h2 id="radarr-instance-setup">Radarr Instance Setup</h2>
|
||||
|
||||
<h3>Adding Your Radarr Instance</h3>
|
||||
<p>To connect your existing Radarr instance to Huntarr:</p>
|
||||
<ol>
|
||||
<li>Navigate to the Radarr section in Huntarr</li>
|
||||
<li>Click "Add Radarr Instance" if you don't have one configured</li>
|
||||
<li>Fill in your Radarr connection details</li>
|
||||
<li>Test the connection to ensure Huntarr can communicate with Radarr</li>
|
||||
</ol>
|
||||
|
||||
<h3 id="connection-settings">Connection Settings</h3>
|
||||
<p>Configure these settings to connect Huntarr to your Radarr instance:</p>
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<th>Setting</th>
|
||||
<th>Description</th>
|
||||
<th>Example</th>
|
||||
<th>Notes</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Name</td>
|
||||
<td>Friendly name for this Radarr instance</td>
|
||||
<td>Default, Movies-4K, Foreign</td>
|
||||
<td>Useful when running multiple Radarr instances</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>URL</td>
|
||||
<td>Base URL for your Radarr instance</td>
|
||||
<td>http://10.0.0.10:7878</td>
|
||||
<td>Include protocol (http/https) and port</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>API Key</td>
|
||||
<td>Radarr API key for authentication</td>
|
||||
<td>b04d87c7392d5ce4f9a6b85f6c8e470</td>
|
||||
<td>Found in Radarr Settings > General > Security</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Enabled</td>
|
||||
<td>Whether Huntarr should process this instance</td>
|
||||
<td>On/Off toggle</td>
|
||||
<td>Disable to temporarily stop processing</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<h2 id="search-settings">Search Settings</h2>
|
||||
|
||||
<p>Configure how Huntarr searches for missing movies and upgrades in your Radarr instance. These settings control Huntarr's behavior when processing your movie library.</p>
|
||||
|
||||
<h3 id="missing-search-mode"><i class="fas fa-search" style="margin-right: 10px; color: #f1c40f;"></i>Missing Search Mode</h3>
|
||||
<p>Determines how Huntarr searches for missing movies:</p>
|
||||
<ul>
|
||||
<li><strong>Movies:</strong> Standard mode that searches for individual movies. Recommended for most users</li>
|
||||
<li><strong>Collections:</strong> Searches for movie collections when available. Useful for franchise collections</li>
|
||||
</ul>
|
||||
|
||||
<h3 id="upgrade-mode"><i class="fas fa-arrow-up" style="margin-right: 10px; color: #2ecc71;"></i>Upgrade Mode</h3>
|
||||
<p>Controls how Huntarr handles quality upgrades:</p>
|
||||
<ul>
|
||||
<li><strong>Movies:</strong> Upgrades individual movies when better quality becomes available</li>
|
||||
<li><strong>Collections:</strong> Upgrades entire movie collections at once when better quality is found</li>
|
||||
</ul>
|
||||
|
||||
<h3 id="search-limits"><i class="fas fa-sliders-h" style="margin-right: 10px; color: #f39c12;"></i>Search Limits</h3>
|
||||
<p>Control how many items Huntarr processes per cycle to avoid overwhelming your indexers:</p>
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<th>Setting</th>
|
||||
<th>Description</th>
|
||||
<th>Recommended</th>
|
||||
<th>Notes</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Missing Search</td>
|
||||
<td>Number of missing movies to search per cycle</td>
|
||||
<td>3-5</td>
|
||||
<td>Set to 0 to disable missing searches</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Upgrade Search</td>
|
||||
<td>Number of movies to upgrade per cycle</td>
|
||||
<td>1-2</td>
|
||||
<td>Set to 0 to disable upgrade searches</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Sleep Duration</td>
|
||||
<td>Time in seconds between processing cycles</td>
|
||||
<td>1200 (20 min)</td>
|
||||
<td>Longer intervals reduce indexer load</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>API Cap - Hourly</td>
|
||||
<td>Maximum API requests per hour</td>
|
||||
<td>300 or less</td>
|
||||
<td>Prevents rate limiting from indexers</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<div class="alert alert-warning">
|
||||
<strong>Important:</strong> Movie files are typically larger than TV episodes, so consider lower search limits to avoid overwhelming your indexers and download clients.
|
||||
</div>
|
||||
|
||||
<h3 id="additional-options"><i class="fas fa-cogs" style="margin-right: 10px; color: #9b59b6;"></i>Additional Options</h3>
|
||||
<p>Fine-tune Huntarr's behavior with these additional settings:</p>
|
||||
|
||||
<h4><i class="fas fa-eye" style="margin-right: 8px; color: #f1c40f;"></i>Monitored Only</h4>
|
||||
<p>When enabled, Huntarr will only search for movies that are marked as "Monitored" in Radarr. This prevents searches for movies you've intentionally unmonitored.</p>
|
||||
|
||||
<h4><i class="fas fa-calendar" style="margin-right: 8px; color: #e74c3c;"></i>Skip Future Movies</h4>
|
||||
<p>When enabled, Huntarr will skip movies with future release dates. This prevents unnecessary searches for content that hasn't been released yet.</p>
|
||||
|
||||
<h4><i class="fas fa-star" style="margin-right: 8px; color: #f39c12;"></i>Minimum Availability</h4>
|
||||
<p>Respects Radarr's minimum availability setting. Huntarr will only search for movies that meet your configured availability requirements (Announced, In Cinemas, Released, etc.).</p>
|
||||
|
||||
<h2 id="troubleshooting">Troubleshooting</h2>
|
||||
|
||||
<h3>Common Issues</h3>
|
||||
|
||||
<h4>Connection Failed</h4>
|
||||
<p>If Huntarr can't connect to your Radarr instance:</p>
|
||||
<ul>
|
||||
<li>Verify the URL is correct and includes the protocol (http/https)</li>
|
||||
<li>Check that the port number is correct (default: 7878)</li>
|
||||
<li>Ensure the API key is copied correctly from Radarr Settings > General > Security</li>
|
||||
<li>Confirm Radarr is running and accessible from Huntarr's network</li>
|
||||
<li>Check firewall settings if Huntarr and Radarr are on different machines</li>
|
||||
</ul>
|
||||
|
||||
<h4>No Missing Movies Found</h4>
|
||||
<p>If Huntarr reports no missing movies but you know there are gaps:</p>
|
||||
<ul>
|
||||
<li>Ensure "Monitored Only" is configured correctly for your needs</li>
|
||||
<li>Check that movies are marked as "Monitored" in Radarr</li>
|
||||
<li>Verify "Skip Future Movies" isn't preventing searches for available content</li>
|
||||
<li>Review your minimum availability settings in both Radarr and Huntarr</li>
|
||||
</ul>
|
||||
|
||||
<h4>Large File Downloads</h4>
|
||||
<p>If movie downloads are overwhelming your system:</p>
|
||||
<ul>
|
||||
<li>Reduce the "Missing Search" and "Upgrade Search" limits</li>
|
||||
<li>Increase the "Sleep Duration" between processing cycles</li>
|
||||
<li>Consider setting up separate Radarr instances for different quality profiles</li>
|
||||
<li>Monitor your download client's queue and disk space</li>
|
||||
</ul>
|
||||
|
||||
<h4>Quality Profile Issues</h4>
|
||||
<p>If Huntarr isn't finding the right quality:</p>
|
||||
<ul>
|
||||
<li>Verify your quality profiles are properly configured in Radarr</li>
|
||||
<li>Check that your indexers support the quality levels you're seeking</li>
|
||||
<li>Review cutoff settings to ensure upgrades are allowed</li>
|
||||
<li>Consider adjusting your upgrade search frequency</li>
|
||||
</ul>
|
||||
|
||||
<div class="section-nav">
|
||||
<a href="sonarr.html">← Sonarr Documentation</a>
|
||||
<a href="lidarr.html">Lidarr Documentation →</a>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
Huntarr.io | Radarr Documentation | Thanks 4 Using Huntarr - Admin9705
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
256
docs/apps/readarr.html
Normal file
256
docs/apps/readarr.html
Normal file
@@ -0,0 +1,256 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>Readarr Documentation - Huntarr.io</title>
|
||||
<link rel="stylesheet" href="../css/main.css">
|
||||
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.0/css/all.min.css">
|
||||
<script src="../js/main.js" defer></script>
|
||||
</head>
|
||||
<body>
|
||||
<div class="sidebar">
|
||||
<div class="sidebar-logo">
|
||||
<img src="../images/huntarr-logo.png" alt="Huntarr Logo">
|
||||
<h2>Huntarr.io</h2>
|
||||
</div>
|
||||
|
||||
<nav class="sidebar-nav">
|
||||
<div class="sidebar-section">
|
||||
<h3 class="sidebar-section-title">Getting Started</h3>
|
||||
<ul>
|
||||
<li><a href="../getting-started/installation.html"><svg class="svg-icon" viewBox="0 0 24 24" fill="currentColor"><path d="M19 9h-4V3H9v6H5l7 7 7-7zM5 18v2h14v-2H5z"></path></svg> Installation</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="sidebar-section">
|
||||
<h3 class="sidebar-section-title">Core</h3>
|
||||
<ul>
|
||||
<li><a href="../index.html"><svg class="svg-icon" viewBox="0 0 24 24" fill="currentColor"><path d="M10 20v-6h4v6h5v-8h3L12 3 2 12h3v8z"></path></svg> Home</a></li>
|
||||
<li class="active"><a href="index.html"><svg class="svg-icon" viewBox="0 0 24 24" fill="currentColor"><path d="M4 8h4V4H4v4zm6 12h4v-4h-4v4zm-6 0h4v-4H4v4zm0-6h4v-4H4v4zm6 0h4v-4h-4v4zm6-10v4h4V4h-4zm-6 4h4V4h-4v4zm6 6h4v-4h-4v4zm0 6h4v-4h-4v4z"></path></svg> Apps</a></li>
|
||||
<li><a href="../settings/settings.html"><svg class="svg-icon" viewBox="0 0 24 24" fill="currentColor"><path d="M19.14 12.94c.04-.3.06-.61.06-.94 0-.32-.02-.64-.07-.94l2.03-1.58c.18-.14.23-.41.12-.61l-1.92-3.32c-.12-.22-.37-.29-.59-.22l-2.39.96c-.5-.38-1.03-.7-1.62-.94l-.36-2.54c-.04-.24-.24-.41-.48-.41h-3.84c-.24 0-.43.17-.47.41l-.36 2.54c-.59.24-1.13.57-1.62.94l-2.39-.96c-.22-.08-.47 0-.59.22L2.74 8.87c-.12.21-.08.47.12.61l2.03 1.58c-.05.3-.09.63-.09.94s.02.64.07.94l-2.03 1.58c-.18.14-.23.41-.12.61l1.92 3.32c.12.22.37.29.59.22l2.39-.96c.5.38 1.03.7 1.62.94l.36 2.54c.05.24.24.41.48.41h3.84c.24 0 .44-.17.47-.41l.36-2.54c.59-.24 1.13-.56 1.62-.94l2.39.96c.22.08.47 0 .59-.22l1.92-3.32c.12-.22.07-.47-.12-.61l-2.01-1.58zM12 15.6c-1.98 0-3.6-1.62-3.6-3.6s1.62-3.6 3.6-3.6 3.6 1.62 3.6 3.6-1.62 3.6-3.6 3.6z"></path></svg> Settings</a></li>
|
||||
<li><a href="../features/index.html"><i class="fas fa-star" style="width: 24px; height: 24px; margin-right: 8px; display: inline-flex; align-items: center; justify-content: center;"></i> Features</a></li>
|
||||
<li><a href="../faq.html"><i class="fas fa-question-circle" style="width: 24px; height: 24px; margin-right: 8px; display: inline-flex; align-items: center; justify-content: center;"></i> FAQ</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="sidebar-section">
|
||||
<h3 class="sidebar-section-title">Resources</h3>
|
||||
<ul>
|
||||
<li><a href="https://github.com/plexguide/Huntarr.io" target="_blank"><svg class="svg-icon" viewBox="0 0 24 24" fill="currentColor"><path d="M12 0c-6.626 0-12 5.373-12 12 0 5.302 3.438 9.8 8.207 11.387.599.111.793-.261.793-.577v-2.234c-3.338.726-4.033-1.416-4.033-1.416-.546-1.387-1.333-1.756-1.333-1.756-1.089-.745.083-.729.083-.729 1.205.084 1.839 1.237 1.839 1.237 1.07 1.834 2.807 1.304 3.492.997.107-.775.418-1.305.762-1.604-2.665-.305-5.467-1.334-5.467-5.931 0-1.311.469-2.381 1.236-3.221-.124-.303-.535-1.524.117-3.176 0 0 1.008-.322 3.301 1.23.957-.266 1.983-.399 3.003-.404 1.02.005 2.047.138 3.006.404 2.291-1.552 3.297-1.23 3.297-1.23.653 1.653.242 2.874.118 3.176.77.84 1.235 1.911 1.235 3.221 0 4.609-2.807 5.624-5.479 5.921.43.372.823 1.102.823 2.222v3.293c0 .319.192.694.801.576 4.765-1.589 8.199-6.086 8.199-11.386 0-6.627-5.373-12-12-12z"></path></svg> GitHub</a></li>
|
||||
<li><a href="https://discord.com/invite/PGJJjR5Cww" target="_blank"><i class="fab fa-discord" style="color: #5865F2; font-size: 18px; width: 24px; height: 24px; margin-right: 8px; display: inline-flex; align-items: center; justify-content: center;"></i> Discord</a></li>
|
||||
<li><a href="https://www.reddit.com/r/huntarr/" target="_blank"><i class="fab fa-reddit-alien" style="color: #FF4500; font-size: 18px; width: 24px; height: 24px; margin-right: 8px; display: inline-flex; align-items: center; justify-content: center;"></i> Reddit</a></li>
|
||||
<li><a href="https://donate.plex.one" target="_blank"><i class="fas fa-heart" style="color: #e91e63; font-size: 18px; width: 24px; height: 24px; margin-right: 8px; display: inline-flex; align-items: center; justify-content: center;"></i> Donate</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</nav>
|
||||
</div>
|
||||
|
||||
<div class="main-content">
|
||||
<div class="container">
|
||||
<h1>Readarr Documentation</h1>
|
||||
|
||||
<div style="text-align: center; margin: 20px auto;">
|
||||
<img src="../images/arrs/readarr.png" alt="Readarr Logo" style="width: 80px; height: 80px; object-fit: contain;">
|
||||
</div>
|
||||
|
||||
<p>Readarr is an automated book and audiobook downloading and management application. Huntarr integrates with your existing Readarr instance to automatically search for missing books and quality upgrades that Readarr doesn't actively hunt for.</p>
|
||||
|
||||
<h2 id="readarr-instance-setup">Readarr Instance Setup</h2>
|
||||
|
||||
<h3>Adding Your Readarr Instance</h3>
|
||||
<p>To connect your existing Readarr instance to Huntarr:</p>
|
||||
<ol>
|
||||
<li>Navigate to the Readarr section in Huntarr</li>
|
||||
<li>Click "Add Readarr Instance" if you don't have one configured</li>
|
||||
<li>Fill in your Readarr connection details</li>
|
||||
<li>Test the connection to ensure Huntarr can communicate with Readarr</li>
|
||||
</ol>
|
||||
|
||||
<h3 id="connection-settings">Connection Settings</h3>
|
||||
<p>Configure these settings to connect Huntarr to your Readarr instance:</p>
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<th>Setting</th>
|
||||
<th>Description</th>
|
||||
<th>Example</th>
|
||||
<th>Notes</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Name</td>
|
||||
<td>Friendly name for this Readarr instance</td>
|
||||
<td>Default, Audiobooks, Comics</td>
|
||||
<td>Useful when running multiple Readarr instances</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>URL</td>
|
||||
<td>Base URL for your Readarr instance</td>
|
||||
<td>http://10.0.0.10:8787</td>
|
||||
<td>Include protocol (http/https) and port</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>API Key</td>
|
||||
<td>Readarr API key for authentication</td>
|
||||
<td>d26g09e9514f7hf6c8d0b97f5e3c691</td>
|
||||
<td>Found in Readarr Settings > General > Security</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Enabled</td>
|
||||
<td>Whether Huntarr should process this instance</td>
|
||||
<td>On/Off toggle</td>
|
||||
<td>Disable to temporarily stop processing</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<h2 id="search-settings">Search Settings</h2>
|
||||
|
||||
<p>Configure how Huntarr searches for missing books and upgrades in your Readarr instance. These settings control Huntarr's behavior when processing your book library.</p>
|
||||
|
||||
<h3 id="missing-search-mode"><i class="fas fa-search" style="margin-right: 10px; color: #8b4513;"></i>Missing Search Mode</h3>
|
||||
<p>Determines how Huntarr searches for missing books:</p>
|
||||
<ul>
|
||||
<li><strong>Books:</strong> Searches for individual books. Standard mode for most libraries</li>
|
||||
<li><strong>Authors:</strong> Searches at the author level for complete works</li>
|
||||
<li><strong>Series:</strong> Searches for book series when available</li>
|
||||
</ul>
|
||||
|
||||
<h3 id="upgrade-mode"><i class="fas fa-arrow-up" style="margin-right: 10px; color: #2ecc71;"></i>Upgrade Mode</h3>
|
||||
<p>Controls how Huntarr handles quality upgrades:</p>
|
||||
<ul>
|
||||
<li><strong>Books:</strong> Upgrades individual books when better quality becomes available</li>
|
||||
<li><strong>Authors:</strong> Upgrades at the author level for consistent quality</li>
|
||||
<li><strong>Series:</strong> Upgrades entire book series at once when better quality is found</li>
|
||||
</ul>
|
||||
|
||||
<h3 id="search-limits"><i class="fas fa-sliders-h" style="margin-right: 10px; color: #f39c12;"></i>Search Limits</h3>
|
||||
<p>Control how many items Huntarr processes per cycle to avoid overwhelming your indexers:</p>
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<th>Setting</th>
|
||||
<th>Description</th>
|
||||
<th>Recommended</th>
|
||||
<th>Notes</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Missing Search</td>
|
||||
<td>Number of missing books to search per cycle</td>
|
||||
<td>2-3</td>
|
||||
<td>Set to 0 to disable missing searches</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Upgrade Search</td>
|
||||
<td>Number of books to upgrade per cycle</td>
|
||||
<td>1-2</td>
|
||||
<td>Set to 0 to disable upgrade searches</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Sleep Duration</td>
|
||||
<td>Time in seconds between processing cycles</td>
|
||||
<td>2400 (40 min)</td>
|
||||
<td>Book indexers often have limited content</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>API Cap - Hourly</td>
|
||||
<td>Maximum API requests per hour</td>
|
||||
<td>150 or less</td>
|
||||
<td>Book indexers typically have lower limits</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<div class="alert alert-warning">
|
||||
<strong>Important:</strong> Book indexers often have limited content and stricter rate limits. Use conservative settings and longer intervals between searches.
|
||||
</div>
|
||||
|
||||
<h3 id="additional-options"><i class="fas fa-cogs" style="margin-right: 10px; color: #9b59b6;"></i>Additional Options</h3>
|
||||
<p>Fine-tune Huntarr's behavior with these additional settings:</p>
|
||||
|
||||
<h4><i class="fas fa-eye" style="margin-right: 8px; color: #8b4513;"></i>Monitored Only</h4>
|
||||
<p>When enabled, Huntarr will only search for books that are marked as "Monitored" in Readarr. This prevents searches for authors or books you've intentionally unmonitored.</p>
|
||||
|
||||
<h4><i class="fas fa-calendar" style="margin-right: 8px; color: #e74c3c;"></i>Skip Future Releases</h4>
|
||||
<p>When enabled, Huntarr will skip books with future release dates. This prevents unnecessary searches for content that hasn't been published yet.</p>
|
||||
|
||||
<h4><i class="fas fa-book" style="margin-right: 8px; color: #f39c12;"></i>Book Types</h4>
|
||||
<p>Configure which types of books Huntarr should search for:</p>
|
||||
<ul>
|
||||
<li><strong>Ebooks:</strong> Digital book formats (EPUB, PDF, MOBI, etc.)</li>
|
||||
<li><strong>Audiobooks:</strong> Audio versions of books (MP3, M4A, etc.)</li>
|
||||
<li><strong>Both:</strong> Search for both ebooks and audiobooks</li>
|
||||
</ul>
|
||||
|
||||
<h4><i class="fas fa-user" style="margin-right: 8px; color: #9b59b6;"></i>Author Monitoring</h4>
|
||||
<p>When enabled, Huntarr will respect your author monitoring settings in Readarr, only searching for books from authors you're actively monitoring.</p>
|
||||
|
||||
<h2 id="troubleshooting">Troubleshooting</h2>
|
||||
|
||||
<h3>Common Issues</h3>
|
||||
|
||||
<h4>Connection Failed</h4>
|
||||
<p>If Huntarr can't connect to your Readarr instance:</p>
|
||||
<ul>
|
||||
<li>Verify the URL is correct and includes the protocol (http/https)</li>
|
||||
<li>Check that the port number is correct (default: 8787)</li>
|
||||
<li>Ensure the API key is copied correctly from Readarr Settings > General > Security</li>
|
||||
<li>Confirm Readarr is running and accessible from Huntarr's network</li>
|
||||
<li>Check firewall settings if Huntarr and Readarr are on different machines</li>
|
||||
</ul>
|
||||
|
||||
<h4>No Missing Books Found</h4>
|
||||
<p>If Huntarr reports no missing books but you know there are gaps:</p>
|
||||
<ul>
|
||||
<li>Ensure "Monitored Only" is configured correctly for your needs</li>
|
||||
<li>Check that authors and books are marked as "Monitored" in Readarr</li>
|
||||
<li>Verify "Skip Future Releases" isn't preventing searches for available content</li>
|
||||
<li>Review your book type settings (ebooks vs audiobooks)</li>
|
||||
</ul>
|
||||
|
||||
<h4>Limited Book Availability</h4>
|
||||
<p>If Huntarr isn't finding books that should be available:</p>
|
||||
<ul>
|
||||
<li>Book indexers have much more limited content than movie/TV indexers</li>
|
||||
<li>Consider adding more book-specific indexers to Readarr</li>
|
||||
<li>Check if your indexers support the book formats you're seeking</li>
|
||||
<li>Verify your quality profiles match available content</li>
|
||||
</ul>
|
||||
|
||||
<h4>Metadata and Search Issues</h4>
|
||||
<p>If Huntarr isn't finding the right books:</p>
|
||||
<ul>
|
||||
<li>Verify your metadata provider settings in Readarr (Goodreads, etc.)</li>
|
||||
<li>Check that book titles and author names are correctly matched</li>
|
||||
<li>Review ISBN settings for proper book identification</li>
|
||||
<li>Consider adjusting search criteria for international editions</li>
|
||||
</ul>
|
||||
|
||||
<h4>Format and Quality Issues</h4>
|
||||
<p>If Huntarr isn't finding the right book formats:</p>
|
||||
<ul>
|
||||
<li>Verify your quality profiles support the formats you want (EPUB, PDF, MP3, etc.)</li>
|
||||
<li>Check that your indexers have the formats you're seeking</li>
|
||||
<li>Review cutoff settings to ensure upgrades are allowed</li>
|
||||
<li>Consider separate instances for ebooks vs audiobooks</li>
|
||||
</ul>
|
||||
|
||||
<h4>Audiobook Specific Issues</h4>
|
||||
<p>If you're having trouble with audiobook searches:</p>
|
||||
<ul>
|
||||
<li>Ensure your indexers support audiobook formats</li>
|
||||
<li>Check that audiobook quality profiles are properly configured</li>
|
||||
<li>Verify narrator information is correctly matched</li>
|
||||
<li>Consider longer search intervals due to limited audiobook availability</li>
|
||||
</ul>
|
||||
|
||||
<div class="section-nav">
|
||||
<a href="lidarr.html">← Lidarr Documentation</a>
|
||||
<a href="whisparr-v2.html">Whisparr V2 Documentation →</a>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
Huntarr.io | Readarr Documentation | Thanks 4 Using Huntarr - Admin9705
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -5,6 +5,7 @@
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>Sonarr Documentation - Huntarr.io</title>
|
||||
<link rel="stylesheet" href="../css/main.css">
|
||||
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.0/css/all.min.css">
|
||||
<script src="../js/main.js" defer></script>
|
||||
</head>
|
||||
<body>
|
||||
@@ -107,21 +108,21 @@
|
||||
|
||||
<p>Configure how Huntarr searches for missing content and upgrades in your Sonarr instance. These settings control Huntarr's behavior when processing your TV show library.</p>
|
||||
|
||||
<h3 id="missing-search-mode">Missing Search Mode</h3>
|
||||
<h3 id="missing-search-mode"><i class="fas fa-search" style="margin-right: 10px; color: #3498db;"></i>Missing Search Mode</h3>
|
||||
<p>Determines how Huntarr searches for missing episodes:</p>
|
||||
<ul>
|
||||
<li><strong>Season Packs:</strong> Recommended for torrent users. Searches for entire season packs first, then individual episodes</li>
|
||||
<li><strong>Episodes:</strong> Searches for individual episodes only. Better for Usenet users or when you prefer single episode files</li>
|
||||
</ul>
|
||||
|
||||
<h3 id="upgrade-mode">Upgrade Mode</h3>
|
||||
<h3 id="upgrade-mode"><i class="fas fa-arrow-up" style="margin-right: 10px; color: #2ecc71;"></i>Upgrade Mode</h3>
|
||||
<p>Controls how Huntarr handles quality upgrades:</p>
|
||||
<ul>
|
||||
<li><strong>Episodes:</strong> Upgrades individual episodes when better quality becomes available</li>
|
||||
<li><strong>Seasons/Shows:</strong> Upgrades entire seasons or shows at once when better quality is found</li>
|
||||
</ul>
|
||||
|
||||
<h3 id="search-limits">Search Limits</h3>
|
||||
<h3 id="search-limits"><i class="fas fa-sliders-h" style="margin-right: 10px; color: #f39c12;"></i>Search Limits</h3>
|
||||
<p>Control how many items Huntarr processes per cycle to avoid overwhelming your indexers:</p>
|
||||
|
||||
<table>
|
||||
@@ -161,13 +162,13 @@
|
||||
<strong>Important:</strong> Setting API limits too high can result in your accounts being banned from indexers. Start with conservative values and adjust based on your indexer limits.
|
||||
</div>
|
||||
|
||||
<h3 id="additional-options">Additional Options</h3>
|
||||
<h3 id="additional-options"><i class="fas fa-cogs" style="margin-right: 10px; color: #9b59b6;"></i>Additional Options</h3>
|
||||
<p>Fine-tune Huntarr's behavior with these additional settings:</p>
|
||||
|
||||
<h4>Monitored Only</h4>
|
||||
<h4><i class="fas fa-eye" style="margin-right: 8px; color: #3498db;"></i>Monitored Only</h4>
|
||||
<p>When enabled, Huntarr will only search for content that is marked as "Monitored" in Sonarr. This prevents searches for shows you've intentionally unmonitored.</p>
|
||||
|
||||
<h4>Skip Future Episodes</h4>
|
||||
<h4><i class="fas fa-clock" style="margin-right: 8px; color: #e74c3c;"></i>Skip Future Episodes</h4>
|
||||
<p>When enabled, Huntarr will skip episodes with future air dates. This prevents unnecessary searches for content that hasn't been released yet.</p>
|
||||
|
||||
<h2 id="troubleshooting">Troubleshooting</h2>
|
||||
|
||||
255
docs/apps/whisparr-v2.html
Normal file
255
docs/apps/whisparr-v2.html
Normal file
@@ -0,0 +1,255 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>Whisparr V2 Documentation - Huntarr.io</title>
|
||||
<link rel="stylesheet" href="../css/main.css">
|
||||
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.0/css/all.min.css">
|
||||
<script src="../js/main.js" defer></script>
|
||||
</head>
|
||||
<body>
|
||||
<div class="sidebar">
|
||||
<div class="sidebar-logo">
|
||||
<img src="../images/huntarr-logo.png" alt="Huntarr Logo">
|
||||
<h2>Huntarr.io</h2>
|
||||
</div>
|
||||
|
||||
<nav class="sidebar-nav">
|
||||
<div class="sidebar-section">
|
||||
<h3 class="sidebar-section-title">Getting Started</h3>
|
||||
<ul>
|
||||
<li><a href="../getting-started/installation.html"><svg class="svg-icon" viewBox="0 0 24 24" fill="currentColor"><path d="M19 9h-4V3H9v6H5l7 7 7-7zM5 18v2h14v-2H5z"></path></svg> Installation</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="sidebar-section">
|
||||
<h3 class="sidebar-section-title">Core</h3>
|
||||
<ul>
|
||||
<li><a href="../index.html"><svg class="svg-icon" viewBox="0 0 24 24" fill="currentColor"><path d="M10 20v-6h4v6h5v-8h3L12 3 2 12h3v8z"></path></svg> Home</a></li>
|
||||
<li class="active"><a href="index.html"><svg class="svg-icon" viewBox="0 0 24 24" fill="currentColor"><path d="M4 8h4V4H4v4zm6 12h4v-4h-4v4zm-6 0h4v-4H4v4zm0-6h4v-4H4v4zm6 0h4v-4h-4v4zm6-10v4h4V4h-4zm-6 4h4V4h-4v4zm6 6h4v-4h-4v4zm0 6h4v-4h-4v4z"></path></svg> Apps</a></li>
|
||||
<li><a href="../settings/settings.html"><svg class="svg-icon" viewBox="0 0 24 24" fill="currentColor"><path d="M19.14 12.94c.04-.3.06-.61.06-.94 0-.32-.02-.64-.07-.94l2.03-1.58c.18-.14.23-.41.12-.61l-1.92-3.32c-.12-.22-.37-.29-.59-.22l-2.39.96c-.5-.38-1.03-.7-1.62-.94l-.36-2.54c-.04-.24-.24-.41-.48-.41h-3.84c-.24 0-.43.17-.47.41l-.36 2.54c-.59.24-1.13.57-1.62.94l-2.39-.96c-.22-.08-.47 0-.59.22L2.74 8.87c-.12.21-.08.47.12.61l2.03 1.58c-.05.3-.09.63-.09.94s.02.64.07.94l-2.03 1.58c-.18.14-.23.41-.12.61l1.92 3.32c.12.22.37.29.59.22l2.39-.96c.5.38 1.03.7 1.62.94l.36 2.54c.05.24.24.41.48.41h3.84c.24 0 .44-.17.47-.41l.36-2.54c.59-.24 1.13-.56 1.62-.94l2.39.96c.22.08.47 0 .59-.22l1.92-3.32c.12-.22.07-.47-.12-.61l-2.01-1.58zM12 15.6c-1.98 0-3.6-1.62-3.6-3.6s1.62-3.6 3.6-3.6 3.6 1.62 3.6 3.6-1.62 3.6-3.6 3.6z"></path></svg> Settings</a></li>
|
||||
<li><a href="../features/index.html"><i class="fas fa-star" style="width: 24px; height: 24px; margin-right: 8px; display: inline-flex; align-items: center; justify-content: center;"></i> Features</a></li>
|
||||
<li><a href="../faq.html"><i class="fas fa-question-circle" style="width: 24px; height: 24px; margin-right: 8px; display: inline-flex; align-items: center; justify-content: center;"></i> FAQ</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="sidebar-section">
|
||||
<h3 class="sidebar-section-title">Resources</h3>
|
||||
<ul>
|
||||
<li><a href="https://github.com/plexguide/Huntarr.io" target="_blank"><svg class="svg-icon" viewBox="0 0 24 24" fill="currentColor"><path d="M12 0c-6.626 0-12 5.373-12 12 0 5.302 3.438 9.8 8.207 11.387.599.111.793-.261.793-.577v-2.234c-3.338.726-4.033-1.416-4.033-1.416-.546-1.387-1.333-1.756-1.333-1.756-1.089-.745.083-.729.083-.729 1.205.084 1.839 1.237 1.839 1.237 1.07 1.834 2.807 1.304 3.492.997.107-.775.418-1.305.762-1.604-2.665-.305-5.467-1.334-5.467-5.931 0-1.311.469-2.381 1.236-3.221-.124-.303-.535-1.524.117-3.176 0 0 1.008-.322 3.301 1.23.957-.266 1.983-.399 3.003-.404 1.02.005 2.047.138 3.006.404 2.291-1.552 3.297-1.23 3.297-1.23.653 1.653.242 2.874.118 3.176.77.84 1.235 1.911 1.235 3.221 0 4.609-2.807 5.624-5.479 5.921.43.372.823 1.102.823 2.222v3.293c0 .319.192.694.801.576 4.765-1.589 8.199-6.086 8.199-11.386 0-6.627-5.373-12-12-12z"></path></svg> GitHub</a></li>
|
||||
<li><a href="https://discord.com/invite/PGJJjR5Cww" target="_blank"><i class="fab fa-discord" style="color: #5865F2; font-size: 18px; width: 24px; height: 24px; margin-right: 8px; display: inline-flex; align-items: center; justify-content: center;"></i> Discord</a></li>
|
||||
<li><a href="https://www.reddit.com/r/huntarr/" target="_blank"><i class="fab fa-reddit-alien" style="color: #FF4500; font-size: 18px; width: 24px; height: 24px; margin-right: 8px; display: inline-flex; align-items: center; justify-content: center;"></i> Reddit</a></li>
|
||||
<li><a href="https://donate.plex.one" target="_blank"><i class="fas fa-heart" style="color: #e91e63; font-size: 18px; width: 24px; height: 24px; margin-right: 8px; display: inline-flex; align-items: center; justify-content: center;"></i> Donate</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</nav>
|
||||
</div>
|
||||
|
||||
<div class="main-content">
|
||||
<div class="container">
|
||||
<h1>Whisparr V2 Documentation</h1>
|
||||
|
||||
<div style="text-align: center; margin: 20px auto;">
|
||||
<img src="../images/arrs/whisparr.png" alt="Whisparr Logo" style="width: 80px; height: 80px; object-fit: contain;">
|
||||
</div>
|
||||
|
||||
<p>Whisparr V2 is an automated adult content downloading and management application. Huntarr integrates with your existing Whisparr V2 instance to automatically search for missing content and quality upgrades that Whisparr doesn't actively hunt for.</p>
|
||||
|
||||
<div class="alert alert-warning">
|
||||
<strong>Note:</strong> This documentation covers Whisparr V2. For the newer Whisparr V3 (Eros), please see the <a href="whisparr-v3.html">Whisparr V3 documentation</a>.
|
||||
</div>
|
||||
|
||||
<h2 id="whisparr-instance-setup">Whisparr V2 Instance Setup</h2>
|
||||
|
||||
<h3>Adding Your Whisparr V2 Instance</h3>
|
||||
<p>To connect your existing Whisparr V2 instance to Huntarr:</p>
|
||||
<ol>
|
||||
<li>Navigate to the Whisparr V2 section in Huntarr</li>
|
||||
<li>Click "Add Whisparr V2 Instance" if you don't have one configured</li>
|
||||
<li>Fill in your Whisparr V2 connection details</li>
|
||||
<li>Test the connection to ensure Huntarr can communicate with Whisparr V2</li>
|
||||
</ol>
|
||||
|
||||
<h3 id="connection-settings">Connection Settings</h3>
|
||||
<p>Configure these settings to connect Huntarr to your Whisparr V2 instance:</p>
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<th>Setting</th>
|
||||
<th>Description</th>
|
||||
<th>Example</th>
|
||||
<th>Notes</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Name</td>
|
||||
<td>Friendly name for this Whisparr V2 instance</td>
|
||||
<td>Default, Adult-4K, Scenes</td>
|
||||
<td>Useful when running multiple Whisparr instances</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>URL</td>
|
||||
<td>Base URL for your Whisparr V2 instance</td>
|
||||
<td>http://10.0.0.10:6969</td>
|
||||
<td>Include protocol (http/https) and port</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>API Key</td>
|
||||
<td>Whisparr V2 API key for authentication</td>
|
||||
<td>e37h10f0625g8ig7d9e1c08g6f4d802</td>
|
||||
<td>Found in Whisparr V2 Settings > General > Security</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Enabled</td>
|
||||
<td>Whether Huntarr should process this instance</td>
|
||||
<td>On/Off toggle</td>
|
||||
<td>Disable to temporarily stop processing</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<h2 id="search-settings">Search Settings</h2>
|
||||
|
||||
<p>Configure how Huntarr searches for missing content and upgrades in your Whisparr V2 instance. These settings control Huntarr's behavior when processing your adult content library.</p>
|
||||
|
||||
<h3 id="missing-search-mode"><i class="fas fa-search" style="margin-right: 10px; color: #e91e63;"></i>Missing Search Mode</h3>
|
||||
<p>Determines how Huntarr searches for missing content:</p>
|
||||
<ul>
|
||||
<li><strong>Movies:</strong> Searches for individual movies/scenes. Standard mode for most collections</li>
|
||||
<li><strong>Performers:</strong> Searches at the performer level for complete works</li>
|
||||
<li><strong>Studios:</strong> Searches by studio for specific production companies</li>
|
||||
</ul>
|
||||
|
||||
<h3 id="upgrade-mode"><i class="fas fa-arrow-up" style="margin-right: 10px; color: #2ecc71;"></i>Upgrade Mode</h3>
|
||||
<p>Controls how Huntarr handles quality upgrades:</p>
|
||||
<ul>
|
||||
<li><strong>Movies:</strong> Upgrades individual movies/scenes when better quality becomes available</li>
|
||||
<li><strong>Performers:</strong> Upgrades at the performer level for consistent quality</li>
|
||||
<li><strong>Studios:</strong> Upgrades entire studio collections when better quality is found</li>
|
||||
</ul>
|
||||
|
||||
<h3 id="search-limits"><i class="fas fa-sliders-h" style="margin-right: 10px; color: #f39c12;"></i>Search Limits</h3>
|
||||
<p>Control how many items Huntarr processes per cycle to avoid overwhelming your indexers:</p>
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<th>Setting</th>
|
||||
<th>Description</th>
|
||||
<th>Recommended</th>
|
||||
<th>Notes</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Missing Search</td>
|
||||
<td>Number of missing items to search per cycle</td>
|
||||
<td>1-3</td>
|
||||
<td>Set to 0 to disable missing searches</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Upgrade Search</td>
|
||||
<td>Number of items to upgrade per cycle</td>
|
||||
<td>1-2</td>
|
||||
<td>Set to 0 to disable upgrade searches</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Sleep Duration</td>
|
||||
<td>Time in seconds between processing cycles</td>
|
||||
<td>3600 (60 min)</td>
|
||||
<td>Adult indexers often have strict limits</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>API Cap - Hourly</td>
|
||||
<td>Maximum API requests per hour</td>
|
||||
<td>100 or less</td>
|
||||
<td>Adult indexers typically have very low limits</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<div class="alert alert-warning">
|
||||
<strong>Important:</strong> Adult content indexers typically have very strict rate limits and limited content. Use very conservative settings to avoid being banned.
|
||||
</div>
|
||||
|
||||
<h3 id="additional-options"><i class="fas fa-cogs" style="margin-right: 10px; color: #9b59b6;"></i>Additional Options</h3>
|
||||
<p>Fine-tune Huntarr's behavior with these additional settings:</p>
|
||||
|
||||
<h4><i class="fas fa-eye" style="margin-right: 8px; color: #e91e63;"></i>Monitored Only</h4>
|
||||
<p>When enabled, Huntarr will only search for content that is marked as "Monitored" in Whisparr V2. This prevents searches for performers or content you've intentionally unmonitored.</p>
|
||||
|
||||
<h4><i class="fas fa-calendar" style="margin-right: 8px; color: #e74c3c;"></i>Skip Future Releases</h4>
|
||||
<p>When enabled, Huntarr will skip content with future release dates. This prevents unnecessary searches for content that hasn't been released yet.</p>
|
||||
|
||||
<h4><i class="fas fa-user" style="margin-right: 8px; color: #9b59b6;"></i>Performer Monitoring</h4>
|
||||
<p>When enabled, Huntarr will respect your performer monitoring settings in Whisparr V2, only searching for content from performers you're actively monitoring.</p>
|
||||
|
||||
<h4><i class="fas fa-building" style="margin-right: 8px; color: #f39c12;"></i>Studio Filtering</h4>
|
||||
<p>Configure which studios Huntarr should prioritize or exclude when searching for content.</p>
|
||||
|
||||
<h2 id="troubleshooting">Troubleshooting</h2>
|
||||
|
||||
<h3>Common Issues</h3>
|
||||
|
||||
<h4>Connection Failed</h4>
|
||||
<p>If Huntarr can't connect to your Whisparr V2 instance:</p>
|
||||
<ul>
|
||||
<li>Verify the URL is correct and includes the protocol (http/https)</li>
|
||||
<li>Check that the port number is correct (default: 6969)</li>
|
||||
<li>Ensure the API key is copied correctly from Whisparr V2 Settings > General > Security</li>
|
||||
<li>Confirm Whisparr V2 is running and accessible from Huntarr's network</li>
|
||||
<li>Check firewall settings if Huntarr and Whisparr V2 are on different machines</li>
|
||||
</ul>
|
||||
|
||||
<h4>No Missing Content Found</h4>
|
||||
<p>If Huntarr reports no missing content but you know there are gaps:</p>
|
||||
<ul>
|
||||
<li>Ensure "Monitored Only" is configured correctly for your needs</li>
|
||||
<li>Check that performers and content are marked as "Monitored" in Whisparr V2</li>
|
||||
<li>Verify "Skip Future Releases" isn't preventing searches for available content</li>
|
||||
<li>Review your performer and studio monitoring settings</li>
|
||||
</ul>
|
||||
|
||||
<h4>Limited Content Availability</h4>
|
||||
<p>If Huntarr isn't finding content that should be available:</p>
|
||||
<ul>
|
||||
<li>Adult content indexers have much more limited content than mainstream indexers</li>
|
||||
<li>Consider adding more adult-specific indexers to Whisparr V2</li>
|
||||
<li>Check if your indexers support the content types you're seeking</li>
|
||||
<li>Verify your quality profiles match available content</li>
|
||||
</ul>
|
||||
|
||||
<h4>Rate Limiting Issues</h4>
|
||||
<p>If you're getting rate limited by adult indexers:</p>
|
||||
<ul>
|
||||
<li>Reduce the "API Cap - Hourly" setting to 50-100 requests</li>
|
||||
<li>Increase the "Sleep Duration" to 60+ minutes between cycles</li>
|
||||
<li>Lower the "Missing Search" and "Upgrade Search" limits to 1-2</li>
|
||||
<li>Adult indexers are typically much more restrictive than mainstream ones</li>
|
||||
</ul>
|
||||
|
||||
<h4>Metadata and Search Issues</h4>
|
||||
<p>If Huntarr isn't finding the right content:</p>
|
||||
<ul>
|
||||
<li>Verify your metadata provider settings in Whisparr V2</li>
|
||||
<li>Check that performer names and content titles are correctly matched</li>
|
||||
<li>Review studio and series information for proper identification</li>
|
||||
<li>Consider adjusting search criteria for different naming conventions</li>
|
||||
</ul>
|
||||
|
||||
<h4>Quality and Format Issues</h4>
|
||||
<p>If Huntarr isn't finding the right quality:</p>
|
||||
<ul>
|
||||
<li>Verify your quality profiles support the formats you want</li>
|
||||
<li>Check that your indexers have the quality levels you're seeking</li>
|
||||
<li>Review cutoff settings to ensure upgrades are allowed</li>
|
||||
<li>Consider separate instances for different quality requirements</li>
|
||||
</ul>
|
||||
|
||||
<div class="section-nav">
|
||||
<a href="readarr.html">← Readarr Documentation</a>
|
||||
<a href="whisparr-v3.html">Whisparr V3 Documentation →</a>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
Huntarr.io | Whisparr V2 Documentation | Thanks 4 Using Huntarr - Admin9705
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
282
docs/apps/whisparr-v3.html
Normal file
282
docs/apps/whisparr-v3.html
Normal file
@@ -0,0 +1,282 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>Whisparr V3 (Eros) Documentation - Huntarr.io</title>
|
||||
<link rel="stylesheet" href="../css/main.css">
|
||||
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.0/css/all.min.css">
|
||||
<script src="../js/main.js" defer></script>
|
||||
</head>
|
||||
<body>
|
||||
<div class="sidebar">
|
||||
<div class="sidebar-logo">
|
||||
<img src="../images/huntarr-logo.png" alt="Huntarr Logo">
|
||||
<h2>Huntarr.io</h2>
|
||||
</div>
|
||||
|
||||
<nav class="sidebar-nav">
|
||||
<div class="sidebar-section">
|
||||
<h3 class="sidebar-section-title">Getting Started</h3>
|
||||
<ul>
|
||||
<li><a href="../getting-started/installation.html"><svg class="svg-icon" viewBox="0 0 24 24" fill="currentColor"><path d="M19 9h-4V3H9v6H5l7 7 7-7zM5 18v2h14v-2H5z"></path></svg> Installation</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="sidebar-section">
|
||||
<h3 class="sidebar-section-title">Core</h3>
|
||||
<ul>
|
||||
<li><a href="../index.html"><svg class="svg-icon" viewBox="0 0 24 24" fill="currentColor"><path d="M10 20v-6h4v6h5v-8h3L12 3 2 12h3v8z"></path></svg> Home</a></li>
|
||||
<li class="active"><a href="index.html"><svg class="svg-icon" viewBox="0 0 24 24" fill="currentColor"><path d="M4 8h4V4H4v4zm6 12h4v-4h-4v4zm-6 0h4v-4H4v4zm0-6h4v-4H4v4zm6 0h4v-4h-4v4zm6-10v4h4V4h-4zm-6 4h4V4h-4v4zm6 6h4v-4h-4v4zm0 6h4v-4h-4v4z"></path></svg> Apps</a></li>
|
||||
<li><a href="../settings/settings.html"><svg class="svg-icon" viewBox="0 0 24 24" fill="currentColor"><path d="M19.14 12.94c.04-.3.06-.61.06-.94 0-.32-.02-.64-.07-.94l2.03-1.58c.18-.14.23-.41.12-.61l-1.92-3.32c-.12-.22-.37-.29-.59-.22l-2.39.96c-.5-.38-1.03-.7-1.62-.94l-.36-2.54c-.04-.24-.24-.41-.48-.41h-3.84c-.24 0-.43.17-.47.41l-.36 2.54c-.59.24-1.13.57-1.62.94l-2.39-.96c-.22-.08-.47 0-.59.22L2.74 8.87c-.12.21-.08.47.12.61l2.03 1.58c-.05.3-.09.63-.09.94s.02.64.07.94l-2.03 1.58c-.18.14-.23.41-.12.61l1.92 3.32c.12.22.37.29.59.22l2.39-.96c.5.38 1.03.7 1.62.94l.36 2.54c.05.24.24.41.48.41h3.84c.24 0 .44-.17.47-.41l.36-2.54c.59-.24 1.13-.56 1.62-.94l2.39.96c.22.08.47 0 .59-.22l1.92-3.32c.12-.22.07-.47-.12-.61l-2.01-1.58zM12 15.6c-1.98 0-3.6-1.62-3.6-3.6s1.62-3.6 3.6-3.6 3.6 1.62 3.6 3.6-1.62 3.6-3.6 3.6z"></path></svg> Settings</a></li>
|
||||
<li><a href="../features/index.html"><i class="fas fa-star" style="width: 24px; height: 24px; margin-right: 8px; display: inline-flex; align-items: center; justify-content: center;"></i> Features</a></li>
|
||||
<li><a href="../faq.html"><i class="fas fa-question-circle" style="width: 24px; height: 24px; margin-right: 8px; display: inline-flex; align-items: center; justify-content: center;"></i> FAQ</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="sidebar-section">
|
||||
<h3 class="sidebar-section-title">Resources</h3>
|
||||
<ul>
|
||||
<li><a href="https://github.com/plexguide/Huntarr.io" target="_blank"><svg class="svg-icon" viewBox="0 0 24 24" fill="currentColor"><path d="M12 0c-6.626 0-12 5.373-12 12 0 5.302 3.438 9.8 8.207 11.387.599.111.793-.261.793-.577v-2.234c-3.338.726-4.033-1.416-4.033-1.416-.546-1.387-1.333-1.756-1.333-1.756-1.089-.745.083-.729.083-.729 1.205.084 1.839 1.237 1.839 1.237 1.07 1.834 2.807 1.304 3.492.997.107-.775.418-1.305.762-1.604-2.665-.305-5.467-1.334-5.467-5.931 0-1.311.469-2.381 1.236-3.221-.124-.303-.535-1.524.117-3.176 0 0 1.008-.322 3.301 1.23.957-.266 1.983-.399 3.003-.404 1.02.005 2.047.138 3.006.404 2.291-1.552 3.297-1.23 3.297-1.23.653 1.653.242 2.874.118 3.176.77.84 1.235 1.911 1.235 3.221 0 4.609-2.807 5.624-5.479 5.921.43.372.823 1.102.823 2.222v3.293c0 .319.192.694.801.576 4.765-1.589 8.199-6.086 8.199-11.386 0-6.627-5.373-12-12-12z"></path></svg> GitHub</a></li>
|
||||
<li><a href="https://discord.com/invite/PGJJjR5Cww" target="_blank"><i class="fab fa-discord" style="color: #5865F2; font-size: 18px; width: 24px; height: 24px; margin-right: 8px; display: inline-flex; align-items: center; justify-content: center;"></i> Discord</a></li>
|
||||
<li><a href="https://www.reddit.com/r/huntarr/" target="_blank"><i class="fab fa-reddit-alien" style="color: #FF4500; font-size: 18px; width: 24px; height: 24px; margin-right: 8px; display: inline-flex; align-items: center; justify-content: center;"></i> Reddit</a></li>
|
||||
<li><a href="https://donate.plex.one" target="_blank"><i class="fas fa-heart" style="color: #e91e63; font-size: 18px; width: 24px; height: 24px; margin-right: 8px; display: inline-flex; align-items: center; justify-content: center;"></i> Donate</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</nav>
|
||||
</div>
|
||||
|
||||
<div class="main-content">
|
||||
<div class="container">
|
||||
<h1>Whisparr V3 (Eros) Documentation</h1>
|
||||
|
||||
<div style="text-align: center; margin: 20px auto;">
|
||||
<img src="../images/arrs/whisparr.png" alt="Whisparr Logo" style="width: 80px; height: 80px; object-fit: contain;">
|
||||
</div>
|
||||
|
||||
<p>Whisparr V3 (Eros) is the newer version of the automated adult content downloading and management application. Huntarr integrates with your existing Whisparr V3 instance to automatically search for missing content and quality upgrades that Whisparr doesn't actively hunt for.</p>
|
||||
|
||||
<div class="alert alert-info">
|
||||
<strong>Note:</strong> This documentation covers Whisparr V3 (Eros). For the older Whisparr V2, please see the <a href="whisparr-v2.html">Whisparr V2 documentation</a>.
|
||||
</div>
|
||||
|
||||
<h2 id="whisparr-v3-instance-setup">Whisparr V3 Instance Setup</h2>
|
||||
|
||||
<h3>Adding Your Whisparr V3 Instance</h3>
|
||||
<p>To connect your existing Whisparr V3 instance to Huntarr:</p>
|
||||
<ol>
|
||||
<li>Navigate to the Whisparr V3 section in Huntarr</li>
|
||||
<li>Click "Add Whisparr V3 Instance" if you don't have one configured</li>
|
||||
<li>Fill in your Whisparr V3 connection details</li>
|
||||
<li>Test the connection to ensure Huntarr can communicate with Whisparr V3</li>
|
||||
</ol>
|
||||
|
||||
<h3 id="connection-settings">Connection Settings</h3>
|
||||
<p>Configure these settings to connect Huntarr to your Whisparr V3 instance:</p>
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<th>Setting</th>
|
||||
<th>Description</th>
|
||||
<th>Example</th>
|
||||
<th>Notes</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Name</td>
|
||||
<td>Friendly name for this Whisparr V3 instance</td>
|
||||
<td>Default, Eros-4K, Premium</td>
|
||||
<td>Useful when running multiple Whisparr instances</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>URL</td>
|
||||
<td>Base URL for your Whisparr V3 instance</td>
|
||||
<td>http://10.0.0.10:6969</td>
|
||||
<td>Include protocol (http/https) and port</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>API Key</td>
|
||||
<td>Whisparr V3 API key for authentication</td>
|
||||
<td>f48i21g1736h9jh8e0f2d19h7g5e913</td>
|
||||
<td>Found in Whisparr V3 Settings > General > Security</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Enabled</td>
|
||||
<td>Whether Huntarr should process this instance</td>
|
||||
<td>On/Off toggle</td>
|
||||
<td>Disable to temporarily stop processing</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<h2 id="search-settings">Search Settings</h2>
|
||||
|
||||
<p>Configure how Huntarr searches for missing content and upgrades in your Whisparr V3 instance. These settings control Huntarr's behavior when processing your adult content library.</p>
|
||||
|
||||
<h3 id="missing-search-mode"><i class="fas fa-search" style="margin-right: 10px; color: #e91e63;"></i>Missing Search Mode</h3>
|
||||
<p>Determines how Huntarr searches for missing content:</p>
|
||||
<ul>
|
||||
<li><strong>Movies:</strong> Searches for individual movies/scenes. Standard mode for most collections</li>
|
||||
<li><strong>Performers:</strong> Searches at the performer level for complete works</li>
|
||||
<li><strong>Studios:</strong> Searches by studio for specific production companies</li>
|
||||
<li><strong>Series:</strong> Searches for content series and franchises (V3 enhancement)</li>
|
||||
</ul>
|
||||
|
||||
<h3 id="upgrade-mode"><i class="fas fa-arrow-up" style="margin-right: 10px; color: #2ecc71;"></i>Upgrade Mode</h3>
|
||||
<p>Controls how Huntarr handles quality upgrades:</p>
|
||||
<ul>
|
||||
<li><strong>Movies:</strong> Upgrades individual movies/scenes when better quality becomes available</li>
|
||||
<li><strong>Performers:</strong> Upgrades at the performer level for consistent quality</li>
|
||||
<li><strong>Studios:</strong> Upgrades entire studio collections when better quality is found</li>
|
||||
<li><strong>Series:</strong> Upgrades complete series when better quality is available (V3 enhancement)</li>
|
||||
</ul>
|
||||
|
||||
<h3 id="search-limits"><i class="fas fa-sliders-h" style="margin-right: 10px; color: #f39c12;"></i>Search Limits</h3>
|
||||
<p>Control how many items Huntarr processes per cycle to avoid overwhelming your indexers:</p>
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<th>Setting</th>
|
||||
<th>Description</th>
|
||||
<th>Recommended</th>
|
||||
<th>Notes</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Missing Search</td>
|
||||
<td>Number of missing items to search per cycle</td>
|
||||
<td>1-3</td>
|
||||
<td>Set to 0 to disable missing searches</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Upgrade Search</td>
|
||||
<td>Number of items to upgrade per cycle</td>
|
||||
<td>1-2</td>
|
||||
<td>Set to 0 to disable upgrade searches</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Sleep Duration</td>
|
||||
<td>Time in seconds between processing cycles</td>
|
||||
<td>3600 (60 min)</td>
|
||||
<td>Adult indexers often have strict limits</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>API Cap - Hourly</td>
|
||||
<td>Maximum API requests per hour</td>
|
||||
<td>100 or less</td>
|
||||
<td>Adult indexers typically have very low limits</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<div class="alert alert-warning">
|
||||
<strong>Important:</strong> Adult content indexers typically have very strict rate limits and limited content. Use very conservative settings to avoid being banned.
|
||||
</div>
|
||||
|
||||
<h3 id="additional-options"><i class="fas fa-cogs" style="margin-right: 10px; color: #9b59b6;"></i>Additional Options</h3>
|
||||
<p>Fine-tune Huntarr's behavior with these additional settings:</p>
|
||||
|
||||
<h4><i class="fas fa-eye" style="margin-right: 8px; color: #e91e63;"></i>Monitored Only</h4>
|
||||
<p>When enabled, Huntarr will only search for content that is marked as "Monitored" in Whisparr V3. This prevents searches for performers or content you've intentionally unmonitored.</p>
|
||||
|
||||
<h4><i class="fas fa-calendar" style="margin-right: 8px; color: #e74c3c;"></i>Skip Future Releases</h4>
|
||||
<p>When enabled, Huntarr will skip content with future release dates. This prevents unnecessary searches for content that hasn't been released yet.</p>
|
||||
|
||||
<h4><i class="fas fa-user" style="margin-right: 8px; color: #9b59b6;"></i>Performer Monitoring</h4>
|
||||
<p>When enabled, Huntarr will respect your performer monitoring settings in Whisparr V3, only searching for content from performers you're actively monitoring.</p>
|
||||
|
||||
<h4><i class="fas fa-building" style="margin-right: 8px; color: #f39c12;"></i>Studio Filtering</h4>
|
||||
<p>Configure which studios Huntarr should prioritize or exclude when searching for content.</p>
|
||||
|
||||
<h4><i class="fas fa-list" style="margin-right: 8px; color: #3498db;"></i>Series Management (V3 Feature)</h4>
|
||||
<p>Whisparr V3 introduces enhanced series management. Huntarr can search for missing episodes within series and upgrade entire series collections.</p>
|
||||
|
||||
<h4><i class="fas fa-tags" style="margin-right: 8px; color: #e67e22;"></i>Enhanced Metadata (V3 Feature)</h4>
|
||||
<p>V3 provides improved metadata handling, allowing for more accurate searches based on enhanced performer, studio, and content information.</p>
|
||||
|
||||
<h2 id="v3-enhancements">Whisparr V3 Enhancements</h2>
|
||||
|
||||
<h3>What's New in V3 (Eros)</h3>
|
||||
<p>Whisparr V3 brings several improvements that enhance Huntarr's integration:</p>
|
||||
|
||||
<h4><i class="fas fa-database" style="margin-right: 8px; color: #3498db;"></i>Improved Database Structure</h4>
|
||||
<p>Better organization of content, performers, and metadata for more accurate searches.</p>
|
||||
|
||||
<h4><i class="fas fa-search-plus" style="margin-right: 8px; color: #2ecc71;"></i>Enhanced Search Capabilities</h4>
|
||||
<p>More sophisticated search algorithms that work better with Huntarr's automated searching.</p>
|
||||
|
||||
<h4><i class="fas fa-chart-line" style="margin-right: 8px; color: #f39c12;"></i>Better Performance</h4>
|
||||
<p>Optimized API responses and reduced resource usage for smoother integration with Huntarr.</p>
|
||||
|
||||
<h4><i class="fas fa-shield-alt" style="margin-right: 8px; color: #e74c3c;"></i>Improved Security</h4>
|
||||
<p>Enhanced API security features that work seamlessly with Huntarr's authentication.</p>
|
||||
|
||||
<h2 id="troubleshooting">Troubleshooting</h2>
|
||||
|
||||
<h3>Common Issues</h3>
|
||||
|
||||
<h4>Connection Failed</h4>
|
||||
<p>If Huntarr can't connect to your Whisparr V3 instance:</p>
|
||||
<ul>
|
||||
<li>Verify the URL is correct and includes the protocol (http/https)</li>
|
||||
<li>Check that the port number is correct (default: 6969)</li>
|
||||
<li>Ensure the API key is copied correctly from Whisparr V3 Settings > General > Security</li>
|
||||
<li>Confirm Whisparr V3 is running and accessible from Huntarr's network</li>
|
||||
<li>Check firewall settings if Huntarr and Whisparr V3 are on different machines</li>
|
||||
</ul>
|
||||
|
||||
<h4>V3 Migration Issues</h4>
|
||||
<p>If you're migrating from Whisparr V2 to V3:</p>
|
||||
<ul>
|
||||
<li>Ensure your V3 instance is properly configured and running</li>
|
||||
<li>Update your Huntarr configuration to point to the new V3 instance</li>
|
||||
<li>Verify that all your content has been properly migrated to V3</li>
|
||||
<li>Check that performer and studio information is correctly imported</li>
|
||||
</ul>
|
||||
|
||||
<h4>No Missing Content Found</h4>
|
||||
<p>If Huntarr reports no missing content but you know there are gaps:</p>
|
||||
<ul>
|
||||
<li>Ensure "Monitored Only" is configured correctly for your needs</li>
|
||||
<li>Check that performers and content are marked as "Monitored" in Whisparr V3</li>
|
||||
<li>Verify "Skip Future Releases" isn't preventing searches for available content</li>
|
||||
<li>Review your performer and studio monitoring settings</li>
|
||||
<li>Check series monitoring settings (V3 feature)</li>
|
||||
</ul>
|
||||
|
||||
<h4>Limited Content Availability</h4>
|
||||
<p>If Huntarr isn't finding content that should be available:</p>
|
||||
<ul>
|
||||
<li>Adult content indexers have much more limited content than mainstream indexers</li>
|
||||
<li>Consider adding more adult-specific indexers to Whisparr V3</li>
|
||||
<li>Check if your indexers support the content types you're seeking</li>
|
||||
<li>Verify your quality profiles match available content</li>
|
||||
<li>Utilize V3's enhanced metadata for better search accuracy</li>
|
||||
</ul>
|
||||
|
||||
<h4>Rate Limiting Issues</h4>
|
||||
<p>If you're getting rate limited by adult indexers:</p>
|
||||
<ul>
|
||||
<li>Reduce the "API Cap - Hourly" setting to 50-100 requests</li>
|
||||
<li>Increase the "Sleep Duration" to 60+ minutes between cycles</li>
|
||||
<li>Lower the "Missing Search" and "Upgrade Search" limits to 1-2</li>
|
||||
<li>Adult indexers are typically much more restrictive than mainstream ones</li>
|
||||
</ul>
|
||||
|
||||
<h4>V3 Specific Features Not Working</h4>
|
||||
<p>If V3-specific features aren't functioning properly:</p>
|
||||
<ul>
|
||||
<li>Ensure you're running the latest version of Whisparr V3</li>
|
||||
<li>Verify that Huntarr supports the V3 features you're trying to use</li>
|
||||
<li>Check the Huntarr logs for any V3-specific error messages</li>
|
||||
<li>Consider updating Huntarr if V3 support is limited</li>
|
||||
</ul>
|
||||
|
||||
<div class="section-nav">
|
||||
<a href="whisparr-v2.html">← Whisparr V2 Documentation</a>
|
||||
<a href="index.html">Back to Apps Overview →</a>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
Huntarr.io | Whisparr V3 (Eros) Documentation | Thanks 4 Using Huntarr - Admin9705
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user