Skip to content

Installation and Release Channels

alexphillips-dev edited this page Nov 4, 2026 · 1 revision

Installation and release channels

The manifest declares Unraid 6.8.3 or newer and the bundled packages target x86_64. The dependency archive contains vnStat 2.14, including vnstat, vnstatd, and vnstati. The dependency targets baseline x86_64 and glibc 2.17 or later, links to SQLite's libsqlite3.so.0, and requires libgd.so.3 for image output. Host libraries are not replaced by this package. These are build/package requirements, not a claim that every Unraid release has been tested.

The plugin has two release channels: Stable (main) and Development (dev). Both use the same plugin identity, dvm, and the same settings and database locations. The settings page shows the installed version and channel from packaged release metadata. An older package without that metadata displays an unknown release rather than guessing its channel.

The first stable release is 2026.11.04.11. Use Stable for the published release or Development to test subsequent changes. Development builds may change; keep independent backups before testing them. Automated coverage includes the bundled vnStat binary and isolated filesystem/process fixtures. Live Unraid installation, native page/theme behavior, real Docker/libvirt actions, and reboot restoration remain separate host-acceptance checks.

Do not install alongside the original Data Volume Monitor identity (dwdvm) or Network Stats. The installer checks those plugins because they share vnStat service/database ownership. Follow the migration procedure before replacing an existing installation.

Install and update

In Unraid, open Plugins → Install Plugin and enter the manifest for the chosen channel:

Channel Install/update manifest
Stable https://raw.githubusercontent.com/alexphillips-dev/Data-Volume-Monitor/main/plugin/dvm.plg
Development https://raw.githubusercontent.com/alexphillips-dev/Data-Volume-Monitor/dev/plugin/dvm.plg

Stable manifest:

https://raw.githubusercontent.com/alexphillips-dev/Data-Volume-Monitor/main/plugin/dvm.plg

Each manifest downloads its dependency and plugin archive from its own channel and keeps that channel's URL for future update checks. The installer verifies declared MD5 checksums. Plugin and backend archives also have SHA-256 sidecars in the repository. Checksums identify the corresponding file; they are not digital release signatures.

After installation, open Data Volume Monitor from the Unraid settings UI. The route is /Settings/DVMsettings. Use the Unraid Plugins page to check for updates. A Development installation stays on dev; a Stable installation stays on main. Publishing another branch does not silently move an installed plugin between channels.

Publishing an update to dev does not promote it to main or create a stable GitHub release.

Switch channels in place

Change channels in place. Do not uninstall DVM to switch channels: the uninstall routine deletes its persistent settings/backups and active traffic database. This procedure concerns the dvm Stable/Development channels; moving from the original dwdvm identity uses Migration from the original plugin.

  1. Record the installed version and channel. Keep an independent, verified copy of the settings, action scripts, and stopped traffic database outside plugin-owned directories; see Storage, backups, and recovery.

  2. Check that the destination channel has an announced release with a version newer than the installed version. Equal or older versions may be refused by Unraid's plugin manager. Wait for a newer destination release rather than forcing a downgrade or removing the plugin.

  3. Open Plugins → Install Plugin and enter that channel's canonical manifest URL from the table above. The same dvm.plg identity is installed in place. An administrator can alternatively use the Unraid terminal, for example:

    plugin install https://raw.githubusercontent.com/alexphillips-dev/Data-Volume-Monitor/main/plugin/dvm.plg

    Use that command only after a newer stable release is available. Replace /main/ with /dev/ when deliberately moving to a newer development build.

  4. Check the installation result, reopen the settings page, and confirm the new version/channel, retained settings/history, service status, and reports. Service Check is diagnostic-only. Real action tests require a separate, deliberate choice.

The package install path retains existing supported configuration files and the database; the channel itself does not select a new data directory. Configuration retention during installation is covered by isolated fixtures. A real-host channel switch must still be recorded in the host-acceptance checklist.

Why a newer version matters

Unraid's plugin manager refuses an equal or older version during normal reinstallation. The target channel must therefore have a newer announced build for the supported channel-switch procedure. Release preparation uses a consistently padded date/build scheme and guards ordering. Do not remove DVM or force a downgrade merely to bypass a version refusal.

Official plugin-manager implementation

Clone this wiki locally