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.

Adding a Storj Cloud Sync Task

TrueNAS can send, receive, or synchronize data with the cloud storage provider Storj. Cloud sync 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.

To take advantage of the lower-cost benefits of the Storj-TrueNAS cloud service, you must create your Storj 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 you incur using a third-party vendor with the cloud sync feature.

This procedure provides instructions to set up both Storj and SCALE.

TrueNAS supports major providers like Amazon S3, Google Cloud, and Microsoft Azure. It also supports many other vendors. To see the full list of supported vendors, go to Credentials > Backup Credentials > Cloud Credentials click Add, and open the Provider dropdown list.

Cloud Sync Task Requirements

You must have all system storage (pool and datasets or zvols) configured and ready to receive or send data.

Creating a Storj Cloud Sync Task

To create your cloud sync task for a Storj-TrueNAS transfer you:

  1. Create the SCALE cloud credential.

    Adding the cloud credential in SCALE includes using the link to create the Storj-TrueNAS account, creating a new bucket, and obtaining the S3 authentication credentials you need to complete the process in SCALE.

  2. Create the Storj-TrueNAS account.

    You must create a new Storj-TrueNAS account to use SCALE to access a Storj account.

  3. Add a new Storj bucket.

  4. Create Storj S3 access for the new bucket.

  5. Finish creating the SCALE cloud credential using the S3 access and secret keys provided by Storj.

  6. Create the cloud sync task for one bucket.

Adding Storj Cloud Credentials

The instructions in this section covers 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 Add Cloud Credential screen opens with Storj displayed as the default provider in the Provider field.


  1. Enter a descriptive name to identify the credential in the Name field.

  2. Click Signup for account to create your Stor-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-TrueNAS pricing!

    After setting up your Storj-TrueNAS account, create your Storj bucket and the Storj S3 access for the new bucket.

  3. Enter the authentication information provided by Storj in the Acces Key ID and Secret Access Key fields.

  4. Click Verify Credentials and wait for the system to verify the credentials.


  5. Click Save.

After completing this configuration form, you can set up the cloud sync task.

Creating the Storj-TrueNAS SCALE Account

You can create your iX-Storj cloud service account using two methods:

  • TrueNAS Storj web page and click Sign Up & Log In - iX-Storj
  • Credentials > Backup Credentials, and click Add. Select StorjiX as the Provider on the Cloud Credentials screen, then click Signup 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, then click the button at the bottom of the screen. The Storj main dashboard opens.


Adding the Storj-TrueNAS Bucket

Now you can add the storage bucket you want to use in your Storj-TrueNAS account and SCALE cloud sync task.

From the Storj main dashboard:

  1. Click Buckets on the navigation panel on the left side of the screen to open the Buckets screen.


  2. Click New Bucket to open the Create a bucket window.


  3. Enter a name in Bucket Name using lowercase alphanumeric characters, with no spaces between characters, then click Continue to open the Encrypt your bucket window.


  4. Select the encryption option you want to use. Select Generate passphrase to let Storj provide the encryption or select Enter Passphrase to enter your own. If you already have a Storj account and want to use the same passphrase for your new bucket, select Enter Passphrase.


    If you select Generate a passphrase, Storj allows you to download the encryption keys. You must keep encryption keys stored in a safe place where you can back up the file. Select I understand, and I have saved the passphrase then click Download.

  5. Click Continue to complete the process and open the Buckets screen with your new bucket.


Setting up S3 Access to the Bucket

After creating your bucket, add S3 access for the new bucket(s) you want to use in your Storj-TrueNAS account and the SCALE cloud sync task.

  1. Click Access to open the** Access Management** dashboard, then click Create S3 Credentials on the middle S3 credentials widget.


    The Create Access window opens with Type set to S3 Credentials.

  2. Enter the name you want to use for this credential. Our example uses the name of the bucket we created.


  3. Select the permissions you want to allow this access from the Permissions dropdown and select the bucket you want to have access to this credential from the dropdown list. For example, select All for Permissions, then select the one bucket we created ixstorj1.


    If you want to use the SCALE option to add new buckets in SCALE, set Storj Permissions and Buckets to All.
  4. Select Add Date (optional) if you want to set the duration or length of time you want to allow this credential to exist. This example set this to Forever. You can select a preset period or use the calendar to set the duration.


  5. Click Encrypt My Access to open the Encryption Information dialog, then click Continue to open theSelect Encryption options window.


  6. Select the encryption option you want to use. Select Generate Passphrase to allow Storj to provide the encryption passphrase, or select Create My Own Passphrase to enter a passphrase of your choice.


    Use Copy to Clipboard or Download.txt to obtain the Storj-generated passphrase. Keep this passphrase along with the access keys in a safe place where you can back up the file.


    If you lose your passphrase, neither Storj nor iXsystems can help you recover your stored data!

7 . Click Create my Access to obtain the access and secret keys. Use Download.txt to save these keys to a text file.

This completes the process of setting up your Storj buckets and S3 access. Enter these keys in the Authentication fields in TrueNAS SCALE on the Add Cloud Credential screen to complete setting up the SCALE cloud credential.

Setting Up the Storj Cloud Sync Task

To add the Storj cloud sync task, go to Data Protection > Cloud Sync Tasks:

  1. Click Add to open the Cloudsync Task Wizard.


  2. Select the Storj credential on the Credential dropdown list, then click Next to show the What and When wizard screen.

  3. Set the Direction and Transfer Mode you want to use.


  4. Browse to the dataset or zvol you want to use on SCALE for data storage. Click the arrow to the left of the name to expand it, then click on the name to select it.

    If Direction is set to PUSH, click on the folder icon to add / to the Folder field.

  5. Select the bucket you just 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 either select the new bucket you created in Storj or Add New to create a new Storj bucket here in SCALE!

    If Direction is set to PUSH, click on the folder icon for the Folder field to select the desired folder in the Storj bucket from the dropdown list if not copying/moving/syncing the entire contents of the bucket with the dataset selected in the Directory/Files field.

  6. Set the task schedule for when to run this task.

  7. Click Save.

TrueNAS adds the task to the Cloud Sync Task widget with the Pending status until the task runs on schedule. To test the task, click Dry Run or Run Now to start the task apart from the scheduled time.