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.

Backing Up TrueNAS

After configuring your TrueNAS storage and data sharing or any other function, service, or application, it is time to ensure an effective data backup.

You should also:

You should also set up a data storage backup method using either a cloud sync or replication task.

Backing Up TrueNAS Storage Data

TrueNAS provides for data backup through cloud sync or replication.

Using Cloud Sync for Data Backup

Cloud sync requires an account with a cloud storage provider and a storage location created with that provider, like an Amazon S3 bucket. SCALE supports major providers like Storj, Amazon S3, Google Cloud, Box, and Microsoft Azure, along with a variety of other vendors. These providers can charge fees for data transfer and storage, so please review the policies of your cloud storage provider before transferring your data.

You can configure TrueNAS to send, receive, or synchronize data with a cloud storage provider. The simplest way to set up a cloud sync task is using an iX-Storj account.

Cloud Sync Quickstart with a Storj Account
  1. Create an iX Storj account and link to TrueNAS.

    From the TrueNAS Dashboard, find the Backup Tasks widget and click Cloud Sync to Storj or similar provider.

    Open the Credentials dropdown and select Add New.

    The Storj iX provider is preselected. Click Signup for account to open a browser tab, then register, select a plan, and activate an iX-Storj Account.

    After creating the iX-Storj account, log in to the Storj portal, create a new bucket, and create new S3 access credentials (details). When the new S3 Credentials are created, download the Access Key and Secret Key and paste each string into the TrueNAS Access Key ID and Secret Access Key fields, respectively. Click Save.

  2. Define the backup targets and schedule.

    In the TrueNAS Cloud sync task wizard, review the fields in the What and When section (details). Select the created Storj Bucket before choosing a Folder.

    There are several predefined Schedules to choose from, or you can select Custom to define your own.

    Click Save.

See Adding Cloud Credentials for information on connecting TrueNAS SCALE to other cloud storage providers.

Using Replication for Data Backup

Replication is the process of taking a moment-in-time snapshot of data and then copying that snapshot to another location. Snapshots typically use less storage than full file backups and have more management options.

Click here for basic instructions

To create a simple replication task with the TrueNAS replication wizard:

  1. Create a periodic snapshot task using the Periodic Snapshot Task or use the Run Once replication schedule option. If scheduling a task, SCALE creates the periodic snapshot task when it runs the replication task according to the scheduled time.

  2. Create the replication task.

    Go to Data Protection and click Add on the Replication Tasks widget. The Replication Task Wizard opens on the What and Where configuration screen. Select both the Source Location and Destination Location using the dropdown list options. You can back up your data on the same system or a different system. If you select A different system you must have an SSH connection. Have your destination and source information ready.

    Next, enter the Source and Destination paths. To populate the field with the full path, you can either type the full path to the data you want to back up or click on the caret to the left of mnt and at the pool and dataset levels to expand the options. Click on the dataset and/or the file if you want to narrow backup down to that level.

    The task name populates from the values in Source and Destination. Click Next.

  3. Define when you want this task to occur.

    Select the radio button for Run On a Schedule and select the schedule you want to use. Or select Run Once to run the task manually. If using this option you must have a periodic snapshot task already defined. If running on a schedule, you don’t have to have a pre-defined snapshot task.

    Select the radio button to specify the destination snapshot lifetime.

  4. Click START REPLICATION. The task appears on the Replication Tasks widget with the status PENDING.

You can monitor created backup tasks from the Dashboard widget.

Backing Up the System Configuration

Now that you configured your system network, storage, and the data shares you want, and you have set up your data backup solution, it is time to back up your system configuration.

Click here for instructions

When you download the configuration file, you have the option to Export Password Secret Seed, which includes encrypted passwords in the configuration file. This 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.

We recommend backing up the system configuration regularly. Doing so preserves settings when migrating, restoring, or fixing the system if it runs into any issues. Save the configuration file each time the system configuration changes.

Go to System Settings > General and click on Manage Configuration. Select Download File.


The Save Configuration dialog displays.


Click Export Password Secret Seed and then click Save. The system downloads the system configuration. Save this file in a safe location on your network where files are regularly backed up.

Anytime you change your system configuration, download the system configuration file again and keep it safe.

Downloading the Initial System Debug File

After saving the system configuration, go to System Settings > Advanced and click Save Debug. After the download completes, save this initial debug file with your system configuration file.

Create a Boot Environment

After installing and completing your SCALE system configuration, create a boot environment to use as a restore point. If an issue occurs where you lose access to the SCALE UI, you can establish an SSH session and restore it from the boot environment. You can clone the boot environment listed after the initial-install environment and rename the clone to something you recognize, such as the release number with date and time.