mirror of
https://github.com/plexguide/Huntarr.io.git
synced 2026-01-03 11:28:21 -05:00
275 lines
21 KiB
HTML
275 lines
21 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<title>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="../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>Eros Documentation</h1>
|
|
|
|
<div style="text-align: center; margin: 20px auto;">
|
|
<img src="../images/arrs/eros.png" alt="Eros 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 Eros?</strong>
|
|
Eros is an adult content management application that works similarly to Radarr but for adult films. It automatically monitors, downloads, and organizes adult content from your configured indexers and download clients.
|
|
</div>
|
|
|
|
<p>Eros 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>
|
|
|
|
<h2 id="overview">Overview</h2>
|
|
|
|
<h3><i class="fas fa-download" style="margin-right: 10px; color: #3498db;"></i>What Eros Does</h3>
|
|
<p>Eros provides automated content management for adult media by:</p>
|
|
<ul>
|
|
<li><strong>Automatic Searching:</strong> Monitors for new releases 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 Eros</h3>
|
|
<p>Huntarr adds intelligent automation on top of Eros:</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 Eros instances from one interface</li>
|
|
</ul>
|
|
|
|
<h2 id="instances">Instance Configuration</h2>
|
|
|
|
<p>Configure your Eros instances to connect Huntarr with your Eros installation(s).</p>
|
|
|
|
<h3 id="instance-name"><i class="fas fa-tag" style="margin-right: 8px; color: #9b59b6;"></i>Instance Name</h3>
|
|
<p><strong>What it does:</strong> Friendly name to identify this Eros instance in logs and notifications.</p>
|
|
<p><strong>Examples:</strong> "Main Eros", "4K Eros", "Private Tracker Eros"</p>
|
|
<p><strong>Best practices:</strong> Use descriptive names that help you identify the purpose of each instance, especially if you have multiple setups.</p>
|
|
|
|
<h3 id="instance-url"><i class="fas fa-link" style="margin-right: 8px; color: #3498db;"></i>Instance URL</h3>
|
|
<p><strong>What it does:</strong> The base URL where your Eros instance is accessible.</p>
|
|
<p><strong>Format examples:</strong></p>
|
|
<ul>
|
|
<li><strong>Local:</strong> <code>http://localhost:6969</code></li>
|
|
<li><strong>Docker:</strong> <code>http://eros:6969</code></li>
|
|
<li><strong>Remote:</strong> <code>http://192.168.1.100:6969</code></li>
|
|
<li><strong>Reverse Proxy:</strong> <code>https://eros.yourdomain.com</code></li>
|
|
</ul>
|
|
<p><strong>Important:</strong> Don't include <code>/api</code> at the end - Huntarr adds this automatically.</p>
|
|
|
|
<h3 id="instance-api-key"><i class="fas fa-key" style="margin-right: 8px; color: #e74c3c;"></i>API Key</h3>
|
|
<p><strong>What it does:</strong> Authentication key that allows Huntarr to communicate with your Eros instance.</p>
|
|
<p><strong>How to find it:</strong></p>
|
|
<ol>
|
|
<li>Open your Eros web interface</li>
|
|
<li>Go to <strong>Settings → General</strong></li>
|
|
<li>Look for <strong>API Key</strong> in the Security section</li>
|
|
<li>Copy the long alphanumeric string</li>
|
|
</ol>
|
|
<p><strong>Security note:</strong> Keep your API key private - it provides full access to your Eros instance.</p>
|
|
|
|
<h3 id="instance-enabled"><i class="fas fa-power-off" style="margin-right: 8px; color: #2ecc71;"></i>Instance Enabled</h3>
|
|
<p><strong>What it does:</strong> Controls whether Huntarr actively monitors this Eros instance.</p>
|
|
<p><strong>When to disable:</strong> Temporarily stop monitoring without losing your configuration, during maintenance, or for testing.</p>
|
|
|
|
<h2 id="search-settings">Search Settings</h2>
|
|
|
|
<p>Configure how Huntarr searches for content in your Eros instance.</p>
|
|
|
|
<h3 id="search-mode"><i class="fas fa-search" style="margin-right: 8px; color: #f39c12;"></i>Search Mode</h3>
|
|
<p><strong>What it does:</strong> Determines what type of content Eros will search for.</p>
|
|
<p><strong>Options:</strong></p>
|
|
<ul>
|
|
<li><strong>Movie:</strong> Search for individual movies/scenes</li>
|
|
<li><strong>Collection:</strong> Search for movie collections or series</li>
|
|
</ul>
|
|
<p><strong>Recommendation:</strong> Use "Movie" for most setups unless you specifically focus on collections.</p>
|
|
|
|
<h3 id="missing-search"><i class="fas fa-search-plus" style="margin-right: 8px; color: #3498db;"></i>Missing Search</h3>
|
|
<p><strong>What it does:</strong> Enable (1) or disable (0) automatic searching for missing content.</p>
|
|
<p><strong>How it works:</strong> When enabled, Huntarr will automatically search for content that's monitored in Eros but not yet downloaded.</p>
|
|
<p><strong>Recommendation:</strong> Keep enabled (1) for automated content acquisition.</p>
|
|
|
|
<h3 id="upgrade-search"><i class="fas fa-arrow-up" style="margin-right: 8px; color: #9b59b6;"></i>Upgrade Search</h3>
|
|
<p><strong>What it does:</strong> Enable (1) or disable (0) automatic searching for quality upgrades.</p>
|
|
<p><strong>How it works:</strong> When enabled, Huntarr will search for higher quality versions of content you already have.</p>
|
|
<p><strong>Recommendation:</strong> Enable only if you want automatic quality upgrades and have sufficient storage space.</p>
|
|
|
|
<h3 id="sleep-duration"><i class="fas fa-moon" style="margin-right: 8px; color: #6c5ce7;"></i>Sleep Duration</h3>
|
|
<p><strong>What it does:</strong> Time (in seconds) between Huntarr processing cycles for this app.</p>
|
|
<p><strong>How it affects performance:</strong></p>
|
|
<ul>
|
|
<li><strong>300-600 seconds (5-10 min):</strong> Faster response, more system load</li>
|
|
<li><strong>900-1800 seconds (15-30 min):</strong> Balanced approach (recommended)</li>
|
|
<li><strong>3600+ seconds (1+ hour):</strong> Less frequent checks, lower system load</li>
|
|
</ul>
|
|
<p><strong>Default:</strong> 900 seconds (15 minutes) provides a good balance for most users.</p>
|
|
|
|
<h3 id="api-cap"><i class="fas fa-tachometer-alt" style="margin-right: 8px; color: #e67e22;"></i>API Cap - Hourly</h3>
|
|
<p><strong>What it does:</strong> Maximum API requests Huntarr will make to this Eros instance per hour.</p>
|
|
<p><strong>Safe recommendation:</strong> <strong>20 requests per hour</strong> is a conservative, safe limit that prevents overwhelming your Eros instance.</p>
|
|
<p><strong>Why this matters:</strong></p>
|
|
<ul>
|
|
<li>Prevents API abuse and potential bans</li>
|
|
<li>Keeps your Eros instance responsive</li>
|
|
<li>Avoids overwhelming indexers through Eros</li>
|
|
<li>Maintains good neighbor policies with private trackers</li>
|
|
</ul>
|
|
<p><strong>Adjustment guidelines:</strong> Only increase if you have specific performance needs and understand the implications.</p>
|
|
|
|
<h2 id="filtering-options">Filtering Options</h2>
|
|
|
|
<h3 id="monitored-only"><i class="fas fa-eye" style="margin-right: 8px; color: #2ecc71;"></i>Monitored Only</h3>
|
|
<p><strong>What it does:</strong> Only process content that's marked as "monitored" in Eros.</p>
|
|
<p><strong>How it works:</strong> Eros allows you to add content to your library without monitoring it for downloads. This setting respects those choices.</p>
|
|
<p><strong>Recommendation:</strong> Keep enabled to respect your monitoring preferences in Eros.</p>
|
|
|
|
<h3 id="skip-future-releases"><i class="fas fa-calendar-plus" style="margin-right: 8px; color: #f39c12;"></i>Skip Future Releases</h3>
|
|
<p><strong>What it does:</strong> Skip content with release dates in the future.</p>
|
|
<p><strong>Why this helps:</strong> Prevents wasting searches on content that isn't available yet.</p>
|
|
<p><strong>Recommendation:</strong> Keep enabled to avoid searching for unreleased content.</p>
|
|
|
|
<h3 id="tag-processed"><i class="fas fa-tags" style="margin-right: 8px; color: #9b59b6;"></i>Tag Processed Items</h3>
|
|
<p><strong>What it does:</strong> Add a "huntarr-processed" tag to content that Huntarr has attempted to process.</p>
|
|
<p><strong>Benefits:</strong></p>
|
|
<ul>
|
|
<li>Track what Huntarr has worked on</li>
|
|
<li>Prevent duplicate processing</li>
|
|
<li>Useful for troubleshooting and statistics</li>
|
|
<li>Helps identify items that may need manual attention</li>
|
|
</ul>
|
|
<p><strong>Recommendation:</strong> Keep enabled for better tracking and troubleshooting.</p>
|
|
|
|
<h2 id="swaparr-integration">Swaparr Integration</h2>
|
|
|
|
<p>Enable Swaparr monitoring for this Eros 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 downloads</li>
|
|
<li>Your download queue gets clogged with failed items</li>
|
|
<li>You want hands-off automation</li>
|
|
<li>You use public trackers where quality varies</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 trackers with strict ratio requirements</li>
|
|
<li>You prefer manual control over your downloads</li>
|
|
<li>You have very slow internet where downloads take a long time</li>
|
|
</ul>
|
|
|
|
<h2 id="troubleshooting">Troubleshooting</h2>
|
|
|
|
<h3><i class="fas fa-exclamation-circle" style="margin-right: 8px; color: #e74c3c;"></i>Connection Issues</h3>
|
|
<p><strong>Can't connect to Eros:</strong></p>
|
|
<ol>
|
|
<li>Verify the URL is correct and Eros is accessible</li>
|
|
<li>Check that the API key is valid and correctly entered</li>
|
|
<li>Ensure Eros is running and not blocked by firewalls</li>
|
|
<li>Test the connection from the same network as Huntarr</li>
|
|
</ol>
|
|
|
|
<h3><i class="fas fa-ban" style="margin-right: 8px; color: #e74c3c;"></i>Search Issues</h3>
|
|
<p><strong>No content being found:</strong></p>
|
|
<ol>
|
|
<li>Check that content is properly monitored in Eros</li>
|
|
<li>Verify your indexers are working in Eros</li>
|
|
<li>Review the API cap settings - too low may limit searches</li>
|
|
<li>Check Huntarr logs for specific error messages</li>
|
|
</ol>
|
|
|
|
<h3><i class="fas fa-clock" style="margin-right: 8px; color: #f39c12;"></i>Performance Issues</h3>
|
|
<p><strong>Huntarr running slowly:</strong></p>
|
|
<ol>
|
|
<li>Increase sleep duration to reduce processing frequency</li>
|
|
<li>Lower API cap to reduce server load</li>
|
|
<li>Check system resources (CPU, RAM, disk space)</li>
|
|
<li>Review logs for any error patterns</li>
|
|
</ol>
|
|
|
|
<h2 id="best-practices">Best Practices</h2>
|
|
|
|
<h3><i class="fas fa-star" style="margin-right: 8px; color: #fbbf24;"></i>Recommended Settings for New Users</h3>
|
|
<ul>
|
|
<li><strong>Missing Search:</strong> Enabled (1)</li>
|
|
<li><strong>Upgrade Search:</strong> Disabled (0) until you understand the implications</li>
|
|
<li><strong>Sleep Duration:</strong> 900 seconds (15 minutes)</li>
|
|
<li><strong>API Cap:</strong> 20 requests per hour (safe and conservative)</li>
|
|
<li><strong>Monitored Only:</strong> Enabled</li>
|
|
<li><strong>Skip Future Releases:</strong> Enabled</li>
|
|
<li><strong>Tag Processed Items:</strong> Enabled</li>
|
|
</ul>
|
|
|
|
<h3><i class="fas fa-shield-alt" style="margin-right: 8px; color: #2ecc71;"></i>Safety Guidelines</h3>
|
|
<ul>
|
|
<li>Start with conservative settings and adjust gradually</li>
|
|
<li>Monitor your logs regularly, especially when starting</li>
|
|
<li>Keep API limits low to maintain good relationships with indexers</li>
|
|
<li>Test configuration changes during low-activity periods</li>
|
|
<li>Always have backups of your Eros configuration</li>
|
|
</ul>
|
|
|
|
<h3><i class="fas fa-users" style="margin-right: 8px; color: #8b5cf6;"></i>Community and Support</h3>
|
|
<ul>
|
|
<li>Join our <a href="https://discord.com/invite/PGJJjR5Cww" target="_blank">Discord community</a> for real-time help</li>
|
|
<li>Check the <a href="https://github.com/plexguide/Huntarr.io" target="_blank">GitHub repository</a> for issues and updates</li>
|
|
<li>Visit our <a href="https://www.reddit.com/r/huntarr/" target="_blank">Reddit community</a> for discussions</li>
|
|
<li>Review logs carefully before asking for help - they contain valuable troubleshooting information</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html> |