mirror of
https://github.com/plexguide/Huntarr.git
synced 2026-05-03 09:10:14 -05:00
docs: add installation guide with Docker, Unraid and native setup instructions
This commit is contained in:
Admin9705
@@ -697,6 +697,42 @@ footer {
|
||||
100% { background-color: var(--card-bg); }
|
||||
}
|
||||
|
||||
/* Warning and Note Boxes */
|
||||
.warning-box {
|
||||
background-color: rgba(231, 76, 60, 0.1);
|
||||
border-left: 4px solid #e74c3c;
|
||||
padding: 15px;
|
||||
margin: 20px 0;
|
||||
border-radius: 4px;
|
||||
}
|
||||
|
||||
.warning-box h3 {
|
||||
color: #e74c3c;
|
||||
margin-top: 10px;
|
||||
margin-bottom: 10px;
|
||||
}
|
||||
|
||||
.note-box {
|
||||
background-color: rgba(52, 152, 219, 0.1);
|
||||
border-left: 4px solid var(--highlight-color);
|
||||
padding: 15px;
|
||||
margin: 20px 0;
|
||||
border-radius: 4px;
|
||||
}
|
||||
|
||||
.note-box h4 {
|
||||
color: var(--highlight-color);
|
||||
margin-top: 5px;
|
||||
margin-bottom: 10px;
|
||||
}
|
||||
|
||||
.warning-image {
|
||||
max-width: 100%;
|
||||
border-radius: 4px;
|
||||
margin-bottom: 15px;
|
||||
box-shadow: 0 4px 8px rgba(0, 0, 0, 0.2);
|
||||
}
|
||||
|
||||
.back-to-top.visible {
|
||||
opacity: 1;
|
||||
transform: translateY(0);
|
||||
|
||||
@@ -0,0 +1,267 @@
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>Installation Guide - 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 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>
|
||||
</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 id="page-title">Installation Guide</h1>
|
||||
|
||||
<section class="installation-overview">
|
||||
<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="#docker">Docker Installation</a></li>
|
||||
<li><a href="#unraid">Unraid Installation</a></li>
|
||||
<li><a href="#native">Native Installation</a></li>
|
||||
<li><a href="#macos">macOS Installation</a></li>
|
||||
<li><a href="#post-installation">Post Installation</a></li>
|
||||
<li><a href="#troubleshooting">Troubleshooting</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
|
||||
<section id="docker" class="docker-installation">
|
||||
<h2>Docker Installation</h2>
|
||||
|
||||
<p>The recommended way to install Huntarr.io is using Docker. This method simplifies the installation process and ensures that all dependencies are properly managed.</p>
|
||||
|
||||
<h3>Using Docker Compose (Recommended)</h3>
|
||||
<p>Create a <code>docker-compose.yml</code> file with the following content:</p>
|
||||
|
||||
<pre><code>version: '3'
|
||||
services:
|
||||
huntarr:
|
||||
container_name: huntarr
|
||||
image: plexguide/huntarr:latest
|
||||
restart: unless-stopped
|
||||
ports:
|
||||
- "9705:9705"
|
||||
volumes:
|
||||
- ./config:/config
|
||||
- /etc/localtime:/etc/localtime:ro
|
||||
environment:
|
||||
- PUID=1000
|
||||
- PGID=1000
|
||||
- TZ=Europe/London # Set to your timezone</code></pre>
|
||||
|
||||
<p>Then run the following commands:</p>
|
||||
|
||||
<pre class="terminal"><code class="command-prompt">mkdir -p config
|
||||
docker-compose up -d</code></pre>
|
||||
|
||||
<h3>Using Docker Run</h3>
|
||||
<p>If you prefer using the <code>docker run</code> command:</p>
|
||||
|
||||
<pre class="terminal"><code class="command-prompt">docker run -d \
|
||||
--name=huntarr \
|
||||
-p 9705:9705 \
|
||||
-v $(pwd)/config:/config \
|
||||
-v /etc/localtime:/etc/localtime:ro \
|
||||
-e PUID=1000 \
|
||||
-e PGID=1000 \
|
||||
-e TZ=Europe/London \
|
||||
--restart unless-stopped \
|
||||
plexguide/huntarr:latest</code></pre>
|
||||
</section>
|
||||
|
||||
<section id="unraid" class="unraid-installation">
|
||||
<h2>Unraid Installation</h2>
|
||||
|
||||
<p>Huntarr.io can be easily installed on Unraid using the Community Applications plugin.</p>
|
||||
|
||||
<h3>Steps for Unraid Installation</h3>
|
||||
<ol>
|
||||
<li>Navigate to the <strong>Apps</strong> tab in your Unraid dashboard</li>
|
||||
<li>Search for "Huntarr" in the search bar</li>
|
||||
<li>Click on the Huntarr app</li>
|
||||
<li>Configure the container settings:
|
||||
<ul>
|
||||
<li>Set your preferred port (default: 9705)</li>
|
||||
<li>Set the config directory path</li>
|
||||
<li>Set your PUID, PGID, and timezone</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>Click <strong>Apply</strong> to create the container</li>
|
||||
</ol>
|
||||
</section>
|
||||
|
||||
<section id="native" class="native-installation">
|
||||
<h2>Native Installation</h2>
|
||||
|
||||
<p>For advanced users who prefer to install Huntarr.io directly on their system:</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>
|
||||
</section>
|
||||
|
||||
<section id="macos" class="macos-installation">
|
||||
<h2>macOS Installation</h2>
|
||||
|
||||
<div class="warning-box">
|
||||
<img src="../images/mac-os-warning.jpg" alt="macOS Warning" class="warning-image">
|
||||
<h3>Important macOS Permission Warning</h3>
|
||||
<p>The Huntarr macOS application has known permission issues when attempting to write to the <code>~/Library/Application Support/</code> directory. This can cause crashes and data loss.</p>
|
||||
</div>
|
||||
|
||||
<h3>Recommended Configuration for macOS</h3>
|
||||
<p>To avoid permission issues on macOS, we've implemented a fallback system that:</p>
|
||||
<ol>
|
||||
<li>First tries to use the app bundle's own Resources directory for configuration files</li>
|
||||
<li>Falls back to the user's Documents folder if that fails</li>
|
||||
</ol>
|
||||
|
||||
<p>For the best experience on macOS, use the following installation steps:</p>
|
||||
|
||||
<ol>
|
||||
<li>Download the latest macOS installer from the <a href="https://github.com/plexguide/Huntarr.io/releases" target="_blank">GitHub releases page</a></li>
|
||||
<li>Move the application to your Applications folder</li>
|
||||
<li>When running for the first time, right-click and select "Open" to bypass Gatekeeper</li>
|
||||
<li>The application will automatically create its configuration in the appropriate location</li>
|
||||
</ol>
|
||||
|
||||
<div class="note-box">
|
||||
<h4>Troubleshooting macOS Issues</h4>
|
||||
<p>If you encounter crashes or permission errors, check the application logs located in:</p>
|
||||
<code>~/Library/Logs/Huntarr/</code> or <code>~/Documents/Huntarr/logs/</code>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<section id="post-installation" 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>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>
|
||||
</section>
|
||||
|
||||
<section id="troubleshooting" 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>
|
||||
</div>
|
||||
|
||||
<div class="issue-card">
|
||||
<h4>Connectivity problems</h4>
|
||||
<p>If you can't connect to Huntarr.io after installation:</p>
|
||||
<ul>
|
||||
<li>Check if the service is running: <code>docker ps | grep huntarr</code></li>
|
||||
<li>Check the logs: <code>docker logs huntarr</code></li>
|
||||
<li>Ensure your firewall allows traffic on the configured port</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<div class="section-nav">
|
||||
<a href="../index.html">← Back to Home</a>
|
||||
<a href="../apps/index.html">Apps Documentation →</a>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
Huntarr.io <span class="version-badge">v6.5.18</span> | Installation Guide | 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>
|
||||
|
||||
<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 and TOC links
|
||||
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'
|
||||
});
|
||||
});
|
||||
|
||||
// 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>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user