TrueNAS Enterprise
TrueNAS SCALE
TrueNAS CORE
Compare Editions
TrueCommand
Software Status
FreeNAS
Compare Systems
F-Series
M-Series
H-Series
R-Series
Mini Series
Download TrueNAS SCALE
Download TrueNAS CORE
Get TrueNAS Enterprise
Contact an Enterprise SpecialistTrueNAS 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.
Managing TrueCloud Backup Tasks
8 minute read.
TrueNAS can send, receive, or synchronize data with the cloud storage providers available in TrueNAS.
TrueCloud backup tasks allow for single-time transfers or recurring transfers on a schedule. They are an effective method to back up data to a remote location.
This article provides instructions on configuring a TrueCloud backup task using Storj and covers setting up both the Storj iX account and SCALE credential.
To take advantage of the lower-cost benefits of the TrueCloud backup service, you must create your Storj iX account using the link provided on the Add Cloud Credentials screen.
You must also create and authorize the storage buckets on Storj for use by SCALE.
iXsystems is not responsible for any charges incurred using a third-party vendor with the TrueCloud backup feature.
You must have all system storage (pool and datasets or zvols) configured and ready to receive or send data.
To create a TrueCloud Backup task for a TrueCloud transfer:
Create the SCALE Storj cloud credential.
Adding the Storj cloud credential in SCALE includes following the link to create the Storj iX account, creating a new bucket, and obtaining the S3 authentication credentials needed to complete the process in SCALE.
Create the TrueCloud Backup task for one bucket.
The instructions in this section cover adding the Storj iX account and configuring the cloud service credentials in SCALE and Storj. The process includes going to Storj to create a new Storj iX account and returning to SCALE to enter the S3 credentials provided by Storj.
Go to Credentials > Backup Credentials and click Add on the Cloud Credentials widget. The Cloud Credentials screen opens with Storj displayed as the default provider in the Provider field.
Enter a descriptive name to identify the credential in the Name field.
Click Signup for account to create your Storj iX account. This opens the Storj new account screen for TrueNAS.
You must use this link to create your Storj account to take advantage of the benefits of the Storj iX pricing!After setting up your Storj iX account, create your Storj bucket and the Storj S3 access for the new bucket.
Enter the authentication information provided by Storj in the Access Key ID and Secret Access Key fields.
Click Verify Credentials and wait for the system to verify the credentials.
Click Save.
After completing this configuration form, you can set up the TrueCloud Backup task.
You can create your Storj iX cloud service account using two methods:
- Go to the TrueNAS Storj web page and click Sign Up & Log in - iX-Storj.
- Go to Credentials > Backup Credentials and click Add. Select Storj iX as the Provider on the Cloud Credentials screen, then click Sign up for account.
The Storj Create your Storj account web page opens. Enter your information in the fields, select the I agree to the Terms of Service and Privacy Policy, and click the button at the bottom of the screen. The Storj main dashboard opens.
Now you can add the storage bucket you want to use in your Storj iX account and SCALE TrueCloud Backup task.
From the Storj main dashboard:
Click Browse on the navigation panel on the left side of the screen to open the Browse Buckets screen. Click New Bucket to open the New Bucket window.
Enter a name in Bucket Name using lowercase alphanumeric characters, with no spaces between characters, then click Create Bucket. Your new bucket displays on the Browse Buckets screen.
Click on the new bucket to open the Enter passphrase window and configure encryption. Enter a secure passphrase in Encryption Passphrase.
Click Continue to complete the process and open the Browse Files screen with your new bucket.
After creating your bucket, add S3 access for the new bucket(s) you want to use in your Storj iX account and the SCALE TrueCloud Backup task.
Click Access Keys to open the Access Keys dashboard, then click New Access Key.
The New Access window opens.
Enter the name you want to use for this credential. Select S3 Credentials for access type, then click Next.
Select the permissions you want to allow this access key. Choose Full Access to allow permanent full permissions to all buckets and data then click Create Access or select Advanced then click Next to customize access configuration.
If you want to use the SCALE option to add new buckets in SCALE, set the access configuration to Full Access.(Optional) If configuring advanced access options:
a. Select the permissions to allow. Choose one or more of Read, Write, List, Delete, or choose All Permissions. Click Next.
b. Select the buckets to allow access to. Click All Buckets or click Select Buckets and use the Buckets dropdown to select one or more bucket(s). Click Next.
c. Select an expiration date if you want to set the duration or length of time to allow this credential to exist. You can select a preset period, click Set Custom Expiration Date to use the calendar to set the duration, or select No expiration. Click Next to open the Access Encryption window.
d. Review access details and then click Create Access.
Use Copy All or Download All to obtain the access key, secret key, and endpoint. Keep these in a safe place where you can back up the file.
Click Close.
This completes the process of setting up Storj buckets and S3 access. Enter these keys in the Authentication fields in TrueNAS SCALE on the Cloud Credentials screen to complete setting up the SCALE cloud credential.
To add the TrueCloud backup task, go to Data Protection > TrueCloud Backup Tasks:
Click Add to open the Add TrueCloud Backup Task screen.
Enter or browse to select the local Source Path to the directories or files you want sent to the cloud for backup. Click the arrow to the left of the name to expand it, then click on the name to select it.
Select the Storj credential on the Credentials dropdown list. You can select Add New to create the Storj credential if you skipped the instructions above.
Select the bucket you created in Storj from the Bucket dropdown list.
If you set the Storj S3 access to only apply to the new bucket created in Storj, you can only use that bucket, selecting Add New results in an error. If you set the Storj S3 Bucket access to All, you can select the new bucket you created in Storj or Add New to create a new Storj bucket.
Click the arrow icon for the Folder field to expand the dropdown list and select the desired folder in the Storj bucket or enter a folder path. Enter
/name, where name is a folder that does not exist, to create a new folder in the Storj bucket.Enter a name for the task under Task Settings.
Enter the number of snapshot copies to retain in Keep Last.
Enter a password for the backup repository. Record this password in a secure location. You need the password to recreate the task using the same bucket/folder, such as in a new TrueNAS install or system, or to restore data from the existing snapshots in another TrueNAS system.
Set the task schedule for when to run this task.
Click Save.
TrueNAS adds the task to the TrueCloud Backup Tasks widget with the state N/A until the task runs on schedule. To test the task, click Run Job to start the task apart from the scheduled time.
The task status changes to SUCCESS when complete.
Advanced Options and Advanced Remote Options contain additional settings for advanced users.
To take a snapshot before transferring data to Storj, select Take Snapshot. This option is not available for datasets with child datasets.
Advanced users can write scripts that run immediately before or after the TrueCloud backup task. Enter environment variables in either the Pre-script or Post-script fields. The Post-script field only runs when the TrueCloud backup task succeeds.
Use Exclude to enter a list of files and directories to exclude from sync. Separate entries by pressing Enter. See TrueCloud Backup Tasks Screens for syntax examples.
Use Transfers and Bandwidth Limit to prevent excess resource consumption and set a bandwidth availability schedule.
To edit an existing TrueCloud backup task, click Edit to open the Edit TrueCloud Backup Task screen. After making changes, click Save.
To run a scheduled task before the defined time, click Run Job to start the task immediately.
To delete a task, click delete Delete for the task to delete.
See TrueCloud Backup Tasks Screens for more information on TrueCloud Backup Task screens.
To restore data from a TrueCloud backup, locate an existing snapshot on the Snapshots widget.
Click history Restore to open the Restore from Snapshot screen.
Select Include Everything to restore all data, or exclude some data using Include from subfolder, Select paths to exclude, or Exclude by pattern. See TrueCloud Backup Tasks Screens for more information.
Set the local Target to the target dataset of the backup task. Click Save to restore data from the snapshot.
To delete an existing snapshot, locate it on the Snapshots widget. Click delete Delete to delete the snapshot. A Delete Snapshot dialog opens.
Click Confirm and then Delete to start the job.