2016-06-10 22:22:16 -07:00
2016-06-10 22:22:16 -07:00
2016-06-08 22:43:13 -07:00
2016-06-08 22:43:13 -07:00
2016-05-07 22:15:48 -07:00
2016-06-06 20:59:02 -07:00
2016-06-06 20:59:02 -07:00
2016-06-06 21:56:33 -07:00

Flood

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.

Usage

Pre-Requisites

  1. rTorrent needs to be installed with XMLRPC configuration. If you are currently using a web UI for rTorrent, you've already done this.
  • On OS X, brew makes it simple. After installing brew, just run brew install rtorrent --with-xmlrpc-c.
  • For Linux, there are plenty of guides available. Here's one.
  • For Windows, try this guide (I haven't tested this, let me know if you have problems).
  1. Install NodeJS version 4.x:
  • I recommend managing different Node versions with nvm or n.

Configuration

  1. Add your rTorrent SCGI hostname and port in config.js. Defaults are localhost and 5000.
  2. Copy server/db/users.js.example to server/db/users.js and add a username and password (password is stored in plain text for now, but this file is not accessible publicly).

Start It

  1. Run npm start in your terminal at this repo's root.
  • On first run, this may take a few minutes while it installs dependencies and transpiles JavaScript & CSS assets.
  1. Access the UI in your browser at localhost:3000.
  • To change the default port, run npm start localhost {port}.

Updating

  1. To update, simply git pull in this repository's directory, then kill the running server (generally ctrl+c) and restart it with npm start.
  • The start script removes old dependencies, installs new ones, transpiles JavaScript and CSS, and starts the web server.

Tips

  • I run the web server with screen to keep the web server running independently of the terminal session.

Screenshots

S
Description
A modern web UI for various torrent clients with a Node.js backend and React frontend.
Readme GPL-3.0 42 MiB
Languages
TypeScript 81.7%
SCSS 13.5%
JavaScript 2.5%
Shell 1.7%
Dockerfile 0.3%
Other 0.2%