ruTorrent - Plugins
ruTorrent's features can be extended in many different ways through the use of plugins. Though some more common ones will be installed when installing ruTorrent itself there are lots more that can be added.
Naturally, this guide assumes you know how to install ruTorrent (and have done so). Plugins are also added either via SSH or FTP and you may need to connect to your slot via SSH to configure some plugins. You will be instructed to connect via SSH where this is the case.
This page provides information on the most common custom plugins, how to install them and troubleshooting the most common problems that can arise. Please note though the plugins should work (if you follow the guide properly), Feral cannot provide much support for their use or help should anything go wrong. Please make sure you've read these FAQ pages fully as help on the problem may be covered already.
- General method
- Specific instructions per plugin
Plugins can be added to ruTorrent simply by adding its directory to ruTorrent's plugins directory. This is possible in a number of ways, but the easiest is SSH. Since plugins are self-contained in their own directories, you can also just upload this to ruTorrent's plugin directory.
The method described below will pull the plugin from the ruTorrent plugin repository. If the plugin you want is listed under the 'Specific instructions' section please read those instructions first.
Run the following commands to install from the ruTorrent repository, replacing plugin_name with the actual name of the plugin you wish to install:
cd ~/www/$(whoami).$(hostname -f)/public_html/rutorrent/plugins/ svn checkout https://github.com/Novik/ruTorrent/trunk/plugins/plugin_name
Sometimes a plugin needs a different approach. This can be either because the download is located in a different place, another version is needed, the plugin depends on other software or because there are further steps needed to get the plugin up and running.
A separate article covers installing autodl irssi.
Coloured Ratio Column
This plugin adds colour to your ruTorrent UI's ratio column, changing from red to green (though orange and yellow) as your ratio increases.
To install, execute the following:
wget -qO ~/ratio.zip http://git.io/71cumA unzip -qo ~/ratio.zip -d ~/www/$(whoami).$(hostname -f)/public_html/rutorrent/plugins/ rm -f ratio.zip
Then simply open ruTorrent (or refresh the page if it was already open) to see the changes.
The Filemanager plugin adds a way of managing the files on your slot to ruTorrent.
To install Filemanager execute these commands:
cd ~/www/$(whoami).$(hostname -f)/public_html/rutorrent/plugins/ svn co -q https://github.com/nelu/rutorrent-thirdparty-plugins/trunk/filemanager chmod 700 ~/www/$(whoami).$(hostname -f)/public_html/rutorrent/plugins/filemanager/scripts/*
Using the screenshots function
First, you'll need to install FFmpeg to your slot. Next, configure Filemanager with:
cd && sed -i "s|(getExternal(\"ffprobe\")|(getExternal(\"~/bin/ffprobe\")|g" ~/www/$(whoami).$(hostname -f)/public_html/rutorrent/plugins/filemanager/flm.class.php sed -i "s|(getExternal('ffmpeg')|(getExternal('$(pwd)/bin/ffmpeg')|g" ~/www/$(whoami).$(hostname -f)/public_html/rutorrent/plugins/filemanager/flm.class.php
- When I do something (create an archive, move a file etc.) the action seems to complete but nothing has changed
Make sure you've set the permissions correctly in Filemanager's scripts directory.
- When I try to generate screenshots I get ffmpeg/ffprobe related errors
Make sure you've configured screenshots to point to the instance of ffmpeg running on your slot. If in doubt, follow this guide from top to bottom again and refresh ruTorrent.
This plugin allows you to create a URL out of your files for download via HTTP(S). It requires Filemanager to run (see the section above).
To install Fileshare execute these commands:
cd ~/www/$(whoami).$(hostname -f)/public_html/rutorrent/plugins/ svn co -q https://github.com/nelu/rutorrent-thirdparty-plugins/trunk/fileshare
These commands will configure the plugin to run on your slot:
ln -s ~/www/$(whoami).$(hostname -f)/public_html/rutorrent/plugins/fileshare/share.php ~/www/$(whoami).$(hostname -f)/public_html/ sed "/if(getConfFile(/d" -i ~/www/$(whoami).$(hostname -f)/public_html/rutorrent/plugins/fileshare/share.php sed -i "s|'http://mydomain.com/share.php';|'http://$(whoami).$(hostname -f)/share.php';|g" ~/www/$(whoami).$(hostname -f)/public_html/rutorrent/plugins/fileshare/conf.php
This plugin will allow you to use Plowshare to upload to various filesharing services via ruTorrent.
As it's not possible to set a path to plowup (Plowshare's uploading software) within the plugin's configuration files you'll need to make sure that plowup is in your PATH. Otherwise you'll receive an error that rTorrent is not able to access it. To do this, please log in via SSH and execute the following commands:
echo "PATH=$HOME/bin:$PATH" > ~/.bashrc source ~/.bashrc
To install Plowshare execute the following commands:
mkdir -p ~/bin && bash git clone https://github.com/mcrapet/plowshare.git ~/.plowshare-source && cd ~/.plowshare-source make install PREFIX=$HOME cd && rm -rf .plowshare-source
Run this command to install the plowshare modules:
If you get "command not found" then you need to revisit the preparation steps above because your ~/bin/ directory is not in PATH.
Execute these commands to install the plugin itself:
cd ~/www/$(whoami).$(hostname -f)/public_html/rutorrent/plugins/ svn co -q https://github.com/nelu/rutorrent-thirdparty-plugins/trunk/fileupload
You should then refresh ruTorrent to make sure the plugin can communicate with your plowup binary correctly.
If you get an error ("fileupload: Plugin will not work. rTorrent user can't access external program (plowup)."), make sure that you have taken the steps above to add ~/bin to PATH. Then, kill and restart rTorrent.
This is a plugin to allow you to stream from within ruTorrent. It requires the DivX web player to be installed first on your computer. This guide does not cover that step and for anything other than test streaming something like Plex will probably be a better solution for you.
Mediastream requires Filemanager (see the section above). Install Mediasteam using the following commands:
cd ~/www/$(whoami).$(hostname -f)/public_html/rutorrent/plugins/ svn co -q https://github.com/nelu/rutorrent-thirdparty-plugins/trunk/mediastream
mkdir ~/www/$(whoami).$(hostname -f)/public_html/stream ln -s ~/www/$(whoami).$(hostname -f)/public_html/rutorrent/plugins/mediastream/view.php ~/www/$(whoami).$(hostname -f)/public_html/stream/ sed -i "s|'http://mydomain.com/stream/view.php';|'http://$(whoami).$(hostname -f)/stream/view.php';|g" ~/www/$(whoami).$(hostname -f)/public_html/rutorrent/plugins/mediastream/conf.php
- I get the error "Video cannot be found, it may have been removed"
- Please make sure the configuration steps have been followed correctly.
The plugin uses ffmpeg to generate screenshots and due to the removal of this software from Debian stable you'll need to install FFmpeg to your slot. Next, install and configure the screenshots plugin itself with:
rm -rf ~/www/$(whoami).$(hostname -f)/public_html/rutorrent/plugins/screenshots wget -q https://bintray.com/artifact/download/novik65/generic/plugins/screenshots-3.6.tar.gz tar xf screenshots-3.6.tar.gz -C ~/www/$(whoami).$(hostname -f)/public_html/rutorrent/plugins/ rm screenshots-3.6.tar.gz cd && sed -i "s|ffmpeg'] = ''|ffmpeg'] = '$(pwd)/bin/ffmpeg'|g" ~/www/$(whoami).$(hostname -f)/public_html/rutorrent/plugins/screenshots/conf.php
The first command removes any existing instance of screenshots in case you previously installed an incorrect version. Naturally if you are using the 3.7 version of ruTorrent then you can install Screenshots by following the general plugin install method at the top of this page.
- When I load ruTorrent I get an error "screenshots: Plugin will not work. rTorrent user can't access external program (ffmpeg)"
- Make sure you've configured screenshots to point to the instance of ffmpeg running on your slot.
- When I generate screenshots I get no pictures, just a list of numbers
- That happens when using the 3.7 version of screenshots with the 3.6 version of ruTorrent. Please install the 3.6 version using the instructions above.
Since ruTorrent uses the filesystem as a database, the use of its own RSS plugin is not recommended. Things like filling the disk can result in RSS feed information being lost. Instead, if you wish to use RSS feeds, please consider Flexget.
This plugin allows you to extract from .zip and .rar archives, directly from ruTorrent.
To install it, execute the following:
rm -rf ~/www/$(whoami).$(hostname -f)/public_html/rutorrent/plugins/unpack wget -q https://bintray.com/novik65/generic/download_file?file_path=plugins%2Funpack-3.6.tar.gz tar xf download_file\?file_path\=plugins%2Funpack-3.6.tar.gz -C ~/www/$(whoami).$(hostname -f)/public_html/rutorrent/plugins/ rm download_file\?file_path\=plugins%2Funpack-3.6.tar.gz
The first command removes any existing instance of unpack in case you previously installed an incorrect version. Naturally if you are using the 3.7 version of ruTorrent then you can install unpack by following the general plugin install method at the top of this page.
Discordpush is a rutorrent plugin that sends messages on Torrent Added, Deleted and Finished to a specific Discord channel.
First you need to install the rutorrent plugin. Execute these commands to obtain and install the plugin to rutorrent:
cd ~ git clone https://github.com/radonthetyrant/rutorrent-discord.git rutorrent-discord-tmp mv ~/rutorrent-discord-tmp/discordpush ~/www/$(whoami).$(hostname -f)/public_html/rutorrent/plugins/ rm -rf ~/rutorrent-discord-tmp
Obtaining Webhook URL
To allow rutorrent to send Messages through the plugin to Discord servers, you need to obtain a WebHook URL from the Discord API. Here is how it works:
- Click on the "Edit Channel" button of the Text Channel you want the messages to appear (You have to own the necessary rights to do so)
- Navigate to the "Webhooks" Tab
- Click the Button "Create Webhook"
- Give the bot a name of your choice and make sure the correct Channel is selected
- Copy the Webhook URL at the bottom of the popover, you'll need that in a second.
- Click "Save" Button
I recommend you create your own Discord Guild and enable Desktop notifications to know instantly when you downloaded something.
Now reload your rutorrent webinterface. You should be able to find a "Discord" entry in the Settings.
- Open the "Discord Notifications" Settings menu in rutorrent
- Check "Enabled" at the top of the popup
- Enter the webhook url you saved previously, for example: https://discordapp.com/api/webhooks/**NUMBERS**/**CHARACTERS**
- Check any or all of the Torrent Events you want to get notified including "Addition" "Deletion" or "Finish"