TrueNAS CORE Nightly Development Documentation
This content follows experimental early release software. Use the Product and Version selectors above to view content specific to a stable software release.

UI Reference Guide

6 minute read.

Last Modified 2024-03-15 13:07 EDT

Welcome to the TrueNAS CORE 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.

⎙ Download or Print: View all CORE UI Reference content as a single page for download or print.

Top Menu: Reference documentation for the options panel that displays at the top of the TrueNAS UI.

Task Manager: Displays a list of tasks performed by your TrueNAS.
Alert Notifications: Displays system alerts and provides options to dismiss or reopen dismissed alerts on your TrueNAS.
Interface Preferences: Displays a list of general preferences for your TrueNAS.

Dashboard: CORE Dashboard reference.

Accounts: CORE UI User and Group screens documentation.

Groups: Describes the fields on the Groups screen in TrueNAS CORE.
Users: Describes the fields on the Users screens in TrueNAS CORE.

System: Reference documentation for the screens within the System menu option.

General: Describes the fields for the general system settings for TrueNAS CORE.
NTP Servers: Describes the fields for the NTP Server Settings screen on TrueNAS CORE.
Boot: Provides information about the Boot screen for the TrueNAS CORE.
Advanced: Describes the System > Advanced screen on TrueNAS CORE.
View Enclosure: Provides information about the View Enclosure screen on TrueNAS CORE.
Email: Describes the Email screen on TrueNAS CORE.
System Dataset: Describes the System Dataset screen on TrueNAS CORE.
Reporting: Contains information about the Reporting screen on TrueNAS CORE.
Alert Services: Describes the fields on the Alert Services screen on TrueNAS CORE.
Alert Settings: Describes the Alert Settings screen on TrueNAS CORE.
Cloud Credentials: Describes the fields in the Cloud Credentials screen in TrueNAS CORE.
SSH Connections: Describes the SSH screen fields on TrueNAS CORE.
SSH Keypairs: Describes the SSH Keypair screen on TrueNAS CORE.
Tunables: Describes the Tunable screen fields on TrueNAS CORE.
Update: Describes the fields in the Update screen in TrueNAS CORE.
CAs: Describes the Certificate Authorities screen settings and functions.
Certificates: Explains the fields located on the Certificates screen in TrueNAS CORE.
ACME DNS: Describes the fields in the Add ACME DNS Authenticators screen on TrueNAS CORE.
KMIP: Describes the fields in the KMIP Key Status screen on TrueNAS CORE Enterprise.
Failover (HA): Describes the fields in the Failover Configuration screen on TrueNAS CORE.
Support: Describes the Support screen on TrueNAS CORE.
2FA (Two-Factor Authentication): Describes the Two-Factor Authentication User Settings screen on TrueNAS CORE.

Tasks: Reference documentation of screens within the Tasks menu option.

Cron Jobs: Describes the fields on the Cron Jobs screen on TrueNAS CORE.
Init/Shutdown Scripts: Explains the fields on the Init/Shutdown Script screen on TrueNAS CORE.
Rsync Tasks: Provides information about the Rsync Tasks screen on TrueNAS CORE.
S.M.A.R.T. Tests: Describes the fields on the S.M.A.R.T. Test screen on TrueNAS CORE.
Periodic Snapshot Tasks: Defines the fields in the Periodic Snapshot Tasks Screen on TrueNAS CORE.
Replication Tasks: Decribes the fields on the Replication Tasks screen for TrueNAS CORE.
Resilver Priority: Describes the Resilver Priority screen on TrueNAS CORE.
Scrub Tasks: Describes the fields on the Scrub Task screen on TrueNAS CORE.
Cloud Sync Tasks: Describes the Cloud Sync Tasks screen on TrueNAS CORE.
Advanced Scheduler: Describes the fields in the Advanced Scheduler in TrueNAS CORE.

Network: Reference documentation of the various Network menu screens.

Interfaces Screen: Describes the fields in the Network Interface screen on TrueNAS CORE.
Network Summary Screen: Describes the fields in the Network Summary screen in TrueNAS CORE.
Global Configuration Screen: Describes how to use the Global Configuration screen in TrueNAS CORE.
Static Routes Screen: Describes the Static Routes screen in TrueNAS CORE.
IPMI Screen: Describes the fields on the IPMI screen in TrueNAS CORE.

Storage: Reference documentation for the various screens within the Storage menu option.

Pools: Lists the screens related to Pools in TrueNAS CORE.
Snapshots Screens: Describes the Snapshots screens on TrueNAS CORE.
VMware-Snapshots Screen: Describes the fields in the VMware Snapshot screen on TrueNAS CORE.
Disks Screens: Describes the fields in the Disk Screens in TrueNAS CORE.

Directory Services: Reference documentation of the Directory Services screens.

Active Directory Screen: Use the AD screen to configure Active Directory (AD) on TrueNAS CORE.
Idmap Screen: Use the Idmap screen to configure Identity Mapping (Idmap) on TrueNAS CORE.
LDAP Screen: Use the LDAP screen to configure Lightweight Directory Access Protocol (LDAP) server settings on TrueNAS CORE.
NIS Screen: Use the NIS screen to configure Network Information System (NIS) on TrueNAS CORE.
Kerberos Screens: Use the Kerberos screen to configure to configure Kerberos realms and keytabs on TrueNAS CORE.

Sharing: Reference documentation for all screens within the Sharing menu option.

AFP Share Screen: Provides information about the AFP Share screen in TrueNAS CORE.
Block Shares (iSCSI): Provides information about iSCSI terminology and configuration for TrueNAS CORE.
NFS Share Screen: Use the NFS share screen to configure Network File System (NFS) shares on your TrueNAS.
WebDAV Screen: Use the Sharing WebDAV screen to configure Web Distributed Authoring and Versioning (WebDAV) on your TrueNAS.
SMB Share Screen: Desctibes the SMB sharing screen in TrueNAS CORE

Services: Provides information on the Services screen and lists other services UI reference articles.

AFP Screen: Describes the AFP screen in TrueNAS CORE.
Dynamic DNS Screen: Describes the DDNS screen in TrueNAS CORE.
FTP Screen: Describes the FTP screen in TrueNAS CORE.
LLDP Screen: Describes the LLDP screen in TrueNAS CORE.
NFS Screen: Describes the NFS screen in TrueNAS CORE.
OpenVPN Screen: Describes the OpenVPN screen in TrueNAS CORE.
S.M.A.R.T. Screen: Describes the S.M.A.R.T. screen in TrueNAS CORE.
S3 Screen: Describes the S3 screen in TrueNAS CORE.
SMB Service Screen: Describes the SMB screen in TrueNAS CORE.
SNMP Screen: Describes the SNMP screen in TrueNAS CORE.
SSH Screen: Describes the SSH screen in TrueNAS CORE.
TFTP Screen: Describes the TFTP screen in TrueNAS CORE.
UPS Screen: Describes the UPS screen in TrueNAS CORE.
WebDAV Services Screen: Describes the WebDAV screen in TrueNAS CORE.

Jails, Plugins and Virtual Machines: Reference documentation for the Jails, Plugins, and Virtual Machines screens.

Jails Screens: Describes the fields in the Jails screen in TrueNAS CORE.
Virtual Machines: Describes the fields in the Virtual Machines screen in TrueNAS CORE.
Plugins Screens: Describes how to install and maintain 3rd party applications on TrueNAS CORE.

Reporting: Contains information about the graphs displayed on the Reporting screen in TrueNAS CORE.

UI Reference Guide

Table of Contents