mirror of
https://github.com/plexguide/Huntarr.io.git
synced 2026-02-11 16:50:16 -06:00
295 lines
19 KiB
HTML
295 lines
19 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<title>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="../donate.html"><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>
|
|
<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>
|
|
|
|
</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>
|
|
|
|
<div class="alert alert-info" style="margin: 20px 0; padding: 15px; background: rgba(13, 202, 240, 0.1); border-left: 4px solid #0dcaf0;">
|
|
<strong><i class="fas fa-info-circle" style="margin-right: 8px;"></i>What is Whisparr V2?</strong>
|
|
Whisparr V2 is an automated adult content downloading and management application. It monitors for new content, searches indexers, and automatically downloads content using your preferred download clients.
|
|
</div>
|
|
|
|
<p>Whisparr V2 automates the process of monitoring and downloading adult content. It integrates with popular download clients and uses indexers to search for and download content automatically, making it easy to build and maintain an organized adult media library.</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="eros.html">Eros documentation</a>.
|
|
</div>
|
|
|
|
<h2 id="overview">Overview</h2>
|
|
|
|
<h3><i class="fas fa-download" style="margin-right: 10px; color: #3498db;"></i>What Whisparr V2 Does</h3>
|
|
<p>Whisparr V2 provides automated content management for adult media by:</p>
|
|
<ul>
|
|
<li><strong>Automatic Searching:</strong> Monitors for new content and searches configured indexers</li>
|
|
<li><strong>Quality Management:</strong> Downloads content based on your quality preferences</li>
|
|
<li><strong>Library Organization:</strong> Automatically organizes downloaded content in your media library</li>
|
|
<li><strong>Upgrade Management:</strong> Can upgrade existing content to better quality when available</li>
|
|
<li><strong>Download Client Integration:</strong> Works with popular download clients like qBittorrent, Deluge, etc.</li>
|
|
</ul>
|
|
|
|
<h3><i class="fas fa-cogs" style="margin-right: 10px; color: #e67e22;"></i>How Huntarr Enhances Whisparr V2</h3>
|
|
<p>Huntarr adds intelligent automation on top of Whisparr V2:</p>
|
|
<ul>
|
|
<li><strong>Smart Search Timing:</strong> Prevents overwhelming indexers with too many requests</li>
|
|
<li><strong>Missing Content Detection:</strong> Identifies and prioritizes missing content</li>
|
|
<li><strong>Upgrade Intelligence:</strong> Finds better quality versions of existing content</li>
|
|
<li><strong>Rate Limiting:</strong> Respects API limits to prevent bans or throttling</li>
|
|
<li><strong>Multi-Instance Support:</strong> Manage multiple Whisparr V2 instances from one interface</li>
|
|
</ul>
|
|
|
|
<h2 id="connection-settings">Instance Configuration</h2>
|
|
|
|
<p>Configure your Whisparr V2 instances to connect Huntarr with your Whisparr V2 installation(s).</p>
|
|
|
|
<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>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 id="monitored-only"><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 id="skip-future-releases"><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="swaparr-integration">Swaparr Integration</h2>
|
|
|
|
<p>Enable Swaparr monitoring for this Whisparr V2 instance to automatically clean up stalled downloads.</p>
|
|
|
|
<div class="alert alert-info" style="margin: 15px 0; padding: 15px; background: rgba(13, 202, 240, 0.1); border-left: 4px solid #0dcaf0;">
|
|
<strong><i class="fas fa-info-circle" style="margin-right: 8px;"></i>What is Swaparr?</strong>
|
|
Swaparr monitors your download queues and automatically removes stalled, failed, or problematic downloads to keep your automation running smoothly.
|
|
<a href="swaparr.html" style="color: #0dcaf0;">Learn more about Swaparr configuration</a>.
|
|
</div>
|
|
|
|
<h3><i class="fas fa-broom" style="margin-right: 8px; color: #e67e22;"></i>When to Enable Swaparr</h3>
|
|
<ul>
|
|
<li>You frequently have stalled adult content downloads</li>
|
|
<li>Your download queue gets clogged with failed downloads</li>
|
|
<li>You want hands-off automation for your adult media library</li>
|
|
<li>You use public trackers where quality and availability varies</li>
|
|
<li>You download content that sometimes has upload issues</li>
|
|
</ul>
|
|
|
|
<h3><i class="fas fa-exclamation-triangle" style="margin-right: 8px; color: #f39c12;"></i>When to Be Cautious</h3>
|
|
<ul>
|
|
<li>You use private adult trackers with strict ratio requirements</li>
|
|
<li>You prefer manual control over your adult content downloads</li>
|
|
<li>You have very slow internet where downloads take a long time</li>
|
|
<li>You're building ratio on specific adult content torrents</li>
|
|
<li>Adult content indexers have very limited availability</li>
|
|
</ul>
|
|
|
|
<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>
|
|
|
|
<div class="section-nav">
|
|
<a href="index.html">← Back to Apps</a>
|
|
<a href="eros.html">Eros Documentation →</a>
|
|
</div>
|
|
|
|
<footer>
|
|
Huntarr.io | Whisparr V2 Documentation | Thanks 4 Using Huntarr - Admin9705
|
|
</footer>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html> |