0xcaff/flood

Flood镜像说明

镜像概述

Flood是rTorrent的现代Web界面，通过Node.js服务器实现与rTorrent API的通信、历史数据存储，并提供React前端的Web UI。它持续迭代开发，新功能定期更新。

核心功能

• 与rTorrent API交互，管理下载任务的添加、删除、暂停等操作
• 存储下载历史数据，支持任务状态追踪
• 基于JWT的用户认证机制，保障访问安全
• 响应式界面设计，适配桌面与移动设备
• 支持SCGI协议（主机端口或本地socket）连接rTorrent

使用场景

• 个人用户通过Web界面管理本地/远程rTorrent下载任务
• 小团队共享rTorrent下载管理入口
• 需要替代rTorrent命令行操作的可视化需求场景

配置说明

前提条件

1. 已安装带XMLRPC配置的rTorrent（若已使用其他rTorrent Web UI则已满足）
2. Node.js版本7.x.x及以上
3. 安装node-gyp：sudo npm install -g node-gyp（需满足gcc、make、python2等依赖）

基础配置

1. 复制config.template.js到config.js（必需步骤）
2. 在config.js中设置rTorrent SCGI参数：
   • 主机端口模式：填写scgi.host和scgi.port（默认localhost:5000）
   • Socket模式：设置scgi.socket=true并填写scgi.socketPath
3. 设置唯一的JWT密钥（secret字段）
4. 若代理到非根路径，配置baseURI（如/apps/flood）

Docker部署示例

构建镜像

bash
docker build -t rtorrent-flood .

运行容器（主机端口连接）

bash
docker run --name docker.xuanyuan.run/rtorrent-flood \
  -e RTORRENT_SCGI_HOST=192.168.1.100 \
  -e RTORRENT_SCGI_PORT=5000 \
  -e FLOOD_SECRET=your_unique_secret \
  -p 3000:3000 \
  -v ./data:/data \
  docker.xuanyuan.run/rtorrent-flood

运行容器（Socket连接）

bash
docker run --name docker.xuanyuan.run/rtorrent-flood \
  -e RTORRENT_SOCK=true \
  -e RTORRENT_SCGI_HOST=/data/rtorrent.sock \
  -e FLOOD_SECRET=your_unique_secret \
  -p 3000:3000 \
  -v ./rtorrent_socket:/data \
  docker.xuanyuan.run/rtorrent-flood

支持的环境变量

• FLOOD_BASE_URI：代理路径前缀
• FLOOD_SECRET：JWT认证密钥
• RTORRENT_SCGI_HOST：SCGI主机或socket路径
• RTORRENT_SCGI_PORT：SCGI端口（主机模式）
• RTORRENT_SOCK：是否启用socket连接（true/false）
• FLOOD_ENABLE_SSL：启用SSL（需挂载/data/flood_ssl.key和/data/flood_ssl.cert）

容器卷/data用于存储数据库文件和SSL证书（若启用）。