# Deploy Flood with Easypanel

URL: /templates/flood

Flood is a monitoring service for various torrent clients. It's a Node.js service that communicates with your existing torrent client (rTorrent, qBittorrent, Transmission, or Deluge) and serves a clean, modern web UI for administering and monitoring torrents.

## Installation notes

The admin account is created on the first start before Flood is reachable from outside. Log in with the ADMIN_USERNAME and ADMIN_PASSWORD shown in the Environment tab of the service, then change the password from Settings. Flood doesn't bundle a torrent client, so after logging in, go to Settings and replace the placeholder connection with the details (host, port, username/password, or RPC credentials) of your existing rTorrent, qBittorrent, Transmission, or Deluge instance. If that client runs elsewhere on your network, make sure this deployment can reach it. Flood's own configuration is stored on a persistent volume.

## Benefits

### Works With Your Existing Client

Connects to rTorrent, qBittorrent, Transmission, or Deluge, so you keep using the torrent client you already run

### Clean, Modern Web UI

A fast, responsive interface for managing torrents that's a big step up from most torrent clients' built-in web UIs

### Multi-User Support

Create separate accounts for different users, each with their own torrent client connection

## Features

### OpenAPI and Swagger UI

Exposes a full OpenAPI specification with interactive Swagger docs for building your own integrations

### Feed Automation

Set up RSS feeds and rules to automatically add matching torrents to your client

### Bandwidth and Disk Insights

Visualize transfer speed, disk usage, and torrent status at a glance from the dashboard

## Configuration

- `appServiceName` (App Service Name, required): flood

- `appServiceImage` (App Service Image, required): jesec/flood:4.16.1

- `adminUsername` (Admin Username, required): admin

## Services

- flood: app (jesec/flood:4.16.1)

## Resources

- [Website](https://flood.js.org)

- [GitHub](https://github.com/jesec/flood)

- [Documentation](https://github.com/jesec/flood/wiki)

- [Template source](https://github.com/easypanel-io/templates/tree/main/templates/flood)