Need Help?

Need help to install or setup this app? We are available on:

Discord

Setting Up rTorrent

Setting Up rTorrent on Nébulaura

rTorrent is a console-based BitTorrent client built on the libTorrent library for Unix systems. It offers both a command-line interface and a web-based interface (ruTorrent) for ease of use.

Initial Setup

First, connect to your slot via SSH. If you need help connecting to the server, refer to the relevant help article.

To install rTorrent, use the following command:

box install rtorrent

This command will configure rTorrent and ruTorrent for use on your slot.

How to Access

Once rTorrent is installed, you can choose to access it via the web GUI (ruTorrent) or the command-line interface (curses UI).

ruTorrent

Access the ruTorrent web GUI by appending /rutorrent to your hostname:

https://<hostname.io>/rutorrent

Command Line (Curses UI)

rTorrent runs as a daemon using the screen application. To access the curses UI:

  1. Attach to the running rtorrent screen session: 
    screen -r rtorrent
  2. To detach and leave rTorrent running in the background, press: 
    ctrl-a, ctrl-d

For help with the curses UI, refer to the rTorrent User Guide.

Service Management

As with all Nébulaura-configured applications, rTorrent can be managed via SSH using the following commands:

  • Status: Check the current status of rTorrent.
  • Start: Start the rTorrent service.
  • Stop: Stop the rTorrent service.
  • Restart: Restart the rTorrent service.
  • Enable: Configure rTorrent to start automatically at boot.
  • Disable: Prevent rTorrent from starting at boot.

Example:

box start rtorrent

Configuration

rTorrent’s configuration is managed via the .rtorrent.rc file located in your home directory. Avoid editing options such as ip, bind, or network.scgi.open_local, as these changes may cause the client to stop functioning.

Connecting to Other Clients

Unix Sockets

rTorrent creates a Unix socket that can only be accessed by your user. The socket is located at:

/run/<username>/.rtorrent.sock

To use this in a program, prepend the unix:// protocol:

unix:///run/<username>/.rtorrent.sock

RPC Mounts

rTorrent’s RPC mounts are accessible via the webserver (nginx). To connect using an RPC mount:

  • Host: 127.0.0.1
  • Port: 443
  • SSL: ON
  • Username: <your username>
  • Password: <your password>
  • RPC Mount: /rutorrent/plugins/httprpc/action.php or /<username>

For mobile connections (e.g., Transdrone), the ruTorrent plugin mount is recommended as it utilizes compression and reduces data usage.

Transdroid/Transdrone

To connect your rTorrent instance to the Transdrone mobile app:

  • Name: rtorrent (or any name you prefer)
  • Server Type: rTorrent
  • IP or Hostname: <your server hostname>
  • Username: <your username>
  • Password: <your password>
  • Advanced Settings:
    • SCGI Mount Point: /rutorrent/plugins/httprpc/action.php or /<username>
    • Use SSL: ON

Seamlessly Manage Torrents

With rTorrent on Nébulaura, you have a robust and efficient tool to manage your torrents through both a powerful command-line interface and an intuitive web GUI. Set it up today and enjoy seamless torrent management!