Installation Guide

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.

System Requirements

Before installing Huntarr.io, ensure your system meets the following requirements:

Component Minimum Recommended
CPU 2 cores 4+ cores
Memory 2GB RAM 4GB+ RAM
Storage 20GB available space 50GB+ available space
Operating System Linux (Ubuntu 18.04+, Debian 10+)
Windows 10+
macOS 10.15+		 Linux (Ubuntu 20.04+, Debian 11+)
Docker Docker 19.03+ and Docker Compose 1.27+ Latest Docker and Docker Compose versions

Installation Methods

Choose the installation method that best suits your environment:

Docker Installation

The recommended way to install Huntarr.io is using Docker and Docker Compose. This method ensures that all dependencies are correctly installed and configured.

Prerequisites

  • Docker (19.03 or newer)
  • Docker Compose (1.27 or newer)

Steps

  1. Clone the repository: 
    git clone https://github.com/plexguide/Huntarr.io.git
  2. Navigate to the directory: 
    cd Huntarr.io
  3. Run the Docker Compose command: 
    docker-compose up -d
  4. Access Huntarr.io through your browser: 
    http://localhost:7575

Docker Compose Configuration

The default docker-compose.yml file includes all necessary components, but you can customize it according to your needs. Here's a sample configuration:

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

Installation Script

For Linux systems, we provide a convenient installation script that automates the setup process.

Supported Distributions

  • Ubuntu 18.04, 20.04, 22.04
  • Debian 10, 11
  • CentOS 8, Stream
  • Fedora 34+

One-line Installation

Run the following command to install Huntarr.io:

curl -sSL https://install.huntarr.io | bash

Advanced Options

For more control over the installation process, you can use these flags:

curl -sSL https://install.huntarr.io | bash -s -- --prefix /opt/huntarr --port 8080

Available options:

  • --prefix: Installation directory (default: /opt/huntarr)
  • --port: Web interface port (default: 7575)
  • --no-docker: Install without Docker (native installation)
  • --no-deps: Skip dependency installation

Manual Installation

If you prefer to install Huntarr.io manually, follow these steps based on your operating system.

Linux (Ubuntu/Debian)

  1. Install dependencies: 
    sudo apt update
sudo apt install -y nodejs npm git
  2. Clone the repository: 
    git clone https://github.com/plexguide/Huntarr.io.git
  3. Navigate to the directory: 
    cd Huntarr.io
  4. Install npm dependencies: 
    npm install
  5. Start the application: 
    npm start

Windows

  1. Install Node.js
  2. Install Git for Windows
  3. Open Command Prompt or PowerShell
  4. Clone the repository: 
    git clone https://github.com/plexguide/Huntarr.io.git
  5. Navigate to the directory: 
    cd Huntarr.io
  6. Install npm dependencies: 
    npm install
  7. Start the application: 
    npm start

macOS

  1. Install Homebrew if you don't have it yet: 
    /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
  2. Install Node.js and Git: 
    brew install node git
  3. Clone the repository: 
    git clone https://github.com/plexguide/Huntarr.io.git
  4. Navigate to the directory: 
    cd Huntarr.io
  5. Install npm dependencies: 
    npm install
  6. Start the application: 
    npm start

Post Installation

Initial Setup

After installing Huntarr.io, you'll need to complete the initial setup:

  1. Access the web interface (default: http://localhost:7575)
  2. Create an administrator account when prompted
  3. Follow the setup wizard to configure your media paths and integrate with media applications (Sonarr, Radarr, etc.)

Updating Huntarr.io

To update Huntarr.io to the latest version:

Docker Installation

cd /path/to/Huntarr.io
git pull
docker-compose pull
docker-compose up -d

Manual Installation

cd /path/to/Huntarr.io
git pull
npm install
npm restart

Troubleshooting

Common Issues

Port already in use

If port 7575 is already in use, you can change it in the docker-compose.yml file or use the --port option in the installation script.

Permission issues

If you encounter permission issues, make sure the PUID and PGID environment variables in docker-compose.yml match your user's UID and GID.

# Find your user ID and group ID
id $(whoami)

Connectivity problems

If you can't connect to Huntarr.io after installation:

  • Check if the service is running: docker ps | grep huntarr
  • Check the logs: docker logs huntarr
  • Ensure your firewall allows traffic on the configured port
← Back to Home Quick Setup Guide →