TrueNASTrueNAS Nightly Development Documentation
This content follows experimental nightly development software. Pre-release software is intended for testing purposes only.
Use the Product and Version selectors above to view content specific to a stable software release.

UI Reference Guide

Welcome to the TrueNAS UI Reference Guide!

This document shows and describes each screen and configurable option contained within the TrueNAS web interface. The document is arranged in a parallel manner to the TrueNAS web interface, beginning with the top panel and then descending through each option displayed in the web interface left side menu. To display this document in a linear HTML format, export it to PDF, or physically print it, please select ⎙ Download or Print.

TrueNAS UI Reference Guide Sections

  • ⎙ Download or Print: View the TrueNAS UI Reference Guide as a single page for download or print.

    • Top Toolbar: All the icons and options contained in the TrueNAS top toolbar.

      • Alerts: Describes the TrueNAS alert system.

      • Settings Options: Describes the top-level Settings options in TrueNAS.

      • Tasks Screens: Describes the TrueNAS task manager and how to use the task manager to view failed jobs and task logs.

    • Dashboard: Explains the main dashboard information cards (widgets) and provides basic information on synchronizing the system and TrueNAS server times, and on customizing the Dashboard display.

      • Storage: Provides information on the Storage Dashboard widgets and options for pools, devices, and disks listed on this screen.

        • Disks: Describes UI screens and dialogs related to disk operations.

        • Pool Creation Wizard: Descriptions for settings and functions found in the Pool Creation Wizard.

        • Devices: Provides information on settings and functions found on the Devices screens and widget.

      • Datasets: Provides information on the Datasets screens and settings.

        • Zvols: Provides information on the settings and functions found on the Zvol screens and widgets.

        • Capacity Settings: Provides information on the quota settings and functions found on the Capacity Settings screen.

        • Snapshots: Provides information on the settings and functions found on the Snapshots screen.

        • User and Group Quotas : Provides information on the settings and functions found on the User and Group Quota screens.

        • Encryption Settings: Provides information on the settings and functions found on the TrueNAS storage encryption screens.

        • Permissions: Describes the ACL permissions screens, settings for POSIX and NFSv4 ACLs, and the conditions that result in additional setting options.

      • Shares: Describes the various storage sharing screens in TrueNAS.

      • Data Protection: Describes the screens and options contained within the Data Protection section in TrueNAS.

      • Network: Describes the screens and fields in the TrueNAS Network section.

        • Network Interface Screens: Provides information on the Network screen Interfaces widget and configuration screens.

        • Global Configuration Screens: The Global Configuration widget displays the general TrueNAS network settings not specific to any interface.

        • Static Routes Widget: The Static Routes widget displays existing static routes or sets up new ones.

        • IPMI Screens: Provides information on the Network screen IPMI widget and configuration screen.

      • Credentials: Describes the screens and fields in the TrueNAS Credentials section.

        • Users Screens: Provides information on the Users screens and settings in TrueNAS.

        • Groups Screens: Provides information on the Groups screens and settings.

        • Directory Services Screens: Describes the screens and fields in the TrueNAS Directory Services section.

        • Backup Credentials: Information on backup credential screens and settings to integrate TrueNAS with cloud storage providers by setting up SSH connections and keypairs.

        • Certificates: Information about the Certificates screen and widgets.

        • KMIP Screen: Describes the fields in the KMIP Key Status screen on TrueNAS Enterprise.

      • Virtualization: Provides information on the screens and settings to add virtual machines (VMs) and devices to your TrueNAS system.

        • Apps: Articles describing the TrueNAS Apps screens and fields.

          • Custom App Screens: Provides information on the Install Custom App screen and configuration settings.

        • Reporting: Provides information on TrueNAS reporting graph screens and settings.

          • System Settings: Articles describing the various screens and fields contained within the TrueNAS System Settings section.

            • Update Screens: Provides information on functions and fields on the TrueNAS Update screens.

            • General Settings Screen: Provides information on General system setting screen, widgets, and settings for getting support, changing console or the GUI, localization and keyboard setups, and adding NTP servers.

            • Advanced Settings Screen: Provides information on the System Settings > Advanced screen, widgets, and configuration screen settings.

            • Boot: Provides reference descriptions of the boot environment screens and settings.

            • Failover Screen: Provides information on the Failover screen settings and functions.

            • Services: Information on the Services screen and individual service articles in the Services area.

            • Shell Screen: Provides information on the TrueNAS Shell screen, buttons, and slider.

            • Alert Settings Screen: Provides information on Alert Settings service screen settings.

            • View Enclosure Screen (TrueNAS Systems Only): Provides information on the TrueNAS View Enclosure screen available only on compatible TrueNAS hardware systems.