Skip to content

Dispatcharr Dispatcharr

Description / nameInput element
Container Registry
Container Configuration Root Path
Timezone
Dispatcharr Host Port
Dispatcharr /data Path

Build Status Last Commit OCI Pulls sysvipc Required

Dispatcharr — stream dispatching and channel management.

Port 9191
Registry ghcr.io/daemonless/dispatcharr
Daemonless daemonless/dispatcharr
Source Dispatcharr/Dispatcharr
Website dispatcharr.io

Version Tags

Tag Description Best For
latest FreeBSD Port. Built from latest FreeBSD packages. Most users — recommended.

Before deploying, ensure your host environment is ready. See the Quick Start Guide for host setup instructions, including the security model for host vs. container privileges.

Deployment

services:
  dispatcharr:
    image: "ghcr.io/daemonless/dispatcharr:latest"
    container_name: dispatcharr
    environment:
      - TZ=UTC  # Timezone (e.g. America/New_York)
      - POSTGRES_DB=dispatcharr  # PostgreSQL database name (default: dispatcharr)
      - POSTGRES_USER=dispatcharr  # PostgreSQL username (default: dispatcharr)
      - POSTGRES_PASSWORD=dispatcharr  # PostgreSQL password (default: dispatcharr)
      - CELERY_NICE_LEVEL=5  # niceness for Celery workers (default: 5)
      - DISPATCHARR_PORT=  # Web UI port (default: 9191)
      - DJANGO_SECRET_KEY=<DJANGO_SECRET_KEY>  # Django secret key — auto-generated if not set, persisted to /data/secret_key
      - REDIS_HOST=  # Redis hostname (default: 127.0.0.1)
      - REDIS_PORT=  # Redis port (default: 6379)
      - DISABLE_ML_DOWNLOADS=  # Set false to enable ML channel matching (requires torch — not available in this build)
    volumes:
      - "/path/to/containers/dispatcharr:/data"
    ports:
      - "9191:9191"
    annotations:
      org.freebsd.jail.allow.sysvipc: "true"
    # always (not unless-stopped) so FreeBSD's podman rc.d auto-starts it at boot
    restart: always

Save as compose.yaml, then run podman-compose up -d.

podman run -d --name dispatcharr \
  -p 9191:9191 \
  --annotation 'org.freebsd.jail.allow.sysvipc=true' \
  -e TZ=UTC \
  -e POSTGRES_DB=dispatcharr \
  -e POSTGRES_USER=dispatcharr \
  -e POSTGRES_PASSWORD=dispatcharr \
  -e CELERY_NICE_LEVEL=5 \
  -e DISPATCHARR_PORT= \
  -e DJANGO_SECRET_KEY=<DJANGO_SECRET_KEY> \
  -e REDIS_HOST= \
  -e REDIS_PORT= \
  -e DISABLE_ML_DOWNLOADS= \
  -v /path/to/containers/dispatcharr:/data \
  ghcr.io/daemonless/dispatcharr:latest

Save as run.sh, then run sh run.sh.

- name: Deploy dispatcharr
  containers.podman.podman_container:
    name: dispatcharr
    image: "ghcr.io/daemonless/dispatcharr:latest"
    state: started
    restart_policy: always
    env:
      TZ: "UTC"
      POSTGRES_DB: "dispatcharr"
      POSTGRES_USER: "dispatcharr"
      POSTGRES_PASSWORD: "dispatcharr"
      CELERY_NICE_LEVEL: "5"
      DISPATCHARR_PORT: ""
      DJANGO_SECRET_KEY: "<DJANGO_SECRET_KEY>"
      REDIS_HOST: ""
      REDIS_PORT: ""
      DISABLE_ML_DOWNLOADS: ""
    ports:
      - "9191:9191"
    volumes:
      - "/path/to/containers/dispatcharr:/data"
    annotation:
      org.freebsd.jail.allow.sysvipc: "true"

Save as dispatcharr-deploy.yaml, then run ansible-playbook dispatcharr-deploy.yaml.

Warning

Exposing ports in AppJail means that your service can be reached from remote hosts. If that is not your intention, do not expose the ports and communicate with the service using the jail's IPv4 address or hostname assigned by the virtual network.

# .env

DIRECTOR_PROJECT=dispatcharr
TZ=UTC
POSTGRES_DB=dispatcharr
POSTGRES_USER=dispatcharr
POSTGRES_PASSWORD=dispatcharr
CELERY_NICE_LEVEL=5
DISPATCHARR_PORT=
DJANGO_SECRET_KEY=<DJANGO_SECRET_KEY>
REDIS_HOST=
REDIS_PORT=
DISABLE_ML_DOWNLOADS=
# appjail-director.yml

options:
  - virtualnet: ':<random> default'
  - nat:
services:
  dispatcharr:
    name: dispatcharr
    options:
      - container: 'args:--pull'
      - expose: '9191:9191 proto:tcp'
      - template: !ENV '${PWD}/template.conf'
    oci:
      user: root
      environment:
        - TZ: !ENV '${TZ}'
        - POSTGRES_DB: !ENV '${POSTGRES_DB}'
        - POSTGRES_USER: !ENV '${POSTGRES_USER}'
        - POSTGRES_PASSWORD: !ENV '${POSTGRES_PASSWORD}'
        - CELERY_NICE_LEVEL: !ENV '${CELERY_NICE_LEVEL}'
        - DISPATCHARR_PORT: !ENV '${DISPATCHARR_PORT}'
        - DJANGO_SECRET_KEY: !ENV '${DJANGO_SECRET_KEY}'
        - REDIS_HOST: !ENV '${REDIS_HOST}'
        - REDIS_PORT: !ENV '${REDIS_PORT}'
        - DISABLE_ML_DOWNLOADS: !ENV '${DISABLE_ML_DOWNLOADS}'
    volumes:
      - DISPATCHARR_DATA_PATH: /data
volumes:
  DISPATCHARR_DATA_PATH:
    device: '/path/to/containers/dispatcharr'
1
2
3
4
5
6
7
# Makejail

ARG tag=latest

OPTION container=boot
OPTION overwrite=force
OPTION from=ghcr.io/daemonless/dispatcharr:${tag}
1
2
3
4
5
6
7
# template.conf

exec.start: "/bin/sh /etc/rc"
exec.stop: "/bin/sh /etc/rc.shutdown jail"
mount.devfs
persist
allow.sysvipc

Save the files above, then run appjail-director up.

appjail oci run -Pd \
  -o overwrite=force \
  -o container="args:--pull" \
  -o virtualnet=":<random> default" \
  -o nat \
  -o template=template.conf \
  -o expose="9191:9191 proto:tcp" \
  -e TZ=UTC \
  -e POSTGRES_DB=dispatcharr \
  -e POSTGRES_USER=dispatcharr \
  -e POSTGRES_PASSWORD=dispatcharr \
  -e CELERY_NICE_LEVEL=5 \
  -e DISPATCHARR_PORT= \
  -e DJANGO_SECRET_KEY=<DJANGO_SECRET_KEY> \
  -e REDIS_HOST= \
  -e REDIS_PORT= \
  -e DISABLE_ML_DOWNLOADS= \
  -o fstab="/path/to/containers/dispatcharr /data <pseudofs>" \
  ghcr.io/daemonless/dispatcharr:latest dispatcharr

template.conf:

1
2
3
4
5
6
7
# template.conf

exec.start: "/bin/sh /etc/rc"
exec.stop: "/bin/sh /etc/rc.shutdown jail"
mount.devfs
persist
allow.sysvipc

Save the files above, then run sh run.sh.

Experimental

Bastille's OCI support is experimental. It requires buildah and shares the host network stack (inherit). Mount volumes with --volume HOST JAIL; without it, image-declared volumes are stored under ${bastille_volumesdir}/${jail}.

services:
  dispatcharr:
    name: dispatcharr
    image: "ghcr.io/daemonless/dispatcharr:latest"
    network:
      - mode: host
    environment:
      - TZ=UTC
      - POSTGRES_DB=dispatcharr
      - POSTGRES_USER=dispatcharr
      - POSTGRES_PASSWORD=dispatcharr
      - CELERY_NICE_LEVEL=5
      - DISPATCHARR_PORT=
      - DJANGO_SECRET_KEY=<DJANGO_SECRET_KEY>
      - REDIS_HOST=
      - REDIS_PORT=
      - DISABLE_ML_DOWNLOADS=
    volumes:
      - "/path/to/containers/dispatcharr:/data"

Save as bastille-compose.yml, then run bastille up.

bastille create -O \
  --env TZ=UTC \
  --env POSTGRES_DB=dispatcharr \
  --env POSTGRES_USER=dispatcharr \
  --env POSTGRES_PASSWORD=dispatcharr \
  --env CELERY_NICE_LEVEL=5 \
  --env DISPATCHARR_PORT= \
  --env DJANGO_SECRET_KEY=<DJANGO_SECRET_KEY> \
  --env REDIS_HOST= \
  --env REDIS_PORT= \
  --env DISABLE_ML_DOWNLOADS= \
  --volume /path/to/containers/dispatcharr /data \
  dispatcharr ghcr.io/daemonless/dispatcharr:latest inherit

Access at: http://localhost:9191

Interactive Configuration

Parameters

Environment Variables

Variable Default Description
TZ UTC Timezone (e.g. America/New_York)
POSTGRES_DB dispatcharr PostgreSQL database name (default: dispatcharr)
POSTGRES_USER dispatcharr PostgreSQL username (default: dispatcharr)
POSTGRES_PASSWORD dispatcharr PostgreSQL password (default: dispatcharr)
CELERY_NICE_LEVEL 5 niceness for Celery workers (default: 5)
DISPATCHARR_PORT `` Web UI port (default: 9191)
DJANGO_SECRET_KEY <DJANGO_SECRET_KEY> Django secret key — auto-generated if not set, persisted to /data/secret_key
REDIS_HOST `` Redis hostname (default: 127.0.0.1)
REDIS_PORT `` Redis port (default: 6379)
DISABLE_ML_DOWNLOADS `` Set false to enable ML channel matching (requires torch — not available in this build)

Volumes

Path Description
/data Persistent data — PostgreSQL cluster, media, backups, logos

Ports

Port Protocol Description
9191 TCP Web UI

Work in Progress: This is an all-in-one (AIO) image — PostgreSQL, Redis, Nginx, Celery, Daphne, and the Django app all run inside a single container.

First run: the container initialises a fresh PostgreSQL cluster under /data/postgres and runs Django migrations automatically. This takes a few extra seconds on first start.

PostgreSQL requires allow.sysvipc in the jail. Add the annotation to your podman run command or compose deploy block:

podman run --annotation 'org.freebsd.jail.allow.sysvipc=true' ...

DJANGO_SECRET_KEY: if not provided, a random key is auto-generated on first start and persisted to /data/secret_key. Set it explicitly if you need a stable key across container recreations.

AI channel matching (torch / sentence-transformers) is not available in this build — PyTorch exists in FreeBSD ports but Python 3.13 support is not yet available (FreeBSD bug #285957, expected ~2027). The rest of Dispatcharr is fully functional.

Implementation Details

  • Architectures: amd64
  • User: bsd (UID/GID set via PUID/PGID). Defaults to 1000:1000.
  • Base: Built on ghcr.io/daemonless/base (FreeBSD 15.1).
  • sysvipc: Requires --annotation 'org.freebsd.jail.allow.sysvipc=true' (ocijail 0.5.0+)

Need help? Join our Discord community.