jesec/flood

Flood

Flood是一个适用于多种 torrent 客户端的监控服务。它是一个 Node.js 服务，可与您喜爱的 torrent 客户端通信，并提供完善的 Web UI 进行管理。https://github.com/Flood-UI 组织托管相关项目。

支持的客户端

快速开始

前置要求

安装 Node.js 运行时。Flood 跟踪 "Current" 版本，并同时支持 "Active LTS" 版本。

• Debian、Ubuntu（apt/.deb）和 Enterprise Linux（yum/dnf/.rpm）系统用户可从 https://github.com/nodesource/distributions 软件仓库安装 nodejs。
• Windows 用户可使用 winget、Chocolatey 或安装程序。
• macOS 用户可使用 brew 或安装程序。
• 更多信息请查看 Node.js 网站。

实验性：您可以从 https://github.com/jesec/flood/releases 下载单可执行文件构建版本（或从 Actions 获取滚动构建）。它捆绑了 Node.js 并支持 Linux、macOS 和 Windows。

安装

(sudo) npm install --global flood 或 npx flood

或使用 @jesec/flood 获取前沿构建版本。

或 https://github.com/jesec/flood#Building-Flood%E3%80%82

运行

如果通过 npm 安装 Flood，则运行 flood 或 npx flood。

如果从源代码编译 Flood，则运行 npm run start。

有关如何将 Flood 安装为服务的信息，请查看 https://github.com/jesec/flood/wiki%E3%80%82

配置

Flood 使用命令行配置界面。

运行 flood --help、npx flood --help 或 npm run start -- --help 获取有关命令行参数的帮助。

如果您想了解更多关于配置的信息，请查看 https://github.com/jesec/flood/blob/master/shared/schema/Config.ts%E3%80%82

当 Flood 的内置用户管理启用时（默认），加载 Web 界面时会提示您配置与 torrent 客户端的连接。

配置要点：

1. 如果您从自己的 Web 服务器代理请求到 Flood，请在 --baseuri（或 baseURI）属性中配置 Flood 从主机的路径。所有请求都将以此值为前缀。
   • 例如，如果从 https://foo.bar/apps/flood 提供 Flood，则应将 baseURI 设置为 /apps/flood。如果从 https://foo.bar 提供 Flood，则不需要配置 baseURI。
   • 有关将请求代理到 Flood 的更多信息，请阅读 https://github.com/jesec/flood/wiki%E3%80%82
2. 查看 https://github.com/jesec/flood/wiki%EF%BC%8C%E7%89%B9%E5%88%AB%E6%98%AF "安全" 部分。

升级

再次运行安装命令即可升级。

故障排除

• Flood 与文件系统：
  • Flood 服务器自行执行文件操作。因此，Flood 需要具有文件的权限/访问权。
  • Flood 仅使用 torrent 客户端提供的路径，因此它需要与 torrent 客户端具有相同的文件系统上下文。如果文件对 torrent 客户端是 "/path/to/a/file"，则对 Flood 也必须是 "/path/to/a/file" 才能使文件操作正常工作。不能是 "/mnt/some/different/path/file"。
• rTorrent：
  • Linux 用户可以从 https://github.com/jesec/rtorrent 下载最新的静态可执行文件（适用于 amd64 和 arm64）。或者，使用平台的包管理器（如 apt、yum、pacman）安装 rTorrent。
  • macOS 用户可以使用 brew 安装 rTorrent。
  • https://github.com/rakshasa/rtorrent/wiki/Installing%EF%BC%9A%E7%BC%96%E8%AF%91%E6%9C%9F%E9%97%B4%E9%9C%80%E8%A6%81 XMLRPC 支持标志 (--with-xmlrpc-c)。
  • 某些功能（顺序下载、初始播种等）在 vanilla rTorrent 中不可用。
  • rTorrent 需要对 Flood 的临时目录 (<rundir>/temp) 中的文件具有读取访问权限，因为 Flood 通过本地文件路径将 torrents 添加到 rTorrent (https://github.com/jesec/flood/commit/96c754ddeb614b45a565e8307c9985ee85bcb7fa)%E3%80%82
• 可在 Flood *** 服务器 寻求帮助。

Docker 部署方案

# 基本运行
docker run -it -p 3000:3000 jesec/flood --help

# 带数据持久化的运行
docker run -d \
  -p 3000:3000 \
  -v /path/to/flood/data:/data \
  --name flood \
  jesec/flood \
  --port 3000 \
  --allowedpath /data

# 前沿版本
docker run -it jesec/flood:master --help

# 升级镜像
docker pull jesec/flood

注意：您需要让 Docker 知道应该暴露哪个端口（例如 -p 3000:3000）和文件夹映射（例如 -v /data:/data）。不要忘记注意 flood 的参数，如 --port 和 --allowedpath。

反馈

如果您有特定的问题或错误，请提交 https://github.com/jesec/flood/issues%E3%80%82%E8%AF%B7%E5%8A%A0%E5%85%A5 Flood *** 服务器 讨论功能请求和实现细节。

更多信息

查看 https://github.com/jesec/flood/wiki 获取更多信息。