Plugins

• Plugins
• Installation
• plugins.ini
• Explanation of plugin.ini settings
• An Example of how to use plugins.ini
• per user plugin config files
• a note on upgrading plugins
• Starting plugins with rtorrent
• Uninstallation
• Currently there are the following plug-ins:
• 3rd Party Plugins
• Depreciated Plugins

ruTorrent is designed with a robust plugin system. The reason for this is to allow users to customize the behavior of the WebUI, and exlude the parts they do not need And even add something we missed, without modifying a ruTorrent code

Installation

To install a plugin, download the tarball from the download page and extract it in the plugins directory. (if rutorrent is installed to /var/www/rutorrent this would be

/var/www/rutorrent/plugins

If you use the svn version of rutorrent, you can fetch the plguins via svn as well as follows:

svn co http://rutorrent.googlecode.com/svn/trunk/plugins/PLUGIN_NAME

Attention! Please install only those plug-ins you really need. The more plug-ins are installed - the longer load of the ruTorrent interface.

(note: many plugins will require a commandline php installation to be set in rutorrent/conf/config.php (or rutorrent/conf/users/USERNAME/config.php). Please check your distro for how to install. )

plugins.ini

Some of the following information is also included in Config page

Since 3.0, rutorrent includes a configuration file for plugins called plugin.ini. It is located at rutorrent/conf/plugins.ini. As of the writing of this wiki, the default format is as follows:

;; Plugin's permissions. 
;; If flag is not found in plugin section, corresponding flag from "default" section is used.
;; If flag is not found in "default" section, it is assumed to be "yes".
;;
;; For setting individual plugin's permissions you must write something like that:
;;
;; [ratio]
;; enabled = yes
;; canChangeToolbar = yes
;; canChangeMenu = yes
;; canChangeOptions = no
;; canChangeTabs = yes
;; canChangeColumns = yes

[default]
enabled = yes
canChangeToolbar = yes
canChangeMenu = yes
canChangeOptions = yes
canChangeTabs = yes
canChangeColumns = yes

These options allow you to change how each plugin behaves and allow you to create a unique configuration for multiple user systems.

For a multiuser system with rutorrent installed at /var/www/rutorrent with users tom dick and harry you would do something like:

cp /var/www/rutorrent/conf/plugins.ini /var/www/rutorrent/users/tom
cp /var/www/rutorrent/conf/plugins.ini /var/www/rutorrent/users/dick
cp /var/www/rutorrent/conf/plugins.ini /var/www/rutorrent/users/harry

and edit each accordingly. For more information about multi-user setups, see Config and Installation

Explanation of plugin.ini settings

• enabled - this setting should be obvious, when set to yes, a plugin is enabled. When set to no, it is not.
• canChangeToolbar - this setting controls whether or not a plugin can make changes to the main toolbar.
• canChangeMenu - this setting controls whether or not the plugin can effect the rightclick menu.
• canChangeOptions - this setting controls whether or not the plugin can add to the "Settings" menu.
• canChangeTabs - this setting controls whether or not a plugin can add a tab to the tab bar.
• canChangeColumns - this setting controls whether or not a plugin can add a data column to the torrent information window.

An Example of how to use plugins.ini

So why is this useful? Using our 3 user system from the earlier example, lets say for harry and dick, you want to completely disable the RSS plugin, but you wish to allow tom access to it. You would install RSS and add the following to both /var/www/rutorrent/conf/users/harry/plugins.ini and /var/www/rutorrent/conf/users/dick/plugins.ini

[rss]
enabled = no

Lets say you want to let tom use the unpack plugin, but you do not want him to be able to enable "automatic unpack" via the settings window. You might add soemthing like this to /var/www/rutorrent/conf/users/tom/plugins.ini

[unpack]
enabled = yes               
canChangeToolbar = yes      
canChangeMenu = yes         
canChangeOptions = no      
canChangeTabs = yes         
canChangeColumns = yes

per user plugin config files

In the new rutorrent 3.0 multi-user setup, it is possible to have different plugins config settings for each user. This is done by creating a plugins directory for each user, adding a directory for the plugin you wish to have the config for, and copying the base plugin conf.php to this directory. For example: If you have 3 users, tom dick and harry, and you want to have different rss update intervals for each user, you would do something like this: (note: the following assumes rutorrent installed at /var/www/rutorrent )

mkdir -p /var/www/rutorrent/conf/users/tom/plugins/rss
mkdir -p /var/www/rutorrent/conf/users/dick/plugins/rss
mkdir -p /var/www/rutorrent/conf/users/harry/plugins/rss
cp /var/www/rutorrent/plugins/rss/conf.php /var/www/rutorrent/conf/users/tom/plugins/rss
cp /var/www/rutorrent/plugins/rss/conf.php /var/www/rutorrent/conf/users/dick/plugins/rss
cp /var/www/rutorrent/plugins/rss/conf.php /var/www/rutorrent/conf/users/harry/plugins/rss

then edit accordingly. This works for all plugins which have a conf.php file.

a note on upgrading plugins

It's very important to remember, when upgrading a plugin, you should always:

1. stop rtorrent
2. upgrade the plugin(s)
3. restart rtorrent

Failure to stop/start rtorrent can result in plugins not behaving as you'd expect.

Starting plugins with rtorrent

Plugins will load when the webui is opened. If you have plugins which need to poll for data (like rss or scheduler) you may wish to have them start when rtorrent starts, regardless of whether or not the webui has been loaded. In 2.0, this used to require a setting for each plugin via the .rtorrent.rc Now, all plugins can be brought up with a single .rtorrent.rc command. Be sure to edit this command for:

1. php path Your path may be different
2. rutorrent location Rutorrent may be installed in a different location on your syste
3. webusername you may or may not be using web authentication, if you aren't, remove the username entirely, if you are, edit it accordingly

(the following is for user tom with rutorrent installed at /var/www/rutorrent)

execute = {sh,-c,/usr/bin/php /var/www/rutorrent/php/initplugins.php tom &}

Uninstallation

1. remove the plugin directory, for example, to remove the rpc plugin you might do this:

rm -r /var/www/rutorrent/plugins/rpc/

2. restart rtorrent. This is important for plugins which work with the rtorrent scheduler, such plugins will send a command to rtorrent telling it to do something every x minutes. If you do not restart rtorrent, this even will keep occuring.

Currently there are the following plug-ins:

1. RPC - a plug-in for linking rtorrent and a web server. (Replacement for mod_scgi).
2. erasedata - adds "Delete with the data" to the right click context menu.
3. сreate - adds the command of new torrent creation.
4. trafic - adds a subsystem of the traffic counting.
5. RSS - realizes operations with RSS-feeds.
6. edit - allows to edit the trackers list of the existing torrent.
7. throttle - allows to set different speed limitations for groups of torrents.
8. retrackers - automatically adds defined re-trackers for newly added torrents.
9. cookies - allows to define a set of cookies for trackers which use such method of authorization.
10. scheduler - allows to change speed limitations of downloads/uploads depending on hour of the day and day of the week.
11. autotools - realizes some automation functions (autolabel, automove).
12. datadir - allows to change the torrent's data directory.
13. tracklabels - adds a set of automatically generated by trackers' names labels onto categories pane.
14. geoip - shows country name and flag for connected peers.
15. ratio - allows to set different ratio limitations for groups of torrents.
16. Show_peers_like_wtorrent - changes the format of values in "Seeds" and "Peers" columns of the torrents list.
17. seedingtime - adds the column with the torrent's finishing time to torrents list.
18. HTTPRPC - Similar to RPC but with low bandwidth use in mind.
19. Diskspace -- Shows remaining space on the bottom bar in an easy to read fashion.
20. Unpack -- Unrars and Unzips downloaded torrents.
21. _getdir Plugin -- this plugin helps rutorrent find and render directories.
22. Source -- This plugin lets you download the .torrent file.
23. Chunks -- This plugin shows info on torrent pieces (which pieces have downloaded).
24. Data -- This plugin adds an http download option to the "files" tab and torrent menu.
25. Cpuload - Shows cpu loading on the bottom bar in an easy to read fashion.
26. Extsearch - adds an internal search function to many popular public and private sites
27. Theme - adds several themes and the ability to choose which one to use from the settings menu.
28. Loginmgr - This plugin is used for sites where cookies fail, to help support RSS and PluginExtsearch Extsearch
29. Rssurlrewrite - This plugin is used to rewrite http links for rss using regular expressions

3rd Party Plugins

1. Autodl-irssi - irc bot for auto downloading.
2. Pause -- plugin to pause the ui
3. tadd-labels - plugin which makes labeling torrents easier
4. HostName - plugin which show host column for peers
5. NFO - plugin for displaying the content of the .nfo file
6. Chat - plugin adds a chatbox
7. Logoff - plugin allows you to switch users or logoff
8. InstantSearch - plugin allows you to search for running torrents, displaying results instantly

Depreciated Plugins

1. search - allows to redefine the list of search engines. replaced by Extsearch
2. Darkpal - a darker theme (replaced by Theme