Skip to content

theone11/swapfile_plugin

Repository files navigation

#Swap File Plugin for unRAID v5 and v6

If you are low on memory and would like to add a Swap File to your unRAID server this plugin makes it simpler. The plugin enables creation/starting/stopping/changing of a Swap File on your unRAID server.

If this is your first plugin upgrade from version 0.5.3 or before to a newer version (supporting unRAID v6 plugin manager) then I suggest deleting the existing swapfile.plg file at /boot/config/plugins and then install as described below for unRAID v6 - all your settings should remain intact.

##To install under unRAID v6:

  1. In the unRAID Plugin Manager under "Install Plugin" tab enter https://raw.githubusercontent.com/theone11/swapfile_plugin/master/swapfile.plg
  2. Wait for installation to complete.
  3. Go to plugin WEGUI and change initial settings

##To install under unRAID v5:

  1. Initial Download of plugin at https://raw.githubusercontent.com/theone11/swapfile_plugin/master/swapfile.plg
  2. Copy plugin to /boot/config/plugins on your flash drive.
  3. Reboot unRAID server or Install from command line:
    • installplg /boot/config/plugins/swapfile.plg
    • /etc/rc.d/rc.swapfile boot
  4. Go to plugin WEGUI and change initial settings

##To update the plugin:

  • For WEBUI and functionality updates - Use the unRAID Plugin Manager or the swapfile Plugin WEBUI
  • For new swapfile compiled packages - Use the swapfile Plugin WEBUI

The WEBUI is divided into 3 parts:

  1. Status Summary - Shows status of configured Swap File and plugin version.
  2. Actions - Shows all possible actions available to the user depending on the status of the user's server.
    • Start/Stop/Restart Swap File.
    • Update plugin.
  3. Configuration - Change settings of the plugin and Swap File.

Configuration Notes:

  1. Boot and Startup options - Change what happens during array mount.
  2. Swapfile settings - Change Swap File location, name, etc...
    • Default Swap File location is on the Cache Drive - Change it if you must.

Please comment on any problems encountered and any enhancements or missing features, that you would like added. (Here if possible: https://github.com/theone11/swapfile_plugin/issues)

Enjoy the plugin :)

Note:

I used cofin's initial plugin (http://lime-technology.com/forum/index.php?topic=23515.0) and Joe L's unmenu swafile plugin as reference.

About

Swap File plugin for unRAID

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published