mirror of
https://github.com/plexguide/Huntarr.io.git
synced 2026-01-04 21:20:33 -06:00
336 lines
19 KiB
HTML
336 lines
19 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<title>Installation Guide - 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">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/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>
|
|
|
|
<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>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 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 class="installation-methods">
|
|
<h2>Installation Methods</h2>
|
|
<p>Choose the installation method that best suits your environment:</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>
|
|
|
|
<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 class="terminal"><code class="command-prompt">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 class="terminal"><code class="command-prompt">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 class="terminal"><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 class="terminal"><code class="command-prompt">/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"</code></pre>
|
|
</li>
|
|
<li>Install Node.js and Git:
|
|
<pre class="terminal"><code class="command-prompt">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>
|
|
</div>
|
|
</section>
|
|
|
|
<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: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 class="troubleshooting">
|
|
<h2>Troubleshooting</h2>
|
|
|
|
<h3>Common Issues</h3>
|
|
|
|
<div class="issue-card">
|
|
<h4>Port already in use</h4>
|
|
<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>
|
|
<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="quick-setup.html">Quick Setup Guide →</a>
|
|
</div>
|
|
|
|
<footer>
|
|
Huntarr.io <span class="version-badge">v6.5.18</span> | Installation Guide | Thanks 4 Using Huntarr - Admin9705
|
|
</footer>
|
|
</div>
|
|
</div>
|
|
|
|
<script>
|
|
document.addEventListener('DOMContentLoaded', function() {
|
|
// Tab functionality
|
|
const tabButtons = document.querySelectorAll('.tab-button');
|
|
const tabPanes = document.querySelectorAll('.tab-pane');
|
|
|
|
tabButtons.forEach(button => {
|
|
button.addEventListener('click', function() {
|
|
// Remove active class from all buttons and panes
|
|
tabButtons.forEach(btn => btn.classList.remove('active'));
|
|
tabPanes.forEach(pane => pane.classList.remove('active'));
|
|
|
|
// Add active class to current button and corresponding pane
|
|
this.classList.add('active');
|
|
const tabId = this.getAttribute('data-tab');
|
|
document.getElementById(tabId).classList.add('active');
|
|
});
|
|
});
|
|
});
|
|
</script>
|
|
</body>
|
|
</html> |