{"id":15108555,"url":"https://github.com/flood-ui/flood","last_synced_at":"2025-09-27T07:31:36.007Z","repository":{"id":30087580,"uuid":"33637217","full_name":"Flood-UI/flood","owner":"Flood-UI","description":"A web UI for rTorrent, qBittorrent and Transmission with a Node.js backend and React frontend. Migrate to v4: https://github.com/jesec/flood/wiki/Migrate-from-older-versions-of-Flood. ","archived":true,"fork":false,"pushed_at":"2021-05-30T19:05:48.000Z","size":30994,"stargazers_count":1820,"open_issues_count":170,"forks_count":173,"subscribers_count":66,"default_branch":"master","last_synced_at":"2024-04-21T16:47:05.309Z","etag":null,"topics":["nodejs","qbittorrent","react","rtorrent","transmission","webui"],"latest_commit_sha":null,"homepage":"https://flood.js.org","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Flood-UI.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-04-08T23:13:16.000Z","updated_at":"2024-04-21T05:18:59.000Z","dependencies_parsed_at":"2022-07-28T00:47:29.100Z","dependency_job_id":null,"html_url":"https://github.com/Flood-UI/flood","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Flood-UI%2Fflood","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Flood-UI%2Fflood/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Flood-UI%2Fflood/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Flood-UI%2Fflood/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Flood-UI","download_url":"https://codeload.github.com/Flood-UI/flood/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":234410124,"owners_count":18828146,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["nodejs","qbittorrent","react","rtorrent","transmission","webui"],"created_at":"2024-09-25T22:03:53.807Z","updated_at":"2025-09-27T07:31:28.387Z","avatar_url":"https://github.com/Flood-UI.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Flood ⚠️ *DEPRECATED* ⚠️ [Go here](https://github.com/jesec/flood)\n\nDevelopment has ceased in this repository, visit https://github.com/jesec/flood instead\n\n![Flood logo](flood.png)\n\n[![Travis CI build status badge](https://img.shields.io/travis/Flood-UI/flood/master.svg?style=flat-square)](https://travis-ci.org/Flood-UI/flood) [![Discord server badge](https://img.shields.io/discord/418267176873623553.svg?style=flat-square)](https://discord.gg/Z7yR5Uf)\n\nFlood is a monitoring service for [rTorrent](https://github.com/rakshasa/rtorrent). It's a Node.js service that communicates with rTorrent instances and serves a decent web UI for administration. It's a work-in-progress.\n\n#### Feedback\n\nIf you have a specific issue or bug, please file a Github issue. Please join the [Flood Discord server](https://discord.gg/Z7yR5Uf) to discuss feature requests and implementation details.\n\n# Getting started\n\n### Pre-Requisites\n\n1. [rTorrent](https://github.com/rakshasa/rtorrent) needs to be installed and running __with XMLRPC__ configuration.\n    * For Linux \u0026 OS X, check out [rTorrent's installation wiki](https://github.com/rakshasa/rtorrent/wiki/Installing#compilation-help) and/or [this third-party tutorial](https://jes.sc/kb/rTorrent+ruTorrent-Seedbox-Guide.php#Install-Dependencies). When you run `./configure`, be sure to run with the `--with-xmlrpc-c` flag.\n    * For Windows, try [this guide](https://rtwi.jmk.hu/wiki/rTorrentOnWindows).\n2. Install NodeJS version `8` or higher (you might want to manage different Node versions with [nodenv](https://github.com/nodenv/nodenv) or [nvm](https://github.com/creationix/nvm) or [n](https://github.com/tj/n)).\n3. Install `node-gyp` pre-requisites, see https://www.npmjs.com/package/node-gyp#installation, ex: `python2`, `make`, `gcc`.\n\n### Configuration\n\nCopy `config.template.js` to `config.js` and review its comments. **This is required.**\n\nWhen loading the web interface, you will be prompted to configure the connection to rtorrent. Other configuration options are handled `config.js`.\n\n**What to configure**\n\n1. Be sure to create a long and unique secret (used to sign [JWT auth tokens](https://github.com/auth0/node-jsonwebtoken)).\n3. If you are proxying requests to Flood from your own web server, configure Flood's path from the host at the `baseURI` property. All requests will be prefixed with this value.\n    * For example, if serving Flood from `https://foo.bar/apps/flood`, you would set `baseURI` to `/apps/flood`. If serving flood from `https://foo.bar`, you do not need to configure `baseURI`.\n    * [Read more about proxying requests to Flood on the Wiki](https://github.com/Flood-UI/flood/wiki/Using-Flood-behind-a-reverse-proxy), this is a common pain-point for users.\n    \n**Note**: Some of these values are baked into the static assets (like `baseURI`), so changes to this file require recompling static assets.\n\n### Compiling assets and starting the server\n\nFrom the root of the Flood directory...\n1. Run `npm install` if you haven't already or if you've pulled changes.\n2. Run `npm run build`.\n3. Run `npm start`.\n\nAccess the UI in your browser. With default settings, go to `http://localhost:3000`. You can configure the port in `config.js`.\n\n### Updating\n\nI've been bad about cutting actual releases, so check this repo for recent commits.\n\n1. To update, run `git pull` in this repository's directory.\n1. Check `config.template.js` for configuration changes that you may wish to incoporate in your `config.js`.\n1. Kill the currently running Flood server.\n1. Run `npm install` to update dependencies.\n1. Run `npm run build` to transpile and bundle static assets.\n1. Start the Flood server with `npm start`.\n\n### Troubleshooting\n\n* Ubuntu users may need to install `nodejs-legacy` (`sudo apt-get install nodejs-legacy`) for dependencies to install successfully. You can read more on [this Stack Overflow post](http://stackoverflow.com/questions/21168141/cannot-install-packages-using-node-package-manager-in-ubuntu).\n* Ask for help in the [Flood Discord server](https://discord.gg/Z7yR5Uf).\n\n### Local Development\n\n1. Run `npm install`.\n2. Run `npm run start:development:server` and `npm run start:development:client` in separate terminal instances.\n    * `npm run start:development:server` uses [nodemon](https://github.com/remy/nodemon) to watch for changes to the server-side JavaScript.\n    * `npm run start:development:client` watches for changes in the client-side source.\n3. Access the UI in your browser. Defaults to `localhost:4200`.\n\n### Environment Variables\n\n1. `DEV_SERVER_PORT`: webpackDevServer's port, used when developing Flood. Defaults to `4200`.\n1. `DEV_SERVER_HOST`: webpackDevServer's host, used when developing Flood. Defaults to `0.0.0.0`.\n1. `DEV_SERVER_HTTPS`: webpackDevServer's protocol, used when developing Flood. Defaults to `http`.\n\n### Running with Docker\n\n1. `docker build -t rtorrent-flood .`\n2. `docker run --name rtorrent-flood -e RTORRENT_SCGI_HOST=w.x.y.z -p 3000:3000 rtorrent-flood`\n3. Other supported environment variables:\n    * `FLOOD_BASE_URI`\n    * `FLOOD_SECRET`\n    * `FLOOD_ENABLE_SSL`\n\nThe docker container includes a volume at `/data`, which is where the database will be located.  Additionally, you can place your SSL files there, `/data/flood_ssl.key` and `/data/flood_ssl.cert`. Set `FLOOD_ENABLE_SSL` to `true` to enable their use if present. Additionally, a local rtorrent socket file located at `/data/rtorrent.sock` can be used if `RTORRENT_SOCK` is set to `true`. The location of the socket file can be overrided by setting `RTORRENT_SOCK_PATH` to the path of the socket.\n\nCheck out the [Wiki](https://github.com/Flood-UI/flood/wiki/Docker) for more information.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflood-ui%2Fflood","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fflood-ui%2Fflood","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflood-ui%2Fflood/lists"}