Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/chrisbenincasa/tunarr/llms.txt

Use this file to discover all available pages before exploring further.

Tunarr automatically generates an XMLTV-formatted Electronic Program Guide (EPG) for all active channels. This guide data allows media clients — Plex, Jellyfin, Emby, Channels DVR, and others — to display program titles, descriptions, air dates, and other metadata alongside your live streams in their guide views. No manual curation is required; Tunarr builds the EPG continuously from the metadata already attached to your media.

The XMLTV Endpoint

Tunarr writes XMLTV data to a file in its data directory, but clients should always consume it through the API endpoint rather than reading the file directly:
http://<tunarr-host>:<port>/api/xmltv.xml
The full URL for your instance is available in the Tunarr web UI under Settings → HDHR / M3U. Point your client’s “guide data source” or “XMLTV URL” setting at this address to populate the program guide for all of your Tunarr channels at once.
Most clients also need your M3U playlist URL to import the channel list before guide data will map correctly. The M3U endpoint is available at the same Settings page: http://<tunarr-host>:<port>/api/channels.m3u.

What Data Tunarr Includes in the EPG

Tunarr populates the XMLTV output with program metadata sourced from your media libraries. The following fields are included when available:
XMLTV FieldSource
Program titleMedia library title metadata
Episode titleMedia library episode name
Description / plot summaryLibrary description metadata
Air date and yearLibrary air date metadata
Content ratingLibrary content rating metadata
Cast and crew creditsLibrary cast/crew metadata
GenresLibrary genre tags (written as XMLTV <category> elements)
Genre data is only included for programs that have genre metadata in the originating media source. If a program’s entry in your media server has no genres attached, the <category> tag will not be present for that program in the XMLTV output. Clients that display genre information in their guide — such as Channels DVR — will pick up these categories automatically when they are present.

Connecting a Client to the EPG

The general pattern for connecting any IPTV-capable client to Tunarr is the same: provide the M3U URL for channel discovery and the XMLTV URL for guide data. The exact settings location differs by client:
  • Plex — Add an IPTV source under Live TV & DVR settings.
  • Jellyfin — Add a Live TV tuner device with the M3U URL, then add a guide data provider with the XMLTV URL.
  • Channels DVR — Add Tunarr as an M3U source, then point the guide data source at the XMLTV URL.
  • Emby — Similar to Jellyfin; add the M3U tuner and XMLTV guide source separately.
See the Clients section for client-specific setup guides.

EPG Channel Mapping

Tunarr uses each channel’s name and number to produce stable channel identifiers in the XMLTV output. When clients import the M3U playlist and the XMLTV guide, they match channel entries using these identifiers. Changing a channel’s number or name after a client has already imported the playlist may cause the guide mapping to break; in that case, re-import the M3U in the client to re-establish the mapping.

Build docs developers (and LLMs) love