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

The SCALE top navigation top toolbar provides access to functional areas of the UI that you might want to directly access while on other screens in the UI. Icon buttons provide quick access to dropdown lists of options, dropdown panels with information on system alerts or tasks, and can include access to other information or configuration screens. It also shows the name of admin user currently logged into the system to the left of the Settings and Power icons.

You can also collapse or expand the main function menu on the left side of the screen.

Search UI

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

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.

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.

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

iXsystems

The iXsystems logo opens the iXsystems home page where users can find information about iXsystems storage and server systems.

Users can also use the iXsystems home page to access their customer portal and the community section for support.

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, and 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.

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

You can abort active jobs (for example, wiping a disk) by clicking the white circled X next to the active job.

Click on History to open the Tasks screen with lists of all successful, active, and failed 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 SCALE 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 Settings account_circle icon opens a dropdown list of options to change passwords, set up user two-factor authentication, create and manage API keys, access the TrueNAS API guide, see information on the system, and to logout of the SCALE UI.

Change Password

Click on the Change Password dialpad icon button to display the change password dialog where you can enter a new password for the currently logged-in user.

Click on the visibility_off icon to display entered passwords. To stop displaying the password, click on the visibility icon.

API Keys

Click on API Keys laptop to add an API key. API keys identify an outside resource or application without a principal. For example, when adding a new system to TrueCommand if you are required to add an API key to authenticate the system. Use this function to create an API key for this purpose.

Click API Docs to access the API documentation portal with information on TrueNAS SCALE API commands.

See API Keys for more information on adding or managing API keys.

Guide and About

Click on Guide library_books to open the TrueNAS Documentation Hub in a new tab.

Click on About to display the information window with links to the TrueNAS Documentation Hub, TrueNAS Community Forums, FreeNAS Open Source Storage Appliance GitHub repository, and iXsystems home page.

Log Out Log Out logs the current user out of the SCALE UI, but does not power off the system. The Read-Only Admin and Sharing Admin roles only have access to the Log Out option.
Power Options

Click the Power power_settings_new button to open the dropdown list of power options. Options Restart which logs you out of the SCALE UI and restarts the server or Shut Down which logs you out of the SCALE UI and powers off the system as though you pressed the power button on the physical server.

With the implementation of administrator roles, the power options are locked based on the level of privileges for the administrator role. The full administrator has access to both power options but readonly and sharing admin roles do not. The power options that show a lock icon indicate the function is not permitted.

Content