Installation Guide

Docker Installation

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

Prerequisites

• Docker (1.27 or newer)

Docker Run Method

The simplest way to run Huntarr is via Docker (all configuration is done via the web UI):

Option 1: DockerHub

docker run -d --name huntarr \
  --restart always \
  -p 9705:9705 \
  -v /your-path/huntarr:/config \
  -e TZ=America/New_York \
  huntarr/huntarr:latest

Option 2: GitHub Container Registry

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

To check on the status of the program:

docker logs huntarr

Docker Compose Method

For those who prefer Docker Compose, add this to your docker-compose.yml file:

Option 1: DockerHub

services:
  huntarr:
    image: huntarr/huntarr:latest
    container_name: huntarr
    restart: always
    ports:
      - "9705:9705"
    volumes:
      - /your-path/huntarr:/config
    environment:
      - TZ=America/New_York

Option 2: GitHub Container Registry

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

Then run:

docker-compose up -d huntarr

Unraid Installation

You can install Huntarr using the Unraid App Store.

If not, you can run this from Command Line in Unraid:

Option 1: DockerHub

docker run -d --name huntarr \
  --restart always \
  -p 9705:9705 \
  -v /mnt/user/appdata/huntarr:/config \
  -e TZ=America/New_York \
  huntarr/huntarr:latest

Option 2: GitHub Container Registry

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

macOS Installation

Huntarr.io provides native macOS installers for both Intel and Apple Silicon Macs.

Two Types of macOS Installers

• Intel (x86_64) - For Intel-based Macs
• ARM (arm64) - For Apple Silicon Macs (M1, M2, etc.)

Installation Steps

1. Download the appropriate installer package (.pkg) for your Mac from the GitHub Releases page.
2. Double-click the downloaded .pkg file to start the installation process.
3. 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.
4. To proceed with installation, go to System Settings → Privacy & Security, scroll down to the security section, and click "Open Anyway" as shown below:

Configuration

When first launched, Huntarr.io will create the necessary configuration directories in your user folder:

~/Library/Application Support/Huntarr/config/

Notes about macOS Version

• The macOS version is provided as a convenience for users who prefer native applications
• The Docker version remains the primary supported deployment method

Alternative Installation Methods

Although Docker and the native macOS installers are the recommended methods, there are additional ways to install and run Huntarr.

From Source (Advanced)

If you're familiar with Python and want to run Huntarr from source:

1. Ensure you have Python 3.9+ and Git installed on your system
2. Clone the repository:

   git clone https://github.com/plexguide/Huntarr.io.git

3. Navigate to the directory:

   cd Huntarr.io

4. Install Python dependencies:

   pip install -r requirements.txt

5. Run the application:

   python run.py