TrueNAS 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.

Top Toolbar

8 minute read.

Last Modified 2024-11-15 16:32 EST

The top toolbar icon buttons provide access to the iXsystems website, displays the status of TrueCommand and directory services configured on your system, and displays other configuration menu 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.
	iXsystems	Opens the iXsystems home page website where users can find information about storage and server systems. Users can also use the iXsystems home page to access their customer portal and community section for support.
	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.
	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	Jobs	Displays the 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, API Keys, Guide, About, 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 an arrow.

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 Send Feedback FeedbackIcon icon opens a feedback window. Alternately, go to System > General, find the Support widget, and click File Ticket to see the feedback window.

The feedback window allows users to send page ratings, comments, vote for new features on the community forum, report issues, or suggest improvements directly to the TrueNAS development team. Submitting a bug report requires a free Atlassian account.

Click between the tabs at the top of the window to see options for your specific feedback.

Rate this page

Use the Rate this page tab to quickly review and provide comments on the currently active TrueNAS user interface screen. You can include a screenshot of the current page and/or upload additional images with your comments.

Report a bug

Use the Report a bug tab to notify the development team when a TrueNAS screen or feature is not working as intended. For example, report a bug when a middleware error and traceback appears while saving a configuration change.

Bug reports are created in the publicly-visible TrueNAS Jira project.

Enter a descriptive summary in the Subject. TrueNAS can show a list of existing Jira tickets with similar summaries. When there is an existing ticket about the issue, consider clicking on that ticket and leaving a comment instead of creating a new one. Duplicate tickets are closed in favor of consolidating feedback into one report.

Enter details about the issue in the Message. Keep the details concise and focused on how to reproduce the issue, what the expected result of the action is, and what the actual result of the action was. This helps ensure a speedy ticket resolution. Include system debug and screenshot files to also speed up the issue resolution.

Bug Reports from Enterprise Licensed Systems

TrueNAS Enterprise
When an Enterprise license is applied to the system, the Report a bug tab has additional environment and contact information fields for sending bug reports directly to iXsystems.
Figure 8: TrueNAS Enterprise Bug Report Form
Filling out the entire form with precise details and accurate contact information ensures a prompt response from the iXsystems Customer Support team.

Status of TrueCommand

The Status of TrueCommand TrueCommandIcon 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.

Directory Services Monitor

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 Jobs assignment icon button displays all running and failed jobs/processes. Users can see minimized jobs/processes here.

Users can minimize a job/process by clicking the minus (-) at the top right corner of any dialog or pop-up window.

Click on a running task to display a dialog for that running task.

A running job shows a progress bar and a white circle with a square in the middle to the right of the job. Click on this to show the Abort dialog. Click Abort to stop the job and abort the process.

Click on History to open the Tasks screen with lists of all successful, active, 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 Tasks 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.

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.

Settings

The account_circle Settings icon button displays a menu of general system settings options. The options are Change Password, Two-Factor Authentication, Preferences, API Keys, Guide and About.

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

The Two-Factor Authentication icon button opens the Two-Factor Authentication Screen.

The laptop API Keys icon 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 icon button opens the TrueNAS Documentation Hub website in a new browser tab.

The info About icon button displays a window with links to the TrueNAS Documentation Hub, the TrueNAS Community Forums, the FreeNAS Open Source Storage Appliance GitHub repository, and the iXsystems home page. Use the Close button to close the window.

The info Log Out icon button logs the currently logged in user out of the TrueNAS UI.

Power

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

Alerts: Describes the TrueNAS alert system.

Alert Settings Screens: The Alert Settings screen allows users to set the warning levels and frequency of alerts.
Email Screens: Provides information on the email configuration screens for SMTP and GMail OAuth.

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

API Keys Screen: Describes how the API keys screen in TrueNAS.
Two-Factor Authentication Screen: Provides information on two-factor authentication screen settings.

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