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

General Settings Screen

The TrueNAS SCALE System Settings > General screen includes widgets for Support, GUI, Localization, NTP, and system Email functions. Each widget displays information about current settings and includes one or more buttons for related actions and configuration options.

System General Screen
Figure 1: System General Screen

The Manage Configuration dropdown provides three options to backup, restore, or reset system configuration settings.

Manage Configuration

TrueNAS SCALE allows users to manage the system configuration via uploading/downloading configurations, or resetting the system to the default configuration.

Download File

The Download File option opens the Save Configuration dialog, which allows users to download the current system configuration to the local machine.

Save Configuration
Figure 2: Save Configuration

The Export Password Secret Seed option includes encrypted passwords in the downloaded configuration file. This option allows you to restore the configuration file to a different operating system device where the decryption seed is not already present. Users must physically secure configuration backups containing the seed to prevent unauthorized access or password decryption.

Upload File

The Upload File option opens the Upload Config dialog, which allows users to choose a previously saved TrueNAS SCALE configuration to replace the current system configuration.

Upload Config
Figure 3: Upload Config

Choose File opens a file browser window where you can locate the downloaded and saved configuration. After selecting the file, it displays in the Upload Config window. Upload uploads the selected configuration file.

All passwords reset if the uploaded configuration file saved without Export Password Secret Seed enabled.

Reset to Defaults

The Reset to Defaults option opens the Reset Configuration dialog, which resets the system configuration to factory settings and restarts the system. Users must set a new login password.

Reset Configuration
Figure 4: Reset Configuration

Save the system current configuration with the Download File option before resetting the configuration to default settings.

If you do not save the system configuration before resetting it, you may lose data that you did not back up, and you will not be able to revert to the previous configuration.

Support Widget

The Support widget displays general hardware and software specs and contains links to the Documentation Hub, TrueNAS Forums, and offers TrueNAS Licensing information.

Support Widget
Figure 5: Support Widget

Add License opens the License screen.

File Ticket opens the Feedback Window.

License Screen

The License screen allows you to copy your license into the box and save it.

Click Here for More Information

When prompted to reload the page, click Reload Now.

When the End User License Agreement (EULA) opens, read it thoroughly and completely, then click I AGREE. The Support widget updates to display license and hardware information.

Select This is a production system and click Proceed to send iXsystems email notification that the system is in production.

Feedback Window

The How would you rate this page? FeedbackIcon icon opens a feedback window. Alternately, go to System Settings > 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 or improvement suggestion requires a free Atlassian account.

Click between the different tabs at the top of the window to see different 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 or Suggest an improvement

Use the Report a bug or Suggest an improvement tabs to notify the development team when a TrueNAS screen or feature is either not working as intended or can be evolved with new functionality. For example, report a bug when a middleware error and traceback appears while saving a configuration change or enter an improvement suggestion when a feature can be configured in fewer clicks.

Both bug reports and improvement suggestions are created in the publicly-visible TrueNAS Jira project and have the same reporting fields.

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 Feedback window has a single Report a bug tab 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.

Proactive Support Screen

Silver/Gold Coverage Customers can enable iXsystems Proactive Support. This feature automatically emails iXsystems when certain conditions occur in a TrueNAS system.

Click Here for More Information

To configure Proactive Support, click Proactive Support in the Support widget.

Complete all available fields, and check the Enable iXsystems Proactive Support box, then click Save.

GUI Settings Screen

Click Settings on the GUI widget to open the GUI Settings screen that allows users to configure the TrueNAS SCALE web interface address.

Click Here for More Information

Click Settings to open the GUI Settings screen.

SettingDescription
ThemeSelect a preferred color theme from the dropdown list of eight options.
GUI SSL CertificateSelect a self-signed certificate from the dropdown list. The system uses a self-signed certificate to enable encrypted web interface connections. Manage Certificates opens the Certificates screen.
Web Interface IPv4 AddressSelect a recent IP address from the dropdown list to limit 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 AddressSelect a recent IPv6 address from the dropdown list 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 PortEnter a port number for an HTTP connection to the web interface. 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 PortEnter a port number for an HTTPS connection to the web interface. This field allows configuring a non-standard port to access the GUI over HTTPS.
HTTPS ProtocolsSelect the Transport Layer Security (TLS) versions TrueNAS SCALE can use for connection security from the dropdown list. Cryptographic protocol for securing client/server connections.
Web Interface HTTP -> HTTPS RedirectSelect to 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.
Usage CollectionSelect to enable sending anonymous usage statistics to iXsystems.
Show Console MessagesSelect to display console messages in real-time at the bottom of the browser.

Localization Settings Screen

Click Settings on the Localization widget to open the Localization Settings screen that lets users localize their system to a specific region.

Click Here for More Information

Click Settings to open the Localization Settings screen.

SettingDescription
LanguageSelect a language from the dropdown list.
Console Keyboard MapSelect a language keyboard layout from the dropdown list.
TimezoneSelect a time zone from the dropdown list.
Date FormatSelect a date format from the dropdown list.
Time FormatSelect a time format from the dropdown list.

Add NTP Server Screen

Click Add on the NTP Servers widget to open the Add NTP Server screen that allows users to configure Network Time Protocol (NTP) servers, which sync the local system time with an accurate external reference.

Click Here for More Information

By default, new installations use several existing NTP servers. TrueNAS SCALE supports adding custom NTP servers. Click Add to open the Add NTP Server screen.

SettingDescription
AddressEnter the hostname or IP address of the NTP server.
BurstSelect to use a non-public NTP server. Recommended when Max Poll is greater than 10. Only use on personal NTP servers or those under direct control. Do not enable it when using public NTP servers.
IBurstSelect to speed up the initial synchronization (seconds instead of minutes).
PreferSelect when using highly accurate NTP servers such as those with time monitoring hardware. Only use for these highly accurate NTP servers.
Min PollEnter the minimum polling interval, in seconds, as a power of 2. For example, 6 means 2^6, or 64 seconds. The default is 6, and the minimum value is 4.
Max PollEnter 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, and the maximum value is 17.
ForceSelect to force the addition of the NTP server, even if it is currently unreachable.

Email Options Screen

Click Settings on the Email widget to open the Email Options screen that allows users to configure the system email send method.

Click Here for More Information

An automatic script sends a nightly email to the administrator account containing important information such as the health of the disks. Users must first configure an email address for the admin account or another administrative user in Credentials > Local Users.

The Email Options screen offers two options to set up email. Select either SMTP or GMail OAuth. The configuration settings change based on the selected radio button.

SMTP

If SMTP is selected, the screen displays the SMTP configuration fields.

SettingDescription
From EmailThe email address to use for sending emails. You must first configure the user account email in Credentials > Local Users.
From NameThe name to show in front of the sending email address, for example: TrueNAS.
Outgoing Mail ServerHost name or IP address of SMTP server to use for sending emails.
Mail Server PortSMTP port number. Typically 25, 465 (secure SMTP), or 587 (submission).
SecuritySelect the security option from the dropdown list. Options are Plain (No Encryption), SSL (Implicit TLS), or TLS (STARTTLS). See email encryption for more information on types.
SMTP AuthenticationSelect to enable SMTP AUTH using PLAIN SASL. Requires a valid user name and password.
UsernameDisplays when SMTP Authentication is selected. The user name for the sending email account, typically the full email address.
PasswordDisplays when SMTP Authentication is selected. The password for the sending email account.

Send Test Mail generates a test email to confirm the system email works correctly.

Save stores the email configuration and closes the Email Options screen.

Gmail OAuth

If GMail OAuth is selected, the screen displays Log in to Gmail to set up Oauth Credentials and the Log In To Gmail button.

After setting up Gmail OAuth authentication, the screen displays Gmail credentials have been applied and the button changes to Log In To Gmail Again.

Send Test Mail generates a test email to confirm the system email works correctly.

Save stores the email configuration and closes the Email Options screen.