Skip to content
View in the app

A better way to browse. Learn more.

Unraid

A full-screen app on your home screen with push notifications, badges and more.

To install this app on iOS and iPadOS
  1. Tap the Share icon in Safari
  2. Scroll the menu and tap Add to Home Screen.
  3. Tap Add in the top-right corner.
To install this app on Android
  1. Tap the 3-dot menu (⋮) in the top-right corner of the browser.
  2. Tap Add to Home screen or Install app.
  3. Confirm by tapping Install.

Convention for plugin config files

Featured Replies

Hey all,

 

I've been following the discussion rather closely for plugin development, but something that I don't think I saw mentioned (or may have potentially missed) is the notion of standardizing where we will put various config & other files associated with plugins.

 

For example, in my current unraid setup, I use /boot/custom/etc to store all my files related to various tools I install. If I take SABnzbd for instance, I'll keep all the config files for sabnzbd in /boot/custom/etc/sabnzbd. This allows me to update my SAB package without having to worry about backing up my config files.

 

I've noticed in the first few plugins that have been release that the tools are being installed in /boot/custom/<plugin>.. This is fine, but if we store all files in this folder, won't it make upgrading a bit more tedious?

 

I'm not convinced either that we should use /boot/config either, as this is a unraid system directory.

 

Any ideas? Maybe we could use:

 

/boot/custom/etc or

/boot/custom/config or

<insert suggestion here>?

 

I've been working on a few plugins (SAB and Sickbeard for PVR-like functionality) and I've been wrestling with this issue. It'd be nice to standardize on one location.

 

Best,

Generally, we use:

 

/boot/custom/<application name>

  • Author

I was under the impression this is where you're storing the full application, not just the config/extra files?

 

Are you installing binaries, etc in the default /usr locations?

 

 

I would like it to be:

 

/boot/config/plugin/<plugin-name>/

 

This is because I have told many people via email & posts that all the critical unRAID configuration data is in the 'config' directory on the flash.  So if someone is already routinely backing up this directory, this won't change.

But then again, /boot/extra lives outside of /boot/config ....

  • Author

I would like it to be:

 

/boot/config/plugin/<plugin-name>/

 

This is because I have told many people via email & posts that all the critical unRAID configuration data is in the 'config' directory on the flash.  So if someone is already routinely backing up this directory, this won't change.

 

Works for me!

I was under the impression this is where you're storing the full application, not just the config/extra files?

 

Are you installing binaries, etc in the default /usr locations?

 

The way plugins (should) work is they are normal slackware packages.  In the absence of a Package Manager, a plugin package file should be copied into the /boot/extra directory because unRAID will automatically install all packages that exist in /boot/extra upon boot.

 

When the package is installed, the run-time application files get extracted to their proper place in the root file system (which is in ram).  webGui pages and php files should be extracted to /usr/local/emhttp/plugins/<plugin-name>.  If config files are needed they should be extracted to /boot/config/plugins/<plugin-name> directory, being careful not overwrite any existing config file in that directory.

 

Under control of a Package Manager, plugins will probably be stored somewhere else than /boot/extra (so that the Package Manager can control what gets installed).  I think this will probably end up being /boot/config/<plugin-name>.  Again, this is to aide backup of "vital config data", your set of plugins included.

 

Edit: correct the paths & use 'plugins' not 'plugin'.

But then again, /boot/extra lives outside of /boot/config ....

 

Yes, I believe that is a design weakness.

But then again, /boot/extra lives outside of /boot/config ....

 

Yes, I believe that is a design weakness.

How about:

 

test -d /boot/config/extra || mkdir /boot/config/extra

mv /boot/extra/* /boot/config/extra                      <-- only need do this once

mount --bind /boot/config/extra /boot/extra

 

Now, a backup of /boot/config will get the "extra" folder.

 

Joe L.

Archived

This topic is now archived and is closed to further replies.

Account

Navigation

Search

Search

Configure browser push notifications

Chrome (Android)
  1. Tap the lock icon next to the address bar.
  2. Tap Permissions → Notifications.
  3. Adjust your preference.
Chrome (Desktop)
  1. Click the padlock icon in the address bar.
  2. Select Site settings.
  3. Find Notifications and adjust your preference.