Web UI Guide

iplayer-arr ships with a built-in web interface for managing downloads, searching BBC iPlayer, and configuring the application. All pages are accessible from the sidebar navigation.

---

Setup Wizard

The setup wizard appears automatically on first launch or whenever the API key has not been configured. It walks you through three steps: health checks (BBC iPlayer geo-availability and ffmpeg detection), Sonarr indexer setup, and Sonarr download client setup. Each step shows the exact values to copy into Sonarr so you can complete the integration without switching back and forth.

---

Dashboard

Route: /

The dashboard is the landing page after setup is complete. A health strip across the top shows geo status, ffmpeg version, the last Sonarr request timestamp, and available disk space. Below that, the active downloads section displays real-time progress for each running download via server-sent events (SSE). A pause/resume button lets you halt all downloads globally. The history section at the bottom lists completed and failed downloads with filtering by status and time range, plus sortable columns.

---

Downloads

Route: /downloads

Shows the contents of the download directory as a folder listing. Each entry displays the folder name, file count, and total size. Use this page to verify completed downloads before Sonarr imports them.

---

Search

Route: /search

Search the BBC iPlayer catalogue directly from the web UI. Results show programme thumbnails, episode information, a quality badge indicating available stream quality, and a channel badge. Each result has a download button to queue the episode immediately, bypassing Sonarr if needed.

---

Logs

Route: /logs

A real-time log viewer that streams new entries via SSE. Filter by log level (All, Info, Warn, Error) using the toggle buttons at the top. A search box lets you filter entries by text, and the pause button freezes the stream for easier reading. The clear button resets the visible log output.

---

Config

Route: /config

Displays the API key with a copy-to-clipboard button for use in Sonarr configuration. Below that, editable settings include default quality, maximum concurrent download workers, download directory path, and auto-cleanup behaviour. The page also includes Sonarr setup instructions and a button to re-run the setup wizard at any time.

---

Overrides

Route: /overrides

Per-show episode numbering overrides for programmes where BBC iPlayer metadata does not match TheTVDB or other sources that Sonarr uses. The table columns are: show name, date-based flag, force series number, series offset, episode offset, and custom name. Add overrides here when Sonarr cannot match episodes automatically due to numbering differences.

---

System

Route: /system

A system status page showing BBC iPlayer geo-availability (with a re-check button), ffmpeg version and binary path, download statistics, storage usage with a visual progress bar, Sonarr integration status, and application version/build information. Use the geo re-check button after a VPN reconnect to verify access without restarting the container.