Initial Setup

Please make yourself aware of the Ultra.cc Fair Usage Policy. Directly pointing any torrent client to seed from your cloud storage using Rclone will create extreme strain on your slot's disk and _WILL_ cause a 24-hour ban on accessing your cloud storage repeatedly. It is _your_ responsibility to ensure usage is within acceptable limits. Ignorance is not an excuse.

rTorrent is a text-based ncurses BitTorrent client written in C++, based on the libTorrent libraries for Unix, whose author's goal is "a focus on high performance and good code." It is known to be stable and can handle many seeding torrents, making it a solid choice for long-term seeding.

ruTorrent is a popular front-end for rTorrent, which can be used to interact with rTorrent. It is designed to emulate the look and feel of µTorrent WebUI, so its appearance is quite similar to the "parent." The name "ruTorrent" is the combination of µTorrent and rtorrent. The original version of ruTorrent was based on an older version of µTorrent Webui but has been completely rewritten as of 3.0.

For more information on rTorrent and ruTorrent, refer to the following links:

https://github.com/rakshasa/rtorrent https://github.com/Novik/ruTorrent

Initial Setup

rTorrent/ruTorrent is already configured and tuned out of the box. To Install:

Install it from our Control Panel

  • Install rTorrent first before installing ruTorrent
  • For ruTorrent, add in your desired password in the textbox
  • Once installed, click Connect under ruTorrent
  • Enter your set credentials
    • Your username is your slot username, and your ruTorrent password

Accessing rTorrent CLI Interface

  • Should you need to access rTorrent's CLI interface, type in the following command in SSH:
screen -r rtorrent
  • To exit the interface, do CTRL + A + D

Default File Paths

Default Downloads Folder: ~/files

Default Watch Folder: ~/watch

rTorrent's config folder: ~/.config/rtorrent

Limiting Seeding Ratio with ruTorrent

This section will show you how to limit the seeding ratio in ruTorrent.

Ratio Groups

Start off by opening up your settings in ruTorrent and clicking the Ratio Groups option.

  • Fill out the top group (or any other one if you wish) with the following settings and give it a name
    • In this example, this group stops the torrent from seeding as soon as it finishes downloading.
Min % Max % UL,MB TIme,h Action
0 0 0 0 Stop
  • You can choose any action to the torrent after it has reached that requirement.
    • We recommend Stop as the action. This is to stop the torrents from seeding, mark it as completed, and for you to download the files to your PC
    • You can also select Remove to remove the torrent or Remove data to remove the torrent and its associated files.

Ultra_000061.png

You can also set this to be done by default to all future torrents by using the Default ratio group option in the bottom right of the ratio groups screen

Select the number corresponding to the created ratio group. In this case, select 1 and click OK.

Please note that setting this will restrict every torrent, in ruTorrent to not seed after download is finised.

ExtRatio Plugin

You can also use ExtRatio to automatically filter and set future torrents to a particular ratio group or throttle group.

Installation
  • To install ExtRatio, run the following command on your SSH to install this plugin.
cd ~/www/rutorrent/plugins/ && svn checkout https://github.com/Novik/rutorrent/trunk/plugins/extratio && svn checkout https://github.com/Novik/rutorrent/trunk/plugins/throttle && cd ~

Installing ruTorrent Plugins

ruTorrent is equipped with most of the plugins any client needs. Should there be a plugin that you need that is not installed, this section will help you learn to install those plugins. To do this, you will need to access the slot via SSH. For more information on that, visit this guide to learn more: How to connect to your slot via SSH

Installation

To install any plugin, first navigate to ruTorrent's plugin folder by doing the following command

cd ~/www/rutorrent/plugins/

Then, visit this link to check the following plugins available. To install the plugin, run the following command

 `plugin_name` is the name of the plugin you wish to install
svn checkout https://github.com/Novik/ruTorrent/trunk/plugins/plugin_name
throttle
cd ~/www/rutorrent/plugins/
svn checkout https://github.com/Novik/rutorrent/trunk/plugins/throttle
ratiocolor
cd ~/www/rutorrent/plugins/
svn co https://github.com/Gyran/rutorrent-ratiocolor.git/trunk ratiocolor

# To change to colored text only

sed -i "s:changeWhat = \"cell-background\";:changeWhat = \"font\";:g" ~/www/rutorrent/plugins/ratiocolor/init.js

# To change back to default

sed -i "s:changeWhat = \"font\";:changeWhat = \"cell-background\";:g" ~/www/rutorrent/plugins/ratiocolor/init.js

There are few plugins that cannot be installed using this, such as mediashare, plowshare, and others.

If you want any specific plugin to be installed which cannot be installed by this method, please contact support.

ExtRatio Plugin

  • You can also use ExtRatio to automatically filter and set future torrents to a particular ratio group or throttle group.
Installation
  • To install ExtRatio, run the following command on your SSH to install this plugin.
cd ~/www/rutorrent/plugins/ && svn checkout https://github.com/Novik/rutorrent/trunk/plugins/extratio && svn checkout https://github.com/Novik/rutorrent/trunk/plugins/throttle && cd ~

Automatically Unpack Archives with ruTorrent

This section will teach you how to enable auto unpacking of archived files in your seeding torrents. This is useful if you want to use your slot to extract your archived files so you can download only the extracted files and leave the archive seeding, or you need automatic unpacking for Sonarr, Radarr, and Lidarr.

Go to Settings -> Unpack

Check Enable autounpacking if torrents label matches filter

  • This will enable unpacking on all future torrents. You may also set Unpack to a directory you want within your home folder or leave it blank to extract it in-place/to your torrent's current directory
    • Leaving it blank is useful for DVR apps such as Sonarr, Radarr, and Lidarr.
  • If you want to enable unpacking to specific labels, add the following to the textbox beside Enable auto unpacking if torrents label matches filter
/.*(label_1|label_2|label_3).*/i
  • For example, if you want to enable auto unpacking to all torrents from Sonarr, Radarr, and Lidarr
/.*(tv-sonarr|radarr|lidarr).*/i

Bad response from server: (0 [error,getplugins])

This Error requires your webserver to be reinstalled from your UCP. The reinstall webserver button (Orange button) can be found in your main dashboard next to your traffic quota. You can also do this on your slot's shell by running the following commands:

app-nginx uninstall
app-nginx install

No connection to rTorrent. Check if it is running. Check $ scgi_port and $ scgi_host in config.php and scgi_port in rTorrent config file.

This Error means that rTorrent is not running, and it usually needs to be restarted from your UCP or running app-rtorrent restart while connected to your shell. This can happen in a few scenarios:

  • Your allotted disk quota is exceeded, so your session cannot write to your directory.
    • You will need to connect to your service via Shell or FTP, remove unneeded data, and restart rTorrent.
  • You have a bad torrent in your session.
    • You need to restart rTorrent, quickly connect to your ruTorrent, and stop all torrents. Then, start the torrents one by one. Usually, torrents with random letters or a .meta extension in the name are the bad torrents. Once you have found the files, remove them from the client, and try again.
  • Your HDD's IO is extremely saturated.
    • You will need to check this using iostat. Visit this guide here for more information.

Error downloading files. Make sure autodl-irssi is started and configured correctly (e.g., password, port number): Error getting files listing: Error: Could not connect: (111) Connection refused

Two common reasons why you would receive the Error:

  • The first and most common is irssi is just not running for whatever reason, such as a hard crash or a reboot. In most cases restarting autodl-irssi will fix the issue.
  • The other reason maybe you have reinstalled ruTorrent. This changes the GUI password, so autodl-irssi can no longer connect to ruTorrent. In this case, you will need to back up ~/.autodl/autodl.cfg and reinstall autodl-irssi.

Uncaught TypeError: Cannot read property 'rTorrent' of undefined or JS errors in general;

These errors are usually caused by security and antivirus software or browser extensions such as ad blockers preventing the scripts from ruTorrent from loading. Try disabling these and test ruTorrent in an incognito tab to start. These are almost always client-side.

Clients who use Kaspersky software are most likely to see this Error.

Why does the main IP of my slot and torrent clients appear different? Which IP should I report to trackers?

Our slot IPs are pooled to avoid clashing on trackers with a more extensive user database to help peers and seeders. If you need to submit IP's to trackers, then you should use the IP's that are binding to the torrent clients. You can obtain them by the following methods:

rTorrent: cat .config/rtorrent/rtorrent.rc | grep bind
ruTorrent: Settings -> Advanced -> Bind (bottom field)

Why aren't my torrents producing any upload? They're not seeding!

This usually causes the following:

  • After the first couple of hours, Linux distros and freeware content are generally overpopulated. For that, you may have to grab the torrent as it is posted on the website. Tracker forums usually have methods to snatch them automatically via RSS or Autodl-irssi.
  • Some tracker forums block the seeding of new torrents after a particular ratio within a day. You may have to refer to your tracker's rules for this.
  • Your torrents may have some errors. Check the torrent's status for this.

Why is Autounpack not working? How to configure it correctly?

A lot of plugins have compatibility issues after 0.9.6, and this is one of them, unfortunately. You will need to roll back your client to 0.9.6 for this and a few other plugins to work.

You can resolve it using the repair option in your UCP under the rTorrent action menu in the installed application tab. This should revert you to 0.9.6 by running app-rtorrent install -v 0.9.6. app-rtorrent repair will also work in your shell.

Editing rtorrent.rc to allow more options

Rtorrent is a reasonably powerful torrent client with many features not in use by default, being a command line application changing settings require you to edit a file on your slot while rtorrent is shutdown. Without this method any changes made using the Webui companion RUtorrent will be lost whenever you next restart the rtorrent process.

Editing the settings can cause issues if done incorrectly and Ultra.cc cannot support modifications done to rtorrent.rc.

You will need to use SSH in order to follow this guide.

Backing up your original file before editing

If this is your first time editing values in rtorrent, it is best first to create a copy so it can be restored should anything go wrong.

This can break your rtorrent installation BACKUP is a MUST.

Your .rtorrent.rc is located in your home folder, so it is simple to backup in one command

cp ~/.rtorrent.rc .rtorrent.rc.bk

This will leave you with two files now rtorrent.rc and .rtorrent.rc.bk

If you make a mistake on the original file, you can quickly revert back by running the following commands

rm ~/.rtorrent.rc

cp ~/.rtorrent.rc.bk ~/.rtorrent.rc

This keeps the backup intact, so you won't need to back up again until you settle on your working modified version.

Now that the file is safe, we can begin to dig into the file but before doing so it would be best if you stopped rutorrent/rtorrent via your control panel it is considered an excellent measure to pause your active torrents before stopping rtorrent/rutorrent as it will be quicker when starting again.

Return to your SSH client and open up the .rtorrent.rc file.

nano .rtorrent.rc

Now what you see is the current configuration, don't worry, as any changes can be added to a new line at the bottom

Options Available

Adding new watch Directory with RUtorrent label

You may need to create the watch directories you plan on using before you can make the changes. This can be done with this command

mkdir -p ~/watch2 changing the path ~/watch2 to whatever you'd like to call your new watch directory


schedule =
watch_directory_2,5,5,load.start=~/watch2/*.torrent,d.set_custom1=watch2"

schedule =
watch_directory_3,5,5,load.start=~/watch3/*.torrent,d.set_custom1=watch3"

schedule =
watch_directory_4,5,5,load.start=~/watch4/*.torrent,d.set_custom1=watch4"

To help explain what the above is actually telling rtorrent, we can easily break it down

schedule = watch_directory Explains the kind of instruction you are passing to rtorrent

_2,5,5 Now this is important, notice in the example above that the first number in the sequence is rising with each watch folder; you must make sure that each watch folder you add has the following number

load.start=~/ load.start=~/watch2/*. start download instruction and the path to the folder to watch for .torrent files (setting the value `load.start to load.normal will cause torrents to be added in a "Paused" state)

d.set_custom1=watch3" Direction to create a label for any files found in the watch directory specified in the line.

Once your modification is completed, press Ctrl+X then Press Y, and then Enter to confirm and save

Move completed files to Folder matching Label Number

Building on the above, it is possible to move completed downloads to a folder matching your label name.

For example, we want all files under our new watch folder "watch2" to be stored in a folder called watch2 inside our ~/files directory. This will actually apply to any labels you are using, so please keep this in mind before making the change below.

Paste this code under your watch directory code and Save it.

method.insert = d.get_finished_dir,simple,"cat=~/files/,$d.get_custom1="
method.set_key =
event.download.finished,move_complete,"d.set_directory=$d.get_finished_dir=;execute=mkdir,-p,$d.get_finished_dir=;execute=mv,-u,$d.get_base_path=,$d.get_finished_dir="

Rtorrent/rutorrent can now be started

The changes will only apply to any future torrents, so it is a good idea to now give this a test by placing a .torrent file into your new watch directory.

Troubleshooting FAQ for rTorrent and ruTorrent

Bad response from server: (0 [error,getplugins])

This Error requires your webserver to be reinstalled from your UCP. The reinstall webserver button (Orange button) can be found in your main dashboard next to your traffic quota. You can also do this on your slot's shell by running the following commands:

app-nginx uninstall
app-nginx install

No connection to rTorrent. Check if it is running. Check $ scgi_port and $ scgi_host in config.php and scgi_port in rTorrent config file.

This Error means that rTorrent is not running, and it usually needs to be restarted from your UCP or running app-rtorrent restart while connected to your shell. This can happen in a few scenarios:

  • Your allotted disk quota is exceeded, so your session cannot write to your directory.
    • You will need to connect to your service via Shell or FTP, remove unneeded data, and restart rTorrent.
  • You have a bad torrent in your session.
    • You need to restart rTorrent, quickly connect to your ruTorrent, and stop all torrents. Then, start the torrents one by one. Usually, torrents with random letters or a .meta extension in the name are the bad torrents. Once you have found the files, remove them from the client, and try again.
  • Your HDD's IO is extremely saturated.
    • You will need to check this using iostat. Visit this guide here for more information.

Error downloading files. Make sure autodl-irssi is started and configured correctly (e.g., password, port number): Error getting files listing: Error: Could not connect: (111) Connection refused

Two common reasons why you would receive the Error:

  • The first and most common is irssi is just not running for whatever reason, such as a hard crash or a reboot. In most cases restarting autodl-irssi will fix the issue.
  • The other reason maybe you have reinstalled ruTorrent. This changes the GUI password, so autodl-irssi can no longer connect to ruTorrent. In this case, you will need to back up ~/.autodl/autodl.cfg and reinstall autodl-irssi.

Uncaught TypeError: Cannot read property 'rTorrent' of undefined or JS errors in general;

These errors are usually caused by security and antivirus software or browser extensions such as ad blockers preventing the scripts from ruTorrent from loading. Try disabling these and test ruTorrent in an incognito tab to start. These are almost always client-side.

Clients who use Kaspersky software are most likely to see this Error.

Why does the main IP of my slot and torrent clients appear different? Which IP should I report to trackers?

Our slot IPs are pooled to avoid clashing on trackers with a more extensive user database to help peers and seeders. If you need to submit IP's to trackers, then you should use the IP's that are binding to the torrent clients. You can obtain them by the following methods:

rTorrent: cat .config/rtorrent/rtorrent.rc | grep bind
ruTorrent: Settings -> Advanced -> Bind (bottom field)

Why aren't my torrents producing any upload? They're not seeding!

This usually causes the following:

  • After the first couple of hours, Linux distros and freeware content are generally overpopulated. For that, you may have to grab the torrent as it is posted on the website. Tracker forums usually have methods to snatch them automatically via RSS or Autodl-irssi.
  • Some tracker forums block the seeding of new torrents after a particular ratio within a day. You may have to refer to your tracker's rules for this.
  • Your torrents may have some errors. Check the torrent's status for this.

Why is Autounpack not working? How to configure it correctly?

A lot of plugins have compatibility issues after 0.9.6, and this is one of them, unfortunately. You will need to roll back your client to 0.9.6 for this and a few other plugins to work.

You can resolve it using the repair option in your UCP under the rTorrent action menu in the installed application tab. This should revert you to 0.9.6 by running app-rtorrent install -v 0.9.6. app-rtorrent repair will also work in your shell.