Repository navigation
Platform and Updates
The Platform page keeps both the ZNAS portal and the operating system up to date; the Terminal gives you a shell without leaving the browser. On the USB Appliance, the OS is updated as a whole image from the USB Appliance Upgrades card instead.

- Click Check for Releases — queries a server-side version cache (GitHub is only hit when the cache expires)
- If a newer version exists, an Instant Update to vX.Y.Z button appears
- Click it — the portal downloads the new binary, replaces itself on disk, and restarts automatically
Downgrades are blocked to prevent accidental configuration regressions.
Auto-update: the gear icon on the update card configures the check interval (Daily / Weekly / Monthly / Manual) and optional unattended auto-install at a chosen time of day.
Release notes: Releases Details opens a scrollable viewer of all GitHub release notes.
Two ways to update the operating system, both on the OS Packages card of the Platform page:
-
Auto Update — non-interactive
aptupgrade with output streamed live into the page - Interactive Update — opens a popout terminal running the update so you can answer prompts (config file questions, service restarts) yourself
On the USB Appliance the OS is a read-only image, so the OS Packages card is replaced by USB Appliance Upgrades:

- The card shows the appliance release (e.g. ZNAS Appliance version 26.04.1 LTS, release 26.04.1-3) and the kernel, and checks the appliance releases for a newer signed image.
- Upgrade Appliance ▾ offers Stage the Upgrade (write it now, active at the next reboot) or Upgrade Now & Reboot.
- A three-part progress bar follows the download (to a ZFS pool when one is available, otherwise the stick), the signature check, and the write to the USB stick. Rebooting from the portal is blocked during the write.
Details, requirements and alternatives: USB Appliance → Upgrading.
Below it, Where ZNAS runs shows whether the appliance started from its USB stick or an internal disk, and offers Move to an internal disk… (USB Appliance → Moving to an internal disk).

The Terminal sidebar item opens a docked shell panel (drag its top edge to resize; heights are remembered). Terminals can also pop out into their own browser tab or window for multi-terminal work.
- Runs as the
zfsnasservice user — with hardened sudoers,sudoremains limited to the whitelist (Security). On the USB Appliance it runs as root. - Sessions survive page reloads and can be resumed or taken over from another device
- Admin-only by default; grant the Terminal permission to standard users as needed
- In InterLink remote view, the terminal attaches to the remote server
The Requisites page manages everything the portal depends on:

| Tab | Content |
|---|---|
| Optional Features | One-click install/uninstall of iSCSI, UPS, disk power management, remote VM backups (syncoid), MergerFS and VMs & Containers. Each row shows its status and, once installed, a ⋮ menu (uninstall, and for UPS: re-detect / hide the widget). The S3 row only appears when MinIO is already installed (why). |
| OS Packages | Required packages with an Install Missing Packages button (progress streams live) |
| Hardening | Current sudo mode + the Sudoers Hardening review/apply workflow (Security) |
On the USB Appliance every feature is built into the image: Optional Features shows each one as Enabled (read-only), and only UPS keeps its menu.
ZNAS implements the TrueNAS widget API from homepage.dev:
- My NAS:
href: https://192.168.1.10:8443
widget:
type: truenas
url: https://192.168.1.10:8443
key: <your-api-key>
version: 1
enablePools: true
version: 1is required. Create the API key in Settings → API Keys.
With the Firewall on, the same key also feeds homepage's Pi-hole and OPNsense widgets: see Firewall → Dashboards.
Getting Started
Storage
- Dashboard & Monitoring
- Physical Disks
- ZFS Pools
- Datasets & ZVols
- MergerFS
- Snapshots & Protection
- File Sharing — SMB
- File Sharing — NFS
- iSCSI
- S3 Object Storage
- Capacity Trends
- Encryption
- UPS Management
Virtualization
Networking
Administration
Reference