Development has ceased in this repository, visit https://github.com/jesec/flood instead
Flood is a monitoring service for 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.
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.
./configure
, be sure to run with the --with-xmlrpc-c
flag.8
or higher (you might want to manage different Node versions with nodenv or nvm or n).node-gyp
pre-requisites, see https://www.npmjs.com/package/node-gyp#installation, ex: python2
, make
, gcc
.Copy config.template.js
to config.js
and review its comments. This is required.
When loading the web interface, you will be prompted to configure the connection to rtorrent. Other configuration options are handled config.js
.
What to configure
baseURI
property. All requests will be prefixed with this value.
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
.Note: Some of these values are baked into the static assets (like baseURI
), so changes to this file require recompling static assets.
From the root of the Flood directory...
npm install
if you haven't already or if you've pulled changes.npm run build
.npm start
.Access the UI in your browser. With default settings, go to http://localhost:3000
. You can configure the port in config.js
.
I've been bad about cutting actual releases, so check this repo for recent commits.
git pull
in this repository's directory.config.template.js
for configuration changes that you may wish to incoporate in your config.js
.npm install
to update dependencies.npm run build
to transpile and bundle static assets.npm start
.nodejs-legacy
(sudo apt-get install nodejs-legacy
) for dependencies to install successfully. You can read more on this Stack Overflow post.npm install
.npm run start:development:server
and npm run start:development:client
in separate terminal instances.
npm run start:development:server
uses nodemon to watch for changes to the server-side JavaScript.npm run start:development:client
watches for changes in the client-side source.localhost:4200
.DEV_SERVER_PORT
: webpackDevServer's port, used when developing Flood. Defaults to 4200
.DEV_SERVER_HOST
: webpackDevServer's host, used when developing Flood. Defaults to 0.0.0.0
.DEV_SERVER_HTTPS
: webpackDevServer's protocol, used when developing Flood. Defaults to http
.docker build -t rtorrent-flood .
docker run --name rtorrent-flood -e RTORRENT_SCGI_HOST=w.x.y.z -p 3000:3000 rtorrent-flood
FLOOD_BASE_URI
FLOOD_SECRET
FLOOD_ENABLE_SSL
The 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.
Check out the Wiki for more information.