discarr/docs/index.md
pyr0ball dc768a8dbb docs: add MkDocs site
14-page documentation site covering installation, quick start,
full config reference, Sonarr/Radarr/qBittorrent/Tdarr integrations,
ffmpeg/HandBrake transcoder setup, SSH transcode workers, disc format
reference, and troubleshooting.

Stack: mkdocs-material 9.x (MIT), pinned <10 to avoid 2.0 licence wall.
2026-05-27 09:45:29 -07:00

2.3 KiB

Discarr

Scan disc rips. Map titles. Queue HEVC encodes. Notify Sonarr and Radarr when done.

Discarr is a self-hosted web UI that bridges disc ripping (VIDEO_TS / BDMV / ISO) into Sonarr and Radarr. Point it at a disc directory, map each title to the right episode or movie, and it handles the encode queue and arr notification.


How it works

Disc rip (MakeMKV / HandBrake)
        │
        ▼
  Discarr web UI
  ┌─────────────────────────────┐
  │  1. Scan disc structure     │
  │  2. Map titles → arr items  │
  │  3. Queue HEVC encode       │
  │  4. Notify Sonarr / Radarr  │
  └─────────────────────────────┘
        │
        ▼
  Sonarr / Radarr import

Features

  • Disc scanning — detects VIDEO_TS, BDMV, multi-disc, and ISO structures automatically
  • IFO chapter extraction — reads DVD structure to split multi-episode discs correctly
  • Episode/movie mapping — browser UI maps disc titles to Sonarr episodes or Radarr movies
  • HEVC encode queue — dispatches ffmpeg or HandBrake jobs locally or over SSH
  • Arr notification — custom script hooks notify on import, file delete, or completion
  • qBittorrent integration — optional hook triggers a scan on torrent completion
  • Tdarr integration — optional ping to Tdarr after encode completes
  • Persistent job queue — survives restarts; jobs resume automatically
  • No npm dependencies — pure Node.js built-ins only

Requirements

Dependency Required Notes
Node.js 18+ Yes Runtime
ffmpeg + ffprobe Yes Disc scanning, encode dispatch
HandBrake CLI Recommended HEVC encoding (falls back to ffmpeg)
libdvdcss Recommended CSS-encrypted DVD decryption
libdvdread + libdvdnav Yes (DVD) DVD structure reading

License

GPL-3.0. Source on Forgejo and GitHub.