qoopido/easyepg.minimal

easyepg.minimal

轻量级Docker容器，用于按需或通过内置定时任务永久运行easyepg，支持多架构（amd64、arm32v7、arm64v8），适用于命令行环境和NAS系统的Docker GUI。

镜像概述和主要用途

easyepg.minimal是一个轻量级Docker容器，旨在简化easyepg的部署和运行。它支持两种运行模式：按需执行或通过内置定时任务（cronjob）永久运行，适用于需要定期更新EPG（电子节目指南）XML文件的场景，如与TVheadend等电视服务集成。

核心功能和特性

• 多架构支持：提供amd64、arm32v7和arm64v8架构变体，自动适配主机架构
• 灵活运行模式：支持admin（配置）、run（单次运行）和cron（定时任务）三种模式
• 内置定时任务：cron模式下默认每日2:00运行easyepg，可自定义执行频率
• 用户权限控制：可配置运行用户ID（UID）和组ID（GID），增强安全性
• 时区设置：支持自定义时区，确保定时任务时间准确
• 自动更新：启动时可自动更新easyepg至指定仓库和分支版本
• 数据持久化：通过卷挂载实现easyepg配置和XML文件的持久化存储

使用场景和适用范围

• 命令行环境：适用于直接运行TVheadend的专用主机，需要通过Docker部署easyepg的用户
• NAS系统：支持Synology、UnRaid、OpenMediaVault等带Docker GUI的NAS系统
• EPG自动更新：需要定期生成和更新EPG XML文件，并可能自动推送至TVheadend等服务

使用方法和配置说明

手动安装（命令行用户）

本部分适用于直接运行TVheadend的专用主机用户，不适用于NAS系统的Docker GUI用户（详见Docker GUI技术信息）。

前提条件

• 系统已安装Docker
• 运行容器的用户已加入docker用户组

安装步骤

切换到要运行容器的用户，执行以下命令启动安装：

bash
sh -c "$(curl -s -H 'Cache-Control: no-cache' https://raw.githubusercontent.com/dlueth/easyepg.minimal/master/init)"

注意：镜像为多架构构建，会自动拉取与主机架构匹配的变体（amd64、arm32v7或arm64v8）。

注意：若init脚本检测到有效的xmltv.sock，会默认设置为"yes"并自动提供路径；否则默认设置为"no"。

初始配置

切换到运行容器的用户，启动并进入admin容器进行easyepg配置：

bash
docker start easyepg.admin
docker exec -ti -u easyepg -w /easyepg easyepg.admin /bin/bash ./epg.sh

完成配置后，输入exit退出容器，然后执行docker stop easyepg.admin停止admin容器。

注意：若以root用户运行init脚本，容器将没有easyepg用户，需从上述命令中移除-u easyepg参数。出于安全考虑，不建议以root用户运行。

更新EPG XML文件

方式A：容器内置定时任务

以目标用户登录，执行以下命令启动cron容器：

bash
docker start easyepg.cron

容器内已配置默认定时任务，每日2:00运行easyepg。

方式B：主机定时任务

注意：若已选择方式A（如在NAS上运行），请跳过本部分。

以目标用户登录，执行以下命令编辑crontab：

bash
crontab -e

在打开的文件中添加以下行：

bash
0 2 * * * docker start easyepg.run

若安装时未设置xmltv.sock路径，可能需要额外添加以下两行（替换[your file]为生成的XML文件名）：

bash
0 4 * * * cat ~/easyepg/xml/[your file].xml | socat - UNIX-CONNECT:/home/hts/.hts/tvheadend/epggrab/xmltv.sock
10 4 * * * cat ~/easyepg/xml/[your file].xml | socat - UNIX-CONNECT:/home/hts/.hts/tvheadend/epggrab/xmltv.sock

保存并退出文件即可。

Docker GUI技术信息（例如 Synology、UnRaid、OpenMediaVault）

以下是手动启动容器的示例及可用参数说明，适用于Docker GUI用户：

bash
docker run \
  -d \
  -e MODE="admin" \
  -e USER_ID="1099" \
  -e GROUP_ID="1099" \
  -e TIMEZONE="Europe/Berlin" \
  -e FREQUENCY="0 2 * * *" \
  -e UPDATE="yes" \
  -e REPO="sunsettrack4" \
  -e BRANCH="master" \
  -v {EASYEPG_STORAGE}:/easyepg \
  -v {XML_STORAGE}:/easyepg/xml \
  -v {XMLTV_SOCKET}:/xmltv.sock \
  --name=easyepg \
  --restart unless-stopped \
  --tmpfs /tmp \
  --tmpfs /var/log \
  qoopido/easyepg.minimal:latest

参数说明

常用卷说明

注意：传递卷时，需将包含花括号的名称替换为具有正确权限的绝对路径。若移除XML_STORAGE，生成的XML文件将位于EASYEPG_STORAGE的xml子目录中。

注意：XML_STORAGE可用于将生成的XML文件直接写入单独运行的TVheadend Docker容器的目录。

定时任务语法

 ┌───────────── 分钟 (0 - 59)
 │ ┌───────────── 小时 (0 - 23)
 │ │ ┌───────────── 日 (1 - 31)
 │ │ │ ┌───────────── 月 (1 - 12)
 │ │ │ │ ┌───────────── 星期 (0 - 6) (星期日至星期六；部分系统中7也表示星期日)
 │ │ │ │ │
 │ │ │ │ │
 * * * * *  /要执行的命令