Files

Jef LeCompte ee8c32dfbb feat: support upto 15 days of listings

- change default timespan to 6
- parallize tv listing chunks

special thanks to @majortom9
https://github.com/jef/zap2xml/issues/41#issuecomment-3092418305

2025-07-19 13:33:07 -07:00

4.6 KiB

Raw Blame History

zap2xml

See zap2xml for original Perl script and guidance for the configuration file.

How to use

Retrieving your Lineup ID

Visit the Retrieving Lineup ID in the Wiki.

Node.js

npm i && npm run build && node dist/index.js

See Command line arguments for configuration options.

Docker

Tag	Description
latest	Stable zap2xml releases
nightly	HEAD zap2xml release

docker-compose

services:
  zap2xml:
    container_name: zap2xml
    image: ghcr.io/jef/zap2xml:latest
    environment:
      OUTPUT_FILE: /xmltv/xmltv.xml
    volumes:
      - ./xmltv:/xmltv
    restart: unless-stopped

See Environment variables for configuration options.

Configuration

Environment variables

Variable	Description	Type	Default
`LINEUP_ID`	Lineup ID; Read more in the Wiki	String	`USA-lineupId-DEFAULT` (Attenna)
`TIMESPAN`	Either 3 or 6 hours of shows	String	3
`PREF`	User Preferences, comma separated list. `m` for showing music, `p` for showing pay-per-view, `h` for showing HD	String	(empty)
`COUNTRY`	Country code (default: `US`)	String	US
`POSTAL_CODE`	Postal code of where shows are available.	String	30309
`USER_AGENT`	Custom user agent string for HTTP requests.	String	Uses random if not specified
`TZ`	Timezone	String	System default
`SLEEP_TIME`	Sleep time before next run in seconds (default: 10800, Only used with Docker.)	String	10800
`OUTPUT_FILE`	Output file name (default: xmltv.xml)	String	xmltv.xml

Command line arguments

Argument	Description	Type	Default
`--lineupId`	Lineup ID; Read more in the Wiki	String	`USA-lineupId-DEFAULT` (Attenna)
`--timespan`	Either 3 or 6 hours of shows	String	3
`--pref`	User Preferences, comma separated list. `m` for showing music, `p` for showing pay-per-view, `h` for showing HD	String	(empty)
`--country`	Country code (default: `US`)	String	US
`--postalCode`	Postal code of where shows are available.	String	30309
`--userAgent`	Custom user agent string for HTTP requests.	String	Uses random if not specified
`--timezone`	Timezone	String	System default
`--outputFile`	Output file name (default: xmltv.xml)	String	xmltv.xml

4.6 KiB Raw Blame History