What? Why?
Consider this plugin like topping on steini84's ZFS Plugin.
I love how Unraid makes it easy to run Docker and VMs and to allow for expansion with mismatched drives, but coming from another software I learned to trust ZFS more than other filesystems. If you're reading this, I guess you prefer it too. While the ZFS Plugin brings our loved filesystem, and I fully understand and share steini84's opinion about keeping the plugin pure and simple with just the binaries, I missed a way to keep an eye on the status of my pool without resorting to shell commands or copy-pasted scripts. In fact I was not fully trusting the pool just because I was not monitoring it adequately. Judging by some threads I was not the only one, so...
Enter ZFS-companion.
What does it do?
Right now it's just a dashboard widget. It shows the general health of all your pools, plus a list of all the zpools with their status and last scrub information.
I don't have ETAs, but I have some ideas of what could be added to make it more useful (not necessarily in order):
Full (secondary?) widget in the disks section of the dashboard
Section in the Main screen, something like Unassigned Devices does for other filesystems.
Integrated scripts for scrubbing and error reporting, to avoid copy-pasting from different places
Shares management
Maybe with some detailed page about more detailed info (pool properties? snapshot list?)
How to install
Install it directly (Plugins -> Install Plugin -> Enter Url then click INSTALL):
https://raw.githubusercontent.com/GiorgioAresu/ZFS-companion-unraid/main/ZFS-companion.plg
If you have suggestions or issues you can post them below.
If you can provide examples of different messages for pools status, scrub results, errors, and so on please write them (PM if you want) because I'm having difficulties finding all possible values.
Troubleshooting
If you're having issues or the state is not what you'd expect, please post the output of the following commands:
zpool status -x
zpool status -v
zpool list