Welcome to this Web Interface (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 UI, beginning with the top panel and then descending through each option in the 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.
Each major section of TrueNAS CORE/Enterprise documentation is organized as a standalone book:
The Getting Started Guide provides the first steps for your experience with TrueNAS CORE/Enterprise:
Recommendations and considerations when selecting hardware for CORE.
Software Licensing information.
Installation tutorials.
First-time software configuration instructions.
Configuration Tutorials have many community and iXsystems -provided procedural how-tos for specific software use-cases.
The UI Reference Guide describes each section of the CORE web interface, including descriptions for each configuration option.
API Reference describes how to access the API documentation on a live system and includes a static copy of the API documentation.
CORE Security Reports links to the TrueNAS Security Hub and also contains any additional security-related notices.
Ready to get started? Choose a topic or article from the left-side Navigation pane.
Click the < symbol to expand the menu to show the topics under this section.
1 - Top Menu
This section has reference documentation for the options panel that is at the top of the TrueNAS UI.
Across the top row are links to outside resources and buttons to control the system.
The options described from left to right:
Logos and Side Panel Controls
The logo in the upper-left corner shows the installed TrueNAS software.
Clicking the image takes you to the system Dashboard.
The next two buttons control how the side menu displays.
Click the (menu icon) to hide or show the entire left side panel.
Click the (chevron left icon) to collapse the left side panel to shortcut icons or expand to show icons and text.
Click the iXsystems logo to open the iXsystems corporate website in a new browser tab.
Status Icons
The remaining icons in the top menu show various statuses. They also provide system options.
The icon next to the iXsystems logo shows TrueCommand Cloud connection options.
Clicking the icon shows options for signing up for TrueCommand Cloud. It also displays options for connecting/disconnecting from TrueCommand Cloud.
When the system is not connected to TrueCommand Cloud the options are not available. The icon appears but is gray in color.
TrueNAS Enterprise compatible hardware has a (cloud with HA text) icon that shows the current status of High Availability (HA) on the system.
A checkmark () cloud icon indicates HA is functional.
An on top of the cloud icon indicates HA disabled or otherwise unavailable.
Task Manager
The (clipboard icon) is the system Task Manager.
Click the icon to show a list of running or completed TrueNAS tasks.
Tasks are sortable by their success or error State, task Method, and Progress.
Typing text in the Filter field shows tasks that match the characters typed into the field.
Clicking an entry shows more details about that task. This includes start and end timestamps.
Alerts
The (bell icon) contains system notification messages.
The icon changes to when TrueNAS creates a new alert.
Clicking the icon slides out a panel from the right side of the screen that lists each alert.
Dismiss or reopen alerts in this panel.
Dismissing an alert does not prevent it from recurring. TrueNAS might create a new alert if the alert conditions continue to exist on the system.
Configure the alert system in System > Alert Settings.
Settings
The (gear icon) contains links to various system specific options.
Change Password is a shortcut for changing the administrator (root) account password.
Password required to log in to the TrueNAS web interface.
Please back up or otherwise memorize the updated password when changing it.
Preferences contains theme and other visual options for the web interface:
Name
Description
Choose Theme
Select a preferred theme from the dropdown list. There are several built-in themes designed for light and dark modes. High contrast viewing options of the web interface are also listed.
Prefer buttons with icons only
Select to preserve screen space using icons and tooltips instead of text labels.
Enable Password Toggle
Select to display an eye icon next to password fields. Clicking the icon reveals the password.
Reset Table Columns to Default
Select to reset all tables to display system default table columns.
Retro Logo
Select to revert branding back to FreeNAS.
Reset All Preferences to Default
Select to reset all user preferences to their default values. Preserves custom themes.
Update Preferences
Click to save changes to the General Preferences.
Create and manage custom themes on this screen.
Power
The (power icon) has the options for changing the system state.
Log Out exits the web interface and shows the login screen.
The system remains powered on.
Restart initiates a power cycle.
The web interface closes. Discontinues power to the system which is then re-enabled.
The login screen appears when the boot cycle completes.
Shut Down exits the web interface. The process to safely discontinue power to the system begins.
The system remains offline until the power situation corrects.
Use the Task Manager screen to display a list of tasks performed by your TrueNAS.
1.1 - Task Manager
Use the Task Manager screen to display a list of tasks performed by your TrueNAS.
The Task Manager displays a list of tasks performed by the TrueNAS system. It starts with the most recent. Click the assignment to open the Task Manager.
Name
Description
Filter
Search function to locate or filter the list for a particular running task.
View Logs
Tasks with log file output have a View Logs button to show the log files.
State
Column header for tasks that shows the current condition of the task. Indicates whether the task completed or is still in progress. Click State to sort by this column.
Method
Column header for tasks that indicates both the name of the task and the method used. Click Method to sort by this column.
Progress
Column header for tasks that indicates the progress of the the task. Measured by percentage from start to completion. Click Progress to sort by this column.
CLOSE
Closes the Task Manager dialog. Click anywhere off the dialog or use the Esc to close this dialog.
Use the Interface Preferences screen to display a list of general preferences for your TrueNAS.
There are a few adjustable interface preferences. Also included is a built-in theme editor for creating your own TrueNAS color schemes.
To access user preferences, click settings> Preferences.
This page has options to adjust global settings in the web interface. There are also options to manage custom themes and create new themes.
General Preferences
Name
Description
Choose Theme
Select a preferred theme from the dropdown list. Prebuilt and custom themes are visible here.
Prefer buttons with icons only
Select checkbox to preserve screen space. Displays icons and tooltips instead of text labels.
Enable Password Toggle
Select checkbox to make an eye icon appear next to password fields. Click the icon to reveal the password.
Reset Table Columns to Default
Select checkbox to reset the display of all table columns as system default.
Retro Logo
Select checkbox to revert branding back to FreeNAS.
Reset All Preferences to Default
Select checkbox to reset all user preferences to their default values. Does not reset custom themes.
UPDATE PREFERENCES
Cick button to apply the current checkbox settings to the web interface.
Manage Custom Themes
Name
Description
theme name (variable)
Use checkbox to select a custom theme if listed.
DELETE SELECTED
Click button to remove each selected custom theme from the system.
CREATE NEW THEME
Click button to open the theme editor.
Custom Theme Editor
Create Theme
Name
Description
Load colors from existing theme
Select the theme option from the dropdown list. Imports settings into the Create Theme and Preview tabs.
GENERAL
Click to display the GENERAL tab with the primary options for a new theme.
COLORS
Click to display the COLORS tab with color options for a new theme.
PREVIEW
Click to display the PREVIEW tab. The PREVIEW updates to reflect current selections.
GENERAL
Name
Description
Custom Theme Name
Enter a name to identify the new theme.
Menu Label
Enter a short name to use in the TrueNAS web interface menus.
Description
Enter a short description of the new theme.
Choose Primary
Select a generic color from the dropdown list to use as the primary theme color. Or import a specific color setting.
Choose Accent
Select a generic color from the dropdown list to use as the accent color for the theme. Or import a specific color setting.
Choose Topbar
Select a color from the dropdown list to use as the color for the top menu bar in the web interface.
SUBMIT
Click to save the current selections and create the new theme.
CANCEL
Click to return to the Preferences screen without creating a new theme.
COLORS
Name
Description
Background 1
Either click on the color swatch or enter a hex value. This value applies to the bg1 option in the GENERAL tab.
Background 2
Either click on the color swatch or enter a hex value. This value applies to the bg2 option in the GENERAL tab.
Foreground 1
Either click on the color swatch or enter a hex value. This value applies to the fg1 option in the GENERAL tab.
Foreground 2
Either click on the color swatch or enter a hex value. This value applies to the fg2 option in the GENERAL tab.
Alt Background 1
Either click on the color swatch or enter a hex value. This value applies to the alt-bg1 option in the GENERAL tab.
Alt Background 2
Either click on the color swatch or enter a hex value. This value applies to the alt-bg2 option in the GENERAL tab.
Alt Foreground 1
Either click on the color swatch or enter a hex value. This value applies to the alt-fg1 option in the GENERAL tab.
Alt Foreground 2
Either click on the color swatch or enter a hex value. This value applies to the alt-fg2 option in the GENERAL tab.
Yellow
Either click on the color swatch or enter a hex value. This value applies to the yellow option in the GENERAL tab.
Orange
Either click on the color swatch or enter a hex value. This value applies to the orange option in the GENERAL tab.
Red
Either click on the color swatch or enter a hex value. This value applies to the red option in the GENERAL tab.
Magenta
Either click on the color swatch or enter a hex value. This value applies to the magenta option in the GENERAL tab.
Violet
Either click on the color swatch or enter a hex value. This value applies to the violet option in the GENERAL tab.
Blue
Either click on the color swatch or enter a hex value. This value applies to the blue option in the GENERAL tab.
Cyan
Either click on the color swatch or enter a hex value. This value applies to the cyan option in the GENERAL tab.
Green
Either click on the color swatch or enter a hex value. This value applies to the green option in the GENERAL tab.
SUBMIT
Click the button to save the current selections and create the new theme.
CANCEL
Click the button to return to the Preferences screen without creating a new theme.
PREVIEW
Name
Description
Global Preview
Color selections display in the PREVIEW. Click the toggle to turn the display of the PREVIEW widget on or off.
Preview
Name
Description
Buttons
This tab shows examples of web interface buttons. The buttons display with the current theme settings applied.
Forms
This tab shows examples of web interface form options. The options display with the current theme settings applied.
The web interface dashboard provides system details and shortcuts to various configuration screens.
Dashboard Cards
Card
Description
System Information
Shows simple system-level information about TrueNAS, including hardware name (with compatible systems), TrueNAS version, system hostname, and system uptime. Includes a button to update the installed version of TrueNAS.
CPU
Shows current CPU utilization and heat (with compatible hardware). Includes a shortcut icon to the in-depth CPU reporting screen.
Memory
Shows total memory available to the system and the current breakdown of memory usage. Includes a shortcut icon to the in-depth memory utilization screen.
Pool
Shows details about a configured storage pool. One card is created for each storage pool on the system. Includes shortcut icons to the pool configuration and statistics screens.
Interface
Shows details about system network interfaces, including current status and configuration details. Includes shortcut icons to the interface configuration and statistics screens.
TrueNAS Help
Contains links to verious documentation and assistance portals.
3 - Accounts
CORE UI User and Group screens documentation.
This section has articles documenting the TrueNAS local User and Group screens.
Name and Provider Authentication Amazon S3 Advanced Options BackBlaze B2 Box DropBox FTP Google Cloud Storage Google Drive HTTP Hubic Mega Microsoft Azure Blob Storage Microsoft One Drive OpenStack Swift pCloud SFTP WebDav Yandex Name and Provider Name Description Name Enter a name for the new credential. Provider Third-party Cloud service providers.
Identifier and Type Internal and Intermediate CAs Import CAs Identifier and Type Name Description Name Descriptive identifier for this certificate authority. Type Choose between Internal CA, Intermediate CA, and Import CA. An Internal CA functions like a publicly trusted CA to sign certificates for an internal network. They are not trusted outside the private network.
This article describes how to configure two-factor authentication on TrueNAS CORE.
4.1 - General
This article describes the fields for the general system settings for TrueNAS CORE.
GUI
Name
Description
GUI SSL Certificate
The system uses a self-signed certificate to enable encrypted web interface connections. To change the default certificate, select a different certificate that was created or imported in the Certificates menu.
Web Interface IPv4 Address
Choose a recent IP address to limit the usage when accessing the administrative GUI. The built-in HTTP server binds to the wildcard address of 0.0.0.0 (any address) and issues an alert if the specified address becomes unavailable.
Web Interface IPv6 Address
Choose a recent IPv6 address to limit the usage when accessing the administrative GUI. The built-in HTTP server binds to the wildcard address of 0.0.0.0 (any address) and issues an alert if the specified address becomes unavailable.
Web Interface HTTP Port
Allow configuring a non-standard port to access the GUI over HTTP. Changing this setting might require changing a Firefox configuration setting.
Web Interface HTTPS Port
Allow configuring a non-standard port to access the GUI over HTTPS.
HTTPS Protocols
Cryptographic protocols for securing client/server connections. Select which Transport Layer Security (TLS) versions TrueNAS can use for connection security.
Web Interface HTTP -> HTTPS Redirect
Redirect HTTP connections to HTTPS. A GUI SSL Certificate is required for HTTPS. Activating this also sets the HTTP Strict Transport Security (HSTS) maximum age to 31536000 seconds (one year). This means that after a browser connects to the web interface for the first time, the browser continues to use HTTPS and renews this setting every year.
Localization
Name
Description
Language
Select a language from the drop-down menu.
Date Format
Choose a date format.
Console Keyboard Map
Select a keyboard layout.
Timezone
Select a time zone.
Time Format
Choose a time format.
Other Options
Name
Description
Crash reporting
Send failed HTTP request data which can include client and server IP addresses, failed method call tracebacks, and middleware log file contents to iXsystems.
Usage collection
Enable sending anonymous usage statistics to iXsystems.
SAVE CONFIG: Saves a backup copy of the current configuration database in the format hostname-version-architecture.
UPLOAD CONFIG: Browse to a previously saved configuration file to restore that configuration.
RESET CONFIG: Reset the configuration database to the default base version.
This article describes the fields for the NTP Server Settings screen on TrueNAS CORE.
NTP Server Settings
Name
Description
Address
Enter the hostname or IP address of the NTP server.
Burst
Recommended when Max. Poll is greater than 10. Only use on personal NTP servers or those under direct control. Do not enable when using public NTP servers.
IBurst
Speeds up the initial synchronization (seconds instead of minutes).
Prefer
Should only be used for highly accurate NTP servers such as those with time monitoring hardware.
Min Poll
The minimum polling interval, in seconds, as a power of 2. For example, 6 means 2^6, or 64 seconds. The default is 6, minimum value is 4.
Max Poll
The maximum polling interval, in seconds, as a power of 2. For example, 10 means 2^10, or 1,024 seconds. The default is 10, maximum value is 17.
Force
Forces the addition of the NTP server, even if it is currently unreachable.
This article describes advanced options for configuring system settings on TrueNAS CORE.
System > Advanced contains advanced options for configuring system settings.
These options have reasonable defaults in place.
Make sure you are comfortable with ZFS, FreeBSD, and system configuration backup and restoration before making any changes.
Console
Name
Description
Show Text Console without Password Prompt
Unset to add a login prompt to the system before the console menu is shown.
Enable Serial Console
Do not set this if the Serial Port is disabled. Serial Port and Serial Speed options are visible when this is set.
Serial Port
When Enable Serial Console is set, the available serial port hex addresses are 0x2F8 or 0x3f8.
Serial Speeds
When Enable Serial Console is set, the available serial speeds that can be used by the serial port are 9600 bps, 19200 bps, 38400 bps, 57600 bps, or 115200bps.
MOTD Banner
The message to show when a user logs in with SSH.
Storage
Name
Description
Swap Size in GiB (CORE only)
By default, all data disks are created with the amount of swap specified. Changing the value does not affect the amount of swap on existing disks, only disks added after the change. Does not affect log or cache devices as they are created without swap. Setting to 0 disables swap creation completely. STRONGLY DISCOURAGED
LOG (Write Cache) Overprovision Size in GiB
Overprovisioning a ZFS Log SSD can increase its performance and lifespan by distributing writes and erases across more drive flash blocks. Defining a number of GiB here overprovisions ZFS Log disks during pool creation or extension. Examples: 50 GiB, 10g, 5GB
GUI
Name
Description
Show Console Messages
Display console messages in real time at the bottom of the browser.
Show Advanced Fields by Default
Set to always show advanced fields, when available.
Kernel
Name
Description
Enable Autotune
Activates a tuning script which attempts to optimize the system depending on the installed hardware. Warning: Autotuning is only used as a temporary measure and is not a permanent fix for system hardware issues.
Enable Debug Kernel
Set to boot a debug kernel after the next system reboot.
Self-Encrypting Drive
Name
Description
ATA Security User
User passed to camcontrol security -u to unlock SEDs
SED Password
Global password to unlock SEDs.
Syslog
Name
Description
Use FQDN for Logging
Set to include the Fully-Qualified Domain Name (FQDN) in logs to precisely identify systems with similar hostnames.
Syslog Level
When Syslog Server is defined, only logs matching this level are sent.
Syslog Server
Remote syslog server DNS hostname or IP address. Nonstandard port numbers can be used by adding a colon and the port number to the hostname, like mysyslogserver:1928. Log entries are written to local logs and sent to the remote syslog server.
Syslog Transport
Transport Protocol for the remote system log server connection. Choosing Transport Layer Security (TLS) also requires selecting a preconfigured system Certificate.
Replication
Name
Description
Replication Tasks Limit
Limit the maximum number of replication tasks that can be executed simultaneously.
SAVE DEBUG generates text files that contain diagnostic information.
This article provides information about viewing enclosures, disks and hardware on TrueNAS CORE.
Only compatible TrueNAS hardware and expansion shelves available from iXsystems allow seeing the View Enclosure option.
To learn more about available iXsystems products, see the TrueNAS Systems Overview or browse the Hardware documentation.
Click an enclosure to show details about that hardware.
Name
Description
Disks
Shows a graphic representation of the TrueNAS hardware and details about connected disks.
Cooling
Shows the current status and RPM of each connected fan.
Enclosure Services Controller Electronics
Shows the enclosure status.
Power Supply
Shows details about each power supply.
SAS Connector
Shows the status of the SAS connector components.
Temperature Sensor
Shows the current temperature of each expansion shelf and the disk chassis.
Voltage Sensor
Shows the current voltage for each sensor, VCCP, and VCC.
This article describes the system dataset screen on TrueNAS CORE.
The system dataset stores debugging core files, encryption keys for encrypted pools, and Samba4 metadata such as the user and group cache and share level permissions.
Name
Description
System Dataset Pool
Select the pool to contain the system dataset.
Syslog
Store system logs on the system dataset. Unset to store system logs in /var/ on the operating system device.
This article contains information about the Reporting screen on TrueNAS CORE.
TrueNAS has a built in reporting engine that displays helpful graphs and information about the system processes.
TrueNAS uses Graphite for metric gathering and visualizations.
Configure system reporting on the System > Reporting screen.
General Options
Name
Description
Report CPU usage in Percent
Reports CPU usage in percent instead of units of kernel time.
Graphite Separate Instances
Sends the plugin instance and type instance to Graphite as separate path components: host.cpu.0.cpu.idle. Disabling sends the plugin and plugin instance as one path component and type and type instance as another: host.cpu-0.cpu-idle.
Maximum time (in months) TrueNAS stores a graph. Allowed values are 1-60. Changing this value causes the Confirm RRD Destroy dialog to display. Changes do not take effect until TrueNAS destroys the existing reporting database.
Number of Graph Points
The number of points for each hourly, daily, weekly, monthly, or yearly graph. Allowed values are 1-4096. Changing this value displays the Confirm RRD Destroy dialog. Changes do not take effect until TrueNAS destroys the existing reporting database.
Reset to Defaults
Resets all entered values and settings back to defaults.
Report history is cleared after changing and saving CPU reporting, graph age, or graph points.
For information on the Reporting screen graphs see System Reporting.
Reporting data is saved and preserved across system upgrades and reboots.
This allows viewing usage trends over time.
This data is frequently written and should not be stored on the boot pool or operating system device.
Reporting data is saved in /var/db/collectd/rrd/.
Enter or paste the API key. Find the API key by signing into the OpsGenie web interface and going to Integrations/Configured Integrations. Click the desired integration, Settings, and read the API Key field.
API URL
Leave empty for default OpsGenie API.
Name
Description
Service Key
Enter or paste the “integration/service” key for this system to access the PagerDuty API.
Hostname or IP address of the system to receive SNMP trap notifications.
Port
UDP port number on the system receiving SNMP trap notifications. The default is 162.
SNMPv3 Security Model
Enable the SNMPv3 security model.
SNMP Community
Network community string. The community string acts like a user ID or password. A user with the correct community string has access to network information. The default is public. For more information, see this helpful SNMP Community Strings tutorial.
icon next to the iXsystems logo shows 
