Skip to Content
Flood

Flood

Modern web UI for monitoring and managing your torrent clients

Flood is a sleek, modern web interface for monitoring and managing various torrent clients. Built as a Node.js service, Flood communicates with your favorite torrent client and serves a beautiful, responsive web UI for administration—perfect for users who want a unified dashboard across multiple download clients.

Modern Interface

Beautiful, responsive web UI that works seamlessly across all devices

Multi-Client Support

Works with Deluge, qBittorrent, rTorrent, and Transmission

Real-Time Monitoring

Live torrent status, speeds, and progress tracking

Secure Access

nginx reverse proxy with user-scoped paths

Torrent Client Required
Info

Flood is a monitoring interface, not a torrent client itself. You must have at least one torrent client installed — Deluge, qBittorrent, rTorrent, TransmissionTorrent client required — for Flood to connect to.


Installation

Install at least one supported torrent client (Deluge, qBittorrent, rTorrent, or Transmission) before Flood — Flood is a monitoring interface and needs a client to connect to.

Install from the Dashboard

Open App Dashboard → Package Management (/dashboard?mode=packages), find Flood in the catalog (browse Download Clients or search), and click Install. The dashboard streams the install log live and Flood appears in your Application Control panel when it finishes. Reinstall and Remove are in the same Package Management panel. To update, use the amber Update badge on the Flood row in the App Dashboard.

What you see and can manage is gated by your account: admins manage any user’s apps; regular users manage their own. For the full package flow see App Management.

Install from the CLI (automation)

The CLI runs the same install and is suited to automation and scripting:

bash
qb install flood -u username
CommandDescription
qb install flood -u username
Install Flood for the specified user
qb reinstall flood -u username
Reinstall Flood while preserving configuration
qb remove flood -u username
Remove Flood and clean up all files
qb update flood -u username
Update Flood to the latest version

CLI Options

OptionDescription
-u, --usernameRequired

Target QuickBox username for install/remove/update operations


Directory Layout

Path
Description
/home/username/.config/Flood
db/
Flood database and settings storage

Per-User Binary Isolation

QuickBox Pro uses a per-user binary architecture for Flood, providing true isolation between users:

/usr/local/bin/username/flood

Each user gets their own independent Flood binary in /usr/local/bin/username/. This means:

  • Independent Updates: Updating one user’s Flood doesn’t affect other users
  • Version Flexibility: Different users can run different Flood versions if needed
  • Enhanced Security: Binaries are owned by the respective user, preventing unauthorized modifications
  • Service Isolation: systemd services are configured to run user-specific binaries with security sandboxing
Multi-User Benefits
Tip

This architecture is especially valuable on shared servers where administrators need to test updates with one user before rolling them out system-wide, or when different users have different stability requirements.


Network & Access

Flood runs on an auto-assigned port (default starting at 3001) and is accessible through the nginx reverse proxy:

https://yourserver.com/username/flood/ 

The first time you access Flood, you’ll be prompted to configure your torrent client connection.


Services

Flood uses a templated systemd unit (flood@.service) for per-user isolation with enhanced security:

bash
# Check status
systemctl status flood@username
 
# View logs
journalctl -u flood@username -f
 
# Restart service
systemctl restart flood@username

Security Hardening

Each Flood service runs with systemd security features enabled:

  • NoNewPrivileges: Prevents privilege escalation
  • PrivateTmp: Isolated /tmp directory per service
  • LimitNOFILE=65536: Increased file descriptor limit for torrent operations
  • User-specific binary: Each service runs its own binary from /usr/local/bin/username/flood
Service Isolation
Info

Each user runs their own Flood binary with process isolation through systemd. The per-user binary architecture means updates to one user’s instance won’t affect others.


Integrations

Supported Torrent Clients

Flood can connect to and manage these torrent clients.


Configuration

On first access, Flood will prompt you to configure your torrent client connection. Use the QuickBox-specific connection details below for each client.

rTorrent

SettingValue
ClientrTorrent
Connection TypeSocket
Socket Path/var/run/username/.rtorrent.sockUse the shim socket

rTorrent SCGI shim (Flood + ruTorrent)

What the shim does
Info
  • Binds the public socket /var/run/username/.rtorrent.sock and forwards to rTorrent’s real socket /var/run/username/.rtorrent-real.sock.
  • Forces Flood to fall back to XML-RPC by blocking JSON probes, which keeps torrent uploads working (watch dirs) across rTorrent/libtorrent versions.
  • Keeps ruTorrent and other clients on the same stable socket path.
Recommended versions
Success

Use rTorrent 0.16.5rTorrent 0.16.5 recommended (libtorrent 0.16.5) with the shim enabled. On current rTorrent/libtorrent builds (0.16.1+), the shim is enabled automatically. Flood should connect to /var/run/username/.rtorrent.sock, while ruTorrent is configured via .rtorrent.rc, /etc/nginx/software/username.scgi.conf, and /srv/rutorrent/conf/users/username/config.php. During installation and updates, all required configurations are automatically adjusted to route through the shim and connect to the underlying socket at /var/run/username/.rtorrent-real.sock.

Shim essentials
  • rTorrent real socket: /var/run/username/.rtorrent-real.sock (this is what is set on the .rtorrent.rc file and ruTorrent/nginx)
  • Shim socket (use this in Flood): /var/run/username/.rtorrent.sock
  • Service: rtorrent-scgi-shim@username
  • Also adds the following entries to /home/username/.rtorrent.rc (Removed during uninstall):
bash
## Load & start methods (used by watch directories)
method.insert = "load.start_throw", "simple", "load.raw_start="
method.insert = "load.throw", "simple", "load.raw="
## End load & start methods
Validate & recover
bash
systemctl status rtorrent-scgi-shim@username
ls -l /var/run/username/.rtorrent.sock /var/run/username/.rtorrent-real.sock
  • If the shim socket is missing: systemctl restart rtorrent-scgi-shim@username
  • If the real socket is missing: systemctl restart rtorrent@username
  • Always point Flood and ruTorrent at /var/run/username/.rtorrent.sock
More details
Info

For additional context on the shim and socket layout, see the rTorrent docs → Unix Socket Communication.

qBittorrent

SettingValue
ClientqBittorrent
Connection TypeWeb API
URLhttp://127.0.0.1:PORT
UsernameYour QuickBox username
PasswordYour QuickBox password
Finding Your Port
Tip

The port used by Flood to connect to qBittorrent’s Web UI. This is the port displayed on the QuickBox App Dashboard on the qBittorrent row. You can also check your qBittorrent Web UI port in /home/username/.config/qBittorrent/qBittorrent.conf under WebUI\Port.

Deluge

SettingValue
ClientDeluge
Connection TypeDaemon
Host127.0.0.1
PortYour Deluge daemon port (check ~/.config/Deluge/core.conf)
UsernameYour QuickBox username
PasswordYour QuickBox password

Transmission

SettingValue
ClientTransmission
Connection TypeRPC
URLhttp://127.0.0.1:PORT/transmission/rpc
UsernameYour QuickBox username
PasswordYour QuickBox password
Finding Your Port
Tip

Check your Transmission RPC port in /home/username/.config/transmission-daemon/settings.json under rpc-port.

Multiple Clients
Note

You can configure Flood to connect to multiple torrent clients if you have several installed. Add each client through the Flood settings panel.


Best Practices

Do

  • Install your preferred torrent client before installing Flood.
  • Use qb update flood to keep Flood updated.
  • Monitor service health with systemctl status flood@username.

Don't

  • Do not manually edit systemd or nginx files—use qb commands.
  • Do not expose Flood directly to the internet without nginx in front.

Additional Resources

Join the Community

Media server operators sharing configs, getting support, and shaping the future of QuickBox Pro.

  • Dedicated Support
  • Feature Previews
  • Community Configs
  • Active Discussions
Join Discord Server
Last updated on