zap2it

This is a docker image for running daniel-widrick/zap2it-GuideScraping in an automated way.

Features

• Running of zap2it-GuideScrape.py
• Docker Compose examples
• Removal of historical xmlguide files
• Healthcheck.io integration
• Run once, or forever based on sleep time

Environment Variables Options

• CONFIGFILE: [string]
  • Location of your config file.
  • default: /data/zap2itconfig.ini
• OUTPUTFILE: [string]
  • Location where you want the output file to be placed.
  • default: /data/xmlguide.xmltv
• HEALTHCHECK_URL: [string]
  • URL to ping when starting and ending the run.
  • default: undefined
• SLEEPTIME: [int]
  • Number of seconds to sleep before running again.
  • default: undefined

Running

1. Create a zap2itconfig.ini file. Check daniel-widrick/zap2it-GuideScraping's repo for more info on that.
2. Make sure your output directory exists. I /data for example.
3. Run the thing

Only Once

docker cli

docker run
  -v $(PWD)/data:/data
  -e CONFIGFILE=/data/zap2itconfig.ini
  -e OUTPUTFILE=/data/xmlguide.xmltv
  -e HEALTHCHECK_URL=https://hc-ping.com/UUID
  --user 1000:1000
  ghcr.io/itsamenathan/zap2it:main

docker-compose.yml

version: '3'
services:
  zap2it:
    image: ghcr.io/itsamenathan/zap2it:main
    volumes:
      - ./data:/data
    environment:
      CONFIGFILE: "/data/zap2itconfig.ini"
      OUTPUTFILE: "/data/xmlguide.xmltv"
      HEALTHCHECK_URL: "https://hc-ping.com/UUID"
    user: "1000:1000"

Running Continually

The only difference is adding the SLEEPTIME variable.

docker cli

docker run
  -v $(PWD)/data:/data
  -e CONFIGFILE=/data/zap2itconfig.ini
  -e OUTPUTFILE=/data/xmlguide.xmltv
  -e HEALTHCHECK_URL=https://hc-ping.com/UUID
  -e SLEEPTIME=43200
  --user 1000:1000
  ghcr.io/itsamenathan/zap2it:main

docker-compose.yml

version: '3'
services:
  zap2it:
    image: ghcr.io/itsamenathan/zap2it:main
    volumes:
      - ./data:/data
    environment:
      CONFIGFILE: "/data/zap2itconfig.ini"
      OUTPUTFILE: "/data/xmlguide.xmltv"
      HEALTHCHECK_URL: "https://hc-ping.com/UUID"
      SLEEPTIME: 43200
    user: "1000:1000"

Running with ofelia

Ofelia can run a docker container on a schedule for you.
Check out the docker-compose.ofelia.yml for reference.