# Flood •

[Flood](https://flood.js.org/) is a sleek and modern interface for managing your torrent server.

# Overview

[![Screen Shot 2025-03-07 at 23.14.16.png](https://hub.subspace.services/uploads/images/gallery/2025-03/scaled-1680-/screen-shot-2025-03-07-at-23-14-16.png)](https://hub.subspace.services/uploads/images/gallery/2025-03/screen-shot-2025-03-07-at-23-14-16.png)

[Flood](https://flood.js.org/) is a sleek and modern interface for managing your torrent server.

- Controls four common torrent servers, including official [qBittorrent](https://hub.subspace.services/books/qbittorrent "qBittorrent") support.
- Download completed torrents directly through your web browser.
- Create user accounts to share access to active and completed torrents.

# Media

## Screenshots

<p class="callout info">App v4.8.5</p>

<table border="1" id="bkmrk-" style="border-collapse: collapse; width: 100%; border-width: 1px; height: 59.6px; border-color: rgb(88, 110, 117);"><colgroup><col style="width: 33.3333%;"></col><col style="width: 33.3333%;"></col><col style="width: 33.3333%;"></col></colgroup><tbody><tr style="height: 29.8px;"><td style="border-width: 1px; height: 29.8px; border-color: rgb(88, 110, 117);">[![Screen Shot 2025-03-07 at 23.14.16.png](https://hub.subspace.services/uploads/images/gallery/2025-03/scaled-1680-/screen-shot-2025-03-07-at-23-14-16.png)](https://hub.subspace.services/uploads/images/gallery/2025-03/screen-shot-2025-03-07-at-23-14-16.png)</td><td style="border-width: 1px; height: 29.8px; border-color: rgb(88, 110, 117);">[![Screen Shot 2025-03-07 at 23.12.24.png](https://hub.subspace.services/uploads/images/gallery/2025-03/scaled-1680-/screen-shot-2025-03-07-at-23-12-24.png)](https://hub.subspace.services/uploads/images/gallery/2025-03/screen-shot-2025-03-07-at-23-12-24.png)</td><td style="border-width: 1px; height: 29.8px; border-color: rgb(88, 110, 117);">[![Screen Shot 2025-03-07 at 23.12.50.png](https://hub.subspace.services/uploads/images/gallery/2025-03/scaled-1680-/screen-shot-2025-03-07-at-23-12-50.png)](https://hub.subspace.services/uploads/images/gallery/2025-03/screen-shot-2025-03-07-at-23-12-50.png)</td></tr><tr style="height: 29.8px;"><td style="border-width: 1px; height: 29.8px; border-color: rgb(88, 110, 117);">[![Screen Shot 2025-03-07 at 23.12.43.png](https://hub.subspace.services/uploads/images/gallery/2025-03/scaled-1680-/screen-shot-2025-03-07-at-23-12-43.png)](https://hub.subspace.services/uploads/images/gallery/2025-03/screen-shot-2025-03-07-at-23-12-43.png)</td><td style="border-width: 1px; height: 29.8px; border-color: rgb(88, 110, 117);">[![Screen Shot 2025-03-07 at 23.16.37.png](https://hub.subspace.services/uploads/images/gallery/2025-03/scaled-1680-/screen-shot-2025-03-07-at-23-16-37.png)](https://hub.subspace.services/uploads/images/gallery/2025-03/screen-shot-2025-03-07-at-23-16-37.png)</td><td style="border-width: 1px; height: 29.8px; border-color: rgb(88, 110, 117);">  
</td></tr></tbody></table>

# Setup & Configuration

We need to install the service through Portainer and configure any necessary settings.

# Preparation

There are some things we need to do in preparation to install this service.

## Volumes

<details id="bkmrk-media-folders-radarr"><summary>Persistent Data</summary>

This is where the service will store its own application data and ensures we can quickly update the service image.

<p class="callout warning">Ensure your user has permissions to access the folder.</p>

</details>## Environment

<details id="bkmrk-tz-this-is-the-curre"><summary>TZ</summary>

This is the current time zone formatted using the [tz database.](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)

<p class="callout info">*For example:* America/Vancouver</p>

</details>

# Installation

Flood can be installed by following the Portainer guide for [creating a new stack](https://hub.subspace.services/books/portainer/page/creating-a-new-stack "Creating a New Stack"). Learn about [configuring a Docker stacks](https://hub.subspace.services/books/services/page/managing-services "Installing Services") and then use the following Docker Compose code to run this app:

```yaml
---
services:
  flood:
    container_name: flood
    image: jesec/flood:latest
    user: 1000:1000
    restart: unless-stopped
    command: --port 3000 --allowedpath /downloads --allowedpath /config
    environment:
      - HOME=/config
      - TZ=America/Vancouver
    volumes:
      # Persistent Data
      - /srv/flood:/config

      # Download Folders
      - /mnt/downloads/:/downloads
    ports:
      - 3000:3000
      
```

# Updating

<p class="callout success">Re-Deploy the Stack</p>

This service has been optimized for running in Docker.

This allows you to [re-deploy the stack through Portainer](https://hub.subspace.services/books/portainer/page/updating-a-stack "Updating a Stack") to download the latest updates.

# User Manual

# Development

<p class="callout info">This software is released under the [GPL-3.0 license](https://opensource.org/license/gpl-3-0). </p>

You can learn more about how to contribute to Flood through their [GitHub](https://github.com/jesec/flood/issues).

# Resources

## Official

- [Official Documentation](https://github.com/jesec/flood/wiki)
- [Official Discord](https://discord.gg/Z7yR5Uf)
- [Official GitHub Repository](https://github.com/jesec/flood)
- [Official Website](https://flood.js.org/)
- [Installation Guide](https://github.com/jesec/flood/wiki/Run-rTorrent-and-Flood-via-Docker)
- [Frequently Asked Questions](https://github.com/jesec/flood/wiki/F.A.Q.)
- [General Troubleshooting](https://github.com/jesec/flood/wiki/Troubleshooting)