Flood is another web interface for rtorrent. It implements a Node.js server for communicating with the rTorrent API, storing historical data, and serving the web UI.
It's a work-in-progress, and it might not have all of the features you want (yet). However, new features are added frequently. Feel free to file an issue and I'll try to prioritize your feature requests.
If you have a specific issue or bug, please file a Github issue. If you want to participate in discussions about Flood's future, please join the Flood Slack team (get an instant invite first).
- rTorrent needs to be installed with XMLRPC configuration. If you are currently using a web UI for rTorrent, you've already done this.
- For Linux & OS X, check out rTorrent's installation wiki and/or this third-party tutorial. When you run
./configure
, be sure to run with the--with-xmlrpc-c
flag. - For Windows, try this guide (I haven't tested this, let me know if you have problems).
- Install NodeJS version
7.x.x
or higher:
- Copy
config.template.js
toconfig.js
. This is required. - Set your rTorrent SCGI hostname and port in
config.js
. Defaults arelocalhost
and5000
.
- If you want to use a socket, change
socket
to true and setsocketPath
to the absolute file path of your rTorrent socket. Make sure Flood has read/write access. Specify the socket path in.rtorrent.rc
. Example:scgi_local = /Users/flood/rtorrent.sock
- If you wish to access an rTorrent instance running on a separate host from Flood (or in a Docker container), allow for incoming connections from external IPs by setting the host in
scgi_port
to0.0.0.0
in.rtorrent.rc
. Example:scgi_port = 0.0.0.0:5000
- Create a long, unique secret (used to sign JWT auth tokens) in
config.js
. - If you're proxying Flood to a path other than the root of the host, you must specify the
baseURI
inconfig.js
. All request URIs will be prefixed with this value.
- For example, if hosting Flood from
https://foo.bar/apps/flood
, you would setbaseURI
to/apps/flood
. If hosting flood fromhttps://foo.bar
, you do not need to configurebaseURI
.
- Run
npm install
. - Run
npm run build
. - Run
npm start
. - Access the UI in your browser. Defaults to
localhost:3000
.
- You may change the default port in
config.js
.
- Upon loading the UI the first time, you will be prompted to create a user account.
- To update, run
git pull
in this repository's directory. - Check
config.template.js
for configuration changes that you may wish to incoporate in yourconfig.js
. - Kill the running Node server.
- Run
npm install
to update dependencies. - Run
npm run build
to transpile and bundle static assets. - Restart it with
npm start
.
- I run the web server with
screen
to keep the web server running independently of the terminal session. - 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.
- Run
npm install
. - Run
npm run start:development:server
andnpm 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.
- Access the UI through the WebpackDevServer. It expects to proxy requests to the Flood server you have running, defined in
config.js
asfloodServerProxy
.
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
.
docker build -t rtorrent-flood .
docker run --name rtorrent-flood -e RTORRENT_SCGI_HOST=w.x.y.z -p 3000:3000 rtorrent-flood
- Other supported environment variables:
FLOOD_BASE_URI
FLOOD_SECRET
RTORRENT_SCGI_HOST
RTORRENT_SCGI_PORT
RTORRENT_SOCK
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
.
This project's client-side build tooling is based on the wonderful create-react-app.