Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 20 additions & 5 deletions src/content/docs/docs/widgets/disk-health.mdx
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
title: Disk health widget
description: SMART status for every drive bay, from Scrutiny or TrueNAS, on your Stackyard dashboard.
description: Drive health for every bay, from Scrutiny, TrueNAS or Unraid, on your Stackyard dashboard.
---

import WidgetGroup from '../../../../components/WidgetGroup.astro';
import ServiceList from '../../../../components/ServiceList.astro';
import SettingList from '../../../../components/SettingList.astro';

One tile per drive bay, coloured by SMART status.
One tile per drive bay, coloured by drive health.

<WidgetGroup caption="Small, a three drive chassis, all healthy. Medium, an eight bay chassis with a failed drive, a drive with no SMART data and one empty bay."
items={[
Expand Down Expand Up @@ -43,16 +43,31 @@ Small holds four bays. Medium holds ten.
notes: ['TrueNAS 25.x only. Later versions do not have the REST API this widget reads. On a later version, run Scrutiny instead.'],
links: [{ label: 'truenas.com', href: 'https://www.truenas.com/' }],
},
{
name: 'Unraid', icon: 'unraid',
kind: 'NAS operating system',
needs: 'URL, API key',
fields: [
['Unraid URL', 'For example `tower.local`.'],
['Unraid API Key', 'A key with the Viewer role is enough. Stored as a secret.'],
],
notes: [
'Lists parity, data and cache drives.',
'Unraid reports disabled and missing drives, not SMART warnings. Use Scrutiny for SMART warnings.',
'A spun-down drive shows no temperature.',
],
links: [{ label: 'unraid.net', href: 'https://unraid.net/' }],
},
]} />

<SettingList title="Settings" items={[
{ name: 'Source', text: 'Scrutiny or TrueNAS. Defaults to Scrutiny.' },
{ name: 'Source', text: 'Scrutiny, TrueNAS or Unraid. Defaults to Scrutiny.' },
{ name: 'Link URL', text: 'Where clicking the widget opens. Leave blank to use the service address, if your browser can reach it.', optional: true },
{ name: 'Bays', text: 'Which drive sits in which bay. Enter the URL, load the drives, then assign each bay.' },
]} />

## Drive states

A bay shows Healthy or Failed. Any failed check in Scrutiny counts as Failed. A drive with no SMART data reports that. It is never shown as healthy.
A bay shows Healthy or Failed. Any failed check in Scrutiny counts as Failed. In Unraid, a disabled, wrong or invalid drive counts as Failed. Unraid does not list a missing drive, so a bay whose drive Unraid no longer lists counts as Failed. After removing a drive on purpose, clear its bay. A drive with no SMART data reports that. It is never shown as healthy.

A bay shows `Not reporting` when its drive is no longer in the monitoring service list. The other bays are unaffected.
With Scrutiny or TrueNAS, a bay shows `Not reporting` when its drive is no longer in the service's list. The other bays are unaffected.
2 changes: 1 addition & 1 deletion src/content/docs/docs/widgets/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Widgets reorder in the same list as apps and folders. See [Apps and folders](/do
{ href: '/docs/widgets/connections/', name: 'Connections', text: 'A VPN tile, or services on a world map.', value: 'Gluetun, NetBird, Conduit, Plausible, Umami' },
{ href: '/docs/widgets/custom/', name: 'Custom', text: 'Any web page, in a frame.', value: 'Any page' },
{ href: '/docs/widgets/dashboard-switch/', name: 'Dashboard switch', text: 'Links to your other dashboards.', value: 'No service' },
{ href: '/docs/widgets/disk-health/', name: 'Disk health', text: 'SMART status per drive bay.', value: 'Scrutiny, TrueNAS' },
{ href: '/docs/widgets/disk-health/', name: 'Disk health', text: 'Drive health per bay.', value: 'Scrutiny, TrueNAS, Unraid' },
{ href: '/docs/widgets/dns/', name: 'DNS', text: 'Blocked and total queries.', value: 'AdGuard Home, Pi-hole, Technitium, NextDNS' },
{ href: '/docs/widgets/github/', name: 'GitHub', text: 'Pull requests or a contribution graph.', value: 'GitHub' },
{ href: '/docs/widgets/now-playing/', name: 'Now Playing', text: 'What is playing, with progress.', value: 'Plex, Jellyfin, Emby, Navidrome' },
Expand Down
Loading