flood
v4.8.4
Published
A modern Web UI for various torrent clients with multi-user and multi-client support
Downloads
1,198
Maintainers
Readme
Flood
Flood is a monitoring service for various torrent clients. It's a Node.js service that communicates with your favorite torrent client and serves a decent web UI for administration. Flood-UI organization hosts related projects.
Supported Clients
| Client | Support | | --------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ | | rTorrent | :white_check_mark: (tested) | | qBittorrent v4.1+ | :white_check_mark: (tested) | | Transmission | :white_check_mark: (tested) | | Deluge v2+ | :alembic: Experimental |
Integrating with Flood
APIs are officially documented inline by the comments and types.
You can also check out:
- community documentation site
- list of unofficial client API libraries
- list of unofficial API integrations
Flood conforms to Semantic Versioning conventions.
Feedback
If you have a specific issue or bug, please file a GitHub issue. Please join the Flood Discord server to discuss feature requests and implementation details.
More Information
Check out the Wiki for more information.
Getting started
Pre-Requisites
Install Node.js runtime. Flood tracks Current
and provides support to Active LTS
as well.
- Debian, Ubuntu (
apt
/.deb
) and Enterprise Linux (yum
/dnf
/.rpm
) -based distributions users can installnodejs
from NodeSource software repository. - Windows users can use winget, Chocolatey or installer.
- macOS users can use brew or installer.
- Check Node.js website for more.
Alternatively, download a single-executable build from Releases (or rolling build from Actions). It bundles Node.js
and supports Linux
, macOS
and Windows
.
Installation
(sudo) npm install --global flood
or npx flood
Or use @jesec/flood
for cutting-edge builds.
Run
flood
or npx flood
if you installed Flood via npm
.
npm run start
if you compiled Flood from source.
Check Wiki for how to install Flood as a service.
Configuration
Flood uses a command line configuration interface.
Run flood --help
, npx flood --help
or npm run start -- --help
to get help about command line arguments.
If you want to know more about configurations, check shared/schema/Config.ts.
When Flood's builtin user management is enabled (default), you will be prompted to configure the connection to torrent client when loading the web interface.
What to configure
- If you are proxying requests to Flood from your own web server, configure Flood's path from the host at the
--baseuri
(orbaseURI
) property. All requests will be prefixed with this value.- For example, if serving Flood from
https://foo.bar/apps/flood
, you would setbaseURI
to/apps/flood
. If serving flood fromhttps://foo.bar
, you do not need to configurebaseURI
. - Read more about proxying requests to Flood in the Wiki.
- For example, if serving Flood from
- Check Wiki, especially
Security
sections.
Upgrade
Run the installation command again.
Troubleshooting
- Flood and filesystem:
- Flood server performs file operations itself. As such, Flood needs to have permissions/access to the files.
- Flood only uses the path provided by the torrent client so it needs to have the same filesystem context as the torrent client. If a file is "/path/to/a/file" to the torrent client, it has to be "/path/to/a/file" to Flood in order to get file operations working. It can't be "/mnt/some/different/path/file".
- rTorrent:
- Linux users can download the latest static executable (available for
amd64
andarm64
) from jesec/rtorrent. Alternatively, use package managers such asapt
,yum
,pacman
of the platform to install rTorrent. - macOS users can use
brew
to install rTorrent. - Compile: XMLRPC support flag (
--with-xmlrpc-c
) is required during compilation. - Certain features (sequential download, initial seeding, etc.) are not available in vanilla rTorrent.
- Linux users can download the latest static executable (available for
- Ask for help in the Flood Discord server.
Docker
docker run -it jesec/flood --help
Or jesec/flood:master
for cutting-edge builds.
To upgrade, docker pull jesec/flood
.
Note that you have to let Docker know which port should be exposed (e.g. -p 3000:3000
) and folder mapping (e.g. -v /data:/data
).
Don't forget to pay attention to flood
's arguments like --port
and --allowedpath
.
Alternatively, you can pass in environment variables instead (e.g. -e FLOOD_OPTION_port=3000
).
Checkout Run Flood (and torrent clients) in containers discussion.
Filesystem parts in Troubleshooting are especially important for containers.
Building Flood
Clone from repository
git clone https://github.com/jesec/flood.git
Compiling assets and starting the server
From the root of the Flood directory...
- Run
npm install
. - Run
npm run build
. - Run
npm start
.
Access the UI in your browser. With default settings, go to http://localhost:3000
. You can configure the port via --port
argument.
Notes
- When you use
npm run start
to execute Flood, you have to pass command line arguments after--
. For example,npm run start -- --host 0.0.0.0 --port 8080
. This applies to anynpm run
(e.g.start:development:client
).
Updating
- To update, run
git pull
in this repository's directory. - Kill the currently running Flood server.
- Run
npm install
to update dependencies. - Run
npm run build
to transpile and bundle static assets. - Start the Flood server with
npm start
.
Local Development
- Run
npm install
. - Run
npm run start:development:server
andnpm run start:development:client
in separate terminal instances.npm run start:development:server
uses ts-node-dev to watch for changes to the server-side source. Or open the folder with VS code and thenRun -> Start Debugging
. You may use a Javascript IDE to debug server codes.npm run start:development:client
watches for changes in the client-side source. Access the UI in your browser. Defaults tolocalhost:4200
. You may use browser's DevTools to debug client codes.
--help --show-hidden
shows advanced arguments.
--proxy
proxies requests from a development client to a URL of your choice (usually URL to a Flood server). It is useful when you wish to do development on the frontend but not the backend. Or when the frontend and backend are being developed on different hosts.
Environment Variables
DEV_SERVER_PORT
: webpackDevServer's port, used when developing Flood. Defaults to4200
.DEV_SERVER_HOST
: webpackDevServer's host, used when developing Flood. Defaults to0.0.0.0
.DEV_SERVER_HTTPS
: webpackDevServer's protocol, used when developing Flood. Defaults tohttp
.
Building Docker
docker build --pull --rm -f Dockerfile -t flood:latest .
docker run -it flood --help