Updating TrueNAS

TrueNAS has several software branches (linear update paths) known as trains. If TrueNAS is in a prerelease train it can have various preview/early build releases of the software.

The Update Screen only displays the current train. When upgrading TrueNAS to a new major version, follow the upgrade path of major versions until the system is on the desired major version release. For more information on other available trains and the upgrade path from one version to the next, see Software Releases.

See the Software Status page for the latest recommendations for software usage. Do not change to a prerelease or nightly release unless you intend to keep the system permanently on early versions and are not storing critical data on it.

If you are using a non-production train, be prepared to experience bugs or other problems. Testers are encouraged to submit bug reports and debug files. For information on how to file an issue ticket see Filing an Issue Ticket in TrueNAS.

The TrueNAS Update screen provides users with two different updated methods for the system, automatic or manual.

We recommend updating TrueNAS when the system is idle (no clients connected, no disk activity, no ongoing S.M.A.R.T. tests, etc.). The system restarts after an upgrade. Update during scheduled maintenance times to avoid disrupting user activities.

All auxiliary parameters are subject to change between major versions of TrueNAS due to security and development issues. We recommend removing all auxiliary parameters from TrueNAS configurations before upgrading.
System Update Upgrade Available
Figure 1: System Update Upgrade Available

Performing an Automatic Update

If an update is available, click Apply Pending Update to install it.

The Save configuration settings from this machine before updating? window opens.

Save Configuration Settings
Figure 2: Save Configuration Settings

Select Export Password Secret Seed then click Save Configuration.

Why should I save the secret seed?

The secret seed is used to decrypt encrypted fields in the TrueNAS configuration database. Various fields are encrypted because they might contain sensitive information such as cryptographic certificates, passwords (not user login passwords), or weak hashing algorithms (for example, NT hashes of SMB users).

When a config file is restored without the secret seed, encrypted fields are set to empty values. This means various services can break due to the missing information. Examples are SMB via local accounts and apps. Always select the option to save the secret seed when downloading the system config file!

Note, the secret seed does not store local users passwords in any form, only a hash of the password sufficient for authentication. Hashed passwords are not encrypted.

What happens if I do not save the secret seed? You might be prompted to enter a default password or reset the password. The UI should allow users to log into the system with their current password but might be prompted to enter a new password. Users can connect a keyboard and monitor to the system and enter a new password if they cannot log into the web UI or reset the current password.

Is there a default password for the system? Enterprise users are issued a password to enter if prompted for such a password after the system resets. Community users are not issued a default password and the system does not generate a default password for this purpose. If you cannot log into the UI with the current administration password, connect a keyboard and monitor to the system server to reset the password.

After logging into the system, recheck all system settings to verify the configurations are correct, and then test to verify the system is working as desired. When complete and the system is operating per the desired configuration, download and save the system configuration with the secret seed option selected and keep it in a secure location.

It is a best practice to always save the secret seed with the system configuration file after making system configuration changes to have a current backup copy to use should the need arise.

The Apply Pending Updates window opens.

Apply Pending Updates
Figure 3: Apply Pending Updates

Select Confirm, then Continue to start the automatic installation process. TrueNAS downloads the configuration and the update files, and then starts the installation.

After updating, clear the browser cache (CTRL+F5) before logging in to TrueNAS. This ensures stale data doesn’t interfere with loading the TrueNAS UI.

Performing a Manual Update

If the system detects an available update, to do a manual update click Download Updates and wait for the file to download to your system.

TrueNAS Manual update files are available from the TrueNAS Download page website.

Click Install Manual Update File. The Save configuration settings from this machine before updating? window opens. Click Export Password Secret Seed then click Save Configuration. The Manual Update screen opens.

Click Choose File to locate the update file on the system. Select a temporary location to store the update file. Select Memory Device or select one of the mount locations on the dropdown list to keep a copy in the server.

Click Apply Update to start the update process. A status window opens and displays the installation progress. When complete, a Restart window opens.

Click Confirm, then Continue to restart the system.

Update Progress

When a system update starts, appears in the toolbar at the top of the UI. Click the icon to see the current status of the update and which TrueNAS administrative account initiated the update.

Update Status
Figure 6: Update Status Example