Instalação

O Dispatcharr pode ser instalado usando Docker em várias plataformas, incluindo Windows, macOS, Proxmox e Unraid. Este guia fornece instruções detalhadas para cada método.

Pré-requisitos

Certifique-se de que Docker e Docker Compose estejam instalados na sua plataforma.

• Docker Desktop para Windows
• Docker Desktop para Mac
• Docker no Linux
• Docker no Proxmox (LXC)
• Docker no Unraid

---

Docker Compose

O Dispatcharr é implantado usando o seguinte docker-compose.yml:

services:
  dispatcharr:
    # build:
    #   context: .
    #   dockerfile: Dockerfile
    image: ghcr.io/dispatcharr/dispatcharr:latest
    restart: unless-stopped
    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
      # Legacy CPU Support (Optional)
      # Uncomment to enable legacy NumPy build for older CPUs (circa 2009)
      # that lack support for newer baseline CPU features
      #- USE_LEGACY_NUMPY=true
      # Process Priority Configuration (Optional)
      # Lower values = higher priority. Range: -20 (highest) to 19 (lowest)
      # Negative values require cap_add: SYS_NICE (uncomment below)
      #- UWSGI_NICE_LEVEL=-5   # uWSGI/FFmpeg/Streaming (default: 0, recommended: -5 for high priority)
      #- CELERY_NICE_LEVEL=5   # Celery/EPG/Background tasks (default: 5, low priority)
    #
    # Uncomment to enable high priority for streaming (required if UWSGI_NICE_LEVEL < 0)
    #cap_add:
    #  - SYS_NICE
    # 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:

---

Passos de Instalação

Windows Docker

1. Instale e abra o Docker Desktop.
2. Crie um diretório, ex.: C:\Dispatcharr, e dentro dele crie um docker-compose.yml com o conteúdo fornecido.
3. Abra uma janela do PowerShell ou Prompt de Comando neste diretório.

4. Inicie o Dispatcharr com:

   docker compose up -d
   

---

macOS Docker

1. Instale e inicie o Docker Desktop.
2. Crie um diretório para o Dispatcharr, ex.: ~/Dispatcharr.
3. Crie um arquivo docker-compose.yml com o conteúdo fornecido.

4. Abra o Terminal e navegue até o seu diretório:

   cd ~/Dispatcharr
   

5. Execute o contêiner:

   docker compose up -d
   

---

Linux Docker

Warning

Algumas distribuições usam versões desatualizadas do Docker, então é recomendado instalar diretamente do Docker

Instale o Docker usando as instruções oficiais, como as para Ubuntu

Exemplo para Ubuntu

1. Desinstale versões antigas.

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

2. Configure o repositório apt do próprio Docker para versões atualizadas.

# 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

3. Instale o Docker.

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

1. Crie e navegue até o diretório do Dispatcharr.

   mkdir ~/dispatcharr && cd ~/dispatcharr
   

2. Adicione seu próprio docker-compose.yml ou use o exemplo fornecido.

3. Inicie o Dispatcharr:

   docker compose up -d
   

Note

Se você deseja usar os comandos docker compose sem sudo, pode ser necessário seguir o guia oficial do Docker aqui.

---

Proxmox

1. Crie um contêiner LXC Ubuntu ou VM com Docker e Docker Compose instalados.

   apt install docker.io docker-compose -y
   

2. Crie e navegue até o diretório do Dispatcharr:

   mkdir ~/dispatcharr && cd ~/dispatcharr
   

3. Adicione seu docker-compose.yml.

4. Inicie o Dispatcharr:

   docker compose up -d
   

---

Unraid

1. Selecione a aba "Apps" do seu servidor Unraid
2. Pesquise "Dispatcharr" e selecione Install
3. Mantenha os padrões a menos que precise alterá-los

---

Implantação Modular

Por padrão, o Dispatcharr é executado no modo all-in-one (AIO) com Redis e PostgreSQL agrupados dentro de um único contêiner. A implantação modular separa estes em contêineres individuais, dando a você controle sobre versões de banco de dados, alocação de recursos e segurança de conexão.

Note

A implantação modular é opcional. O modo AIO funciona para a maioria dos usuários. Considere a implantação modular se você precisa de conexões de banco de dados criptografadas com TLS, deseja usar instâncias externas existentes de Redis ou PostgreSQL, ou precisa de escalonamento independente de serviços.

Docker Compose Modular

# Dispatcharr - Modular Deployment Configuration
# This compose file runs Dispatcharr in modular mode with separate containers
# for web, celery workers, PostgreSQL database, and Redis cache.

services:
  # ============================================================================
  # Web Service
  # ============================================================================
  web:
    image: ghcr.io/dispatcharr/dispatcharr:latest
    container_name: dispatcharr_web
    restart: unless-stopped
    ports:
      - 9191:9191
    volumes:
      - ./data:/data
      #- ./certs:/certs:ro  # TLS certificates (optional)
    depends_on:
      db:
        condition: service_healthy
      redis:
        condition: service_healthy
    extra_hosts:
      - "host.docker.internal:host-gateway"

    # --- Environment Configuration ---
    environment:
      # Deployment Mode
      - DISPATCHARR_ENV=modular

      # PostgreSQL Connection
      - POSTGRES_HOST=db
      - POSTGRES_PORT=5432
      - POSTGRES_DB=dispatcharr
      - POSTGRES_USER=dispatch
      - POSTGRES_PASSWORD=secret
      # PostgreSQL TLS (optional) — mount certs via the volume above
      #- POSTGRES_SSL=true                             # required to enable TLS
      #- POSTGRES_SSL_MODE=verify-full                 # optional: verify-full (default) | verify-ca | require
      #- POSTGRES_SSL_CA_CERT=/certs/postgres/ca.crt   # optional: CA cert to verify the server
      #- POSTGRES_SSL_CERT=/certs/postgres/client.crt  # optional: client cert (only if server requires client auth)
      #- POSTGRES_SSL_KEY=/certs/postgres/client.key   # optional: client key  (only if server requires client auth)

      # Redis Connection
      - REDIS_HOST=redis
      - REDIS_PORT=6379
      # Redis Authentication (Optional)
      # Uncomment and set if your Redis requires authentication:
      #- REDIS_PASSWORD=your_strong_redis_password
      #- REDIS_USER=your_redis_username  # For Redis 6+ ACL - see Redis service below
      # Redis TLS (optional) — mount certs via the volume above
      #- REDIS_SSL=true                                # required to enable TLS
      #- REDIS_SSL_VERIFY=true                         # optional: set false for self-signed certs without a CA
      #- REDIS_SSL_CA_CERT=/certs/redis/ca.crt         # optional: CA cert to verify the server
      #- REDIS_SSL_CERT=/certs/redis/client.crt        # optional: client cert (only if server requires client auth)
      #- REDIS_SSL_KEY=/certs/redis/client.key         # optional: client key  (only if server requires client auth)

      # Logging
      - DISPATCHARR_LOG_LEVEL=info

      # Legacy CPU Support (Optional)
      # Uncomment to enable legacy NumPy build for older CPUs (circa 2009)
      # that lack support for newer baseline CPU features:
      #- USE_LEGACY_NUMPY=true

      # Process Priority Configuration (Optional)
      # Lower values = higher priority. Range: -20 (highest) to 19 (lowest)
      # Negative values require cap_add: SYS_NICE (see below)
      #- UWSGI_NICE_LEVEL=-5   # uWSGI/FFmpeg/Streaming (default: 0, recommended: -5 for high priority)

    # --- Advanced Configuration ---
    # Uncomment to enable high priority for streaming (required if UWSGI_NICE_LEVEL < 0)
    #cap_add:
    #  - SYS_NICE

    # --- Hardware Acceleration (Optional) ---
    # Uncomment for GPU access (transcoding acceleration)
    #group_add:
    #  - video
    #  #- render  # Uncomment if your GPU requires it
    #devices:
    #  - /dev/dri:/dev/dri  # For Intel/AMD GPU acceleration (VA-API)

    # NVIDIA GPU Support (requires NVIDIA Container Toolkit)
    # Uncomment the following lines for NVIDIA GPU support
    #deploy:
    #  resources:
    #    reservations:
    #      devices:
    #        - driver: nvidia
    #          count: all
    #          capabilities: [gpu]

  # ============================================================================
  # Celery Service - Background task worker
  # ============================================================================
  celery:
    image: ghcr.io/dispatcharr/dispatcharr:latest
    container_name: dispatcharr_celery
    restart: unless-stopped
    depends_on:
      db:
        condition: service_healthy
      redis:
        condition: service_healthy
      web:
        condition: service_started
    volumes:
      - ./data:/data
      #- ./certs:/certs:ro  # TLS certificates (optional)
    extra_hosts:
      - "host.docker.internal:host-gateway"
    entrypoint: ["/app/docker/entrypoint.celery.sh"]

    # --- Environment Configuration ---
    environment:
      # Deployment Mode
      - DISPATCHARR_ENV=modular

      # Internal Service Communication
      # Celery uses these to reach the web container for DVR recording.
      # DISPATCHARR_PORT must match the port exposed by the web service.
      # DISPATCHARR_WEB_HOST defaults to "web" (the service name above).
      # Only set DISPATCHARR_WEB_HOST if you rename the web service in this file.
      - DISPATCHARR_PORT=9191
      #- DISPATCHARR_WEB_HOST=web

      # PostgreSQL — must match web service settings
      - POSTGRES_HOST=db
      - POSTGRES_PORT=5432
      - POSTGRES_DB=dispatcharr
      - POSTGRES_USER=dispatch
      - POSTGRES_PASSWORD=secret
      # PostgreSQL TLS — must match web service
      #- POSTGRES_SSL=true
      #- POSTGRES_SSL_MODE=verify-full
      #- POSTGRES_SSL_CA_CERT=/certs/postgres/ca.crt
      #- POSTGRES_SSL_CERT=/certs/postgres/client.crt
      #- POSTGRES_SSL_KEY=/certs/postgres/client.key

      # Redis — must match web service settings
      - REDIS_HOST=redis
      - REDIS_PORT=6379
      #- REDIS_PASSWORD=your_strong_redis_password
      #- REDIS_USER=your_redis_username
      # Redis TLS — must match web service
      #- REDIS_SSL=true
      #- REDIS_SSL_VERIFY=true
      #- REDIS_SSL_CA_CERT=/certs/redis/ca.crt
      #- REDIS_SSL_CERT=/certs/redis/client.crt
      #- REDIS_SSL_KEY=/certs/redis/client.key

      # Logging
      - DISPATCHARR_LOG_LEVEL=info

      # Process Priority Configuration (Optional)
      #- CELERY_NICE_LEVEL=5  # Celery/EPG/Background tasks (default: 5, low priority; Range: -20 to 19)

      # Legacy CPU Support (Optional)
      # Uncomment to enable legacy NumPy build for older CPUs (circa 2009)
      # that lack support for newer baseline CPU features:
      #- USE_LEGACY_NUMPY=true

      # Django Configuration
      - DJANGO_SETTINGS_MODULE=dispatcharr.settings
      - PYTHONUNBUFFERED=1

    # --- Advanced Configuration ---
    # Uncomment to enable high priority for Celery (required if CELERY_NICE_LEVEL < 0)
    #cap_add:
    #  - SYS_NICE

  # ============================================================================
  # PostgreSQL
  # ============================================================================
  db:
    image: postgres:17
    container_name: dispatcharr_db
    restart: unless-stopped
    ports:
      - "5436:5432"
    environment:
      - POSTGRES_DB=dispatcharr
      - POSTGRES_USER=dispatch
      - POSTGRES_PASSWORD=secret
    volumes:
      - postgres_data:/var/lib/postgresql/data
    healthcheck:
      test: ["CMD-SHELL", "pg_isready -U dispatch -d dispatcharr"]
      interval: 5s
      timeout: 5s
      retries: 5

  # ============================================================================
  # Redis
  # ============================================================================
  redis:
    image: redis:latest
    container_name: dispatcharr_redis
    restart: unless-stopped

    # --- Authentication Configuration (Optional) ---
    # By default, Redis runs without authentication.
    # Choose ONE of the following options if authentication is required:

    # Option 1: Password-only authentication (Redis <6 or default user)
    #command: ["redis-server", "--requirepass", "your_strong_redis_password"]

    # Option 2: Redis 6+ ACL with username + password (requires custom config file - see Redis documentation for configuration)
    #command: ["redis-server", "/etc/redis/redis.conf"]
    #volumes:
    #  - ./redis.conf:/etc/redis/redis.conf:ro

    # --- Health Check Configuration ---
    healthcheck:
      # Default: No authentication
      test: ["CMD", "redis-cli", "ping"]

      # If using Option 1 (password-only), uncomment this instead:
      #test: ["CMD", "redis-cli", "-a", "your_strong_redis_password", "ping"]

      # If using Option 2 (Redis 6+ ACL), uncomment this instead:
      #test: ["CMD", "redis-cli", "--user", "your_redis_username", "-a", "your_strong_redis_password", "ping"]

      interval: 5s
      timeout: 5s
      retries: 5

# ==============================================================================
# Volumes
# ==============================================================================
volumes:
  postgres_data:

Principais Diferenças do AIO

• DISPATCHARR_ENV=modular substitui DISPATCHARR_ENV=aio
• PostgreSQL e Redis são executados como contêineres separados com suas próprias verificações de saúde
• O worker Celery é executado em um contêiner dedicado com seu próprio entrypoint
• As variáveis de ambiente para PostgreSQL e Redis devem corresponder entre os serviços web e celery
• A criptografia TLS para conexões de banco de dados está disponível apenas no modo modular

Configuração TLS

Implantações modulares suportam criptografia TLS para conexões entre o Dispatcharr e serviços externos de Redis/PostgreSQL. Consulte Segurança de Conexão na seção Avançado para detalhes de configuração.

---

Acessando o Dispatcharr

Abra seu navegador e acesse:

http://localhost:9191

Substitua localhost pelo endereço IP do seu servidor se estiver acessando remotamente.