UnRAID Plugins for V6

From unRAID
Jump to: navigation, search

Disclaimer: All plugins are the responsibility of the plugin author; USE AT YOUR OWN RISK. Lime Technology LLC does not recommend or endorse any plugin for any particular purpose, and shall assume no responsibility for their use.

Work in progress, incomplete, missing plugins

The Plugins page is a powerful addition to version 6 and serves a dual function, both to add, update, and remove plugins, AND to upgrade the GUI and the unRAID Server OS itself! The Installed Plugins page lists all of the plugins currently installed, plus the Dynamix webGui and the unRAID server, with all of their versions. The Install Plugins page is for adding new plugins.

  • To check to see if any updates are available for installation, simply click on the Check for Updates button. If any are available, you will see an Update button, to download and install its package. NOTE: when you update the base unRAID Server OS through this page, you must reboot the server to complete the update!
  • The Install Plugins tab is the preferred method to install plugins in v6. Doing it this way allows you to manage your plugins through the GUI rather then using the command line in a Linux shell or in a Windows Explorer session. You will need the URL of the plugin to install it, or you will have to download the .plg file and save it to the Flash drive, but NOT to a plugins folder! Using the URL is definitely the easier of these two methods! Some of the most popular plugins are the Dynamix group of plugins. If you want to see how this install process works, pick one of them and install it now.
  • Once you install a plugin, look on the Settings page for the plugin's configuration icon, in the User Utilities section. You will be able to use the GUI to configure any plugin that has been designed to be used with v6. Many plugins do require configuration after installation, so always check on the Settings page for the configuration page of any plugin that you install. Make sure you turn on the new Help feature, by clicking on the Help button in the upper right. Not every plugin has added Help, but if it's there, it's very 'helpful'!
  • To remove a plugin, click the check box to the left of the plugin's Remove button, then click the Remove button.
  • To see the change log for a plugin, click on the little blue circle with the i, next to the version.

Dynamix Plugins

  • Installation
    • To install Dynamix plugins, please see Dynamix - V6 Plugins, where they are all listed with their installation URL's. Use cut-and-paste to copy the URL of the plugin you want, and paste it into the Install Plugins page.
    • Note: in v5, you copied plugins to a plugins folder. Do NOT do that in v6! Always insert the plugin URL in the Install Plugins box, or browse to where you stored it. Just don't store it in a plugins folder!
    • Note2: the original Dynamix Disk Health and Email Notifications plugins are now built in!
  • Active Streams - show in real-time any open (shared) streams on your system.
    • Streams opened through SMB, AFP or Plex will be displayed in the table together with the receiver (user).
    • By default the IP address of the user is displayed in the overview. It is possible to associate a name with a particular IP address for easier recognition. The tab User Names manages creation of these relations. Any new IP address seen, will be automatically added to the list.
    • Optionally, streams can be stopped from the GUI.
  • CacheDirs - forces dir entries to stay cached, allowing drives to spin down
    • It is called Dynamix Cache Directories on the Plugins page, and Folder Caching on the Settings tab.
    • If you have been running CacheDirs from the go file, that won't be necessary any more, and you will want to install this plugin instead to get the same benefits.
    • After you install the Cache Directories plugin, go to the Settings page, click the Folder Caching icon, first enable the Folder caching function, then configure it as desired, and click the Apply button.
    • If you were running it in v4 or v5 and want to find the old settings you have been using, refer to your go file in the config folder of your v4 or v5 backup, and look for the cache_dirs command line.
    • It defaults to including all top level folders, if you don't specify the Included folders. There is a small bug in the current version that may cause some folders to not be cached some of the time, if set to All folders (nothing set in Included folders). It is therefore strongly recommended (you're probably tired of all these 'strong recommendations'!) that you do select the exact folders you want cached. Just click in the field box, and a list of all top level folders will be presented for you to check or leave unchecked. Only check those that it would be useful to cache, because caching takes memory, no need to waste it!
    • CacheDirs has a couple of small but hidden side-effects that may or may not be suitable for your v6 installation. Both of these system tweaks were added originally to CacheDirs to allow users to run successfully in only 512MB. That's rarely necessary any more.
      • CacheDirs modifies the process virtual memory limit, uses ulimit to set it to '50000' for 64 bit systems like unRAID v6 ('5000' for others). The Linux system default is 'unlimited'.
      Since v6 users generally have plenty of memory, and to avoid any possible side-effects, it is suggested to add the parameter -U 0 (that's a capital U and a zero) to the User defined options field on the Folder Caching settings page. Setting it to zero keeps CacheDirs from modifying it.
      • CacheDirs modifies vm.vfs_cache_pressure, a system parameter governing how aggressively the file and folder dir entries are kept in a cache. The Linux system default is '100', which is considered a "fair" value. Lower values like '1' or '10' or '50' will keep more dir entries cached, '200' would allow them to be more easily dropped, resulting in more drive spinups. The most aggressive would be '0', but unfortunately it may introduce a small risk of out-of-memory conditions, when other memory needs cannot be satisfied because dir entries are hogging it!
      By default, CacheDirs sets it to '10', which is a good value for most users. If you set it to '100', then it will remain the same as the Linux default value.
      If you wish to change it, add a -p # (that's a lowercase p and a number) to the User defined options field on the Folder Caching settings page. For example, to set it to more aggressively protect your cached dir entries, enter -p 1 in the options field. To avoid any possible side effects, add the parameter -p 100, which will restore it to the system default.
    • Most users should leave Scan user shares set to No. Since the User Shares are created and managed in memory, it makes little sense to cache them in more memory!
    • Except for those already mentioned, the rest of the fields are fine with their default values.
  • Local Master - supports detection of the local master browser in an SMB network.
    • It will display an icon in the header at the top-right when unRAID is elected as local master browser.
    • Under SMB Workgroup settings, it provides more information about the current elected local master browser.
  • S3 Sleep - puts the system in a low energy state if no activity (if your system supports it); defines the conditions under which the system will go to S3 sleep mode; adds an unconditional 'sleep' button on the Array Operation page
    • Reports are that if you had this running perfectly in v5, there is no guarantee it will work perfectly in v6, without changes, as there have been numerous system changes
    • Replacing the NIC has worked for some, namely an Intel gigabit adapter.
    • You may have to set up start and stop scripts to run specific commands before and/or after s3-sleep. Please browse through the entire Dynamix V6 Plugins thread.
  • Schedules - a front-end utility for the built-in hourly, daily, weekly and monthly schedules.
    • It allows the user to alter the schedule execution times using the GUI.
  • System Autofan - more sensor-based controls for system fans
    • Allows automatic fan control based on the system temperature. High and low thresholds are used to speed up or slow down the fan. This is a new plugin and still under development.
  • System Buttons - adds a one-click button to the header which allows for instant sleep, reboot, and shutdown of the system, or array start/stop.
  • System Info - gives detailed information about your system hardware
    • Shows various details of your system hardware and BIOS. This includes processor, memory and sub-system components.
    • Much of this information comes from the DMI (SMBIOS), and may be unreliable, as it's entered by the manufacturer.
  • System Stats - graphs your hard disk utilization and system resources
    • Shows in real-time the disk utilizations and critical system resources, such CPU usage, memory usage, interface bandwidth and disk I/O bandwidth.
  • System Temp - displays CPU and motherboard temps (if your system supports it)
    • Shows in real-time the temperature of the system CPU and motherboard. Temperatures can be displayed in Celsius or Fahrenheit.
    • Your hardware must support the necessary probes, and additional software drivers may be required too.
    • This plugin requires PERL, and this package needs to be installed separately.
    • You will need to click the Detect button first, to let it identify what sensors you have and what modules/drivers are needed and available.
    • Then click the Save button to save it. This will ensure that the selected drivers are automatically loaded upon a system reboot.
    • If you would like to use the drivers now, rather than after the next boot, click the Load Drivers button to make them active.
    • Now select the most appropriate sensor for each of the CPU and motherboard temps. Original documentation of your motherboard may be helpful here. Click Apply to activate the sensor display.
    • If your motherboard has fan controls, then these can be made viewable too. At the moment only a single fan can be displayed though.
    • Temps should now be visible on the bottom status line of the Main page.
    • Sensor creation can be undone by selecting Not used, then click Apply.

Other Plugins

The following lists the plugins that seem to be the ones that are most commonly installed based on mentions in the forum. It is not an exhaustive list of the available plugins.

  • Powerdown
    • Same Powerdown plugin as before, updated for v6. However, the built in powerdown has improved and you may not need this plugin any more, unless you use some of its added functionality.
    • A new feature was added, support for start and stop scripts to control special needs of certain plugins, scripts, and VM's. See the support thread.
    • Installation URL is https://github.com/dlandon/unraid-snap/raw/master/powerdown-x86_64.plg.
    • Support thread is here.
  • NerdPack
    • This plugin includes command line tools for advanced users. Since it includes screen, other users will also be interested in installing it, typically for use with PreClear but also for use when converting drive file systems or other long command line jobs.
    • Tools included are: iftop, iotop, screen & utempter, lshw, kbd, inotify-tools, cpio, unrar, bwm-ng, strace, git, lftp, subversion,.
    • Installation URL is https://raw.githubusercontent.com/eschultz/unraid6-nerdpack/master/NerdPack.plg.
    • Support thread is here.
    • A helpful guide to using screen is Screen Tips.
  • Recycle Bin
    • Provides control and easy recovery of deleted files, subject to certain conditions. Provides control of trash emptying.
    • Important Notes!
      • Because this depends on the vfs recycle features of Samba, this is only for shares over Samba! The only files that are covered are those being accessed across SMB (which is generally all or most of them). Files deleted locally from the console or Telnet session, or through NFS or AFP, are not covered by this!
      • The files are recoverable, but not their timestamps, their 'last date modified'.
      • Requires unRAID v6.1 or later
    • For viewing the deleted files, shares are organized by Disk, Cache, User, Unassigned, and Flash.
    • Installation URL is https://github.com/dlandon/recycle.bin/raw/master/recycle.bin.plg.
    • Support thread is here.
  • overbyrn plugins
    • overbyrn has v6 plugins for NZBGet, SSH (enhances the default SSH in v6 by allowing multiple users and finer access control), Denyhosts, Dropbox, Beets, LMS, and possibly pyload.
    • Make sure you install the V6 version of the plugins, not the v5 version!
    • To install, right-click on the v6 link for a plugin, copy the link address (begins with 'https' and ends with '.plg'), then paste it into the URL input box on the Install Plugins tab.
    • Support thread for all overbyrn plugins is here.
  • PhAzE plugins
    • PhAzE has v6 plugins for CouchPotato, Headphones, Maraschino, Sonarr, SABnzbd, SickBeard, SickBeard_alt, Emby Server, Plex Media Server, NZBmegasearcH, Mylar, Transmission, FlexGet, Serviio, Subsonic, BitTorrent Sync, FileBot, PlexConnect.
    • Make sure you install the v2 plugins, which are the defaults.
    • To install, right-click on the plugin link, copy the link address (begins with 'https' and ends with '.plg'), then paste it into the URL input box on the Install Plugins tab.
    • Support thread for all PhAzE plugins is here. It is currently 122 pages long, make sure you read every word! Just kidding!
  • SNAP - mount and share drives outside of the unRAID array
    This is now deprecated and is being superseded by the new Unassigned Devices plugin above.
    • Currently, SNAP does have at least one feature not yet in Unassigned Devices, the ability to schedule a script using cron. But further development appears to have stopped and it is likely this capability will shortly be added to the Unassigned Devices plugin.
    • Installation URL is https://github.com/dlandon/unraid-snap/raw/master/snap-x86_64.plg.
    • Support thread is here.
    • An old support thread (for v5!) is here, with much helpful information, but DO NOT install anything from this thread, as it will be 32 bit only!
    • For mounting NTFS drives, you will need ntfs-3g support via one of the plugins above that provide it.
  • There are more plugins not yet listed above. Please see the Plugins forum.