Skip to content

EPGs

EPGs (Electronic Program Guides) define collections of TV program schedules from XML sources. Each EPG can contain multiple sources.

YAML Structure

epgs:
  - name: ""
    sources: []
    proxy: {}
    skip_on_error: false

Fields

Field Type Required Description
name string Yes Unique name identifier for this EPG
sources []string Yes List of EPG sources (URLs or file paths, XML or .gz).
proxy Proxy No EPG-specific proxy overrides. For EPGs only the http_client settings (cache, headers) take effect — they apply to fetching the guide sources.
skip_on_error bool No When true, a failing source is skipped instead of aborting the response. Default false. See Skip Failing Sources.

Examples

Basic EPG

epgs:
  - name: tv-guide
    sources:
      - "https://provider.com/guide.xml"

Multi-Source EPG

epgs:
  - name: combined-guide
    sources:
      - "https://provider-1.com/epg.xml.gz"
      - "https://provider-2.com/schedule.xml"
      - "/local/custom-guide.xml"

EPG with Proxy

epgs:
  - name: international-guide
    sources:
      - "https://international-provider.com/epg.xml"
    proxy:
      enabled: true

Skip Failing Sources

When skip_on_error: true is set, an upstream EPG source that errors out (network failure, non-2xx status, decode error) is logged and skipped instead of aborting the whole response. Useful for non-priority or free EPG providers. Any channels/programmes read before a mid-stream failure are kept; the rest of that source is dropped. If all sources fail, the request still errors out with no data in subscriptions.

epgs:
  - name: combined-guide
    sources:
      - "https://reliable-provider.com/epg.xml"
      - "https://flaky-provider.com/epg.xml"
    skip_on_error: true