Skip to main content

Lineup

The lineup is the file ersatztv runs: ersatztv <lineup.json>. It sets the HTTP server, where channels write their HLS output, and which channels exist. ersatztv add-lineup creates one, and ersatztv add-channel adds channels to it.

  • A relative path is relative to the lineup file.
  • version is the format version of the file. See Config Versions.
  • For validation and completion in an editor such as VS Code, set $schema to the JSON schema, https://ersatztv.org/schema/lineup/0.0.1.json. ErsatzTV Next ignores $schema.
  • Since is the first lineup version with the property. A property marked unreleased is on main and not in a release yet.
{
  "version": "https://ersatztv.org/lineup/version/0.0.1",
  "output": { "folder": "./hls" },
  "channels": [
    { "number": "1", "name": "Channel 1", "config": "./channels/1/channel.json" }
  ]
}

Top level​

Server settings: where to listen, where to write HLS output, and which channels to serve.

channelsRequired
array of ChannelSince 0.0.0

The channels to serve, in playlist order.

outputRequired
OutputSince 0.0.0

Where channels write their HLS output.

server
ServerSince 0.0.0

HTTP server settings.

Default value
{
  "bind_address": "0.0.0.0",
  "port": 8409
}
version
stringSince 0.0.1

Schema version URI, e.g. "https://ersatztv.org/lineup/version/0.0.1"; missing is 0.0.0.

xmltv
XMLTVSince 0.0.0

Where to find guide data for /xmltv.xml. Unset serves channels without programmes.

Server​

server
bind_address
stringDefault: "0.0.0.0"Since 0.0.0

IP address to listen on. 0.0.0.0 listens on all IPv4 interfaces.

port
integerDefault: 8409Since 0.0.0

TCP port to listen on.

Output​

output
folderRequired
stringSince 0.0.0

Folder for HLS output. Each channel writes to a subfolder named after its number. A relative path is relative to the lineup file.

XMLTV​

xmltv
folderRequired
stringSince 0.0.0

Folder of per-channel guide files named {tvg_id}.xml. Their programme elements are copied into /xmltv.xml; a missing file is skipped. A relative path is relative to the lineup file.

Channel​

channels[]

Each channel's settings are in its own channel.json.

configRequired
stringSince 0.0.0

Path to the channel's channel.json. A relative path is relative to the lineup file.

group
stringSince 0.0.0

Channel group in the M3U playlist (/channels.m3u), sent as group-title. Not used in the XMLTV guide.

logo
stringSince 0.0.0

Logo URL, sent as tvg-logo in the playlist and icon in the guide.

nameRequired
stringSince 0.0.0

Channel name shown in the M3U playlist and XMLTV guide.

numberRequired
stringSince 0.0.0

Channel number, e.g. 1 or 2.1. Used in URLs (/channel/{number}.m3u8) and as the name of the channel's output subfolder, so it must be unique.

overlays
array of stringSince 0.0.0

Paths to channel config overlays, merged over config in order. An overlay value replaces the base value, and null removes the key. Each overlay must carry its own version. A relative path is relative to the lineup file.

tvg_id
stringSince 0.0.0

Guide ID that links the playlist entry to its XMLTV channel and names its guide file. Unset is ersatztv.{number}.