flood v0.1.0

Media

Flood — a modern, responsive web UI for your torrent client (Transmission, qBittorrent, Deluge or rTorrent). Deployed as a single host-networked Nomad service.

nomad-pack run flood --registry nomploy

…or one line (add registry + run)

curl -fsSL https://packs.nomploy.com/install.sh | sh -s -- flood

Needs nomad-pack on PATH. The script only adds the nomploy registry and runs this pack.

Source ↗ Project ↗ ★ 2.8k ⚑ Report an issue

2 tasks http 3000 1 volume image jesec/flood:latest tracks :latest image bumped today

Variables 8

values.hcl

Save as values.hcl, edit, then run:

nomad-pack run flood -f values.hcl --registry nomploy

# The name of the Nomad job.
job_name = "flood"

# The Nomad namespace to deploy into.
namespace = "default"

# The datacenters to deploy to.
datacenters = ["*"]

# The Flood container image. Pin a tag in production.
image = "jesec/flood:latest"

# Host port for the Flood web UI.
port = 3000

# Named volume mounted at /data.
data_volume = "flood_data"

# Placement constraints. On a nomploy cluster: attribute = "$${meta.nomploy_control_plane}", operator = "=", value = "true".
constraints = []

# The task resources.
resources = {
    cpu    = 300
    memory = 256
  }

Name	Type	Default	Description
job_name	string	"flood"	The name of the Nomad job.
namespace	string	"default"	The Nomad namespace to deploy into.
datacenters	list	["*"]	The datacenters to deploy to.
image	string	"jesec/flood:latest"	The Flood container image. Pin a tag in production.
port	number	3000	Host port for the Flood web UI.
data_volume	string	"flood_data"	Named volume mounted at /data.
constraints	list	[]	Placement constraints. On a nomploy cluster: attribute = "$${meta.nomploy_control_plane}", operator = "=", value = "true".
resources	object	{ cpu = 300 memory = 256 }	The task resources.

Back up this pack

This pack stores data in one Docker named volume: flood_data

restic

# Run on the node hosting this pack. Point restic at your repo first:
#   export RESTIC_REPOSITORY="s3:https://<account>.r2.cloudflarestorage.com/<bucket>"
#   export RESTIC_PASSWORD="<repo-password>"
#   export AWS_ACCESS_KEY_ID=<key>  AWS_SECRET_ACCESS_KEY=<secret>
restic backup \
  /var/lib/docker/volumes/flood_data/_data

rclone (sync to S3/R2)

rclone sync /var/lib/docker/volumes/flood_data/_data backup:<bucket>/flood_data

Paths assume the default Docker volume location (/var/lib/docker/volumes). Restore by stopping the job, restoring files into the same volume, and re-running the pack.

Readme

flood

Flood — a modern, responsive web UI for your torrent client. Point it at Transmission, qBittorrent, Deluge or rTorrent and get a clean dashboard with labels, feeds, per-torrent details and multi-user support — a nicer front-end than the clients' built-in UIs.

Single host-networked Nomad service with a persistent data volume.

Deploy

nomad-pack registry add nomploy https://github.com/Nomploy/nomad-packs
nomad-pack run flood --registry=nomploy

Configure

Variable	Default	Description
`port`	`3000`	Web UI port (`FLOOD_OPTION_port`).
`image`	`jesec/flood:latest`	Container image. Pin a tag in production.
`data_volume`	`flood_data`	`/data` — users and settings.
`resources`	`{ cpu = 300, memory = 256 }`	Task resources.

Needs a torrent client: connect Flood to a running client from its web UI on first login (e.g. transmission, qbittorrent or deluge). Flood does file operations itself, so it must see the same download paths as the client — run them on the same node and share the downloads volume. A prestart init task chowns the data volume to uid 1000. Pin the job with constraints.