项目介绍
IPTV-API 读取订阅、按频道模板匹配并检测可用性,生成供播放器读取的结果。它适合维护固定订阅入口,检测任务的频率与并发需根据网络条件调整。
它把频道处理拆成来源读取、名称匹配、可用性检测和结果输出。模板决定需要哪些频道,别名帮助识别同一个频道的不同写法,检测结果再决定保留哪些地址。
适合已经有订阅来源,希望给家中播放器维护一个固定入口的用户。检测应先用少量频道运行,观察延迟与连续播放表现,再增加来源和计划任务;频繁测速也会占用家庭带宽。
核心功能
| 功能 | 作用与使用方式 |
|---|---|
| 来源输入 | 读取订阅列表、本地频道文件或项目支持的输入方式。 |
| 频道模板 | 按需要的频道与分组匹配结果,减少无关条目。 |
| 别名对应 | 处理 CCTV1、CCTV-1 等不同命名方式。 |
| 检测与筛选 | 按配置检测可用性与播放质量,为同一频道筛选地址。 |
| 固定结果地址 | 生成供播放器订阅的 M3U 或 TXT,后续通过更新结果维护。 |
功能示意

图 1:自制功能示意图,概括本文的使用要点。

项目信息
| 项目 | 说明 |
|---|---|
| 类型 | 项目指南 |
| 分类 | 影音与下载 |
| 项目仓库 | Guovin/iptv-api |
| 整理日期 | 2026-11-14 |
群晖 Compose 安装
空白宿主机目录会遮住镜像内置的默认配置,因此准备命令先从同一镜像复制 /iptv-api/config,然后再启动。仅首次配置为空时复制,不覆盖现有设置。
1. 创建项目目录
群晖先安装并启动 Container Manager。通过 SSH 登录后执行下列命令,只为本项目准备目录:
sudo -i
mkdir -p /volume1/docker/iptv-api /volume1/docker/iptv-api/config /volume1/docker/iptv-api/output
cd /volume1/docker/iptv-api
2. 保存完整 Compose
在 /volume1/docker/iptv-api/compose.yaml 保存下面的配置。在 Container Manager 中新建项目时,项目路径选择 /volume1/docker/iptv-api 并导入该文件;有 .env 的项目要保留它与 Compose 在同一目录。
services:
iptv-api:
image: guovern/iptv-api:latest
container_name: iptv-api
restart: unless-stopped
ports:
- 8000:8000
volumes:
- /volume1/docker/iptv-api/config:/iptv-api/config
- /volume1/docker/iptv-api/output:/iptv-api/output
environment:
APP_PORT: '8000'
TZ: Asia/Shanghai
挂载参数冒号左侧是群晖的实际目录,右侧是应用内目录。以上只挂载本项目所需的数据;若已有同类数据,请先备份再调整路径。端口冲突时只改宿主机一侧,应用内端口保持不变。
3. 检查、拉取与启动
cd /volume1/docker/iptv-api
docker compose config --quiet
docker compose pull
if [ -z "$(ls -A /volume1/docker/iptv-api/config)" ]; then
init_container=$(docker create guovern/iptv-api:latest)
docker cp "$init_container:/iptv-api/config/." /volume1/docker/iptv-api/config/
docker rm "$init_container"
fi
docker compose up -d
docker compose ps
docker compose logs --tail=100
浏览器访问 http://群晖IP:8000。群晖IP 替换为自己的 NAS 局域网地址;首次启动时先等待初始化,再检查日志。若群晖仍使用旧 Docker 套件且只有 docker-compose,将命令中的 docker compose 替换为对应命令。
首次使用与验证
修改 config 中的订阅/来源配置,先关闭不需要的搜索方式,仅保留有权使用的少量频道做一次检测。任务结束后在 output 中检查生成的 M3U,再将订阅地址导入播放器。
先保存一条测试数据或完成一次最小任务,再执行 docker compose restart,确认设置及应该持久化的数据仍在。无服务端持久化目录的纯前端工具,应通过自身导出功能保存工作结果。
常见问题
- 页面打不开:运行
docker compose ps检查状态;查看日志里的初始化错误,核对端口冲突和 DSM 防火墙。不要把容器的 IP 当作固定访问地址。 - 数据目录为空:应用内应填写 Compose 冒号右侧的目录;核对宿主机文件是否已放到对应左侧目录。
- 目录无法写入:先查看日志和目录权限,仅为对应数据目录授予镜像实际运行用户需要的权限,不对整个
/volume1设置 777。 - 拉取镜像失败:先排查 Container Manager 的仓库网络;应用自己的 HTTP 代理设置与 Docker 守护进程拉取镜像的代理设置是两件事。
更新、备份与停止
更新前保存 compose.yaml,并备份上面映射的项目数据。数据库服务应先使用自身的数据库备份,或停止整个项目后复制完整数据目录,不能只复制运行中的单个数据库文件。
cd /volume1/docker/iptv-api
docker compose pull
docker compose up -d
docker compose logs --tail=100
临时停止使用 docker compose stop,重新启动使用 docker compose start。卸载容器用 docker compose down,不要附加 -v,也不要直接删除宿主机数据目录。涉及数据库迁移的升级,先保留原镜像版本和完整备份,再安排维护窗口。