Cloud Sync Tasks Screens

The Cloud Sync Tasks widget on the Data Protection screen provides access to cloud sync tasks configured on SCALE and to configuration screens with settings to add single-time or scheduled recurring transfers between TrueNAS SCALE and a cloud storage provider. They are an effective method to back up data to a remote location.

These providers are supported for Cloud Sync tasks in TrueNAS SCALE:

Cloud Sync Task Widget

The Cloud Sync Task widget displays a list of tasks configured on the system.

Data Protection Cloud Sync Task
Figure 1: Data Protection Cloud Sync Task

If cloud sync task are not yet configured No Cloud Sync Tasks configured displays in the widget.

No Cloud Sync Tasks
Figure 2: No Cloud Sync Tasks

Add opens the Add Cloud Sync Task screen. Each task listed is a link that opens the Edit Cloud Sync Task screen populated with with the settings for that task. Click on the Description, Frequency or Next Run column entry to open the edit task screen.

State displays the status of the next cloud sync task. Click on the state for the cloud sync task to display a Logs dialog for that task. Download Logs saves a copy of the current task logs.

Cloud Sync Task State Log
Figure 3: Cloud Sync Task State Log

The Run Now icon starts the cloud sync, running outside of the time scheduled in the saved configuration. When doing a dry run, you can close the window and monitor the task using the Jobs option on the top toolbar.

The loop Dry Run icon performs the same function as the Dry Run button on the add and edit configuration screens. It performs a test of the configured settings.

The restore Restore icon creates a new cloud sync task from an existing task that uses the same options but reverses the data transfer.

Restore Cloud Sync Tasks
Figure 4: Restore Cloud Sync Tasks

The delete Delete icon opens a simple delete dialog where you confirm before the system deletes the saved cloud sync task.

Add and Edit Cloud Sync Task Screens

The Add Cloud Sync Task and Edit Cloud Sync Task display the same settings.

The Manage Credentials link opens the Backup Credentials screen.

Transfer Settings

Transfer setting options change the cloud sync task direction (send or receive) and data transfer method (copy or move).

Add Cloud Sync Task Remote Settings
Figure 5: Add Cloud Sync Task Remote Settings
DescriptionEnter a description of the cloud sync task.
DirectionSelect a direction option from the dropdown list. PUSH sends data to cloud storage. PULL receives data from cloud storage and is the default setting.
Transfer ModeSelect the transfer mode type from the dropdown list. To keep all files identical between the two storage locations, select SYNC. This changes files on the destination to match those on the source. If a file does not exist on the source, it is also deleted from the destination. To duplicate each source file into the destination and overwrite destination files using the same source select COPY. This copies files from the source to the destination. If files with the same names are present on the destination, they are overwritten. To transfer files from the source to the destination and delete source files select MOVE. If first copies files from the source to the destination and then deletes them from the source. Files with the same names on the destination are overwritten.
Directory/FilesEnter or click the arrow_right arrow to the left of folder/mnt and at each dataset until you locate the dataset, directory location you want to send to the cloud for push syncs, or the destination to write to for pull syncs. Be cautious with pull destinations to avoid overwriting existing files. Click the arrow_right arrow to the left of folder/mnt again to collapse the directory tree.

Remote Settings

The option selected in Credential changes settings displayed in the Remote settings area. Use the Manage Credentials link to open the Backup Credentials screen where you can add a new provider credential using the Cloud Credentials widget.

CredentialSelect an exiting backup cloud storage provider credential from the dropdown list. A Bucket setting displays after selecting a credential that uses S3, like Amazon S3. TrueNAS automatically validates the selected credential.
BucketSelect the pre-defined bucket S3 to use.
FolderEnter or click the arrow_right arrow to the left of the folder icon and at each directory or folder to reach the storage location to uses for this task.

Control Settings

Control settings establish when the cloud sync task occurs.

Add Cloud Sync Task Control and Advanced Options
Figure 6: Add Cloud Sync Task Control and Advanced Options
ScheduleSelect a schedule preset or choose Custom to open the advanced scheduler.
EnabledSelect to enable this Cloud Sync Task. To disable this cloud sync task without deleting it and make the configuration available without allowing the specified schedule to run the task, clear the checkbox. You can use the Enable column on the Cloud Sync Tasks widget to enable or disable the task.

Advanced Options Settings

Advanced Options settings include settings for advanced users. Selecting Push in Direction adds the Take Snapshot option in Advanced Options.

Take SnapshotDisplays if Direction is set to Push. Select to take a snapshot before transfering data to the cloud storage provider.
Create empty source dirs on destination after syncSelect to create an empty source directory in the cloud storage provider folder when pushing data to the cloud provider location, or in TrueNAS if pulling data from the cloud storage provider.
Follow SymlinksSelect to follow symlinks and copy the items to which they link.
Pre-ScriptFor advanced users. Enter a script to execute before running sync. See the Cloud Sync tutorial for more information.
Post-ScriptFor advanced user. Enter a script to execute after running sync. See the Cloud Sync tutorial for more information.
ExcludeEnter a list of files and directories to exclude from sync. Separate entries by pressing Enter.
Examples of proper syntax used to exclude files/directories are:
  • photos</code> excludes a file named photos
  • /photos> excludes a file named photos from root directory (but not subdirectories)
  • photos/ excludes a directory named *photos
  • /photos/ excludes a directory named photos from root directory (but not subdirectories).
  • See rclone filtering for more details about the --exclude option.

    Advanced Remote Options

    Advanced Remote Options configure settings related to the remote system.

    Advanced Remote Encryption Options
    Figure 7: Advanced Remote Encryption Options
    Remote EncryptionSelect to use rclone crypt encryption during pull and push transfers. Selecting PUSH in Direction encrypts files before transfer and stores the encrypted files on the remote system. Files are encrypted using the encryption password and encryption salt values. Selecting PULL decrypts files stored on the remote system before the transfer. Transferring the encrypted files requires entering the same encryption password and encryption salt used to encrypt the files. Additional details about the encryption algorithm and key derivation are available in the rclone crypt File formats documentation.
    Filename EncryptionSelected by default. When selected, the pull and push tranfers encrypt or decrypt file names with the rclone Standard file name encryption mode. The original directory structure of the files is preserved. When disabled, encryption does not hide file names or directory structure, file names can be 246 characters long, use sub-paths, and copy single files. When enabled, file names are encrypted, file names are limited to 143 characters, directory structure is visible, and files with identical names have identical uploaded names. File names can use sub-paths, single copy files, and shortcuts to shorten the directory recursion.
    Encryption PasswordEnter the password to encrypt and decrypt remote data. Warning: Always securely back up this password! Losing the encryption password results in data loss.
    Encryption SaltEnter a long string of random characters for use as salt for the encryption password. Warning: Always securely back up the encryption salt value! Losing the salt value results in data loss.
    TransfersEnter the number of simultaneous file transfers. Enter a number based on the available bandwidth and destination system performance. See rclone –transfers.
    Bandwidth limitEnter a single bandwidth limit or bandwidth limit schedule in rclone format. Separate entries by pressing <kbdEnter. Example: 08:00,512 12:00,10MB 13:00,512 18:00,30MB 23:00,off. You can specify units with the beginning letter: b, k (default), M, or G. See rclone –bwlimit.