Installation¶

Dispatcharr can be installed using Docker on various platforms, including Windows, macOS, Proxmox, and Unraid. This guide provides detailed instructions for each method.

Prerequisites¶

Ensure Docker and Docker Compose are installed on your platform.

Docker Compose¶

Dispatcharr is deployed using the following docker-compose.yml:

services:
  dispatcharr:
    # build:
    #   context: .
    #   dockerfile: Dockerfile
    image: ghcr.io/dispatcharr/dispatcharr:latest
    container_name: dispatcharr
    ports:
      - 9191:9191
    volumes:
      - dispatcharr_data:/data
    environment:
      - DISPATCHARR_ENV=aio
      - REDIS_HOST=localhost
      - CELERY_BROKER_URL=redis://localhost:6379/0
      - DISPATCHARR_LOG_LEVEL=info
    # Optional for hardware acceleration
    #devices:
    #  - /dev/dri:/dev/dri  # For Intel/AMD GPU acceleration (VA-API)
    # Uncomment the following lines for NVIDIA GPU support
    # NVidia GPU support (requires NVIDIA Container Toolkit)
    #deploy:
    #  resources:
    #      reservations:
    #          devices:
    #              - driver: nvidia
    #                count: all
    #                capabilities: [gpu]


volumes:
  dispatcharr_data:

Installation Steps¶

Windows Docker¶

Install and open Docker Desktop.
Create a directory, e.g., C:\Dispatcharr, and inside it create a docker-compose.yml with the provided content.
Open a PowerShell or Command Prompt window in this directory.
Start Dispatcharr with:
```
docker compose up -d
```

macOS Docker¶

Install and start Docker Desktop.
Create a directory for Dispatcharr, e.g., ~/Dispatcharr.
Create a docker-compose.yml file with the provided content.
Launch Terminal and navigate to your directory:
```
cd ~/Dispatcharr
```
Run the container:
```
docker compose up -d
```

Linux Docker¶

Warning

Some distros use outdated versions of Docker so it is recommended to install directly from Docker

Install Docker using the official instructions, such as those for Ubuntu

Ubuntu example

Uninstall old versions.

for pkg in docker.io docker-doc docker-compose docker-compose-v2 podman-docker containerd runc; do sudo apt-get remove $pkg; done

Setup Dockers own apt repository for up-to-date versions.

# Add Docker's official GPG key:
sudo apt-get update
sudo apt-get install ca-certificates curl
sudo install -m 0755 -d /etc/apt/keyrings
sudo curl -fsSL https://download.docker.com/linux/ubuntu/gpg -o /etc/apt/keyrings/docker.asc
sudo chmod a+r /etc/apt/keyrings/docker.asc

# Add the repository to Apt sources:
echo \
"deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/ubuntu \
$(. /etc/os-release && echo "${UBUNTU_CODENAME:-$VERSION_CODENAME}") stable" | \
sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
sudo apt-get update

Install Docker.

sudo apt-get install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin

Create and navigate to your Dispatcharr directory.
```
mkdir ~/dispatcharr && cd ~/dispatcharr
```
Add your own docker-compose.yml or use the provided example.
Launch Dispatcharr:
```
docker compose up -d
```

Note

If you wish to use the docker compose commands without sudo you may need to follow Dockers official guide here.

Proxmox¶

Create an Ubuntu LXC container or VM with Docker and Docker Compose installed.
```
apt install docker.io docker-compose -y
```
Create and navigate to your Dispatcharr directory:
```
mkdir ~/dispatcharr && cd ~/dispatcharr
```
Add your docker-compose.yml.
Launch Dispatcharr:
```
docker compose up -d
```

Unraid¶

Select the "Apps" tab of your Unraid server
Search "Dispatcharr" and Select Install
Leave the defaults unless you need to change them

Building from Source (Unsupported)¶

Clone this repository:

git clone https://github.com/Dispatcharr/Dispatcharr.git
cd Dispatcharr

Create and activate a virtual environment (optional but recommended):
```
python -m venv venv
source venv/bin/activate
```
Install required dependencies:
```
pip install -r requirements.txt
```
Run database migrations and start the server (Django + React front-end):
```
python manage.py migrate
python manage.py runserver
```
For the front-end, navigate to the frontend/ folder and run:
```
npm install
npm run build
```
Once running, visit http://localhost:9191 (or the port you exposed) in your browser.

Accessing Dispatcharr¶

Open your web browser and navigate to:

http://localhost:9191

Replace localhost with your server's IP address if accessing remotely.