xanderstrike/manual2

manual2 Docker镜像文档

1. 镜像概述

1.1 基本信息

• 镜像名称：manual2
• 主要用途：用于手动将torrent文件添加到下载工具的监视文件夹，实现torrent文件的手动管理与自动下载触发
• Docker Hub地址：https://hub.docker.com/repository/docker/xanderstrike/manual2

2. 核心功能与特性

2.1 核心功能

• torrent文件转发：将指定目录中的torrent文件复制或移动到目标监视文件夹，供下载工具（如Transmission、qBittorrent等）自动检测并开始下载
• 目录挂载支持：通过Docker卷挂载机制，灵活指定宿主机上的torrent源目录和目标监视文件夹

2.2 特性

• 轻量级：基于精简基础镜像构建，镜像体积小，资源占用低
• 操作简单：无需复杂配置，通过目录挂载即可快速实现功能
• 手动触发：支持按需运行，处理完成后自动退出（适合一次性任务）

3. 使用场景与适用范围

3.1 典型场景

• 个人用户手动管理下载任务：用户将获取到的torrent文件存放于本地目录，通过运行该镜像将文件自动转发至下载工具的监视文件夹，避免手动复制粘贴
• 批量添加torrent文件：需要一次性添加多个torrent文件到下载队列时，将所有文件放入源目录，通过容器批量处理
• 配合下载工具监视机制：与支持“监视文件夹”功能的下载工具配合使用，实现torrent文件的自动加载与下载

3.2 适用范围

• 支持所有基于torrent协议的下载工具（需配置监视文件夹功能）
• 适用于Linux、Windows、macOS等支持Docker的操作系统

4. 使用方法与配置说明

4.1 前置要求

• 已安装Docker引擎（推荐版本20.10+）
• 宿主机已存在：
  • 源目录：用于存放待添加的torrent文件（如/path/to/local/torrents）
  • 目标目录：下载工具的监视文件夹（如/path/to/downloader/watch）

4.2 基本使用（docker run命令）

通过docker run命令运行容器，挂载源目录和目标目录，容器将自动处理源目录中的torrent文件并转发至目标目录。

命令示例：

bash
docker run --rm \
  -v /path/to/local/torrents:/source \  # 挂载宿主机torrent源目录到容器内/source
  -v /path/to/downloader/watch:/target \  # 挂载宿主机监视目录到容器内/target
  xanderstrike/manual2

参数说明：

• --rm：容器运行完成后自动删除，避免残留容器实例
• -v /path/to/local/torrents:/source：必填，宿主机上存放待添加torrent文件的目录，容器将读取该目录下的.torrent文件
• -v /path/to/downloader/watch:/target：必填，下载工具的监视文件夹，容器将torrent文件复制/移动到该目录

4.3 Docker Compose配置

通过docker-compose.yml定义服务，适合需要重复使用或与其他服务联动的场景。

配置示例：

yaml
version: '3'
services:
  manual2:
    image: xanderstrike/manual2
    volumes:
      - /path/to/local/torrents:/source  # 宿主机torrent源目录
      - /path/to/downloader/watch:/target  # 下载工具监视目录
    # 可选：指定用户ID以匹配宿主机文件权限（如宿主机用户UID=1000）
    user: "1000:1000"

使用方式：

1. 创建docker-compose.yml文件，填入上述配置并替换实际路径
2. 执行以下命令启动容器：

   bash
   docker-compose up
   

4.4 配置参数说明

5. 注意事项

1. 文件权限：确保宿主机的源目录和目标目录对容器运行用户有读写权限（可通过chmod或--user参数调整）
2. 文件格式：仅处理扩展名为.torrent的文件，其他格式文件将被忽略
3. 操作方式：默认行为为“复制”文件（保留源目录文件），部分场景下可能为“移动”（具体以镜像实际实现为准，建议测试前备份源文件）
4. 容器生命周期：容器处理完成后会自动退出，适合作为一次性任务执行（无需后台运行）