Skip to content
This repository was archived by the owner on Jun 27, 2019. It is now read-only.

How to Install Plugins

Jump to bottom
Influencer edited this page Aug 26, 2012 · 3 revisions

Table of Contents

Introduction

Many users will know how to do this, others will not. I decided to put up a simple wiki page explaining some of the ins and outs of installing plug-ins. It may seem like common sense, but who knows, might help.

Details

Download Plugins

Since these plug-ins are made and supported by the community, you will probably run across many different hosting methods. Some host them on private dropbox accounts, some use google code, private hosting, and many use github.

Each may have a slightly different way of downloading the plug-ins. For Github, you cannot download from the link on the main gitpage. If you do this you will save the HTML page, which will give you errors when trying to install the plug-in. You must click on the link and when the code page loads, right click on the "RAW" button at the top right hand corner of the code, and then "Save Link As".

To make things easier, I have included in the Readme(text at the bottom of the main gitpage), a "Downloads" section. You can right click and "Save Link As" directly from that section.

Installation

First, the easiest way to install a plug-in is to place the plug-in on your flash drive in /config/plugins/. From telnet, the "flash" disk share, or your unraid console, this will be located at /boot/config/plugins/.

After placing the plug-in or plug-ins in that directory, you can reboot UNraid and the plug-ins will be installed on reboot.

If you are currently using your server, or it is working on something else, such as a parity check, preclearing a drive, or is otherwise utilized, you can install a plug-in manually. To do this, you can invoke the installplg script. 

 
installplg /boot/config/plugins/mynewplugin.plg
This will install the plug-in without rebooting. You can place a plug-in anywhere else and change the path to fit the location, but the plug-in 'will not' be automatically installed on reboot.

Thats all there is to it. Some plug-ins may have additional requirements, if so, follow the instructions set by the author!

Clone this wiki locally