jeanfabrice/flexget

Flexget Docker镜像文档

1. 镜像概述

Flexget Docker镜像是Flexget工具的容器化版本，旨在为家庭用户提供便捷的自动化下载任务管理解决方案。通过容器化部署，简化了依赖配置流程，确保Flexget在隔离环境中稳定运行，适用于家庭媒体中心、个人下载管理等场景。

2. 核心功能与特性

• 多数据源支持：兼容RSS、HTML、CSV、JSON、Torrent RSS等多种内容来源，灵活对接各类资源平台。
• 自定义规则引擎：支持基于标题关键词、文件大小、发布时间、内容评分等多维度条件筛选内容，实现精准内容获取。
• 任务调度能力：内置定时任务功能，可按分钟、小时、日、周等周期自动执行下载任务，无需手动触发。
• 插件扩展系统：提供丰富插件生态，支持与Transmission、Deluge等下载工具集成，以及与Plex、Kodi等媒体中心联动。
• 配置简化：采用YAML格式配置文件，支持任务模块化定义，便于管理多场景下载需求。
• 数据持久化：通过卷挂载机制，确保配置文件、任务历史及运行状态数据在容器重启后不丢失。

3. 使用场景与适用范围

• 家庭媒体中心内容自动化：配合Plex、Emby等媒体服务器，自动获取指定类型剧集、电影资源，实现媒体库动态更新。
• 定期资源下载管理：如每周自动下载技术播客、开源软件更新包、订阅杂志等周期性内容。
• 个性化内容筛选：通过规则过滤低质量资源（如小于指定大小的文件、评分低于阈值的内容），提升下载效率。
• 多任务并行管理：同时配置多个独立任务（如电影、音乐、文档下载），实现分类化资源管理。

4. 使用方法与配置说明

4.1 基础部署（Docker Run）

通过docker run命令快速启动容器，需指定数据持久化卷及必要环境变量：

bash
docker run -d \
  --name flexget \
  --restart unless-stopped \
  -v /path/to/local/config:/config \  # 挂载配置目录（必选）
  -v /path/to/local/downloads:/data \  # 挂载下载目录（可选，根据任务配置）
  -e TZ=Asia/Shanghai \  # 设置时区（可选，默认UTC）
  -e PUID=1000 \  # 运行用户ID（可选，避免权限问题）
  -e PGID=1000 \  # 运行用户组ID（可选）
  -p 5050:5050 \  # 暴露WebUI端口（需在配置中启用webui插件）
  flexget/flexget:latest

4.2 Docker Compose配置

通过docker-compose.yml实现更便捷的服务编排，适合多容器协同场景（如与下载工具联动）：

yaml
version: '3'
services:
  flexget:
    image: flexget/flexget:latest
    container_name: flexget
    restart: unless-stopped
    volumes:
      - ./flexget/config:/config  # 本地配置目录映射
      - ./downloads:/data         # 本地下载目录映射
    environment:
      - TZ=Asia/Shanghai
      - PUID=1000
      - PGID=1000
    ports:
      - "5050:5050"  # WebUI端口（需配置启用）
    depends_on:
      - transmission  # 若依赖下载工具，需在此声明（示例）
  transmission:  # 可选，下载工具示例
    image: linuxserver/transmission:latest
    volumes:
      - ./transmission/config:/config
      - ./downloads:/downloads

3. 环境变量说明

4. 数据持久化配置

为避免容器重启后配置与数据丢失，需挂载以下目录：

• /config：存放Flexget配置文件（config.yml）、数据库（flexget.db）及插件数据，必须挂载。
• /data：下载任务目标目录或临时工作目录，根据任务配置挂载（如无需本地存储可忽略）。

5. 配置文件示例

Flexget核心配置文件为/config/config.yml（YAML格式），以下为基础任务配置示例：

yaml
tasks:
  # 示例1：从RSS源下载指定关键词电影
  movie_download:
    rss: https://example.com/movie_rss.xml  # RSS源地址
    accept:
      - title:
          contains: ["2024", "科幻"]  # 标题包含"2024"或"科幻"
      - quality: 1080p  # 筛选1080p画质
    download: /data/movies  # 下载目录

  # 示例2：定期清理过期临时文件
  clean_temp:
    schedule:
      - daily at 23:00  # 每日23点执行
    filesystem:
      path: /data/temp
      regexp: .*\.tmp$  # 匹配.tmp后缀文件
    delete: yes  # 删除匹配文件

6. 常用操作命令

• 启动容器：docker start flexget
• 停止容器：docker stop flexget
• 查看实时日志：docker logs -f flexget
• 验证配置文件：docker exec flexget flexget check（检查配置语法错误）
• 手动触发任务：docker exec flexget flexget execute --task movie_download（执行指定任务）
• 进入容器终端：docker exec -it flexget /bin/sh（用于修改配置文件或调试）