mirror of
https://github.com/plexguide/Huntarr.io.git
synced 2026-02-23 07:08:45 -06:00
refactor: simplify navigation by removing Getting Started section and updating settings links
This commit is contained in:
Admin9705
+74
-125
@@ -5,7 +5,6 @@
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>Huntarr.io Applications Documentation</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>
|
||||
@@ -16,19 +15,12 @@
|
||||
</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="../settings/index.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>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
@@ -55,140 +47,97 @@
|
||||
|
||||
<div class="main-content">
|
||||
<div class="container">
|
||||
<h1 id="page-title">Huntarr.io Applications</h1>
|
||||
<h1>Huntarr.io Applications</h1>
|
||||
|
||||
<p>Huntarr.io provides a unified interface to manage your media automation applications. Each application has its own dedicated documentation page with setup instructions, configuration options, and usage guides.</p>
|
||||
|
||||
<h2>Supported Applications</h2>
|
||||
|
||||
<div class="apps-grid">
|
||||
<div class="app-card sonarr-card">
|
||||
<div class="app-card-header">
|
||||
<div class="app-card-icon sonarr">
|
||||
<img src="../images/arrs/48-sonarr.png" alt="Sonarr Logo" width="48" height="48">
|
||||
</div>
|
||||
<h3 class="app-card-title">Sonarr</h3>
|
||||
</div>
|
||||
<div class="app-card-content">
|
||||
<p>Manage and automate TV show downloads.</p>
|
||||
</div>
|
||||
<div class="app-card-footer">
|
||||
<a href="sonarr.html">View Sonarr Documentation →</a>
|
||||
</div>
|
||||
<div class="app-card sonarr-card">
|
||||
<div class="app-card-header">
|
||||
<div class="app-card-icon sonarr">S</div>
|
||||
<h3 class="app-card-title">Sonarr</h3>
|
||||
</div>
|
||||
|
||||
<div class="app-card radarr-card">
|
||||
<div class="app-card-header">
|
||||
<div class="app-card-icon radarr">
|
||||
<img src="../images/arrs/48-radarr.png" alt="Radarr Logo" width="48" height="48">
|
||||
</div>
|
||||
<h3 class="app-card-title">Radarr</h3>
|
||||
</div>
|
||||
<div class="app-card-content">
|
||||
<p>Manage and automate movie downloads.</p>
|
||||
</div>
|
||||
<div class="app-card-footer">
|
||||
<a href="radarr.html">View Radarr Documentation →</a>
|
||||
</div>
|
||||
<div class="app-card-content">
|
||||
<p><strong>Purpose:</strong> Manage and automate TV show downloads.</p>
|
||||
<p><strong>Features:</strong> Calendar view, automatic searching, series management, quality profiles, and more.</p>
|
||||
</div>
|
||||
|
||||
<div class="app-card lidarr-card">
|
||||
<div class="app-card-header">
|
||||
<div class="app-card-icon lidarr">
|
||||
<img src="../images/arrs/48-lidarr.png" alt="Lidarr Logo" width="48" height="48">
|
||||
</div>
|
||||
<h3 class="app-card-title">Lidarr</h3>
|
||||
</div>
|
||||
<div class="app-card-content">
|
||||
<p>Manage and automate music downloads.</p>
|
||||
</div>
|
||||
<div class="app-card-footer">
|
||||
<a href="lidarr.html">View Lidarr Documentation →</a>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="app-card readarr-card">
|
||||
<div class="app-card-header">
|
||||
<div class="app-card-icon readarr">
|
||||
<img src="../images/arrs/48-readarr.png" alt="Readarr Logo" width="48" height="48">
|
||||
</div>
|
||||
<h3 class="app-card-title">Readarr</h3>
|
||||
</div>
|
||||
<div class="app-card-content">
|
||||
<p>Manage and automate book downloads.</p>
|
||||
</div>
|
||||
<div class="app-card-footer">
|
||||
<a href="readarr.html">View Readarr Documentation →</a>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="app-card whisparr-card">
|
||||
<div class="app-card-header">
|
||||
<div class="app-card-icon whisparr">
|
||||
<img src="../images/arrs/48-whisparr.png" alt="Whisparr Logo" width="48" height="48">
|
||||
</div>
|
||||
<h3 class="app-card-title">Whisparr V2</h3>
|
||||
</div>
|
||||
<div class="app-card-content">
|
||||
<p>Manage and automate adult content downloads.</p>
|
||||
</div>
|
||||
<div class="app-card-footer">
|
||||
<a href="whisparr.html">View Whisparr Documentation →</a>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="app-card whisparr-card">
|
||||
<div class="app-card-header">
|
||||
<div class="app-card-icon whisparr">
|
||||
<img src="../images/arrs/48-whisparr.png" alt="Whisparr V3 Logo" width="48" height="48">
|
||||
</div>
|
||||
<h3 class="app-card-title">Whisparr V3 (Eros)</h3>
|
||||
</div>
|
||||
<div class="app-card-content">
|
||||
<p>Newer version of Whisparr for managing adult content downloads.</p>
|
||||
</div>
|
||||
<div class="app-card-footer">
|
||||
<a href="eros.html">View Whisparr V3 Documentation →</a>
|
||||
</div>
|
||||
<div class="app-card-footer">
|
||||
<a href="sonarr.html">View Sonarr Documentation →</a>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="app-card radarr-card">
|
||||
<div class="app-card-header">
|
||||
<div class="app-card-icon radarr">R</div>
|
||||
<h3 class="app-card-title">Radarr</h3>
|
||||
</div>
|
||||
<div class="app-card-content">
|
||||
<p><strong>Purpose:</strong> Manage and automate movie downloads.</p>
|
||||
<p><strong>Features:</strong> Automatic searching, movie management, quality profiles, and more.</p>
|
||||
</div>
|
||||
<div class="app-card-footer">
|
||||
<a href="radarr.html">View Radarr Documentation →</a>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="app-card lidarr-card">
|
||||
<div class="app-card-header">
|
||||
<div class="app-card-icon lidarr">L</div>
|
||||
<h3 class="app-card-title">Lidarr</h3>
|
||||
</div>
|
||||
<div class="app-card-content">
|
||||
<p><strong>Purpose:</strong> Manage and automate music downloads.</p>
|
||||
<p><strong>Features:</strong> Artist management, album tracking, quality profiles, and more.</p>
|
||||
</div>
|
||||
<div class="app-card-footer">
|
||||
<a href="lidarr.html">View Lidarr Documentation →</a>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="app-card readarr-card">
|
||||
<div class="app-card-header">
|
||||
<div class="app-card-icon readarr">R</div>
|
||||
<h3 class="app-card-title">Readarr</h3>
|
||||
</div>
|
||||
<div class="app-card-content">
|
||||
<p><strong>Purpose:</strong> Manage and automate ebook and audiobook downloads.</p>
|
||||
<p><strong>Features:</strong> Author management, book tracking, quality profiles, and more.</p>
|
||||
</div>
|
||||
<div class="app-card-footer">
|
||||
<a href="readarr.html">View Readarr Documentation →</a>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="app-card whisparr-card">
|
||||
<div class="app-card-header">
|
||||
<div class="app-card-icon whisparr">W</div>
|
||||
<h3 class="app-card-title">Whisparr</h3>
|
||||
</div>
|
||||
<div class="app-card-content">
|
||||
<p><strong>Purpose:</strong> Manage and automate adult content downloads.</p>
|
||||
<p><strong>Features:</strong> Scene tracking, automatic searching, quality profiles, and more.</p>
|
||||
</div>
|
||||
<div class="app-card-footer">
|
||||
<a href="whisparr.html">View Whisparr Documentation →</a>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<h2>Adding (i) Links to Your Huntarr.io UI</h2>
|
||||
|
||||
<p>The information icon (<span class="info-link">i</span>) in the Huntarr.io user interface can be used to link directly to these documentation pages. When implementing the (i) links in your app's HTML, use the following format:</p>
|
||||
|
||||
<pre><code><a href="https://plexguide.github.io/Huntarr.io/apps/sonarr.html" class="info-link" target="_blank">i</a></code></pre>
|
||||
|
||||
<div class="section-nav">
|
||||
<a href="../index.html">← Back to Home</a>
|
||||
<a href="../settings/settings.html">Settings Documentation →</a>
|
||||
<a href="../settings/index.html">Settings Documentation →</a>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
Huntarr.io <span class="version-badge">v6.5.18</span> | Applications Documentation | Thanks 4 Using Huntarr - Admin9705
|
||||
</footer>
|
||||
|
||||
<a href="#page-title" class="back-to-top" id="back-to-top" title="Back to Top">
|
||||
<i class="fas fa-arrow-up"></i>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<script>
|
||||
// Show/hide back-to-top button based on scroll position
|
||||
window.addEventListener('scroll', function() {
|
||||
var backToTopButton = document.getElementById('back-to-top');
|
||||
if (window.pageYOffset > 300) {
|
||||
backToTopButton.classList.add('visible');
|
||||
} else {
|
||||
backToTopButton.classList.remove('visible');
|
||||
}
|
||||
});
|
||||
|
||||
// Add smooth scrolling for back-to-top button
|
||||
document.getElementById('back-to-top').addEventListener('click', function(e) {
|
||||
e.preventDefault();
|
||||
var targetId = this.getAttribute('href');
|
||||
var targetElement = document.querySelector(targetId);
|
||||
window.scrollTo({
|
||||
top: targetElement.offsetTop - 20,
|
||||
behavior: 'smooth'
|
||||
});
|
||||
});
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -15,13 +15,6 @@
|
||||
</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>
|
||||
|
||||
+15
-160
@@ -414,53 +414,29 @@ a:hover {
|
||||
}
|
||||
|
||||
code {
|
||||
background-color: rgba(30, 35, 45, 0.8);
|
||||
padding: 4px 6px;
|
||||
background-color: rgba(10, 15, 25, 0.6);
|
||||
padding: 2px 6px;
|
||||
border-radius: 3px;
|
||||
border: 1px solid var(--border-color);
|
||||
font-family: 'Courier New', monospace;
|
||||
font-size: 1em;
|
||||
color: #ffffff;
|
||||
font-size: 0.9em;
|
||||
color: #f8f8f8;
|
||||
}
|
||||
|
||||
pre {
|
||||
background-color: var(--card-bg);
|
||||
padding: 20px;
|
||||
border-radius: 8px;
|
||||
background-color: rgba(10, 15, 25, 0.6);
|
||||
padding: 15px;
|
||||
border-radius: 5px;
|
||||
border: 1px solid var(--border-color);
|
||||
border-left: 4px solid var(--highlight-color);
|
||||
overflow-x: auto;
|
||||
color: #ffffff;
|
||||
color: #f8f8f8;
|
||||
position: relative;
|
||||
margin: 20px 0 30px 0;
|
||||
line-height: 1.5;
|
||||
box-shadow: 0 2px 4px rgba(0, 0, 0, 0.3);
|
||||
}
|
||||
|
||||
/* Special styling for terminal command blocks */
|
||||
pre.terminal {
|
||||
border-left: 4px solid var(--highlight-color);
|
||||
}
|
||||
|
||||
pre.terminal code {
|
||||
color: #ffffff; /* White text for better readability */
|
||||
}
|
||||
|
||||
/* Add this class to any code block that shows terminal commands */
|
||||
.command-prompt::before {
|
||||
content: '$ ';
|
||||
color: #999;
|
||||
user-select: none;
|
||||
}
|
||||
|
||||
pre code {
|
||||
background-color: transparent;
|
||||
border: none;
|
||||
padding: 0;
|
||||
display: block;
|
||||
width: 100%;
|
||||
white-space: pre-wrap;
|
||||
word-break: break-word;
|
||||
}
|
||||
|
||||
.copy-button {
|
||||
@@ -468,19 +444,16 @@ pre code {
|
||||
right: 10px;
|
||||
top: 10px;
|
||||
padding: 5px 10px;
|
||||
background-color: rgba(255, 255, 255, 0.9);
|
||||
border: 1px solid #ccc;
|
||||
background-color: rgba(255, 255, 255, 0.1);
|
||||
border: 1px solid var(--border-color);
|
||||
border-radius: 3px;
|
||||
cursor: pointer;
|
||||
color: #000;
|
||||
color: var(--text-color);
|
||||
font-size: 0.8rem;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
.copy-button:hover {
|
||||
background-color: rgba(52, 152, 219, 0.5);
|
||||
transform: translateY(-2px);
|
||||
box-shadow: 0 2px 5px rgba(0, 0, 0, 0.2);
|
||||
background-color: rgba(255, 255, 255, 0.2);
|
||||
}
|
||||
|
||||
img {
|
||||
@@ -592,121 +565,6 @@ footer {
|
||||
margin-left: 10px;
|
||||
}
|
||||
|
||||
/* Table of Contents styles */
|
||||
.toc {
|
||||
background-color: var(--card-bg);
|
||||
border-radius: 8px;
|
||||
padding: 20px;
|
||||
margin: 20px 0 30px 0;
|
||||
border-left: 4px solid var(--highlight-color);
|
||||
}
|
||||
|
||||
.toc h3 {
|
||||
margin-top: 0;
|
||||
padding-bottom: 10px;
|
||||
border-bottom: 1px solid var(--border-color);
|
||||
}
|
||||
|
||||
.toc ul {
|
||||
margin: 0;
|
||||
padding-left: 20px;
|
||||
}
|
||||
|
||||
.toc li {
|
||||
margin-bottom: 8px;
|
||||
}
|
||||
|
||||
.toc a {
|
||||
text-decoration: none;
|
||||
color: var(--text-color);
|
||||
display: block;
|
||||
padding: 5px 0;
|
||||
transition: color 0.2s;
|
||||
}
|
||||
|
||||
.toc a:hover {
|
||||
color: var(--highlight-color);
|
||||
}
|
||||
|
||||
/* Back to top button */
|
||||
.back-to-top {
|
||||
position: fixed;
|
||||
bottom: 30px;
|
||||
right: 30px;
|
||||
width: 40px;
|
||||
height: 40px;
|
||||
background-color: var(--highlight-color);
|
||||
border-radius: 50%;
|
||||
color: white;
|
||||
display: flex;
|
||||
align-items: center;
|
||||
justify-content: center;
|
||||
text-decoration: none;
|
||||
box-shadow: 0 2px 5px rgba(0, 0, 0, 0.3);
|
||||
opacity: 0; /* Start hidden */
|
||||
transition: opacity 0.3s, transform 0.3s;
|
||||
transform: translateY(20px);
|
||||
z-index: 1000;
|
||||
}
|
||||
|
||||
/* Settings Page Styles */
|
||||
.setting-item {
|
||||
margin: 30px 0;
|
||||
background-color: var(--secondary-bg);
|
||||
padding: 20px;
|
||||
border-radius: 4px;
|
||||
}
|
||||
|
||||
.setting-item h3 {
|
||||
color: var(--highlight-color);
|
||||
font-size: 1.4em;
|
||||
padding-bottom: 5px;
|
||||
border-bottom: 1px solid var(--border-color);
|
||||
display: flex;
|
||||
align-items: center;
|
||||
}
|
||||
|
||||
.info-icon {
|
||||
color: var(--highlight-color);
|
||||
margin-right: 10px;
|
||||
font-size: 0.8em;
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
.setting-item h4 {
|
||||
color: var(--sonarr-color);
|
||||
font-size: 1.2em;
|
||||
margin-top: 20px;
|
||||
margin-bottom: 10px;
|
||||
}
|
||||
|
||||
.state-time {
|
||||
color: var(--highlight-color);
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
/* Highlight effect when anchor links are clicked */
|
||||
.highlight {
|
||||
animation: highlight-pulse 2s;
|
||||
}
|
||||
|
||||
@keyframes highlight-pulse {
|
||||
0% { background-color: var(--card-bg); }
|
||||
25% { background-color: rgba(52, 152, 219, 0.2); }
|
||||
50% { background-color: rgba(52, 152, 219, 0.1); }
|
||||
100% { background-color: var(--card-bg); }
|
||||
}
|
||||
|
||||
.back-to-top.visible {
|
||||
opacity: 1;
|
||||
transform: translateY(0);
|
||||
}
|
||||
|
||||
.back-to-top:hover {
|
||||
background-color: #217dbb;
|
||||
transform: translateY(-5px);
|
||||
}
|
||||
|
||||
/* Card style for app blocks */
|
||||
/* App Cards Grid Container */
|
||||
.apps-grid {
|
||||
@@ -733,10 +591,9 @@ footer {
|
||||
}
|
||||
|
||||
.app-card-header {
|
||||
padding: 12px;
|
||||
padding: 15px;
|
||||
display: flex;
|
||||
align-items: center;
|
||||
border-bottom: 1px solid rgba(255, 255, 255, 0.1);
|
||||
}
|
||||
|
||||
.app-card-icon {
|
||||
@@ -787,16 +644,14 @@ footer {
|
||||
}
|
||||
|
||||
.app-card-content {
|
||||
padding: 12px;
|
||||
padding: 15px;
|
||||
flex: 1;
|
||||
font-size: 0.9em;
|
||||
}
|
||||
|
||||
.app-card-footer {
|
||||
padding: 8px 12px;
|
||||
padding: 10px 15px;
|
||||
background-color: rgba(10, 15, 25, 0.3);
|
||||
text-align: right;
|
||||
font-size: 0.9em;
|
||||
}
|
||||
|
||||
/* Card styled for sonarr */
|
||||
|
||||
@@ -15,19 +15,12 @@
|
||||
</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><a href="../apps/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="../settings/index.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>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
|
||||
@@ -15,19 +15,21 @@
|
||||
</div>
|
||||
|
||||
<nav class="sidebar-nav">
|
||||
<div class="sidebar-section">
|
||||
<h3 class="sidebar-section-title">Getting Started</h3>
|
||||
<ul>
|
||||
<li class="active"><a href="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><a href="../apps/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="../settings/index.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>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="sidebar-section">
|
||||
<h3 class="sidebar-section-title">Getting Started</h3>
|
||||
<ul>
|
||||
<li class="active"><a href="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>
|
||||
<li><a href="quick-setup.html"><svg class="svg-icon" viewBox="0 0 24 24" fill="currentColor"><path d="M12 3v10.55c-.59-.34-1.27-.55-2-.55-2.21 0-4 1.79-4 4s1.79 4 4 4 4-1.79 4-4V7h4V3h-6z"></path></svg> Quick Setup</a></li>
|
||||
<li><a href="configuration.html"><svg class="svg-icon" viewBox="0 0 24 24" fill="currentColor"><path d="M3 17.25V21h3.75L17.81 9.94l-3.75-3.75L3 17.25zM20.71 7.04c.39-.39.39-1.02 0-1.41l-2.34-2.34c-.39-.39-1.02-.39-1.41 0l-1.83 1.83 3.75 3.75 1.83-1.83z"></path></svg> Configuration</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
@@ -49,196 +51,244 @@
|
||||
<p>This guide will walk you through the installation process for Huntarr.io. Huntarr.io can be installed in several ways depending on your preference and system configuration.</p>
|
||||
</section>
|
||||
|
||||
<section id="toc" class="toc">
|
||||
<h3>Table of Contents</h3>
|
||||
<ul>
|
||||
<li><a href="#installation-methods">Installation Methods</a>
|
||||
<ul>
|
||||
<li><a href="#docker-installation">Docker Installation</a></li>
|
||||
<li><a href="#unraid-installation">Unraid Installation</a></li>
|
||||
<li><a href="#macos-installation">macOS Installation</a></li>
|
||||
<li><a href="#alternative-methods">Alternative Installation Methods</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="#post-installation">Post Installation</a></li>
|
||||
<li><a href="#troubleshooting">Troubleshooting</a></li>
|
||||
</ul>
|
||||
<section class="system-requirements">
|
||||
<h2>System Requirements</h2>
|
||||
<p>Before installing Huntarr.io, ensure your system meets the following requirements:</p>
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<th>Component</th>
|
||||
<th>Minimum</th>
|
||||
<th>Recommended</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>CPU</td>
|
||||
<td>2 cores</td>
|
||||
<td>4+ cores</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Memory</td>
|
||||
<td>2GB RAM</td>
|
||||
<td>4GB+ RAM</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Storage</td>
|
||||
<td>20GB available space</td>
|
||||
<td>50GB+ available space</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Operating System</td>
|
||||
<td>Linux (Ubuntu 18.04+, Debian 10+)<br>Windows 10+<br>macOS 10.15+</td>
|
||||
<td>Linux (Ubuntu 20.04+, Debian 11+)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Docker</td>
|
||||
<td>Docker 19.03+ and Docker Compose 1.27+</td>
|
||||
<td>Latest Docker and Docker Compose versions</td>
|
||||
</tr>
|
||||
</table>
|
||||
</section>
|
||||
|
||||
<section id="installation-methods" class="installation-methods">
|
||||
<section class="installation-methods">
|
||||
<h2>Installation Methods</h2>
|
||||
<p>Choose the installation method that best suits your environment:</p>
|
||||
|
||||
<div id="docker">
|
||||
<h3 id="docker-installation">Docker Installation</h3>
|
||||
<p>The recommended way to install Huntarr.io is using Docker. This method ensures that all dependencies are correctly installed and configured.</p>
|
||||
|
||||
<h4>Prerequisites</h4>
|
||||
<ul>
|
||||
<li>Docker (1.27 or newer)</li>
|
||||
</ul>
|
||||
|
||||
<h4>Docker Run Method</h4>
|
||||
<p>The simplest way to run Huntarr is via Docker (all configuration is done via the web UI):</p>
|
||||
|
||||
<h5>Option 1: DockerHub</h5>
|
||||
<pre class="terminal"><code>docker run -d --name huntarr \
|
||||
--restart always \
|
||||
-p 9705:9705 \
|
||||
-v /your-path/huntarr:/config \
|
||||
-e TZ=America/New_York \
|
||||
huntarr/huntarr:latest</code></pre>
|
||||
|
||||
<h5>Option 2: GitHub Container Registry</h5>
|
||||
<pre class="terminal"><code>docker run -d --name huntarr \
|
||||
--restart always \
|
||||
-p 9705:9705 \
|
||||
-v /your-path/huntarr:/config \
|
||||
-e TZ=America/New_York \
|
||||
ghcr.io/plexguide/huntarr:latest</code></pre>
|
||||
|
||||
<p>To check on the status of the program:</p>
|
||||
<pre class="terminal"><code class="command-prompt">docker logs huntarr</code></pre>
|
||||
|
||||
<h4>Docker Compose Method</h4>
|
||||
<p>For those who prefer Docker Compose, add this to your <code>docker-compose.yml</code> file:</p>
|
||||
|
||||
<h5>Option 1: DockerHub</h5>
|
||||
<pre class="terminal"><code>services:
|
||||
huntarr:
|
||||
image: huntarr/huntarr:latest
|
||||
container_name: huntarr
|
||||
restart: always
|
||||
ports:
|
||||
- "9705:9705"
|
||||
volumes:
|
||||
- /your-path/huntarr:/config
|
||||
environment:
|
||||
- TZ=America/New_York</code></pre>
|
||||
|
||||
<h5>Option 2: GitHub Container Registry</h5>
|
||||
<pre class="terminal"><code>services:
|
||||
huntarr:
|
||||
image: ghcr.io/plexguide/huntarr:latest
|
||||
container_name: huntarr
|
||||
restart: always
|
||||
ports:
|
||||
- "9705:9705"
|
||||
volumes:
|
||||
- /your-path/huntarr:/config
|
||||
environment:
|
||||
- TZ=America/New_York</code></pre>
|
||||
|
||||
<p>Then run:</p>
|
||||
<pre class="terminal"><code class="command-prompt">docker-compose up -d huntarr</code></pre>
|
||||
</div>
|
||||
|
||||
<div id="unraid">
|
||||
<h3 id="unraid-installation">Unraid Installation</h3>
|
||||
<p>You can install Huntarr using the Unraid App Store.</p>
|
||||
<p>If not, you can run this from Command Line in Unraid:</p>
|
||||
|
||||
<h5>Option 1: DockerHub</h5>
|
||||
<pre class="terminal"><code>docker run -d --name huntarr \
|
||||
--restart always \
|
||||
-p 9705:9705 \
|
||||
-v /mnt/user/appdata/huntarr:/config \
|
||||
-e TZ=America/New_York \
|
||||
huntarr/huntarr:latest</code></pre>
|
||||
|
||||
<h5>Option 2: GitHub Container Registry</h5>
|
||||
<pre class="terminal"><code>docker run -d --name huntarr \
|
||||
--restart always \
|
||||
-p 9705:9705 \
|
||||
-v /mnt/user/appdata/huntarr:/config \
|
||||
-e TZ=America/New_York \
|
||||
ghcr.io/plexguide/huntarr:latest</code></pre>
|
||||
</div>
|
||||
|
||||
<div id="macos">
|
||||
<h3 id="macos-installation">macOS Installation</h3>
|
||||
<p>Huntarr.io provides native macOS installers for both Intel and Apple Silicon Macs.</p>
|
||||
|
||||
<h4>Two Types of macOS Installers</h4>
|
||||
<ul>
|
||||
<li><strong>Intel (x86_64)</strong> - For Intel-based Macs</li>
|
||||
<li><strong>ARM (arm64)</strong> - For Apple Silicon Macs (M1, M2, etc.)</li>
|
||||
</ul>
|
||||
|
||||
<h4>Installation Steps</h4>
|
||||
<ol>
|
||||
<li>Download the appropriate installer package (.pkg) for your Mac from the <a href="https://github.com/plexguide/Huntarr.io/releases" target="_blank">GitHub Releases</a> page.</li>
|
||||
<li>Double-click the downloaded .pkg file to start the installation process.</li>
|
||||
<li>When you first try to open the package, you may see a security warning. This is expected as the app isn't signed by Apple.</li>
|
||||
<li>To proceed with installation, go to System Settings → Privacy & Security, scroll down to the security section, and click "Open Anyway" as shown below:</li>
|
||||
</ol>
|
||||
|
||||
<div class="screenshot" style="text-align: center;">
|
||||
<img src="../images/mac-os-warning.jpg" alt="macOS Security Warning" style="max-width: 50%; border: 1px solid #333; border-radius: 5px;">
|
||||
<p class="caption">The "Open Anyway" button allows you to proceed with installation despite macOS security warnings</p>
|
||||
<div class="method-tabs">
|
||||
<div class="tab-buttons">
|
||||
<button class="tab-button active" data-tab="docker">Docker (Recommended)</button>
|
||||
<button class="tab-button" data-tab="script">Installation Script</button>
|
||||
<button class="tab-button" data-tab="manual">Manual Installation</button>
|
||||
</div>
|
||||
|
||||
<h4>Configuration</h4>
|
||||
<p>When first launched, Huntarr.io will create the necessary configuration directories in your user folder:</p>
|
||||
<pre><code>~/Library/Application Support/Huntarr/config/</code></pre>
|
||||
|
||||
<h4>Notes about macOS Version</h4>
|
||||
<ul>
|
||||
<li>The macOS version is provided as a convenience for users who prefer native applications</li>
|
||||
<li>The Docker version remains the primary supported deployment method</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div id="alternative">
|
||||
<h3 id="alternative-methods">Alternative Installation Methods</h3>
|
||||
<p>Although Docker and the native macOS installers are the recommended methods, there are additional ways to install and run Huntarr.</p>
|
||||
|
||||
<div class="alert alert-warning">
|
||||
<strong>Note:</strong> These methods are provided for advanced users and development purposes only. For most users, we recommend the Docker installation or macOS installer.
|
||||
<div class="tab-content">
|
||||
<div class="tab-pane active" id="docker">
|
||||
<h3>Docker Installation</h3>
|
||||
<p>The recommended way to install Huntarr.io is using Docker and Docker Compose. This method ensures that all dependencies are correctly installed and configured.</p>
|
||||
|
||||
<h4>Prerequisites</h4>
|
||||
<ul>
|
||||
<li>Docker (19.03 or newer)</li>
|
||||
<li>Docker Compose (1.27 or newer)</li>
|
||||
</ul>
|
||||
|
||||
<h4>Steps</h4>
|
||||
<ol>
|
||||
<li>Clone the repository:
|
||||
<pre><code>git clone https://github.com/plexguide/Huntarr.io.git</code></pre>
|
||||
</li>
|
||||
<li>Navigate to the directory:
|
||||
<pre><code>cd Huntarr.io</code></pre>
|
||||
</li>
|
||||
<li>Run the Docker Compose command:
|
||||
<pre><code>docker-compose up -d</code></pre>
|
||||
</li>
|
||||
<li>Access Huntarr.io through your browser:
|
||||
<pre><code>http://localhost:7575</code></pre>
|
||||
</li>
|
||||
</ol>
|
||||
|
||||
<h4>Docker Compose Configuration</h4>
|
||||
<p>The default docker-compose.yml file includes all necessary components, but you can customize it according to your needs. Here's a sample configuration:</p>
|
||||
|
||||
<pre><code>version: '3'
|
||||
services:
|
||||
huntarr:
|
||||
image: plexguide/huntarr:latest
|
||||
container_name: huntarr
|
||||
ports:
|
||||
- 7575:7575
|
||||
volumes:
|
||||
- ./config:/config
|
||||
- /path/to/media:/media
|
||||
- /path/to/downloads:/downloads
|
||||
environment:
|
||||
- PUID=1000
|
||||
- PGID=1000
|
||||
- TZ=UTC
|
||||
restart: unless-stopped</code></pre>
|
||||
</div>
|
||||
|
||||
<div class="tab-pane" id="script">
|
||||
<h3>Installation Script</h3>
|
||||
<p>For Linux systems, we provide a convenient installation script that automates the setup process.</p>
|
||||
|
||||
<h4>Supported Distributions</h4>
|
||||
<ul>
|
||||
<li>Ubuntu 18.04, 20.04, 22.04</li>
|
||||
<li>Debian 10, 11</li>
|
||||
<li>CentOS 8, Stream</li>
|
||||
<li>Fedora 34+</li>
|
||||
</ul>
|
||||
|
||||
<h4>One-line Installation</h4>
|
||||
<p>Run the following command to install Huntarr.io:</p>
|
||||
<pre><code>curl -sSL https://install.huntarr.io | bash</code></pre>
|
||||
|
||||
<h4>Advanced Options</h4>
|
||||
<p>For more control over the installation process, you can use these flags:</p>
|
||||
<pre><code>curl -sSL https://install.huntarr.io | bash -s -- --prefix /opt/huntarr --port 8080</code></pre>
|
||||
|
||||
<p>Available options:</p>
|
||||
<ul>
|
||||
<li><code>--prefix</code>: Installation directory (default: /opt/huntarr)</li>
|
||||
<li><code>--port</code>: Web interface port (default: 7575)</li>
|
||||
<li><code>--no-docker</code>: Install without Docker (native installation)</li>
|
||||
<li><code>--no-deps</code>: Skip dependency installation</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="tab-pane" id="manual">
|
||||
<h3>Manual Installation</h3>
|
||||
<p>If you prefer to install Huntarr.io manually, follow these steps based on your operating system.</p>
|
||||
|
||||
<h4>Linux (Ubuntu/Debian)</h4>
|
||||
<ol>
|
||||
<li>Install dependencies:
|
||||
<pre><code>sudo apt update
|
||||
sudo apt install -y nodejs npm git</code></pre>
|
||||
</li>
|
||||
<li>Clone the repository:
|
||||
<pre><code>git clone https://github.com/plexguide/Huntarr.io.git</code></pre>
|
||||
</li>
|
||||
<li>Navigate to the directory:
|
||||
<pre><code>cd Huntarr.io</code></pre>
|
||||
</li>
|
||||
<li>Install npm dependencies:
|
||||
<pre><code>npm install</code></pre>
|
||||
</li>
|
||||
<li>Start the application:
|
||||
<pre><code>npm start</code></pre>
|
||||
</li>
|
||||
</ol>
|
||||
|
||||
<h4>Windows</h4>
|
||||
<ol>
|
||||
<li>Install <a href="https://nodejs.org/" target="_blank">Node.js</a></li>
|
||||
<li>Install <a href="https://git-scm.com/download/win" target="_blank">Git for Windows</a></li>
|
||||
<li>Open Command Prompt or PowerShell</li>
|
||||
<li>Clone the repository:
|
||||
<pre><code>git clone https://github.com/plexguide/Huntarr.io.git</code></pre>
|
||||
</li>
|
||||
<li>Navigate to the directory:
|
||||
<pre><code>cd Huntarr.io</code></pre>
|
||||
</li>
|
||||
<li>Install npm dependencies:
|
||||
<pre><code>npm install</code></pre>
|
||||
</li>
|
||||
<li>Start the application:
|
||||
<pre><code>npm start</code></pre>
|
||||
</li>
|
||||
</ol>
|
||||
|
||||
<h4>macOS</h4>
|
||||
<ol>
|
||||
<li>Install <a href="https://brew.sh/" target="_blank">Homebrew</a> if you don't have it yet:
|
||||
<pre><code>/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"</code></pre>
|
||||
</li>
|
||||
<li>Install Node.js and Git:
|
||||
<pre><code>brew install node git</code></pre>
|
||||
</li>
|
||||
<li>Clone the repository:
|
||||
<pre><code>git clone https://github.com/plexguide/Huntarr.io.git</code></pre>
|
||||
</li>
|
||||
<li>Navigate to the directory:
|
||||
<pre><code>cd Huntarr.io</code></pre>
|
||||
</li>
|
||||
<li>Install npm dependencies:
|
||||
<pre><code>npm install</code></pre>
|
||||
</li>
|
||||
<li>Start the application:
|
||||
<pre><code>npm start</code></pre>
|
||||
</li>
|
||||
</ol>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<h4>From Source (Advanced)</h4>
|
||||
<p>If you're familiar with Python and want to run Huntarr from source:</p>
|
||||
|
||||
<ol>
|
||||
<li>Ensure you have Python 3.9+ and Git installed on your system</li>
|
||||
<li>Clone the repository:
|
||||
<pre class="terminal"><code class="command-prompt">git clone https://github.com/plexguide/Huntarr.io.git</code></pre>
|
||||
</li>
|
||||
<li>Navigate to the directory:
|
||||
<pre class="terminal"><code class="command-prompt">cd Huntarr.io</code></pre>
|
||||
</li>
|
||||
<li>Install Python dependencies:
|
||||
<pre class="terminal"><code class="command-prompt">pip install -r requirements.txt</code></pre>
|
||||
</li>
|
||||
<li>Run the application:
|
||||
<pre class="terminal"><code class="command-prompt">python run.py</code></pre>
|
||||
</li>
|
||||
</ol>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<section id="post-installation" class="post-installation">
|
||||
<section class="post-installation">
|
||||
<h2>Post Installation</h2>
|
||||
|
||||
<h3>Initial Setup</h3>
|
||||
<p>After installing Huntarr.io, you'll need to complete the initial setup:</p>
|
||||
<ol>
|
||||
<li>Access the web interface (default: <code>http://localhost:9705</code>)</li>
|
||||
<li>Access the web interface (default: <code>http://localhost:7575</code>)</li>
|
||||
<li>Create an administrator account when prompted</li>
|
||||
<li>Follow the setup wizard to configure your media paths and integrate with media applications (Sonarr, Radarr, etc.)</li>
|
||||
</ol>
|
||||
|
||||
<h3>Updating Huntarr.io</h3>
|
||||
<p>To update Huntarr.io to the latest version:</p>
|
||||
|
||||
<h4>Docker Installation</h4>
|
||||
<pre><code>cd /path/to/Huntarr.io
|
||||
git pull
|
||||
docker-compose pull
|
||||
docker-compose up -d</code></pre>
|
||||
|
||||
<h4>Manual Installation</h4>
|
||||
<pre><code>cd /path/to/Huntarr.io
|
||||
git pull
|
||||
npm install
|
||||
npm restart</code></pre>
|
||||
</section>
|
||||
|
||||
<section id="troubleshooting" class="troubleshooting">
|
||||
<section class="troubleshooting">
|
||||
<h2>Troubleshooting</h2>
|
||||
|
||||
<h3>Common Issues</h3>
|
||||
|
||||
<div class="issue-card">
|
||||
<h4>Port already in use</h4>
|
||||
<p>If port 9705 is already in use, you can change it in the docker-compose.yml file or use the <code>--port</code> option in the installation script.</p>
|
||||
<p>If port 7575 is already in use, you can change it in the docker-compose.yml file or use the <code>--port</code> option in the installation script.</p>
|
||||
</div>
|
||||
|
||||
<div class="issue-card">
|
||||
<h4>Permission issues</h4>
|
||||
<p>If you encounter permission issues, make sure the PUID and PGID environment variables in docker-compose.yml match your user's UID and GID.</p>
|
||||
<pre><code># Find your user ID and group ID
|
||||
id $(whoami)</code></pre>
|
||||
</div>
|
||||
|
||||
<div class="issue-card">
|
||||
<h4>Connectivity problems</h4>
|
||||
@@ -259,37 +309,6 @@
|
||||
<footer>
|
||||
Huntarr.io <span class="version-badge">v6.5.18</span> | Installation Guide | Thanks 4 Using Huntarr - Admin9705
|
||||
</footer>
|
||||
|
||||
<a href="#toc" class="back-to-top" id="back-to-top" title="Back to Top">
|
||||
<svg width="24" height="24" viewBox="0 0 24 24" fill="currentColor">
|
||||
<path d="M7.41 15.41L12 10.83l4.59 4.58L18 14l-6-6-6 6z"></path>
|
||||
</svg>
|
||||
</a>
|
||||
|
||||
<script>
|
||||
// Show/hide back-to-top button based on scroll position
|
||||
window.addEventListener('scroll', function() {
|
||||
var backToTopButton = document.getElementById('back-to-top');
|
||||
if (window.pageYOffset > 300) {
|
||||
backToTopButton.classList.add('visible');
|
||||
} else {
|
||||
backToTopButton.classList.remove('visible');
|
||||
}
|
||||
});
|
||||
|
||||
// Smooth scroll to the target when clicking on table of contents links
|
||||
document.querySelectorAll('.toc a').forEach(function(anchor) {
|
||||
anchor.addEventListener('click', function(e) {
|
||||
e.preventDefault();
|
||||
var targetId = this.getAttribute('href');
|
||||
var targetElement = document.querySelector(targetId);
|
||||
window.scrollTo({
|
||||
top: targetElement.offsetTop - 20,
|
||||
behavior: 'smooth'
|
||||
});
|
||||
});
|
||||
});
|
||||
</script>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
+1
-8
@@ -15,19 +15,12 @@
|
||||
</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 class="active"><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><a href="apps/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="settings/index.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>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
|
||||
@@ -1,269 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>General Settings - Huntarr.io Documentation</title>
|
||||
<link rel="stylesheet" href="../css/main.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><a href="../apps/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 class="active"><a href="index.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>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="sidebar-section">
|
||||
<h3 class="sidebar-section-title">Settings</h3>
|
||||
<ul>
|
||||
<li class="active"><a href="general.html"><svg class="svg-icon" viewBox="0 0 24 24" fill="currentColor"><path d="M12 2C6.48 2 2 6.48 2 12s4.48 10 10 10 10-4.48 10-10S17.52 2 12 2zm0 18c-4.41 0-8-3.59-8-8s3.59-8 8-8 8 3.59 8 8-3.59 8-8 8zm.31-8.86c-1.77-.45-2.34-.94-2.34-1.67 0-.84.79-1.43 2.1-1.43 1.38 0 1.9.66 1.94 1.64h1.71c-.05-1.34-.87-2.57-2.49-2.97V5H10.9v1.69c-1.51.32-2.72 1.3-2.72 2.81 0 1.79 1.49 2.69 3.66 3.21 1.95.46 2.34 1.15 2.34 1.87 0 .53-.39 1.39-2.1 1.39-1.6 0-2.23-.72-2.32-1.64H8.04c.1 1.7 1.36 2.66 2.86 2.97V19h2.34v-1.67c1.52-.29 2.72-1.16 2.73-2.77-.01-2.2-1.9-2.96-3.66-3.42z"></path></svg> General</a></li>
|
||||
<li><a href="network.html"><svg class="svg-icon" viewBox="0 0 24 24" fill="currentColor"><path d="M12 2C6.48 2 2 6.48 2 12s4.48 10 10 10 10-4.48 10-10S17.52 2 12 2zm-1 17.93c-3.95-.49-7-3.85-7-7.93 0-.62.08-1.21.21-1.79L9 15v1c0 1.1.9 2 2 2v1.93zm6.9-2.54c-.26-.81-1-1.39-1.9-1.39h-1v-3c0-.55-.45-1-1-1H8v-2h2c.55 0 1-.45 1-1V7h2c1.1 0 2-.9 2-2v-.41c2.93 1.19 5 4.06 5 7.41 0 2.08-.8 3.97-2.1 5.39z"></path></svg> Network</a></li>
|
||||
<li><a href="storage.html"><svg class="svg-icon" viewBox="0 0 24 24" fill="currentColor"><path d="M2 20h20v-4H2v4zm2-3h2v2H4v-2zM2 4v4h20V4H2zm4 3H4V5h2v2zm-4 7h20v-4H2v4zm2-3h2v2H4v-2z"></path></svg> Storage</a></li>
|
||||
<li><a href="security.html"><svg class="svg-icon" viewBox="0 0 24 24" fill="currentColor"><path d="M12 1L3 5v6c0 5.55 3.84 10.74 9 12 5.16-1.26 9-6.45 9-12V5l-9-4zm0 10.99h7c-.53 4.12-3.28 7.79-7 8.94V12H5V6.3l7-3.11v8.8z"></path></svg> Security</a></li>
|
||||
<li><a href="integration.html"><svg class="svg-icon" viewBox="0 0 24 24" fill="currentColor"><path d="M3.9 12c0-1.71 1.39-3.1 3.1-3.1h4V7H7c-2.76 0-5 2.24-5 5s2.24 5 5 5h4v-1.9H7c-1.71 0-3.1-1.39-3.1-3.1zM8 13h8v-2H8v2zm9-6h-4v1.9h4c1.71 0 3.1 1.39 3.1 3.1s-1.39 3.1-3.1 3.1h-4V17h4c2.76 0 5-2.24 5-5s-2.24-5-5-5z"></path></svg> Integration</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://plexguide.github.io/Huntarr.io/" target="_blank"><svg class="svg-icon" viewBox="0 0 24 24" fill="currentColor"><path d="M12 2c5.514 0 10 4.486 10 10s-4.486 10-10 10-10-4.486-10-10 4.486-10 10-10zm0-2c-6.627 0-12 5.373-12 12s5.373 12 12 12 12-5.373 12-12-5.373-12-12-12zm-2.033 16.01c.564-1.789 1.632-3.932 1.821-4.474.273-.787-.211-1.136-1.74.209l-.34-.64c1.744-1.897 5.335-2.326 4.113.613-.763 1.835-1.309 3.074-1.621 4.03-.455 1.393.694.828 1.819-.211.153.25.203.331.356.619-2.498 2.378-5.271 2.588-4.408-.146zm4.742-8.169c-.532.453-1.32.443-1.761-.022-.441-.465-.367-1.208.164-1.661.532-.453 1.32-.442 1.761.022.439.466.367 1.209-.164 1.661z"></path></svg> Website</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</nav>
|
||||
</div>
|
||||
|
||||
<div class="main-content">
|
||||
<div class="container">
|
||||
<h1>System Settings</h1>
|
||||
|
||||
<p>This page contains all settings for customizing your Huntarr.io instance. Each setting has been documented with explanations suitable for both beginners and advanced users.</p>
|
||||
|
||||
<div class="toc">
|
||||
<h3>Table of Contents</h3>
|
||||
<ul>
|
||||
<li><a href="#system-settings">System Settings</a>
|
||||
<ul>
|
||||
<li><a href="#check-for-updates">Check for Updates</a></li>
|
||||
<li><a href="#debug-mode">Debug Mode</a></li>
|
||||
<li><a href="#display-resources">Display Resources</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="#stateful-management">Stateful Management</a>
|
||||
<ul>
|
||||
<li><a href="#emergency-reset">Emergency Reset</a></li>
|
||||
<li><a href="#state-reset-hours">State Reset (Hours)</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="#security">Security</a>
|
||||
<ul>
|
||||
<li><a href="#authentication-mode">Authentication Mode</a></li>
|
||||
<li><a href="#enable-ssl-verify">Enable SSL Verify</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="#advanced-settings">Advanced Settings</a>
|
||||
<ul>
|
||||
<li><a href="#api-timeout">API Timeout</a></li>
|
||||
<li><a href="#command-wait-delay">Command Wait Delay</a></li>
|
||||
<li><a href="#cmd-wait-attempts">CMD Wait Attempts</a></li>
|
||||
<li><a href="#max-dl-queue-size">Max DL Queue Size</a></li>
|
||||
<li><a href="#log-refresh-interval">Log Refresh Interval</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<section id="system-settings">
|
||||
<h2>System Settings</h2>
|
||||
<p>These settings control basic functionality and appearance of your Huntarr.io instance.</p>
|
||||
|
||||
<div class="setting-item" id="check-for-updates">
|
||||
<h3>Check for Updates</h3>
|
||||
<p>When enabled, Huntarr will automatically check for new versions and notify you when updates are available.</p>
|
||||
|
||||
<div class="info-box">
|
||||
<h4>For Beginners:</h4>
|
||||
<p>We recommend keeping this enabled to ensure you're running the latest version with bug fixes and new features. Updates are not installed automatically; you'll just be notified when they're available.</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="setting-item" id="debug-mode">
|
||||
<h3>Debug Mode</h3>
|
||||
<p>Enables verbose logging for troubleshooting issues. This setting applies to all apps connected to Huntarr.</p>
|
||||
|
||||
<div class="info-box">
|
||||
<h4>For Beginners:</h4>
|
||||
<p>Only enable this when you're experiencing issues and need to troubleshoot or when requested by support. Debug mode generates more detailed logs that can help identify problems, but it can also increase disk usage and slightly reduce performance.</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="setting-item" id="display-resources">
|
||||
<h3>Display Resources</h3>
|
||||
<p>Controls whether the Resources section is shown on the home page.</p>
|
||||
|
||||
<div class="info-box">
|
||||
<h4>For Beginners:</h4>
|
||||
<p>The Resources section displays helpful links like documentation, GitHub repository, and community forums. You may want to hide this once you're familiar with Huntarr to optimize screen space.</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<section id="stateful-management">
|
||||
<h2>Stateful Management</h2>
|
||||
<p>These settings control how Huntarr manages the state of processed media.</p>
|
||||
|
||||
<div class="setting-item" id="emergency-reset">
|
||||
<h3>🔥 EMERGENCY RESET 🔥</h3>
|
||||
<p>This button immediately resets all processed media state information.</p>
|
||||
|
||||
<div class="info-box">
|
||||
<h4>For Beginners:</h4>
|
||||
<p>Use this only in emergency situations where you need to force Huntarr to reprocess all media. This will clear all records of what media has been processed, allowing Huntarr to start fresh. This does not delete your media files or configuration settings.</p>
|
||||
<p><strong>Warning:</strong> After reset, Huntarr may reprocess media that was already processed before, potentially causing duplicate downloads.</p>
|
||||
</div>
|
||||
|
||||
<div class="stateful-info">
|
||||
<p><strong>Initial State Created:</strong> <span class="state-time">Sun, May 18, 2025, 02:45 PM (today)</span></p>
|
||||
<p><strong>State Reset Date:</strong> <span class="state-time">Sun, May 25, 2025, 02:45 PM (in 7 days)</span></p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="setting-item" id="state-reset-hours">
|
||||
<h3>State Reset (Hours)</h3>
|
||||
<p>Determines how many hours before automatically resetting processed media state information (default: 168 hours, or 7 days).</p>
|
||||
|
||||
<div class="info-box">
|
||||
<h4>For Beginners:</h4>
|
||||
<p>This setting controls how long Huntarr remembers which media files it has already processed. After this time, Huntarr will "forget" what it has processed, allowing reprocessing of media.</p>
|
||||
<p>Increasing this value means Huntarr will remember processed media for longer, reducing the chance of duplicate processing. Decreasing it allows more frequent reprocessing of media, which might be useful if you often make changes to your media library or configuration.</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<section id="security">
|
||||
<h2>Security</h2>
|
||||
<p>These settings control access security and encryption options.</p>
|
||||
|
||||
<div class="setting-item" id="authentication-mode">
|
||||
<h3>Authentication Mode</h3>
|
||||
<p>Controls how users authenticate with Huntarr:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>Login Mode:</strong> Standard login required for all connections</li>
|
||||
<li><strong>Local Bypass Mode:</strong> Only local network connections (192.168.x.x, 10.x.x.x) bypass login</li>
|
||||
<li><strong>No Login Mode:</strong> Completely disable authentication when running behind your own reverse proxy</li>
|
||||
</ul>
|
||||
|
||||
<div class="info-box">
|
||||
<h4>For Beginners:</h4>
|
||||
<p>Choose "Login Mode" for maximum security, especially if your Huntarr instance is accessible from the internet.</p>
|
||||
<p>"Local Bypass Mode" is convenient for home networks as it doesn't require login when accessing from your local network, but still requires login when accessing remotely.</p>
|
||||
<p>Only use "No Login Mode" if your instance is behind a secure reverse proxy (like Nginx or Cloudflare) that handles authentication for you.</p>
|
||||
<p><strong>Warning:</strong> Using "No Login Mode" without proper security could allow unauthorized access to your media and system!</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="setting-item" id="enable-ssl-verify">
|
||||
<h3>Enable SSL Verify</h3>
|
||||
<p>Controls whether Huntarr verifies SSL certificates when connecting to other services.</p>
|
||||
|
||||
<div class="info-box">
|
||||
<h4>For Beginners:</h4>
|
||||
<p>Normally, this should be enabled for security. It ensures Huntarr only connects to services with valid SSL certificates.</p>
|
||||
<p>You might need to disable this if you're using self-signed certificates on your private network. For example, if you have self-signed certificates for Sonarr, Radarr, or other services, Huntarr might not be able to connect to them unless this is disabled.</p>
|
||||
<p><strong>Note:</strong> Only disable this on private, trusted networks.</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<section id="advanced-settings">
|
||||
<h2>Advanced Settings</h2>
|
||||
<p>These settings are for advanced users who need to fine-tune Huntarr's performance and behavior.</p>
|
||||
|
||||
<div class="setting-item" id="api-timeout">
|
||||
<h3>API Timeout</h3>
|
||||
<p>The number of seconds Huntarr will wait for API responses before timing out (default: 120 seconds).</p>
|
||||
|
||||
<div class="info-box">
|
||||
<h4>For Beginners:</h4>
|
||||
<p>If you notice Huntarr frequently reporting timeouts when connecting to Sonarr, Radarr, or other services, you might need to increase this value. This is especially useful on slower networks or when services are under heavy load.</p>
|
||||
<p>However, setting this too high could cause Huntarr to appear unresponsive if a service is down, as it will wait longer before giving up on connections.</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="setting-item" id="command-wait-delay">
|
||||
<h3>Command Wait Delay</h3>
|
||||
<p>The delay in seconds between command status checks (default: 1 second).</p>
|
||||
|
||||
<div class="info-box">
|
||||
<h4>For Beginners:</h4>
|
||||
<p>This setting controls how frequently Huntarr checks if a command sent to another service (like Sonarr or Radarr) has completed. Lower values make Huntarr more responsive but might increase network traffic. Higher values reduce network traffic but might make Huntarr seem less responsive.</p>
|
||||
<p>The default of 1 second works well for most users and shouldn't need changing.</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="setting-item" id="cmd-wait-attempts">
|
||||
<h3>CMD Wait Attempts</h3>
|
||||
<p>The maximum number of attempts to check command status (default: 600).</p>
|
||||
|
||||
<div class="info-box">
|
||||
<h4>For Beginners:</h4>
|
||||
<p>This setting, combined with Command Wait Delay, determines how long Huntarr will wait for a command to complete before giving up. With default settings (600 attempts × 1 second delay), Huntarr will wait up to 10 minutes.</p>
|
||||
<p>If you're processing very large libraries or have slower systems, you might need to increase this value. If commands are typically quick on your system, you could decrease it.</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="setting-item" id="max-dl-queue-size">
|
||||
<h3>Max DL Queue Size</h3>
|
||||
<p>If the current download queue for an app instance exceeds this value, downloads will be skipped until the queue reduces (default: -1, which means no limit).</p>
|
||||
|
||||
<div class="info-box">
|
||||
<h4>For Beginners:</h4>
|
||||
<p>This setting helps prevent overwhelming your download client with too many simultaneous downloads. If you notice performance issues when Huntarr triggers many downloads at once, you might want to set this to a reasonable value (like 5 or 10).</p>
|
||||
<p>Setting this to -1 means there's no limit on how many downloads Huntarr will queue, which can be useful if you have a very powerful system and fast internet.</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="setting-item" id="log-refresh-interval">
|
||||
<h3>Log Refresh Interval</h3>
|
||||
<p>How often Huntarr refreshes logs from apps, in seconds (default: 30 seconds).</p>
|
||||
|
||||
<div class="info-box">
|
||||
<h4>For Beginners:</h4>
|
||||
<p>This setting controls how frequently Huntarr updates the logs you see in the UI. Lower values (like 10-15 seconds) make logs update more frequently but might increase system load. Higher values (like 60 seconds) reduce system load but make logs less current.</p>
|
||||
<p>The default of 30 seconds provides a good balance between timely updates and system efficiency.</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<div class="section-nav">
|
||||
<a href="index.html">← Back to Settings</a>
|
||||
<a href="network.html">Network Settings →</a>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
Huntarr.io <span class="version-badge">v6.5.18</span> | General Settings Documentation | Thanks 4 Using Huntarr - Admin9705
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -15,13 +15,6 @@
|
||||
</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>
|
||||
|
||||
@@ -1,278 +0,0 @@
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>System Settings - Huntarr.io Documentation</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><a href="../apps/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 class="active"><a href="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>
|
||||
</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://plexguide.github.io/Huntarr.io/" target="_blank"><svg class="svg-icon" viewBox="0 0 24 24" fill="currentColor"><path d="M12 2c5.514 0 10 4.486 10 10s-4.486 10-10 10-10-4.486-10-10 4.486-10 10-10zm0-2c-6.627 0-12 5.373-12 12s5.373 12 12 12 12-5.373 12-12-5.373-12-12-12zm-2.033 16.01c.564-1.789 1.632-3.932 1.821-4.474.273-.787-.211-1.136-1.74.209l-.34-.64c1.744-1.897 5.335-2.326 4.113.613-.763 1.835-1.309 3.074-1.621 4.03-.455 1.393.694.828 1.819-.211.153.25.203.331.356.619-2.498 2.378-5.271 2.588-4.408-.146zm4.742-8.169c-.532.453-1.32.443-1.761-.022-.441-.465-.367-1.208.164-1.661.532-.453 1.32-.442 1.761.022.439.466.367 1.209-.164 1.661z"></path></svg> Website</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</nav>
|
||||
</div>
|
||||
|
||||
<div class="main-content">
|
||||
<div class="container">
|
||||
<h1>System Settings</h1>
|
||||
|
||||
<p>This page contains all settings for customizing your Huntarr.io instance with detailed explanations to help you optimize your setup.</p>
|
||||
|
||||
<div id="toc" class="toc">
|
||||
<h3>Table of Contents</h3>
|
||||
<ul>
|
||||
<li><a href="#system-settings">System Settings</a>
|
||||
<ul>
|
||||
<li><a href="#check-for-updates">Check for Updates</a></li>
|
||||
<li><a href="#debug-mode">Debug Mode</a></li>
|
||||
<li><a href="#display-resources">Display Resources</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="#stateful-management">Stateful Management</a>
|
||||
<ul>
|
||||
<li><a href="#emergency-reset">Emergency Reset</a></li>
|
||||
<li><a href="#state-reset-hours">State Reset (Hours)</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="#security">Security</a>
|
||||
<ul>
|
||||
<li><a href="#authentication-mode">Authentication Mode</a></li>
|
||||
<li><a href="#enable-ssl-verify">Enable SSL Verify</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="#advanced-settings">Advanced Settings</a>
|
||||
<ul>
|
||||
<li><a href="#api-timeout">API Timeout</a></li>
|
||||
<li><a href="#command-wait-delay">Command Wait Delay</a></li>
|
||||
<li><a href="#cmd-wait-attempts">CMD Wait Attempts</a></li>
|
||||
<li><a href="#max-dl-queue-size">Max DL Queue Size</a></li>
|
||||
<li><a href="#log-refresh-interval">Log Refresh Interval</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<section id="system-settings">
|
||||
<h2>System Settings</h2>
|
||||
<p>These settings control basic functionality and appearance of your Huntarr.io instance.</p>
|
||||
|
||||
<h3 id="check-for-updates"><a href="#check-for-updates" class="info-icon"><i class="fas fa-info-circle"></i></a> Check for Updates</h3>
|
||||
<p>When enabled, Huntarr will automatically check for new versions and notify you when updates are available.</p>
|
||||
|
||||
<p>We recommend keeping this enabled to ensure you're running the latest version with bug fixes and new features. Updates are not installed automatically; you'll just be notified when they're available.</p>
|
||||
|
||||
<p>Disabling this option means you'll need to manually check for updates, which could lead to missing important security fixes or helpful new features. Most users should leave this enabled unless running Huntarr in an air-gapped environment.</p>
|
||||
|
||||
<h3 id="debug-mode"><a href="#debug-mode" class="info-icon"><i class="fas fa-info-circle"></i></a> Debug Mode</h3>
|
||||
<p>Enables verbose logging for troubleshooting issues. This setting applies to all apps connected to Huntarr.</p>
|
||||
|
||||
<p>Only enable this when you're experiencing issues and need to troubleshoot or when requested by support. Debug mode generates more detailed logs that can help identify problems, but it can also increase disk usage and slightly reduce performance.</p>
|
||||
|
||||
<p>When troubleshooting, enable this setting, reproduce the issue you're experiencing, then check the logs for detailed information. After resolving the issue, remember to disable debug mode to restore optimal performance.</p>
|
||||
|
||||
<h3 id="display-resources"><a href="#display-resources" class="info-icon"><i class="fas fa-info-circle"></i></a> Display Resources</h3>
|
||||
<p>Controls whether the Resources section is shown on the home page.</p>
|
||||
|
||||
<p>The Resources section displays helpful links like documentation, GitHub repository, and community forums. You may want to hide this once you're familiar with Huntarr to optimize screen space.</p>
|
||||
|
||||
<p>New users should keep this enabled as it provides quick access to documentation and support resources. More experienced users might prefer to hide this section to focus on the core functionality of Huntarr.</p>
|
||||
</section>
|
||||
|
||||
<section id="stateful-management">
|
||||
<h2>Stateful Management</h2>
|
||||
<p>These settings control how Huntarr manages the state of processed media. Understanding these settings is crucial for proper operation of Huntarr's media processing capabilities.</p>
|
||||
|
||||
<h3 id="emergency-reset"><a href="#emergency-reset" class="info-icon"><i class="fas fa-info-circle"></i></a> 🔥 EMERGENCY RESET 🔥</h3>
|
||||
<p>This button immediately resets all processed media state information.</p>
|
||||
|
||||
<p>Use this only in emergency situations where you need to force Huntarr to reprocess all media. This will clear all records of what media has been processed, allowing Huntarr to start fresh. This does not delete your media files or configuration settings.</p>
|
||||
|
||||
<p><strong>Warning:</strong> After reset, Huntarr may reprocess media that was already processed before, potentially causing duplicate downloads.</p>
|
||||
|
||||
<p>Situations where an emergency reset might be necessary include:</p>
|
||||
<ul>
|
||||
<li>After changing your media organization strategy and wanting Huntarr to reevaluate all content</li>
|
||||
<li>When you suspect that Huntarr's processing data has become corrupted</li>
|
||||
<li>After a significant configuration change when you want Huntarr to start fresh</li>
|
||||
</ul>
|
||||
|
||||
<p><strong>Initial State Created:</strong> Sun, May 18, 2025, 02:45 PM (today)<br>
|
||||
<strong>State Reset Date:</strong> Sun, May 25, 2025, 02:45 PM (in 7 days)</p>
|
||||
|
||||
<h3 id="state-reset-hours"><a href="#state-reset-hours" class="info-icon"><i class="fas fa-info-circle"></i></a> State Reset (Hours)</h3>
|
||||
<p>Determines how many hours before automatically resetting processed media state information (default: 168 hours, or 7 days).</p>
|
||||
|
||||
<p>This setting controls how long Huntarr remembers which media files it has already processed. After this time, Huntarr will "forget" what it has processed, allowing reprocessing of media.</p>
|
||||
|
||||
<p>Increasing this value means Huntarr will remember processed media for longer, reducing the chance of duplicate processing. Decreasing it allows more frequent reprocessing of media, which might be useful if you often make changes to your media library or configuration.</p>
|
||||
|
||||
<p>Common settings values and their effects:</p>
|
||||
<ul>
|
||||
<li><strong>168 hours (7 days):</strong> Default setting, suitable for most users</li>
|
||||
<li><strong>720 hours (30 days):</strong> Good for stable setups where you rarely add new content</li>
|
||||
<li><strong>72 hours (3 days):</strong> For more active libraries with frequent changes</li>
|
||||
<li><strong>24 hours (1 day):</strong> For very dynamic environments or testing setups</li>
|
||||
</ul>
|
||||
|
||||
<p>Reset clears all processed media IDs to allow reprocessing. This is especially useful when you've made changes to your naming conventions or organization structure and want Huntarr to reprocess content according to the new rules.</p>
|
||||
</section>
|
||||
|
||||
<section id="security">
|
||||
<h2>Security</h2>
|
||||
<p>These settings control access security and encryption options to protect your Huntarr installation.</p>
|
||||
|
||||
<h3 id="authentication-mode"><a href="#authentication-mode" class="info-icon"><i class="fas fa-info-circle"></i></a> Authentication Mode</h3>
|
||||
<p>Controls how users authenticate with Huntarr. There are three options available:</p>
|
||||
|
||||
<h4>Login Mode</h4>
|
||||
<p>Standard login required for all connections. This is the most secure option and is recommended if your Huntarr instance is accessible from the internet. With this mode, anyone accessing Huntarr will need to provide valid credentials.</p>
|
||||
|
||||
<h4>Local Bypass Mode</h4>
|
||||
<p>Only local network connections (192.168.x.x, 10.x.x.x) bypass login. This is convenient for home networks as it doesn't require login when accessing from your local network, but still requires login when accessing remotely.</p>
|
||||
|
||||
<p>This mode offers a good balance between security and convenience for typical home setups. You won't need to log in when accessing Huntarr from devices on your home network, but external access will still require authentication.</p>
|
||||
|
||||
<h4>No Login Mode</h4>
|
||||
<p>Completely disable authentication when running behind your own reverse proxy. Only use this if your instance is behind a secure reverse proxy (like Nginx or Cloudflare) that handles authentication for you.</p>
|
||||
|
||||
<p><strong>Warning:</strong> Using "No Login Mode" without proper security could allow unauthorized access to your media and system! Only use this mode if you have implemented alternative security measures.</p>
|
||||
|
||||
<h3 id="enable-ssl-verify"><a href="#enable-ssl-verify" class="info-icon"><i class="fas fa-info-circle"></i></a> Enable SSL Verify</h3>
|
||||
<p>Controls whether Huntarr verifies SSL certificates when connecting to other services.</p>
|
||||
|
||||
<p>Normally, this should be enabled for security. It ensures Huntarr only connects to services with valid SSL certificates, protecting against man-in-the-middle attacks and unauthorized access.</p>
|
||||
|
||||
<p>You might need to disable this if you're using self-signed certificates on your private network. For example, if you have self-signed certificates for Sonarr, Radarr, or other services, Huntarr might not be able to connect to them unless this is disabled.</p>
|
||||
|
||||
<p><strong>Note:</strong> Only disable this on private, trusted networks. Disabling SSL verification on public networks or internet-facing installations could expose your system to security risks.</p>
|
||||
|
||||
<p>If you're experiencing connection issues with other services that use SSL, and you're using self-signed certificates or a private certificate authority, you may need to disable this option. However, a better approach would be to properly configure your certificates to be trusted by your system.</p>
|
||||
</section>
|
||||
|
||||
<section id="advanced-settings">
|
||||
<h2>Advanced Settings</h2>
|
||||
<p>These settings are for advanced users who need to fine-tune Huntarr's performance and behavior. Adjust these settings only if you understand their impact on the system.</p>
|
||||
|
||||
<h3 id="api-timeout"><a href="#api-timeout" class="info-icon"><i class="fas fa-info-circle"></i></a> API Timeout</h3>
|
||||
<p>The number of seconds Huntarr will wait for API responses before timing out (default: 120 seconds).</p>
|
||||
|
||||
<p>If you notice Huntarr frequently reporting timeouts when connecting to Sonarr, Radarr, or other services, you might need to increase this value. This is especially useful on slower networks or when services are under heavy load.</p>
|
||||
|
||||
<p>However, setting this too high could cause Huntarr to appear unresponsive if a service is down, as it will wait longer before giving up on connections.</p>
|
||||
|
||||
<p>This setting is particularly important if:</p>
|
||||
<ul>
|
||||
<li>You have services running on slower hardware like a Raspberry Pi</li>
|
||||
<li>Your services are handling large libraries or running intensive tasks</li>
|
||||
<li>Your network has higher latency or occasional connectivity issues</li>
|
||||
</ul>
|
||||
|
||||
<h3 id="command-wait-delay"><a href="#command-wait-delay" class="info-icon"><i class="fas fa-info-circle"></i></a> Command Wait Delay</h3>
|
||||
<p>The delay in seconds between command status checks (default: 1 second).</p>
|
||||
|
||||
<p>This setting controls how frequently Huntarr checks if a command sent to another service (like Sonarr or Radarr) has completed. Lower values make Huntarr more responsive but might increase network traffic. Higher values reduce network traffic but might make Huntarr seem less responsive.</p>
|
||||
|
||||
<p>The default of 1 second works well for most users and shouldn't need changing. In high-performance environments with many services, increasing this value slightly (to 2-3 seconds) might reduce unnecessary network traffic without significantly impacting responsiveness.</p>
|
||||
|
||||
<h3 id="cmd-wait-attempts"><a href="#cmd-wait-attempts" class="info-icon"><i class="fas fa-info-circle"></i></a> CMD Wait Attempts</h3>
|
||||
<p>The maximum number of attempts to check command status (default: 600).</p>
|
||||
|
||||
<p>This setting, combined with Command Wait Delay, determines how long Huntarr will wait for a command to complete before giving up. With default settings (600 attempts × 1 second delay), Huntarr will wait up to 10 minutes.</p>
|
||||
|
||||
<p>If you're processing very large libraries or have slower systems, you might need to increase this value. If commands are typically quick on your system, you could decrease it to detect failed commands more quickly.</p>
|
||||
|
||||
<p>Calculation: Total wait time = Command Wait Delay × CMD Wait Attempts</p>
|
||||
<ul>
|
||||
<li>Default: 1 second × 600 attempts = 600 seconds (10 minutes)</li>
|
||||
<li>For slower systems: 1 second × 1200 attempts = 1200 seconds (20 minutes)</li>
|
||||
<li>For faster systems: 1 second × 300 attempts = 300 seconds (5 minutes)</li>
|
||||
</ul>
|
||||
|
||||
<h3 id="max-dl-queue-size"><a href="#max-dl-queue-size" class="info-icon"><i class="fas fa-info-circle"></i></a> Max DL Queue Size</h3>
|
||||
<p>If the current download queue for an app instance exceeds this value, downloads will be skipped until the queue reduces (default: -1, which means no limit).</p>
|
||||
|
||||
<p>This setting helps prevent overwhelming your download client with too many simultaneous downloads. If you notice performance issues when Huntarr triggers many downloads at once, you might want to set this to a reasonable value (like 5 or 10).</p>
|
||||
|
||||
<p>Setting this to -1 means there's no limit on how many downloads Huntarr will queue, which can be useful if you have a very powerful system and fast internet.</p>
|
||||
|
||||
<p>Consider your bandwidth and system resources when setting this value:</p>
|
||||
<ul>
|
||||
<li><strong>-1 (No limit):</strong> For high-bandwidth connections and powerful systems</li>
|
||||
<li><strong>10-15:</strong> For good broadband connections and moderately powerful systems</li>
|
||||
<li><strong>5-10:</strong> For typical home broadband connections</li>
|
||||
<li><strong>1-5:</strong> For slower connections or systems with limited resources</li>
|
||||
</ul>
|
||||
|
||||
<h3 id="log-refresh-interval"><a href="#log-refresh-interval" class="info-icon"><i class="fas fa-info-circle"></i></a> Log Refresh Interval</h3>
|
||||
<p>How often Huntarr refreshes logs from apps, in seconds (default: 30 seconds).</p>
|
||||
|
||||
<p>This setting controls how frequently Huntarr updates the logs you see in the UI. Lower values (like 10-15 seconds) make logs update more frequently but might increase system load. Higher values (like 60 seconds) reduce system load but make logs less current.</p>
|
||||
|
||||
<p>The default of 30 seconds provides a good balance between timely updates and system efficiency. If you're actively troubleshooting an issue and need to see log updates more quickly, you might temporarily reduce this value. For regular operation, especially on less powerful hardware, keeping it at 30 seconds or higher is recommended.</p>
|
||||
|
||||
<p>When adjusting this setting, consider:</p>
|
||||
<ul>
|
||||
<li><strong>10-15 seconds:</strong> For active troubleshooting when you need near real-time log updates</li>
|
||||
<li><strong>30 seconds:</strong> Default, good balance for most users</li>
|
||||
<li><strong>60 seconds:</strong> For systems with limited resources or when logs aren't frequently needed</li>
|
||||
</ul>
|
||||
</section>
|
||||
|
||||
<div class="section-nav">
|
||||
<a href="../index.html">← Back to Home</a>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
Huntarr.io <span class="version-badge">v6.5.18</span> | System Settings Documentation | Thanks 4 Using Huntarr - Admin9705
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a href="#toc" class="back-to-top" id="back-to-top" title="Back to Top">
|
||||
<svg width="24" height="24" viewBox="0 0 24 24" fill="currentColor">
|
||||
<path d="M7.41 15.41L12 10.83l4.59 4.58L18 14l-6-6-6 6z"></path>
|
||||
</svg>
|
||||
</a>
|
||||
|
||||
<script>
|
||||
// Show/hide back-to-top button based on scroll position
|
||||
window.addEventListener('scroll', function() {
|
||||
var backToTopButton = document.getElementById('back-to-top');
|
||||
if (window.pageYOffset > 300) {
|
||||
backToTopButton.classList.add('visible');
|
||||
} else {
|
||||
backToTopButton.classList.remove('visible');
|
||||
}
|
||||
});
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
Reference in New Issue
Block a user