Skip to content

Repository files navigation

Dispatcharr

Build StatusLast Commitsysvipc Required

Dispatcharr — stream dispatching and channel management.

Warning

Requires ocijail ≥ 0.6.0 (annotation support). This image needs the jail permission allow.sysvipc, applied via OCI annotations. FreeBSD quarterly ships ocijail 0.4.0, which has no annotation support — the container starts but the permission is silently dropped, so the app can crash or misbehave at runtime. Point your pkg repos at the latest branch (ocijail ≥ 0.6.0), then run with the annotation flag below. See the ocijail guide.

Port9191
Registryghcr.io/daemonless/dispatcharr
Sourcehttps://github.com/Dispatcharr/Dispatcharr
Websitehttps://dispatcharr.io/

Version Tags

TagDescriptionBest For
latestFreeBSD Port. Built from latest FreeBSD packages.Most users. Matches Linux Docker behavior.

Prerequisites

Before deploying, ensure your host environment is ready. See the Quick Start Guide for host setup instructions.

Deployment

Podman Compose

services:
dispatcharr:
image: "ghcr.io/daemonless/dispatcharr:latest"container_name: dispatcharrenvironment:
- 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"restart: unless-stopped

AppJail Director

.env:

# .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:

# appjail-director.ymloptions:
- virtualnet: ':<random> default'
- nat:
services:
dispatcharr:
name: dispatcharroptions:
- container: 'boot args:--pull'
- expose: '9191:9191 proto:tcp'oci:
user: rootenvironment:
- 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: /datavolumes:
dispatcharr:
device: '/path/to/containers/dispatcharr'

Makejail:

# Makejail
ARG tag=latest
OPTION overwrite=force
OPTION from=ghcr.io/daemonless/dispatcharr:${tag}
SET allow.sysvipc=1

Note: 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 IPv4 address assigned by the virtual network.

Podman CLI

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

AppJail

appjail oci run -Pd \
-o overwrite=force \
-o container="args:--pull" \
-o virtualnet=":<random> default" \
-o nat \
-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

Note: 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 IPv4 address assigned by the virtual network.

Ansible

- name: Deploy dispatcharrcontainers.podman.podman_container:
name: dispatcharrimage: "ghcr.io/daemonless/dispatcharr:latest"state: startedrestart_policy: alwaysenv:
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"

Access at: http://localhost:9191

Parameters

Environment Variables

VariableDefaultDescription
TZUTCTimezone (e.g. America/New_York)
POSTGRES_DBdispatcharrPostgreSQL database name (default: dispatcharr)
POSTGRES_USERdispatcharrPostgreSQL username (default: dispatcharr)
POSTGRES_PASSWORDdispatcharrPostgreSQL password (default: dispatcharr)
CELERY_NICE_LEVEL5niceness 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

PathDescription
/dataPersistent data — PostgreSQL cluster, media, backups, logos

Ports

PortProtocolDescription
9191TCPWeb 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.

Architectures: amd64 User:bsd (UID/GID via PUID/PGID, defaults to 1000:1000) Base: FreeBSD 15.1


Need help? Join our Discord community.

Releases

Packages

Contributors

Languages