TrueNAS Development Documentation
This content follows experimental development changes in TrueNAS 28, a future version of TrueNAS.
Use the Product and Version selectors above to view content specific to a stable software release.

Top Toolbar Screens

11 minute read.

Last Modified 2026-10-12 09:22 EDT

The top toolbar buttons allows for quick software feedback, displays the status of TrueCommand and directory services configured on your system, active alerts, and shows other system management options.

Icon	Name	Description
	Toggle collapse	Click to expand or collapse the main menu panel on the left side of the screen.
	Search UI	Searches UI screens and elements or redirects queries to the TrueNAS Documentation Hub.
	Send Feedback	Opens the Send Feedback feedback window for sending UI ratings and bug reports to the TrueNAS developers.
	Status of TrueCommand	Displays either the status of a TrueCommand cloud connection or a dialog that allows users to sign up for a new TrueCommand cloud connection.
	Status of TrueNAS Connect	Opens the TrueNAS Connect Service and dialog showing the current status of the service and the TrueNAS Connect dialog that allows you to connect to the service and open the login screen for TrueNAS Connect.
	Update Status	Shows the system update progress and which user account started the update. Only appears in the top bar when a TrueNAS system update starts.
info	Directory Services status	Displays a dialog with the status of Active Directory and LDAP directory servers configured on the system.
assignment	Running Jobs	Displays the Running Jobs dialog. Click the History button to display the Tasks screen with a list of All, Active or Failed tasks or processes.
notifications	Alerts	Displays a list of system alerts and a dropdown list with the alert options Alert Settings and Email.
account_circle	Settings	Displays a dropdown list of setting options Change Password, Two-Factor Authentication (when Global 2FA is enabled), My API Keys, Guide, and Log Out.
power_settings_new	Power options	Displays the power related options Restart or Shut Down.

Search UI

The Search UI global search bar allows users to search for screens and elements within the TrueNAS UI or to redirect search terms to the TrueNAS Documentation Hub.

Using Global Search

Searching UI Fields

Click the Search UI bar or type Ctrl + / to select the UI global search.

Entering a Query

Enter a keyword to search for elements within the TrueNAS UI. For example, enter SMB to search for results relating to SMB shares and the SMB service.

Global search returns UI screens, widgets, and button names matching the entered query. Click View More to view additional results, if needed.

Navigating Results

Select a screen result under UI to go to the matching screen within the TrueNAS UI. For example, select Shares SMB to go to the SMB screen.

Select a widget or button result to go to the screen containing the element. For example, select Shares SMB Add SMB Share to locate to the Add button on the SMB screen.

Figure 5: Global Search Result - Element

TrueNAS indicates the selected element with a glow effect.

Searching TrueNAS Documentation

Click Search Documentation for «query» to redirect the search to the TrueNAS Documentation Hub. TrueNAS opens a new browser tab to display documentation search results for the query.

Use this option to search for tutorials and UI reference documentation for the feature, or to look for further information when the entered search term does not find any matching UI elements.

Send Feedback

The icon on the toolbar at the top of all UI screens, and the File Ticket button on the System > General Settings > Support card open the Send Feedback window.

There are two version of the Send Feedback window: community and Enterprise.

Send Feedback (Community Version)

The Send Feedback window community version allows non-Enterprise users to submit bug reports and open Jira tickets if they have a Jira account.

Login To Jira To Submit opens a Jira login screen where you enter your Jira credentials so TrueNAS can create the ticket using your credentials.

Community Report a bug Settings

Setting	Description
Subject	Brief statement or description of the issue being reported. This becomes the title for the Jira ticket. For example, Traceback received when pressing Save.
Message	Specifies a full description of the nature of the issue encountered, steps taken before the issue occured, and the result or steps taken. Provides examples of what to enter. Populates the Jira ticket description field after clicking Login to Jira to Submit.
Attach debug	Downloads a system debug and attaches it to a Jira ticket in the Private Attachement Area for TrueNAS, which provides a secure way for users to submit confidential but required data included in the debug file.
Take screenshot of the current page	Takes a screenshot of the currently active TrueNAS screen and attaches it to the ticket created.
Attach additional images	Opens a file browser to select additional files or screenshots to attach to the ticket. Allowed files are screenshots, video files, or other files (logs, etc) to further clarify the issue reported.

TrueNAS Enterprise
Send Feedback (Enterprise Version)
The Enterprise version of the Send Feedback window includes contact, system, and other details required to support Enterprise customer reports. If the system is down or impacting a prodcution system please contact TrueNAS support directly.
Figure 8: Enterprise Send Feedback Window
User Guide opens the Documentation hub.
EULA opens the End User License Agreement (EULA) screen showing a copy of the TrueNAS end user license agreement. I Agree digitally marks it as signed, then closes the screen and updates the Support card with the license and hardware information.
Submit sends the bug report to TrueNAS.
Enterprise Report a bug Settings
Setting Description
Name Specifies the Enterprise contact person reporting the issue or the person TrueNAS should contact regarding the reported issue.
Phone Specifies the phone number for the contact person.
Email Specifies the email for the contact person.
CC Specifies any additional email addresses to receive follow-up communication regarding the reported issue.
Type Specifies the type of issue being reported. For problems use the default Bug as the type setting.
Environment Specifies the environment the system operates in. Select Production for systems in production environments rather than test systesm.
Criticality Sets the level of importance for the ticket. For example, production systems in a down state are critical where others might only require the inquiry level. For downed systems impacting production please contact support directly!
Subject Brief statement or description of the issue being reported. This becomes the title for the Jira ticket.
Message Specifies a full description of the nature of the issue encountered, steps taken before the issue occured, and the result or steps taken. Provides examples of what to enter. Populates the Jira ticket description field after clicking Login to Jira to Submit.
Attach debug Downloads a system debug and attaches it to a Jira ticket in the Private Attachement Area for TrueNAS, which provides a secure way for users to submit confidential but required data included in the debug file.
Take screenshot of the current page Takes a screenshot of the currently active TrueNAS screen and attaches it to the ticket created.
Attach additional images Opens a file browser to select additional files or screenshots to attach to the ticket. Allowed files are screenshots, video files, or other files (logs, etc) to further clarify the issue reported.

Setting	Description
Name	Specifies the Enterprise contact person reporting the issue or the person TrueNAS should contact regarding the reported issue.
Phone	Specifies the phone number for the contact person.
Email	Specifies the email for the contact person.
CC	Specifies any additional email addresses to receive follow-up communication regarding the reported issue.
Type	Specifies the type of issue being reported. For problems use the default Bug as the type setting.
Environment	Specifies the environment the system operates in. Select Production for systems in production environments rather than test systesm.
Criticality	Sets the level of importance for the ticket. For example, production systems in a down state are critical where others might only require the inquiry level. For downed systems impacting production please contact support directly!
Subject	Brief statement or description of the issue being reported. This becomes the title for the Jira ticket.
Message	Specifies a full description of the nature of the issue encountered, steps taken before the issue occured, and the result or steps taken. Provides examples of what to enter. Populates the Jira ticket description field after clicking Login to Jira to Submit.
Attach debug	Downloads a system debug and attaches it to a Jira ticket in the Private Attachement Area for TrueNAS, which provides a secure way for users to submit confidential but required data included in the debug file.
Take screenshot of the current page	Takes a screenshot of the currently active TrueNAS screen and attaches it to the ticket created.
Attach additional images	Opens a file browser to select additional files or screenshots to attach to the ticket. Allowed files are screenshots, video files, or other files (logs, etc) to further clarify the issue reported.

Status of TrueCommand

The Status of TrueCommand icon lets users sign up with and connect to TrueCommand Cloud.

Clicking Signup opens the TrueCommand sign-up page in a new tab.

After users sign up, they can click the Connect button and enter their API key to connect TrueNAS to TrueCommand Cloud.

TrueNAS displays a message telling users to check their email for verification instructions.

Status of TrueNAS Connect

TrueNAS provides quick access to TrueNAS Connect from the top toolbar in your TrueNAS system. The Status of TrueNAS Connect icon opens the TrueNAS Connect dialog. Before you sign up for TrueNAS Connect, the dialog shows it is waiting to connect.

Click Get Connected to open the TrueNAS Connect sign-in screen.

After connecting to TrueNAS Connect and registering the system, the Status of TrueNAS Connect icon shows an active status indicator. The TrueNAS Connect dialog shows the status of the active connection.

Figure 14: TrueNAS Connect Dialog Connected

Click Open TrueNAS Connect to open the TrueNAS Connect management interface. Click Disable Service to disconnect the system from TrueNAS Connect.

See connect.truenas.com for more information.

Directory Services Monitor

When configured, the Directory Services Monitor info icon button displays the status of Active Directory and LDAP services.

Click on either service to go to its configuration screen.

Jobs

The Running Jobs assignment icon button opens the Running Jobs window showing a minimized view of all running, waiting, and failed jobs/processes. Hover the mouse over an error job to view a pop-up window with the error message for that failed job.

Click the minus (-) at the top right corner of any dialog or pop-up window to minimize a job/process.

Click on a running job to open a dialog for that job.

A running job shows a progress bar and a button to the right of the job. Click on this to show the Abort dialog. Click Abort to stop the job and abort the process.

Beginning in 25.04, the Abort option is only available for select jobs. Jobs that are unable to be aborted are listed without the button as an option.

Click on Go to Jobs to open the Jobs screen with tabs to screens listing all successful, active, or failed and aborted jobs. Click on the All, Active, or Failed button at the top of the screen to show the log of jobs that fit that classification.

Click View next to a task to see the log information and error message for that task.

For more information, see Jobs Screens.

Alerts

The Alerts notifications icon displays a list of current alert notifications. To remove an alert notification click Dismiss below it or use Dismiss All Alerts to remove all notifications from the list. You can also select the All Alerts, Critical, Warnings, Info, or Dismissed alert type tabs to filter alerts by type.

Use the settings icon to display the Alerts dropdown list with two options: Alert Settings and Email.

Select Alert Settings to add or edit existing system alert services and configure alert options such as the warning level and frequency and how the system notifies you. See Alerts Settings Screens for more information.

TrueNAS Enterprise
The Alert Settings Screens article includes information about the TrueNAS Enterprise high availability (HA) alert settings.

Select Email to configure the method for the system to send email reports and alerts. See Setting Up System Email for information about configuring the system email service and alert emails.

Alerts Admonitions

Each screen in TrueNAS displays relevant alerts with an admonition box.

Click Learn More on an admonition to view documentation related to the issue, or click close to dismiss the alert.

Settings

The account_circle Settings button shows a menu of general system settings options. The options are Change Password, Preferences, Two-Factor Authentication (when Global 2FA is enabled), My API Keys, Guide, and Log Out.

The dialpad Change Password button displays a dialog where you can change the login password for the currently logged-in administrator.

The settings Preferences option opens a screen with Theme, Session Timeout, and Localization settings to customize the UI for the currently logged in user account.

The Two-Factor Authentication button displays only when Global 2FA is enabled and opens the Two Factor Auth screen. Users can also access this screen from Credentials > Two Factor Auth.

The laptop My API Keys button displays the API Keys screen that lists current API keys and where you can add or manage API keys that identify outside resources and applications without a principal.

The library_books Guide button opens the TrueNAS Documentation Hub website in a new browser tab.

The exit_to_app Log Out button logs the current user out of the TrueNAS UI.

Preferences Screen Settings

The Preferences screen customizes the UI screens for the currently logged-in user.

Setting	Description
Theme	Sets the UI color theme for the currently logged-in user. Options are: ixDark (default option), ixBlue, Dracula, Nord, Paper, Solarized Dark, Midnight, and High Contrast. Selecting an option immediately changes the UI to the selected color theme.
Session Timeout	Sets the number of seconds a session remains active or inactive before it is automatically ended by logging out the user.
Language	Sets the lauguage for the UI screen. The default setting is English, but it might be customized to the language based on the country of origin for an Enterprise customer. You can filter the list by typing in the field after clearing the default value, or use the scroll option to find and select a language.
Date Format	Sets the desired date format for the UI.
Time Format	Sets the desired time format for the UI.

Power

The Power power_settings_new button provides two options that let the user restart or shut down their TrueNAS system.

Industry

Use Cases

TrueNAS as an Alternative

Support

Resources

Community