wiserain/flexget

docker-flexget - Flexget 的 Docker 镜像文档

镜像概述与主要用途

docker-flexget 是用于运行 Flexget 的 Docker 镜像。Flexget 是一款功能强大的自动化任务管理工具，主要用于下载任务调度、RSS 源监控、Torrent 文件处理及与下载客户端（如 Transmission、Deluge）集成等场景。本镜像提供了 Flexget 的容器化部署方案，简化环境配置，预装必要依赖，便于快速启动和使用。

核心功能与特性

• 轻量级基础镜像：基于 lsiobase/alpine 构建，兼顾轻量性与安全性
• 预装插件依赖：内置多个常用插件的运行环境，包括：
  • 通知类：***
  • 工具类：cfscraper、convert_magnet、decompress
  • 下载客户端集成：transmission、deluge
  • 通信类：irc
• WebUI 安全保护：支持通过环境变量设置 WebUI 密码，保障访问安全
• 灵活扩展：支持自定义安装额外系统包（Alpine 包）和 Python 依赖，以及自定义插件

使用场景与适用范围

• 个人媒体库自动化管理：监控 RSS 源或网页内容，自动抓取并下载媒体文件（如剧集、电影）
• 下载任务调度：根据自定义规则（如文件大小、发布时间）筛选和处理下载任务
• 下载客户端集成：与 Transmission、Deluge 等下载工具联动，自动添加任务至客户端
• 通知与监控：通过 *** 等服务发送任务状态通知，实时监控下载进度

使用方法

Docker Run 命令

直接通过 docker run 快速启动容器：

bash
docker run -d \
    --name=<容器名称> \
    --restart on-failure:5 \
    -p 5050:5050 \
    -v <数据文件路径>:/data \
    -v <配置文件路径>:/config \
    -e PUID=<用户ID> \
    -e PGID=<组ID> \
    -e TZ=<时区> \
    -e FG_WEBUI_PASSWD=<WebUI密码> \
    wiserain/flexget

说明：

• <容器名称>：自定义容器名称（如 flexget-server）
• <数据文件路径>：宿主机用于存储 Flexget 数据的目录（如 /home/user/flexget/data）
• <配置文件路径>：宿主机用于存储 Flexget 配置的目录（如 /home/user/flexget/config）
• 必须设置 FG_WEBUI_PASSWD 以保障 WebUI 安全，建议使用强密码

Docker Compose 配置

通过 docker-compose.yml 管理容器（推荐用于多服务部署）：

yaml
version: "3"
services:
  flexget:
    image: wiserain/flexget
    container_name: <容器名称>
    restart: on-failure:5
    ports:
      - 5050:5050  # WebUI 端口
    volumes:
      - <数据文件路径>:/data  # 数据存储目录
      - <配置文件路径>:/config  # 配置文件目录
    environment:
      - PUID=<用户ID>          # 运行应用的用户ID
      - PGID=<组ID>            # 运行应用的组ID
      - TZ=<时区>              # 时区（如 Asia/Shanghai）
      - FG_WEBUI_PASSWD=<WebUI密码>  # WebUI 访问密码（必填）

配置说明

环境变量

容器行为可通过以下环境变量自定义：

安装额外依赖

如需安装镜像未预装的系统包（Alpine 包）或 Python 包，可通过以下两种方式：

方法 1：自定义初始化脚本

在宿主机的 <配置文件路径>/custom-cont-init.d/ 目录下创建任意名称的 bash 脚本（如 install_deps.sh），内容示例：

bash
#!/usr/bin/with-contenv bash
# 安装 Alpine 系统包（如编译依赖）
apk add -q --no-cache build-base python3-dev
# 安装 Python 包（如性能分析工具）
pip install guppy3

容器启动时会自动执行该目录下的脚本。

方法 2：通过环境变量指定

直接通过 INSTALL_APK_PKGS 和 INSTALL_PIP_PKGS 环境变量指定需安装的包，示例：

bash
# 在 docker run 中添加
-e "INSTALL_APK_PKGS=build-base python3-dev" \
-e "INSTALL_PIP_PKGS=guppy3"

自定义插件

通过 FG_PLUGINS 环境变量安装自定义插件，值为空格分隔的插件名称。当前支持的自定义插件：

• write_magnet：功能与内置 convert_magnet 类似，但性能更优，错误处理更完善，且兼容容器内预装的 libtorrent 版本。

示例：

bash
# 安装 write_magnet 插件
-e "FG_PLUGINS=write_magnet"