OpenMediaVaultLab
Isometric pink cubes with keyhole marks linked by lines to glowing bulbs and round nodes on a dark navy grid, evoking an OpenMediaVault plugin network
getting-started

OpenMediaVault omv-extras Plugin Explained for OMV 8

omv-extras adds a third-party plugin repo to OpenMediaVault 8. What it installs, what its Docker and backports buttons do, and which plugins need it.

By OpenMediaVaultLab Editorial · · 8 min read

OpenMediaVault omv-extras plugin explained in one line: it is a small community-maintained package, openmediavault-omvextrasorg (version 8.0.3 on OMV 8 at the time of writing), that adds the omv-extras apt repository and a settings page to your NAS. That repository holds more than 30 third-party plugins, including Compose, ZFS, mergerfs, SnapRAID and Kernel. Without it, System > Plugins shows only the official set.

You almost certainly want it. The core project keeps its own list short: the OMV 8 docs name 21 official plugins, from MD RAID and NUT to Podman and USB Backup, and their 3rd-party page is one sentence pointing at omv-extras.org. Compose, ZFS, mergerfs and WireGuard, the reasons most people build an OMV box in the first place, all sit on the far side of that sentence. The price is a second set of maintainers and a second apt repository to trust.

What does installing omv-extras actually change?

It adds one Debian package, the omv-extras apt source with its signing key, and a System > omv-extras page in the web UI. On its own it starts no services and installs no plugins; those are separate choices you make later in System > Plugins. The one-liner comes from the maintainers’ packages README:

wget -O - https://github.com/OpenMediaVault-Plugin-Developers/packages/raw/master/install | bash

Run it as root over SSH (the README also gives a sudo form). The install script is short enough to read before you pipe it into bash, which is a habit worth keeping. It checks for root and a supported architecture, exits on any openmediavault older than 6, makes sure Debian’s main and updates sources exist, then downloads and installs the matching openmediavault-omvextrasorg .deb from GitHub.

The script still accepts armhf and i386, but the OMV 8 compatibility page says 32-bit platforms of any type are no longer supported, so a current box means an amd64 mini-PC or a 64-bit Pi. The OpenMediaVault 8 system requirements cover the rest. If you installed with the script rather than the ISO, skip the command: the OMV 8 new user guide notes omv-extras is installed by default on SBC and scripted amd64 installs. It’s the amd64 ISO route that needs it added. The Raspberry Pi install walkthrough follows the scripted path.

What is on the System > omv-extras page in OMV 8?

One checkbox and seven buttons. The plugin’s page definition has a Docker repo checkbox plus Save, apt clean, apt clean repos, Enable backports, Disable backports, Wiki and Docker Wiki. A guide showing a Docker install or Portainer button is out of date: omv-extras 6.3 moved Docker install, Portainer and Yacht into the compose plugin in May 2023. Here is what each control runs, read from the plugin’s omv-aptclean and omv-changebackports helpers:

ControlWhat it actually does
Docker repo + SaveAdds Docker’s own apt repository and GPG key, so Docker Engine and the Compose plugin come from Docker rather than Debian
apt cleanRuns apt-get clean, wipes /var/lib/apt/lists, clears OMV’s cached archives, runs apt-get update and rebuilds the plugin index
apt clean reposEverything above, plus deletes and rewrites the omv-extras source (and Docker’s, if ticked) and re-imports the keys
Enable / Disable backportsSets OMV_APT_USE_KERNEL_BACKPORTS to YES or NO, redeploys OMV’s apt config through omv-salt, then runs apt clean repos
Wiki / Docker WikiOpens the omv-extras wiki

The Docker repo checkbox is the one most people came for. The wiki’s Docker in OMV 8 procedure is short: tick it, Save, then install openmediavault-compose from System > Plugins. Compose pulls in openmediavault-sharerootfs as a dependency, and uninstalling sharerootfs takes Compose with it. The full layout, including keeping Docker’s storage off the OS disk, is in the OMV 8 Docker Compose setup.

Backports is the button to leave alone unless you know why you’re pressing it. OMV’s apt documentation warns that Debian Backports can install incompatible package versions and says anything taken from there must be properly pinned. omv-extras does that pinning for a short list of packages, the ZFS and libvirt packages among them, and the 8.0.3 release added seabios to it. On a box running ZFS or KVM, toggling backports changes where those packages come from. Do it on purpose or not at all.

When should you press apt clean repos?

Press it when System > Plugins looks empty or stale after installing omv-extras, when apt complains about an omv-extras or Docker signature, or after a major OMV upgrade leaves old source files behind. It touches only apt state: package lists, cached archives and the omv-extras and Docker source files. Shares, filesystems and containers are left alone.

The changelog shows the button arriving in 7.0.1 for exactly this reset job, and the repository signing key changing in 8.0.1, which is how an unattended NAS can end up with apt signature errors months later. Plain apt clean is the lighter option, refreshing lists and rebuilding the plugin index without rewriting sources. Try it first if the only symptom is a plugin list that never populated.

Which omv-extras plugins are worth installing?

For a single-box home NAS, usually just Compose. Add mergerfs plus SnapRAID if your disks are mismatched sizes, ZFS if they’re matched and the hardware is amd64, and Write Cache if the OS lives on an SD card or USB stick. Everything else solves a specific problem: install it when you have the problem, not because the list is long.

The wiki’s OMV 8 plugin summary groups the third-party set like this:

CategoryPlugins listedWorth it when
Utilities and admin14, including Compose, Kernel, KVM, Scripts, Write Cache, CTermYou run containers, need the Proxmox kernel, or boot from flash
Filesystems and storage8, including mergerfs, SnapRAID, ZFS, Encryption, Remote MountYou are pooling disks, adding parity, or mounting another NAS
Backup4: Backup, BorgBackup, Rsnapshot, TimeshiftYou want OS config or data backed up from the GUI
Network and sharing7, including WireGuard, Fail2ban, SFTP, WebDAV, MiniDLNAYou need remote access or a protocol OMV core doesn’t ship

Two caveats. Documentation is uneven: that table marks many OMV 8 plugins “In progress” or “Not documented”, and the Kernel plugin page still says its OMV 8 docs are being written and points at the OMV 6 version. And every plugin has to keep pace with the next major release. OMV 7 went end-of-life in June 2026 per the release table; a box with three plugins upgrades more calmly than one with fifteen.

OMV itself nudges the same way. The OMV 8 plugins overview calls containerized software built with Podman or Docker highly recommended over installing software directly, citing dependency conflicts after updates. Use plugins for things that touch the storage stack and containers for apps. KVM works, but if VMs are the main event you probably wanted Proxmox underneath rather than a NAS OS.

Why does ZFS need two omv-extras plugins?

Because ZFS isn’t built into Debian’s kernel, OMV’s own filesystem docs send you to omv-extras twice on amd64: first for openmediavault-kernel to install the Proxmox (PVE) kernel, which has precompiled ZFS support, then for openmediavault-zfs. Do them in that order.

The omv-extras ZFS guide explains why: the Debian backports kernel can lose its ZFS module packages across kernel upgrades, leaving pools inaccessible, while the Proxmox kernel ships prebuilt modules updated in lockstep with the ZFS packages. Apply pending updates, install the Kernel plugin, install the Proxmox kernel, reboot, then install ZFS. The same guide rules out 32-bit and ARM boards such as the Raspberry Pi, so ZFS is an N100-class decision. Planning disks, filesystems and shares weighs it against a mergerfs pool, and the OMV vs TrueNAS comparison covers when a ZFS-first OS is the better call.

Is omv-extras safe to install?

Yes, for most home NAS builds, with your eyes open. It is maintained by the OpenMediaVault-Plugin-Developers group with source on GitHub, its repository is signed, and the official docs send you there for third-party plugins and ZFS. It isn’t the core project, though, so support runs through the OMV forum and the omv-extras wiki.

In practice, plugin fixes come from different people on a different schedule than OMV itself, and the Docker repo means Docker Engine updates arrive on Docker’s cadence rather than Debian’s. omv-extras doesn’t change your backup story either: its Backup plugin covers OS configuration, explicitly excluding data disks, so your data still needs a copy somewhere that isn’t this box.

FAQ

Is omv-extras an official OpenMediaVault project?

No. omv-extras is run by the separate OpenMediaVault-Plugin-Developers group, not the core openmediavault project. The official OMV 8 documentation does point to it, both on its third-party plugins page and as the route to ZFS support, so it is the expected way to extend OMV, just with separate maintainers and forum-based support.

Do I need omv-extras to run Docker on OpenMediaVault?

For the usual route, yes. The openmediavault-compose plugin and the Docker repo toggle both come from omv-extras. The core project does ship an official Podman plugin, and Docker can be installed by hand on the Debian underneath, but the compose plugin is what the wiki documents and what most forum answers assume.

Does omv-extras work on a Raspberry Pi?

Yes, and on a Pi you probably have it already: the scripted OMV install for Raspberry Pi and other SBCs adds omv-extras by default. OMV 8 needs a 64-bit OS, so 32-bit Pi images are out. Just skip ZFS: the omv-extras ZFS guide limits it to amd64 systems and names the Raspberry Pi as unsupported.

How do I update omv-extras plugins?

Through the normal OMV update screen. omv-extras plugins are ordinary Debian packages, so their updates appear under System > Update Management > Updates alongside OMV’s own, where you can read each changelog before installing. Apply pending updates before adding a plugin such as ZFS, which the omv-extras guide makes its first step.

Sources

  1. OpenMediaVault-Plugin-Developers/packages: omv-extras installer README
  2. omv-extras install script (source)
  3. openmediavault-omvextrasorg plugin source (GitHub)
  4. openmediavault-omvextrasorg changelog
  5. openmediavault-omvextrasorg: System > omv-extras page definition
  6. openmediavault-omvextrasorg: omv-aptclean helper script
  7. openmediavault-omvextrasorg: omv-changebackports helper script
  8. omv-extras wiki: Summary of plugins available in OMV8
  9. omv-extras wiki: Docker in OMV 8
  10. omv-extras wiki: ZFS plugin (OMV 8)
  11. omv-extras wiki: Kernel plugin (OMV 8)
  12. omv-extras wiki: OMV 8 new user guide
  13. omv-extras wiki: OMV 8 compatibility
  14. openmediavault documentation: Plugins (8.x)
  15. openmediavault documentation: Available plugins (8.x)
  16. openmediavault documentation: 3rd party plugins (8.x)
  17. openmediavault documentation: Software and update management (8.x)
  18. openmediavault documentation: Filesystems
  19. openmediavault documentation: Releases
#openmediavault #omv-extras#plugins#docker #zfs #nas

Related