layout	title	nav_order
default	PLG File Reference	3

PLG File Reference

{: .note }

✅ Validated against Unraid 7.2.3 - PLG structure and attributes verified against installed plugins.

See the DocTest validation plugin PLG for a complete working example.

The .plg file is the heart of every Unraid plugin. It's an XML document that tells the plugin system how to install, update, and remove your plugin.

Basic Structure

<?xml version='1.0' standalone='yes'?>
<!DOCTYPE PLUGIN [
<!ENTITY name        "myplugin">
<!ENTITY author      "Your Name">
<!ENTITY version     "2026.02.01">
<!ENTITY launch      "Settings/myplugin">
<!ENTITY pluginURL   "https://raw.githubusercontent.com/you/repo/main/myplugin.plg">
<!ENTITY pluginLOC   "/boot/config/plugins/&name;">
<!ENTITY emhttpLOC   "/usr/local/emhttp/plugins/&name;">
]>

<PLUGIN  name="&name;"
         author="&author;"
         version="&version;"
         launch="&launch;"
         pluginURL="&pluginURL;"
         icon="cubes"
         min="6.9.0"
         support="https://forums.unraid.net/topic/12345/"
         project="https://github.com/you/repo"
         readme="https://github.com/you/repo#readme"
>

<CHANGES>
### 2026.02.01
- Initial release
</CHANGES>

<!-- FILE elements and scripts go here -->

</PLUGIN>

DOCTYPE Entities

Entities act like variables in the XML. They make your PLG file easier to maintain:

<!DOCTYPE PLUGIN [
<!ENTITY name        "myplugin">           <!-- Plugin name (required) -->
<!ENTITY author      "Your Name">          <!-- Your name/handle -->
<!ENTITY version     "2026.02.01">         <!-- Current version -->
<!ENTITY launch      "Settings/myplugin">  <!-- Menu path after install -->
<!ENTITY pluginURL   "https://...">        <!-- URL to check for updates -->
<!ENTITY pluginLOC   "/boot/config/plugins/&name;">
<!ENTITY emhttpLOC   "/usr/local/emhttp/plugins/&name;">
<!ENTITY packageMD5  "abc123...">          <!-- MD5 of your package -->
]>

Use entities throughout the file with &name; syntax.

PLUGIN Attributes

The <PLUGIN> tag supports these attributes:

Required Attributes

Attribute	Description
`name`	Unique plugin identifier. Must match the folder names used. No spaces or special characters.
`version`	Version string for update comparison. LimeTech uses `YYYY.MM.DD` format.

Recommended Attributes

Attribute	Description
`author`	Displayed in Plugin Manager. Defaults to "anonymous" if omitted.
`pluginURL`	URL to download latest version. Required for update checking.
`support`	Link to support thread (usually Unraid forums).
`project`	Link to project homepage (usually GitHub).
`readme`	Link to README file.

Optional Attributes

Attribute	Description
`launch`	Menu path to open after installation. Format: `MenuSection/PageTitle`
`icon`	FontAwesome icon name (without `fa-` prefix) for Plugin Manager.
`min`	Minimum Unraid version required (e.g., `"6.9.0"`).
`max`	Maximum Unraid version supported.

Clicking a plugin name in the Plugins page opens the details panel:

Plugin details showing version, author, support link, and changelog

CHANGES Section

The <CHANGES> element contains your changelog in Markdown format:

<CHANGES>
### 2026.02.01
- Fixed bug in settings page
- Added new feature X

### 2026.01.15
- Initial release
</CHANGES>

This is displayed in the Plugin Manager when viewing plugin details.

FILE Elements

<FILE> elements define files to download, create, or run scripts.

Download a File

<FILE Name="/boot/config/plugins/myplugin/myfile.txz">
<URL>https://example.com/myfile.txz</URL>
<SHA256>a1b2c3d4e5f6...</SHA256>
</FILE>

Integrity Verification

Unraid supports both SHA256 and MD5 for file verification:

<!-- Preferred: SHA256 (more secure) -->
<FILE Name="/boot/config/plugins/myplugin/myfile.txz">
<URL>https://example.com/myfile.txz</URL>
<SHA256>a1b2c3d4e5f6789...</SHA256>
</FILE>

<!-- Legacy: MD5 (still supported) -->
<FILE Name="/boot/config/plugins/myplugin/myfile.txz">
<URL>https://example.com/myfile.txz</URL>
<MD5>abc123def456...</MD5>
</FILE>

Generate hashes with these commands. SHA256 is preferred for security, but MD5 is still supported for compatibility with older plugins:

sha256sum file.txz   # SHA256 (recommended)
md5sum file.txz      # MD5 (legacy)

Download and Install a Package

The Run attribute specifies a command to execute after the file is placed:

<FILE Name="/boot/config/plugins/myplugin/myplugin-package.txz" Run="upgradepkg --install-new">
<URL>https://github.com/you/repo/releases/download/v1.0/myplugin-package.txz</URL>
<MD5>abc123def456...</MD5>
</FILE>

Common Run values:

upgradepkg --install-new - Install Slackware package
upgradepkg --install-new --reinstall - Force reinstall even if same version
/bin/bash - Run as a shell script

Run an Inline Script

<FILE Run="/bin/bash">
<INLINE>
echo "Running installation script..."
mkdir -p /boot/config/plugins/myplugin
echo "Done!"
</INLINE>
</FILE>

Using LOCAL for Caching

The <LOCAL> element copies a previously downloaded file:

<!-- First, download to flash (cached) -->
<FILE Name="/boot/config/plugins/myplugin/icon.png">
<URL>https://example.com/icon.png</URL>
</FILE>

<!-- Then copy from flash to emhttp -->
<FILE Name="/usr/local/emhttp/plugins/myplugin/icon.png">
<LOCAL>/boot/config/plugins/myplugin/icon.png</LOCAL>
</FILE>

This caches files on the USB flash so they don't need to be re-downloaded on each boot.

Embedding Base64 Content

For small files like icons, you can embed them directly in the PLG file using base64 encoding:

<FILE Name="/usr/local/emhttp/plugins/myplugin/images/icon.png" Type="base64">
<INLINE>
iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAA...
</INLINE>
</FILE>

The Type="base64" attribute tells the plugin system to decode the content before writing the file.

When to use base64 embedding:

Small icons (< 10KB recommended)
Files that rarely change
Reducing external dependencies during install

Generate base64 content:

base64 -w 0 icon.png
# Or with line wrapping (easier to read in PLG)
base64 icon.png

Method Attribute

The Method attribute controls when a FILE element is processed:

Method	When Processed
(none)	During install only
`install`	During install (explicit)
`remove`	During plugin removal only

Install-Only Script

<FILE Run="/bin/bash">
<INLINE>
echo "Plugin installed!"
</INLINE>
</FILE>

Remove Script

<FILE Run="/bin/bash" Method="remove">
<INLINE>
# Clean up plugin files
rm -rf /boot/config/plugins/myplugin

# Remove the package
removepkg myplugin-package

echo "Plugin removed!"
</INLINE>
</FILE>

Complete Example

Here's a complete, well-structured PLG file:

<?xml version='1.0' standalone='yes'?>
<!DOCTYPE PLUGIN [
<!ENTITY name        "example.plugin">
<!ENTITY author      "YourName">
<!ENTITY version     "2026.02.01">
<!ENTITY launch      "Settings/&name;">
<!ENTITY packageVER  "&version;">
<!ENTITY packageMD5  "d41d8cd98f00b204e9800998ecf8427e">
<!ENTITY packageName "&name;-package-&packageVER;">
<!ENTITY packageFile "&packageName;.txz">
<!ENTITY github      "youruser/yourrepo">
<!ENTITY pluginURL   "https://raw.githubusercontent.com/&github;/main/&name;.plg">
<!ENTITY packageURL  "https://github.com/&github;/releases/download/&version;/&packageFile;">
<!ENTITY pluginLOC   "/boot/config/plugins/&name;">
<!ENTITY emhttpLOC   "/usr/local/emhttp/plugins/&name;">
]>

<PLUGIN  name="&name;"
         author="&author;"
         version="&version;"
         launch="&launch;"
         pluginURL="&pluginURL;"
         icon="cog"
         min="6.9.0"
         support="https://forums.unraid.net/topic/12345/"
         project="https://github.com/&github;"
         readme="https://github.com/&github;#readme"
>

<CHANGES>
### &version;
- Initial release
</CHANGES>

<!--
===========================================
PRE-INSTALL SCRIPT
Runs before the package is installed
===========================================
-->
<FILE Run="/bin/bash">
<INLINE>
# Remove old package versions
rm -f $(ls &pluginLOC;/&name;*.txz 2>/dev/null | grep -v '&packageVER;')

# Create plugin directory if needed
mkdir -p &pluginLOC;
</INLINE>
</FILE>

<!--
===========================================
PACKAGE INSTALLATION
Download and install the main package
===========================================
-->
<FILE Name="&pluginLOC;/&packageFile;" Run="upgradepkg --install-new">
<URL>&packageURL;</URL>
<MD5>&packageMD5;</MD5>
</FILE>

<!--
===========================================
POST-INSTALL SCRIPT
Runs after the package is installed
===========================================
-->
<FILE Run="/bin/bash">
<INLINE>
echo ""
echo "----------------------------------------------------"
echo " &name; has been installed."
echo " Version: &version;"
echo "----------------------------------------------------"
echo ""
</INLINE>
</FILE>

<!--
===========================================
REMOVE SCRIPT
Runs when the plugin is uninstalled
===========================================
-->
<FILE Run="/bin/bash" Method="remove">
<INLINE>
# Remove the package
removepkg &packageName;

# Remove plugin configuration (optional - you may want to keep this)
# rm -rf &pluginLOC;

echo ""
echo "----------------------------------------------------"
echo " &name; has been removed."
echo "----------------------------------------------------"
echo ""
</INLINE>
</FILE>

</PLUGIN>

Best Practices

1. Use Consistent Naming

The plugin name, folder names, and package name should all match:

Plugin name: myplugin
Flash folder: /boot/config/plugins/myplugin/
emhttp folder: /usr/local/emhttp/plugins/myplugin/
Package: myplugin-package-VERSION.txz

2. Use Entities for Maintenance

Define version, URLs, and paths as entities so you only update them in one place.

3. Always Include Integrity Checksums

This ensures file integrity and helps with caching. Use SHA256 for new plugins:

<!-- Preferred: SHA256 -->
<FILE Name="/path/to/file.txz" Run="upgradepkg --install-new">
<URL>https://example.com/file.txz</URL>
<SHA256>a1b2c3d4e5f6789...</SHA256>
</FILE>

<!-- Legacy: MD5 (still supported) -->
<FILE Name="/path/to/file.txz" Run="upgradepkg --install-new">
<URL>https://example.com/file.txz</URL>
<MD5>d41d8cd98f00b204e9800998ecf8427e</MD5>
</FILE>

Generate checksums with:

sha256sum file.txz   # SHA256 (recommended)
md5sum file.txz      # MD5 (legacy)

4. Clean Up Old Versions

In your pre-install script, remove old package versions:

<FILE Run="/bin/bash">
<INLINE>
rm -f $(ls /boot/config/plugins/myplugin/myplugin*.txz 2>/dev/null | grep -v '&packageVER;')
</INLINE>
</FILE>

5. Specify Minimum Version

If your plugin requires specific Unraid features:

<PLUGIN ... min="6.9.0">

6. Include All Required URLs

For updates to work, pluginURL must point to the raw PLG file:

https://raw.githubusercontent.com/user/repo/branch/plugin.plg

Troubleshooting

When plugins encounter errors during installation or removal, Unraid displays detailed error information in the Plugins page:

![Plugin error display showing installation failures]({{ site.baseurl }}/assets/images/screenshots/plugins-errors.png)

Error entries show the specific issue that occurred:

![Error detail]({{ site.baseurl }}/assets/images/screenshots/plugins-errors.png){: .crop-pluginsErrors-single }

Plugin Won't Install

Check XML syntax - use an XML validator
Verify URLs are accessible
Check MD5 checksums match
Look at /var/log/syslog for errors

Plugin Won't Update

Ensure pluginURL attribute is set correctly
Verify the remote PLG has a newer version string
Check that version comparison works (try plugin check myplugin.plg)

Files Not Found After Reboot

Files in /usr/local/emhttp/ are in RAM. They must be:

Inside a .txz package that's installed, OR
Created by an install script that runs on every boot, OR
Cached on flash and copied via <LOCAL>

Next Steps

Learn about [Page Files]({% link docs/page-files.md %}) for creating the web UI
See [Build and Packaging]({% link docs/build-and-packaging.md %}) for CI/CD pipelines and distribution
Check [Examples]({% link docs/examples.md %}) for real-world plugins to study

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

PLG File Reference

Basic Structure

DOCTYPE Entities

PLUGIN Attributes

Required Attributes

Recommended Attributes

Optional Attributes

CHANGES Section

FILE Elements

Download a File

Integrity Verification

Download and Install a Package

Run an Inline Script

Using LOCAL for Caching

Embedding Base64 Content

Method Attribute

Install-Only Script

Remove Script

Complete Example

Best Practices

1. Use Consistent Naming

2. Use Entities for Maintenance

3. Always Include Integrity Checksums

4. Clean Up Old Versions

5. Specify Minimum Version

6. Include All Required URLs

Troubleshooting

Plugin Won't Install

Plugin Won't Update

Files Not Found After Reboot

Next Steps

FilesExpand file tree

plg-file.md

Latest commit

History

plg-file.md

File metadata and controls

PLG File Reference

Basic Structure

DOCTYPE Entities

PLUGIN Attributes

Required Attributes

Recommended Attributes

Optional Attributes

CHANGES Section

FILE Elements

Download a File

Integrity Verification

Download and Install a Package

Run an Inline Script

Using LOCAL for Caching

Embedding Base64 Content

Method Attribute

Install-Only Script

Remove Script

Complete Example

Best Practices

1. Use Consistent Naming

2. Use Entities for Maintenance

3. Always Include Integrity Checksums

4. Clean Up Old Versions

5. Specify Minimum Version

6. Include All Required URLs

Troubleshooting

Plugin Won't Install

Plugin Won't Update

Files Not Found After Reboot

Next Steps