diff --git a/content/SCALE/GettingStarted/Configure/SetUpBackupScale.md b/content/SCALE/GettingStarted/Configure/SetUpBackupScale.md
index a0ade3fa90..a095a619e7 100644
--- a/content/SCALE/GettingStarted/Configure/SetUpBackupScale.md
+++ b/content/SCALE/GettingStarted/Configure/SetUpBackupScale.md
@@ -1,6 +1,6 @@
---
title: "Backing Up TrueNAS"
-description: "Provides general information and instructions on setting up data storage backups, saving the system configuration and initial system debug file, and creating a boot environment."
+description: "Provides general information and instructions on setting up data storage backups, saving the system configuration and initial system debug files, and creating a boot environment."
weight: 60
aliases:
- /scale/gettingstarted/install/setupbackupscale/
@@ -20,12 +20,38 @@ You should also:
* [Download and save your system configuration file](#backing-up-the-system-configuration) to protect your system configuration information.
* [Download a debug file](#downloading-the-initial-system-debug-file).
* [Create a boot environment](#create-a-boot-environment) to use as a restore point.
+* [Backup Stored Data](#backing-up-truenas-storage-data)
-You should also set up a data storage backup method using either a cloud sync or replication task.
+TrueNAS provides several options to set up a data storage backup method including using either a cloud sync provider and scheduled task, or configuring a replication task.
+
+## Backing Up the System Configuration
+The first thing you should do after you set up TrueNAS is back up your system configuration by downloading the system configuration file.
+
+{{< include file="/static/includes/DownloadSystemConfigFileSCALE.md" >}}
+
+### Downloading the Initial System Debug File
+
+After saving the system configuration, go to **System > 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]({{< relref "ManageBootEnvironSCALE.md" >}}) 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.
## Backing Up TrueNAS Storage Data
-TrueNAS provides for data backup through cloud sync or replication.
+TrueNAS has several options that allow you to back up data:
+
+* [TrueCloud backup tasks](#using-truecloud-backup-or-cloud-sync)
+* [Cloud sync tasks]({{< relref "/Scale/ScaleTutorials/DataProtection/CloudSyncTasks/_index.md" >}})
+* [Replication tasks](#using-replication)
+* [Rsync tasks]({{< relref "RsyncTasksSCALE.md" >}})
+
+Both TrueCloud backup and cloud sync tasks require setting up a cloud service provider account and adding the credentials in TrueNAS before configuring and scheduling the tasks.
+
+Replication requires setting up SSH credentials before configuring and scheduling the task. Rsync tasks can be configured with SSH credentials or set up to use a module.
### Using TrueCloud Backup or Cloud Sync
@@ -35,23 +61,27 @@ SCALE supports major providers like Storj, Amazon S3, Google Cloud, Box, and Mic
These providers can charge fees for data transfer and storage, so please review the policies of your cloud storage provider before transferring your data.
{{< /hint >}}
-You can configure TrueNAS to send, receive, or synchronize data with a cloud storage provider.
-The simplest way to set up a TrueCloud backup task is using an Storj iX account.
+Cloud sync and TrueCloud backup tasks can be configured to send, receive, or synchronize data with a cloud storage provider.
+
+The simplest way to set up a TrueCloud backup task is using a Storj iX account.
See [Managing TrueCloud Backup Tasks]({{< relref "TrueCloudTasks.md" >}}) for a full tutorial.
{{< expand "TrueCloud Backup Quickstart with a Storj Account" "v" >}}
-You can create a Storj cloud credential and set up your Storj account from the **Add TrueCloud Backup Task** screen or from the **Credentials > Backup Credentials** screen.
-1. Create a Storj iX account and link to TrueNAS.
+TrueNAS allows you to create a Storj cloud credential in TrueNAS, and set up a Storj account, from the **Backup Task** widget on the main **Dashboard**, the **Add TrueCloud Backup Task** screen, or from the **Add Cloud Credentials** screen accessed from on the **Credentials > Backup Credentials** screens.
+
+To create the TrueCloud backup task using Storj:
+
+1. Create the TrueCloud backup task and set up the Storj iX account.
- From the TrueNAS **Dashboard**, find the **Backup Tasks** widget and click **Cloud Sync to Storj or similar provider**.
+ From the TrueNAS **Dashboard**, find the **Backup Tasks** widget and click **Cloud Sync to Storj or similar provider** to open the **Cloud Sync Task Wizard**.
- Open the **Credentials** dropdown and select **Add New**.
+ Select **Add New** on the **Credentials** dropdown list. The **Cloud Credentials** screen opens with **Storj iX** prepopulated in the **Provider** field.
- The **Storj iX** provider is preselected.
- Click **Signup for account** to open a browser tab, then register, select a plan, and activate an Storj iX Account.
+ Click **Signup for account** to open the **Storj + iX** browser tab. Register an account, select a plan, and activate the Storj iX account.
+
+ After creating the Storj iX account, log into the Storj portal to create a new bucket and new S3 access credentials ([details]({{< relref "TrueCloudTasks.md#adding-storj-cloud-credentials" >}})).
+ Download the **Access Key** and **Secret Key** provided while creating the new S3 credentials. Copy and paste each string into the TrueNAS **Access Key ID** and **Secret Access Key** fields, respectively.
- After creating the Storj iX account, log in to the Storj portal to create a new bucket and new S3 access credentials ([details]({{< relref "TrueCloudTasks.md#adding-storj-cloud-credentials" >}})).
- After 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.
@@ -59,9 +89,10 @@ You can create a Storj cloud credential and set up your Storj account from the *
To add the TrueCloud backup task, go to **Data Protection > TrueCloud Backup Tasks** and click **Add** to open the **Add TrueCloud Backup Task** screen.
Review the fields in the **Local**, **Remote**, **Task Settings**, and **Control** sections.
+
Select the created Storj **Credentials** and **Bucket** before choosing a **Folder**.
- There are several predefined **Schedules** to choose from, or you can select **Custom** to define your own.
+ Set the desired schedule using any of the predefined schedules, or select **Custom** to define your own.
Click **Save**.
{{< /expand >}}
@@ -69,30 +100,37 @@ You can create a Storj cloud credential and set up your Storj account from the *
See [Adding Cloud Credentials]({{< relref "/scale/scaletutorials/credentials/backupcredentials/addcloudcredentials.md" >}}) for information on connecting TrueNAS SCALE to other cloud storage providers.
### Using Replication
-
Replication is the process of taking a moment-in-time snapshot of data and then copying that snapshot to another location.
Snapshot technology typically uses less storage than full file backups and has more management and snapshot storage options.
-{{< expand "Click here for basic instructions" "v" >}}
+{{< expand "Setting Up a Simple Replication Task" "v" >}}
To create a simple replication task with the TrueNAS replication wizard:
-1. Create a periodic snapshot task using the **[Periodic Snapshot Task]({{< relref "PeriodicSnapshotTasksSCALE.md" >}})** or use the **Run Once** replication schedule option.
+Replication needs an existing [periodic snapshot task]({{< relref "PeriodicSnapshotTasksSCALE.md" >}})** to run before the replication task runs or the replication task fails.
+You can define this before configuring the replication task or select the replication wizard **Replicate Custom Snapshots** option to have TrueNAS automatically create the task before running the replication task.
+
+1. Create a periodic snapshot task using the or use the replication wizard **Replicate Custom Snapshots** replication 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.
+ Go to **Data Protection**, and click **Add** on the **Replication Tasks** widget to open the **Replication Task Wizard** 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.
+ Set the **Source** and **Destination** paths, either enter 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 or directory to narrow the backup down to that level.
- The task name populates from the values in **Source** and **Destination**. Click **Next**.
+ The task name populates from the values in **Source** and **Destination**.
+
+ Select **Replicate Custom Snapshots**.
+
+ Click **Next**.
-3. Define when you want this task to occur.
+3. Define when to run this task.
- 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 for **Run On a Schedule** and select the schedule to use. 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 do not need to pre-defined a snapshot task.
Select the radio button to specify the destination snapshot lifetime.
@@ -100,21 +138,3 @@ To create a simple replication task with the TrueNAS replication wizard:
{{< /expand >}}
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.
-
-{{< expand "Click here for instructions" "v" >}}
-{{< include file="/static/includes/DownloadSystemConfigFileSCALE.md" >}}
-{{< /expand >}}
-
-### Downloading the Initial System Debug File
-
-After saving the system configuration, go to **System > 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]({{< relref "ManageBootEnvironSCALE.md" >}}) 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.
diff --git a/content/SCALE/SCALETutorials/Credentials/BackupCredentials/AddCloudCredentials.md b/content/SCALE/SCALETutorials/Credentials/BackupCredentials/AddCloudCredentials.md
index e67259dcf0..5cb75d6c97 100644
--- a/content/SCALE/SCALETutorials/Credentials/BackupCredentials/AddCloudCredentials.md
+++ b/content/SCALE/SCALETutorials/Credentials/BackupCredentials/AddCloudCredentials.md
@@ -15,7 +15,7 @@ keywords:
- cloud backup and recovery
---
-The **Cloud Credentials** widget on the **Backup Credentials** screen allows users to integrate TrueNAS with cloud storage providers.
+The **Cloud Credentials** screen, accessed from the **Backup Credentials** screen allows users to integrate TrueNAS with cloud storage providers.
{{< include file="/static/includes/CloudServiceProvidersSCALE.md" >}}
@@ -27,36 +27,46 @@ Authentication methods for each provider could differ based on the provider secu
You can add credentials for many of the supported cloud storage providers from the information on the [Cloud Credentials Screens]({{< relref "/SCALE/SCALEUIReference/Credentials/BackupCredentials/CloudCredentialScreens.md" >}}).
This article provides instructions for the more involved providers.
-## Before You Begin
-
+## Adding a Cloud Credential
We recommend users open another browser tab to open and log into the cloud storage provider account you intend to link with TrueNAS.
-Some providers require additional information that they generate on the storage provider account page.
-For example, saving an Amazon S3 credential on TrueNAS could require logging in to the S3 account and generating an access key pair found on the **Security Credentials > Access Keys** page.
-
-Have any authentication information your cloud storage provider requires on-hand to make the process easier. Authentication information could include but are not limited to user credentials, access tokens, and access and security keys.
+Some TrueNAS providers credentials require entering additional information generated while creating the provider account.
+For example, the Storj iX account produces an access and secret key that must be entered in the **Cloud Credential** screen to create the credential.
-## Adding Cloud Credentials
+Have the authentication information required by your cloud storage provider on hand to make the process easier.
+Authentication information can include but is not limited to user credentials, access tokens, and access and security keys.
-{{< include file="/static/includes/AddCloudCredentialStep1.md" >}}
+To add a cloud credential:
-2. Select the cloud service from the **Provider** dropdown list. The provider required authentication option settings display.
+1. Select the cloud service from the **Provider** dropdown list. The provider required authentication option settings display.
For details on each provider authentication settings see [Cloud Credentials Screens]({{< relref "/SCALE/SCALEUIReference/Credentials/BackupCredentials/CloudCredentialScreens.md" >}}).
+2. Enter a name for the credential.
+
+3. Enter the required authentication credentials, such as access token, access key and/or secret keys, and user credentials for the account into the appropriate fields.
+
3. Click **Verify Credentials** to test the entered credentials and verify they work.
4. Click **Save**.
-### Adding Storj Cloud Credentials
+## Adding Storj Cloud Credentials
+Storj iX is the default cloud storage provider in TrueNAS.
+
+{{< include file="/static/includes/AddStorjCloudCredential.md" >}}
+
+### Creating the Storj iX Account
-The process to set up the Storj-TrueNAS account, buckets, create the S3 access and download the credentials is documented fully in [Adding a Storj Cloud Sync Task]({{< relref "TrueCloudTasks.md" >}}) in the **Adding Storj Cloud Credentials** section.
+{{< include file="/static/includes/CreateStorjiXAccount.md" >}}
-### Adding Amazon S3 Cloud Credentials
+### Adding Storj Account S3 Access
-If adding an Amazon S3 cloud credential, you can use the default authentication settings or use advanced settings if you want to include endpoint settings.
-{{< expand "Click here for more information" "v" >}}
-After entering a name and leaving **Amazon S3** as the **Provider** setting:
+{{< include file="/static/includes/SetUpStorjiXAccountS3Access.md" >}}
+
+## Adding Amazon S3 Cloud Credentials
+When adding an Amazon S3 cloud credential, you can either use the default authentication settings or advanced settings if you want to include endpoint settings.
+
+To add a cloud credential for Amazon S3, select **Amazon S3** in **Provider**, enter a name and then:
1. Open a web browser tab to [Amazon AWS](https://aws.amazon.com/).
@@ -70,7 +80,7 @@ After entering a name and leaving **Amazon S3** as the **Provider** setting:
4. Enter or copy/paste the Amazon Web Services alphanumeric password that is between 8 and 40 characters into **Secret Access Key**
5. (Optional) Enter a value to define the maximum number of chunks for a multipart upload in **Maximum Upload Ports**.
- Setting a maximum is necessary if a service does not support the 10,000 chunk AWS S3 specification.
+ Setting a maximum is necessary if a service does not support the 10,000-chunk AWS S3 specification.
6. (Optional) Select **Advanced Settings** to display the endpoint settings.
@@ -82,7 +92,7 @@ After entering a name and leaving **Amazon S3** as the **Provider** setting:
b. Enter an [AWS resources in a geographic area](https://docs.aws.amazon.com/general/latest/gr/rande-manage.html) in **Region**.
To detect the correct public region for the selected bucket leave the field blank.
- Entering a private region name allows interacting with Amazon buckets created in that region.
+ Entering a private region name allows interaction with Amazon buckets created in that region.
c. (Optional) Configure a custom endpoint URL.
@@ -96,68 +106,56 @@ After entering a name and leaving **Amazon S3** as the **Provider** setting:
7. Click **Verify Credentials** to check your credentials for any issues.
8. Click **Save**
-{{< /expand >}}
-### Adding Cloud Credentials that Authenticate with OAuth
+## Adding Cloud Credentials that Authenticate with OAuth
+Cloud storage providers using OAuth as an authentication method are Box, Dropbox, Google Drive, Google Photos, pCloud, and Yandex.
+Some providers like Google Drive and pCloud use additional settings to authenticate credentials.
-Cloud storage providers using OAuth as an authentication method are Box, Dropbox, Google Drive, Google Photo, pCloud and Yandex.
-{{< expand "Click here for more information" "v" >}}
{{< include file="/static/includes/OAuthCloudCredentialSetupSCALE.md" >}}
-{{< /expand >}}
-
-### Adding BackBlaze B2 Cloud Credentials
+## Adding BackBlaze B2 Cloud Credentials
BackBlaze B2 uses an application key and key ID to authenticate credentials.
-{{< expand "Click here for more information" "v" >}}
-From the **Cloud Credentials** widget, click **Add** and then:
-1. Enter the name and select **BackBlaze B2** from the **Provider** dropdown list.
+Open the **Cloud Credentials** screen, select **BackBlaze B2** in **Provider**, enter a name and then:
-2. Log into the BackBlaze account, go to **App Keys** page and add a new application key. Copy and paste this into **Key ID**.
+1. Log into the BackBlaze account, go to the **App Keys** page, and add a new application key. Copy and paste this into **Key ID**.
-3. Generate a new application key on the BackBlaze B2 website.
+2. Generate a new application key on the BackBlaze B2 website.
From the **App Keys** page, add a new application key. Copy the application Key string **Application Key**.
-4. Click **Verify Credentials**.
-
-5. Click **Save**.
-{{< /expand >}}
+3. Click **Verify Credentials**.
-### Adding Google Cloud Storage Credentials
+4. Click **Save**.
-Google Cloud Storage uses a service account json file to authenticate credentials.
-{{< expand "Click here for more information" "v" >}}
-From the **Cloud Credentials** widget, click **Add** and then:
+## Adding Google Cloud Storage Credentials
+Google Cloud Storage uses a service account JSON file to authenticate credentials.
-1. Enter the name and select **Google Cloud Storage** from the **Provider** dropdown list.
+Open the **Cloud Credentials** screen, select **Google Cloud Storage** in **Provider**, enter a name and then:
-2. Go to your Google Cloud Storage website to download this file to the TrueNAS SCALE server.
+1. Go to your Google Cloud Storage website to download this file to the TrueNAS SCALE server.
The [Google Cloud Platform Console](https://console.cloud.google.com/apis/credentials) creates the file.
-3. Upload the json file to **Preview JSON Service Account Key** using **Choose File** to browse the server to locate the downloaded file.
+2. Click **Choose File** to browse the server to locate the downloaded JSON file and upload it. The file populates **Preview JSON Service Account Key**
For help uploading a Google Service Account credential file [click here](https://rclone.org/googlecloudstorage/#service-account-support).
-4. Click **Verify Credentials**.
-
-5. Click **Save**.
-{{< /expand >}}
+3. Click **Verify Credentials**.
-### Adding OpenStack Swift Cloud Credentials
+4. Click **Save**.
-OpenStack Swift authentication credentials change based on selections made in **AuthVersion**. All options use the user name, API key or password and authentication URL, and can use the optional endpoint settings.
-{{< expand "Click here for more information" "v" >}}
+## Adding OpenStack Swift Cloud Credentials
+OpenStack Swift authentication credentials change based on selections made in **AuthVersion**.
+All options use the user name, API key or password, and authentication URL, and can use the optional endpoint settings.
For more information on OpenStack Swift settings, see [rclone documentation](https://rclone.org/swift/#standard-options).
-From the **Cloud Credentials** widget, click **Add** and then:
-
-1. Enter the name and select **OpenStack Swift** from the **Provider** dropdown list.
+Open the **Cloud Credentials** screen, select **OpenStack Swift Cloud** in **Provider**, enter a name for the credential and then:
-2. Enter your OpenStack OS_USERNAME from an [OpenStack credentials file](https://rclone.org/swift/#configuration-from-an-openstack-credentials-file) in **User Name**.
+1. Enter your OpenStack OS_USERNAME from an [OpenStack credentials file](https://rclone.org/swift/#configuration-from-an-openstack-credentials-file) in **User Name**.
-3. Enter the OS_PASSWORD from an [OpenStack credentials file](https://rclone.org/swift/#configuration-from-an-openstack-credentials-file) in **API Key or Password**.
-
-4. (Optional) Select the version from the **AuthVersion**. For more information see [rclone documentation](https://rclone.org/swift/#standard-options).
+2. Enter the OS_PASSWORD from an [OpenStack credentials file](https://rclone.org/swift/#configuration-from-an-openstack-credentials-file) in **API Key or Password**.
+3. (Optional) Select the version from the **AuthVersion**. For more information see [rclone documentation](https://rclone.org/swift/#standard-options).
+ Select the desired option based on your use case.
+ {{< expand "Set Auth(vx) to V1 or V2" "v" >}}
If set to **Auth(vX)**, **V1** or **V2**:
a. (Required) Enter the OS_TENANT_NAME from an [OpenStack credentials file](https://rclone.org/swift/#configuration-from-an-openstack-credentials-file) in **Tenant Name**.
@@ -170,8 +168,9 @@ From the **Cloud Credentials** widget, click **Add** and then:
e. (Optional) Enter the URL in **Storage URL**.
- f. (Required) Select service catalog option from the **Endpoint Type** dropdown. Options are **Public**, **Internal** and **Admin**. **Public** is recommended.
-
+ f. (Required) Select the service catalog option from the **Endpoint Type** dropdown. Options are **Public**, **Internal** and **Admin**. **Public** is recommended.
+ {{< /expand >}}
+ {{< expand "Set Auth(vx) to V3" "v" >}}
If set to **v3** the **Advanced Options** settings displayed change.
a. (Optional) Enter the user ID to log into OpenStack. Leave blank to log into most Swift systems.
@@ -188,20 +187,18 @@ From the **Cloud Credentials** widget, click **Add** and then:
g. (Optional) Enter the URL in **Storage URL**.
- h. (Required) Select service catalog option from the **Endpoint Type** dropdown. Options are **Public**, **Internal** and **Admin**. **Public** is recommended.
+ h. (Required) Select the service catalog option from the **Endpoint Type** dropdown. Options are **Public**, **Internal** and **Admin**. **Public** is recommended.
+ {{< /expand >}}
-5. Click **Verify Credentials**.
+4. Click **Verify Credentials**.
-6. Click **Save**.
-{{< /expand >}}
+5. Click **Save**.
## Using Automatic Authentication
-
Some providers can automatically populate the required authentication strings by logging in to the account.
-{{< expand "Click here for more information" "v" >}}
-To automatically configure the credential, click **Login to Provider** and entering your account user name and password.
+
+To automatically configure the credential, click **Login to Provider** and enter your account user name and password.
We recommend verifying the credential before saving it.
-{{< /expand >}}
diff --git a/content/SCALE/SCALETutorials/Credentials/BackupCredentials/AddSSHConnectionKeyPair.md b/content/SCALE/SCALETutorials/Credentials/BackupCredentials/AddSSHConnectionKeyPair.md
index a30a9141ab..aa4f4addd5 100644
--- a/content/SCALE/SCALETutorials/Credentials/BackupCredentials/AddSSHConnectionKeyPair.md
+++ b/content/SCALE/SCALETutorials/Credentials/BackupCredentials/AddSSHConnectionKeyPair.md
@@ -1,6 +1,6 @@
---
title: "Adding SSH Credentials"
-description: "Provides information on adding SSH connections, generating SSH keypairs, and adding the SSH public key to the root user."
+description: "Provides information on adding SSH connections, generating SSH key pairs, and adding the SSH public key to the root user."
weight: 20
alias:
tags:
@@ -11,9 +11,11 @@ keywords:
- enterprise data storage
- nas data storage
- cloud backup and recovery
+- key pair
+- key pairs
---
-The **SSH Connections** and **SSH Keypairs** widgets on the **Backup Credentials** screen display a list of SSH connections and keypairs configured on the system.
+The **SSH Connections** and **SSH Keypairs** widgets on the **Backup Credentials** screen display a list of SSH connections and key pairs configured on the system.
Using these widgets, users can establish Secure Socket Shell (SSH) connections.
You must also configure and activate the [SSH Service]({{< relref "sshservicescale.md" >}}) to allow SSH access.
@@ -22,7 +24,7 @@ You must also configure and activate the [SSH Service]({{< relref "sshservicesca
To begin setting up an SSH connection, go to **Credentials > Backup Credentials**.
-{{< trueimage src="/images/SCALE/Credentials/BackupCredentialsAllCloudSSH.png" alt="Backup Credentials Screen" id="Backup Credentials Screen" >}}
+{{< trueimage src="/images/SCALE/Credentials/BackupCredentialsScreen.png" alt="Backup Credentials Screen" id="Backup Credentials Screen" >}}
Click **Add** on the **SSH Connections** widget.
@@ -31,9 +33,9 @@ Click **Add** on the **SSH Connections** widget.
This procedure uses the semi-automatic setup method for creating an SSH connection with another TrueNAS system.
{{< expand "Click here for more information" "v" >}}
**Semi-automatic** simplifies setting up an SSH connection with another TrueNAS system without logging in to that system to transfer SSH keys.
-This requires an SSH keypair on the local system and administrator account credentials for the remote TrueNAS.
+This requires an SSH key pair on the local system and administrator account credentials for the remote TrueNAS.
You must configure the remote system to allow root access with SSH.
-You can generate the keypair as part of the semiautomatic configuration or a manually created one using **SSH Keypairs**.
+You can generate the key pair as part of the semiautomatic configuration or a manually created one using **SSH Keypairs**.
Using the **SSH Connections** configuration screen:
@@ -52,11 +54,11 @@ Using the **SSH Connections** configuration screen:
b. Enter an admin user name, which is the username on the remote system entered to log in via the web UI to set up the connection.
Or, leave **Admin Username** set to the default **root** user and enter the user password in **Admin Password**.
- c. If two-factor authentication is enabled, enter the one-time password in **One-Time Password (if neccessary)**.
+ c. If two-factor authentication is enabled, enter the one-time password in **One-Time Password (if necessary)**.
d. Enter a **Username**, which is the user name on the remote system to log in via SSH.
- e. Enter or import the private key from a previously created SSH keypair, or create a new one using the **SSH Keypair** widget.
+ e. Enter or import the private key from a previously created SSH key pair, or create a new one using the **SSH Keypair** widget.
4. (Optional) Enter the number of seconds you want to have SCALE wait for the remote TrueNAS system to connect in **Connect Timeout**.
@@ -92,11 +94,11 @@ Using the **SSH Connections** configuration screen:
c. Enter a user name for logging into the remote system in **Username**.
- c. Select the private key from the SSH keypair that you use to transfer the public key on the remote NAS from the **Private Key** dropdown.
+ c. Select the private key from the SSH key pair that you use to transfer the public key on the remote NAS from the **Private Key** dropdown.
d. Click **Discover Remote Host Key** after properly configuring all other fields to query the remote system and automatically populate the **Remote Host Key** field.
-4. (Optional) Enter the number of seconds you want SCALE wait for the remote TrueNAS system to connect in **Connect Timeout**.
+4. (Optional) Enter the number of seconds you want SCALE to wait for the remote TrueNAS system to connect in **Connect Timeout**.
{{< trueimage src="/images/SCALE/Credentials/NewSSHConnectMoreOptions.png" alt="Manual More Options" id="Manual More Options" >}}
@@ -112,9 +114,9 @@ This procedure covers adding a public SSH key to the admin account on the TrueNA
{{< expand "Click here for more information" "v" >}}
1. Copy the SSH public key text or download it to a text file:
- Log into the TrueNAS system that generated the SSH keypair and go to **Credentials > Backup Credentials**.
+ Log into the TrueNAS system that generated the SSH key pair and go to **Credentials > Backup Credentials**.
- Click on the name of the keypair on the **SSH Keypairs** widget to open the keypair for the SSH connection.
+ Click on the name of the key pair on the **SSH Keypairs** widget to open the key pair for the SSH connection.
Copy the text of the public SSH key or download the public key as a text file.
@@ -137,7 +139,7 @@ This procedure covers adding a public SSH key to the admin account on the TrueNA
3. Click **Save**.
-If you need to generate a new SSH keypair:
+If you need to generate a new SSH key pair:
1. Go to **Credentials > Backup Credentials**.
2. Click **Add** on the **SSH Keypairs** widget and select **Generate New**.
@@ -149,17 +151,17 @@ If the remote NAS is not a TrueNAS system, refer to the documentation for that s
## Generating SSH Keypairs
-TrueNAS generates and stores [RSA-encrypted](https://tools.ietf.org/html/rfc8017) SSH public and private keypairs on the **SSH Keypairs** widget found on the **Credentials > Backup Credentials** screen.
-Keypairs are generally used when configuring **SSH Connections** or SFTP **Cloud Credentials**.
-TrueNAS does not support encrypted keypairs or keypairs with passphrases.
+TrueNAS generates and stores [RSA-encrypted](https://tools.ietf.org/html/rfc8017) SSH public and private key pairs on the **SSH Keypairs** widget found on the **Credentials > Backup Credentials** screen.
+Key pairs are generally used when configuring **SSH Connections** or SFTP **Cloud Credentials**.
+TrueNAS does not support encrypted key pairs or key pairs with passphrases.
-TrueNAS automatically generates keypairs as needed when creating new **SSH Connections** or **Replication** tasks.
+TrueNAS automatically generates key pairs as needed when creating new **SSH Connections** or **Replication** tasks.
-To manually create a new keypair:
+To manually create a new key pair:
1. Click **Add** on the **SSH Keypairs** widget.
2. Click **Generate New** on the **SSH Keypairs** screen.
-3. Give the new keypair a unique name and click **Save**.
- The keypair displays on the **SSH Keypairs** widget.
+3. Give the new key pair a unique name and click **Save**.
+ The key pair displays on the **SSH Keypairs** widget.
{{< trueimage src="/images/SCALE/Credentials/BackupCredentialsSSHKeypairsAdd.png" alt="SSH Keypairs Form" id="SSH Keypairs Form" >}}
diff --git a/content/SCALE/SCALETutorials/DataProtection/TrueCloudTasks.md b/content/SCALE/SCALETutorials/DataProtection/TrueCloudTasks.md
index 54b4305df3..611bff7077 100644
--- a/content/SCALE/SCALETutorials/DataProtection/TrueCloudTasks.md
+++ b/content/SCALE/SCALETutorials/DataProtection/TrueCloudTasks.md
@@ -1,6 +1,6 @@
---
title: "Managing TrueCloud Backup Tasks"
-description: "Provides instructions on setting up a TrueCloud backup task and configuring an Storj iX account to work with TrueNAS."
+description: "Provides instructions on setting up a TrueCloud backup task and configuring a Storj iX account to work with TrueNAS."
weight: 5
tags:
- TrueCloud
@@ -14,20 +14,23 @@ aliases:
- cloudsynctasks/addstorjcloudsynctask
---
-TrueNAS can send, receive, or synchronize data with the cloud storage provider Storj.
+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.
+
+*TrueCloud backup tasks streamline functionality for Storj iX cloud backups and restoration.
+
{{< hint type=important >}}
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 you incur using a third-party vendor with the TrueCloud backup feature.
+iXsystems is not responsible for any charges incurred using a third-party vendor with the TrueCloud backup feature.
{{< /hint >}}
-This procedure provides instructions to set up both Storj and SCALE.
-
## TrueCloud Backup Task Requirements
You must have all system storage (pool and datasets or zvols) configured and ready to receive or send data.
@@ -36,140 +39,28 @@ You must have all system storage (pool and datasets or zvols) configured and rea
To create a TrueCloud Backup task for a TrueCloud transfer:
-1. Create the SCALE [cloud credential](#adding-storj-cloud-credentials).
+1. Create the SCALE [Storj cloud credential](#adding-storj-cloud-credentials).
- Adding the cloud credential in SCALE includes using the link to create the Storj iX account, create a new bucket, and obtain the S3 authentication credentials needed to complete the process in SCALE.
+ 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.
2. Create the [TrueCloud Backup task](#setting-up-the-truecloud-backup-task) for one bucket.
-### Adding Storj Cloud Credentials
-
-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.
-
-{{< trueimage src="/images/SCALE/Credentials/AddingStorjCloudCredential.png" alt="Adding Storj Cloud Credentials" id="Adding Storj Cloud Credentials" >}}
-
-1. Enter a descriptive name to identify the credential in the **Name** field.
-
-2. Click **Signup for account** to create your Storj iX account. This opens the Storj new account screen for TrueNAS.
-
- {{< hint type=important >}}
- You must use this link to create your Storj account to take advantage of the benefits of the Storj iX pricing!
- {{< /hint >}}
-
- After setting up your Storj iX account, [create your Storj bucket](#adding-the-storj-truenas-bucket) and the [Storj S3 access](#setting-up-s3-access-to-the-bucket) for the new bucket.
-
-3. Enter the authentication information provided by Storj in the **Access Key ID** and **Secret Access Key** fields.
-4. Click **Verify Credentials** and wait for the system to verify the credentials.
-
- {{< trueimage src="/images/SCALE/Credentials/CloudCredentialsVerified.png" alt="Verify Cloud Credentials" id="Verify Cloud Credentials" >}}
+### Adding Storj Cloud Credentials
-5. Click **Save**.
+{{< include file="/static/includes/AddStorjCloudCredential.md" >}}
After completing this configuration form, you can set up the [TrueCloud Backup task](#setting-up-the-truecloud-backup-task).
### Creating the Storj iX Account
-You can create your Storj iX cloud service account using two methods:
-
-* Go to the [TrueNAS Storj web page](https://www.truenas.com/ix-storj/) 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](https://us1.storj.io/signup?partner=ix-storj-1) 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.
-
-{{< trueimage src="/images/SCALE/DataProtection/StorjMainDashboard.png" alt="Storj Main Dashboard" id="Storj Main Dashboard" >}}
-
-### Adding the Storj iX Bucket
-
-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:
-
-1. 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.
-
- {{< trueimage src="/images/SCALE/DataProtection/StorjAddBucket.png" alt="Storj Browse Buckets Screen" id="Storj Browse Buckets Screen" >}}
-
-2. 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.
-
- {{< trueimage src="/images/SCALE/DataProtection/StorjCreateABucketScreen.png" alt="Storj New Bucket" id="Storj New Bucket" >}}
-
-3. Click on the new bucket to open the **Enter passphrase** window and configure encryption.
- Enter a secure passphrase in **Encryption Passphrase**.
+{{< include file="/static/includes/CreateStorjiXAccount.md" >}}
- {{< trueimage src="/images/SCALE/DataProtection/StorjEncryptYourBucketScreen.png" alt="Storj Enter Passphrase" id="Storj Enter Passphrase" >}}
+#### Setting up S3 Access to the Bucket
-4. Click **Continue** to complete the process and open the **Browse Files** screen with your new bucket.
+{{< include file="/static/includes/SetUpStorjiXAccountS3Access.md" >}}
- {{< trueimage src="/images/SCALE/DataProtection/StorjBucketAdded.png" alt="Storj Browse Files" id="Storj Browse Files" >}}
-
-### 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 iX account and the SCALE TrueCloud Backup task.
-
-1. Click **Access Keys** to open the **Access Keys** dashboard, then click **New Access Key**.
-
- {{< trueimage src="/images/SCALE/DataProtection/StorjAccessManagementScreen.png" alt="Storj Access Keys Screen" id="Storj Access Keys Screen" >}}
-
- The **New Access** window opens.
-
-2. Enter the name you want to use for this credential.
- Select **S3 Credentials** for access type, then click **Next**.
-
- {{< trueimage src="/images/SCALE/DataProtection/StorjCreateAccessWindow.png" alt="Storj New Access Key Window" id="Storj New Access Key Window" >}}
-
-3. 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.
-
- {{< trueimage src="/images/SCALE/DataProtection/StorjCreateAccessSelectConfig.png" alt="Storj Access Permissions Window." id="Storj Access Permissions Window." >}}
-
- {{< hint type=note >}}
- If you want to use the SCALE option to [add new buckets](#setting-up-the-truecloud-backup-task) in SCALE, set the access configuration to **Full Access**.
- {{< /hint >}}
-
-4. (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**.
-
- {{< trueimage src="/images/SCALE/DataProtection/StorjCreateAccessSelectPermissions.png" alt="Storj Access Select Permissions" id="Storj Access Select Permissions" >}}
-
- 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**.
-
- {{< trueimage src="/images/SCALE/DataProtection/StorjCreateAccessSelectBuckets.png" alt="Storj Access Select Buckets." id="Storj Access Select Buckets." >}}
-
- 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.
-
- {{< trueimage src="/images/SCALE/DataProtection/StorjCreateAccessSelectDuration.png" alt="Storj Create Access Select Duration" id="Storj Create Access Select Duration" >}}
-
- d. Review access details and then click **Create Access**.
-
- {{< trueimage src="/images/SCALE/DataProtection/StorjS3ConfirmDetails.png" alt="Storj Create Access Confirm Details" id="Storj Create Access Confirm Details" >}}
-
-5. 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.
-
- {{< trueimage src="/images/SCALE/DataProtection/StorjS3CredentialsGenerated.png" alt="Storj S3 Credentials Generated" id="Storj S3 Credentials Generated" >}}
-
- Click **Close**.
-
-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 **[Cloud Credentials](#adding-storj-cloud-credentials)** screen to complete setting up the SCALE cloud credential.
-
-### Setting Up the TrueCloud Backup Task
+### Adding a Storj TrueCloud Backup Task
To add the TrueCloud backup task, go to **Data Protection > TrueCloud Backup Tasks**:
@@ -181,9 +72,9 @@ To add the TrueCloud backup task, go to **Data Protection > TrueCloud Backup Tas
Click the arrow to the left of the name to expand it, then click on the name to select it.
3. 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.
+ You can select **Add New** to create the Storj credential if you skipped the instructions above.
- 4. Select the bucket you created in Storj from the **Bucket** dropdown list.
+4. 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](#adding-the-storj-truenas-bucket), 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.
@@ -197,7 +88,7 @@ To add the TrueCloud backup task, go to **Data Protection > TrueCloud Backup Tas
7. Enter a password for the backup repository.
Record this password in a secure location.
- It is needed 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.
+ 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.
8. Set the task schedule for when to run this task.
@@ -206,20 +97,20 @@ To add the TrueCloud backup task, go to **Data Protection > TrueCloud Backup Tas
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 displays the status **SUCCESS** when complete.
+The task status changes to **SUCCESS** when complete.
- {{< trueimage src="/images/SCALE/DataProtection/TrueCloudTaskSuccess.png" alt="TrueCloud Backup Task Complete" id="TrueCloud Backup Task Complete" >}}
+{{< trueimage src="/images/SCALE/DataProtection/TrueCloudTaskSuccess.png" alt="TrueCloud Backup Task Complete" id="TrueCloud Backup Task Complete" >}}
### Using Advanced Options
**Advanced Options** and **Advanced Remote Options** contain additional settings for advanced users.
-Select **Take Snapshot** to take a snapshot before transferring data to Storj.
-This option is only available for datasets that have no child datasets.
+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.
+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.
@@ -229,16 +120,15 @@ Use **Transfers** and **Bandwidth Limit** to prevent excess resource consumption
## Managing TrueCloud Tasks
-On the **TrueCloud Backup Tasks** widget, locate an existing task and click ** Edit** to modify configuration details, ** Run Job** to start the task apart from the scheduled time, **visibility View Details** to go to the **TrueCloud Backup Tasks** screen with task selected, or **delete Delete** to delete the selected task.
+To edit an existing TrueCloud backup task, click ** Edit** to open the **Edit TrueCloud Backup Task** screen. After making changes, click **Save**.
-Click **TrueCloud Backup Tasks open_in_new** on the widget title or **visibility View Details** on a task to go to the **TrueCloud Backup Tasks** Screen.
+To run a scheduled task before the defined time, click ** Run Job** to start the task immediately.
- {{< trueimage src="/images/SCALE/DataProtection/TrueCloudBackupTasksScreenComplete.png" alt="TrueCloud Backup Tasks Screen" id="TrueCloud Backup Tasks Screen" >}}
+To delete a task, click **delete Delete** for the task to delete.
-Select an existing TrueCloud backup task to display Task details, including the **Schedule**, general configuration, and **Snapshots** widget.
+See [TrueCloud Backup Tasks Screens]({{< relref "truecloudbackuptasksscreen.md #advanced-options-settings" >}}) for more information on TrueCloud Backup Task screens.
### Restoring Data from TrueCloud Snapshots
-
To restore data from a TrueCloud backup, locate an existing snapshot on the **Snapshots widget**.
{{< trueimage src="/images/SCALE/DataProtection/TrueCloudSnapshots.png" alt="Snapshots Widget" id="Snapshots Widget" >}}
diff --git a/content/SCALE/SCALEUIReference/Credentials/BackupCredentials/CloudCredentialScreens.md b/content/SCALE/SCALEUIReference/Credentials/BackupCredentials/CloudCredentialScreens.md
index 8298cc9d11..1fa509e359 100644
--- a/content/SCALE/SCALEUIReference/Credentials/BackupCredentials/CloudCredentialScreens.md
+++ b/content/SCALE/SCALEUIReference/Credentials/BackupCredentials/CloudCredentialScreens.md
@@ -1,6 +1,6 @@
---
title: "Cloud Credentials Screens"
-description: "Provides information on the Cloud Credentials widget, screens, and settings."
+description: "Provides information on the Cloud Credentials screens and settings."
weight: 10
alias:
- /scale/scaleclireference/task/cloudsync/clicredential/
@@ -12,50 +12,50 @@ tags:
- backup
---
-The **Backup Credentials** screen displays the **Cloud Credentials**, **SSH Connections** and **SSH Keypairs** widgets.
+
+{{< include file="/static/includes/CloudServiceProvidersSCALE.md" >}}
## Cloud Credentials Widget
The **Cloud Credentials** widget displays a list of cloud storage credentials configured on the system.
-
+{{< trueimage src="/images/SCALE/Credentials/BackupCredentialsCloudCredentialsWidget.png" alt="Cloud Credentials Widget" id="Cloud Credentials Widget" >}}
Before adding cloud credentials for a cloud storage provider, the **Cloud Credentials** widget displays **No Cloud Credentials configured**.
-
+{{< trueimage src="/images/SCALE/Credentials/CloudCredentialsNoCredentials.png" alt="Cloud Credentials Widget No Credentials" id="Cloud Credentials Widget No Credentials" >}}
-**Add** opens the **[Cloud Credentials](#cloud-credentials-screen)** configuration screen.
-
-Click the name of a cloud credential to open the **Cloud Credentials** configuration screen populated with the settings for that credential.
+**Add** opens the **[Cloud Credentials](#cloud-credentials-screen)** configuration screen.
## Cloud Credentials Screen
+The **Cloud Credentials** configuration screen opens prepopulated with Storj-iX as the provider.
+It shows settings to add or edit cloud credentials TrueNAS uses to integrate with cloud storage providers.
-The **Cloud Credentials** configuration screen displays settings to add or edit cloud credentials TrueNAS uses to integrate with cloud storage providers.
+{{< trueimage src="/images/SCALE/Credentials/CloudCredentialsAdd.png" alt="Cloud Credentials Configuration Screen" id="Cloud Credentials Configuration Screen" >}}
-
+**Provider** shows a list of available providers.
+Select the name of a cloud provider to populate the configuration screen with credential settings for that provider.
-{{< include file="/static/includes/CloudServiceProvidersSCALE.md" >}}
-Use **Verify Credentials** after entering the authentication settings to verify you can access the cloud storage provider account with the credentials you entered.
+**Verify Credentials** uses the credentials entered to verify access the cloud storage provider account.
### Name and Provider Settings
-
The selection in **Provider** changes the **Authentication** settings.
{{< truetable >}}
| Setting | Description |
|---------|-------------|
-| **Provider** | Required. Default is set to **Storj**. Select the cloud storage provider from the options on the dropdown list. |
+| **Provider** | (Required) Default is set to **Storj**. Select the cloud storage provider from the options on the dropdown list. |
| **Name** | Enter a name for this cloud credential. For example, *cloud1* or *amazon1*. |
{{< /truetable >}}
-### Storj Authentication Settings
-
-Storj authentication includes going to the Storj iX sign-in screen to either create a new Storj iX account or log into an existing Storj iX account, and then returning to SCALE to enter the S3 credentials provided by Storj for this credential.
-{{< expand "Click Here for Settings" "v" >}}
+### Storj iX Credential
+Storj authentication includes going to the Storj iX sign-in screen to either create a new Storj iX account or log into an existing Storj iX account.
+After configuring the Storj account in the Storj-iX portal return to SCALE to enter the S3 credentials provided by Storj.
-
+{{< trueimage src="/images/SCALE/Credentials/CloudCredentialsAdd.png" alt="Cloud Credentials Storj iX" id="Cloud Credentials Storj iX" >}}
+{{< expand "Storj iX Authentication Settings" "v" >}}
{{< truetable >}}
| Setting | Description |
|---------|-------------|
@@ -63,16 +63,14 @@ Storj authentication includes going to the Storj iX sign-in screen to either cre
| **Access Key ID** | Enter the alphanumeric key provided by Storj when you [create the S3 account access]({{< relref "TrueCloudTasks.md" >}}) associated with the storage buckets added in Storj. |
| **Secret Access Key** | Enter the alphanumeric key provided by Storj when you [create the S3 account access]({{< relref "TrueCloudTasks.md" >}}) associated with the storage buckets added in Storj. |
{{< /truetable >}}
-
{{< /expand >}}
-### Amazon S3 Authentication Settings
-
+### Amazon S3 Credential
Amazon S3 has basic authentication and advanced authentication settings. This section provides information on the basic authentication settings.
-{{< expand "Click Here for Settings" "v" >}}
-
+{{< trueimage src="/images/SCALE/Credentials/CloudCredentialsAmzon3AuthenticationSetting.png" alt="Amazon S3 Authentication Settings" id="Amazon S3 Authentication Settings" >}}
+{{< expand "Amazon S3 Authentication Settings" "v" >}}
{{< truetable >}}
| Setting | Description |
|---------|-------------|
@@ -82,30 +80,28 @@ Amazon S3 has basic authentication and advanced authentication settings. This se
{{< /expand >}}
### Amazon S3 Advanced Authentication Options
-
This section provides information on Amazon S3 advanced authentication settings for endpoints. The basic authentication settings are required when using the advanced settings.
-{{< expand "Click Here for Settings" "v" >}}
-
+{{< trueimage src="/images/SCALE/Credentials/CloudCredentialsAmzon3AdvancedAuthSettings.png" alt="Amazon S3 Advanced Authentication Settings" id="Amazon S3 Advanced Authentication Settings" >}}
+{{< expand "Amazon S3 Advanced Authentication Settings" "v" >}}
{{< truetable >}}
| Setting | Description |
|---------|-------------|
| **Maximum Upload Ports** | Enter a value to define the maximum number of chunks for a multipart upload. Setting a maximum is necessary if a service does not support the 10,000 chunk AWS S3 specification. |
-| **Endpoint URL** | Optional. When using AWS, you can leave the endpoint field empty to use the default endpoint for the region and automatically fetch available buckets, or enter an [S3 API endpoint URL](https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteEndpoints.html). Refer to the AWS Documentation for a list of [Simple Storage Service Website Endpoints](https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_website_region_endpoints%20%20target=). |
-| **Region** | Optional. Enter an [AWS resources in a geographic area](https://docs.aws.amazon.com/general/latest/gr/rande-manage.html). Leave empty to detect the correct public region for the bucket. Entering a private region name allows interacting with Amazon buckets created in that region. For example, enter *us-gov-east-1* to discover buckets created in the eastern [AWS GovCloud](https://docs.aws.amazon.com/govcloud-us/latest/UserGuide/whatis.html) region. |
+| **Endpoint URL** | (Optional) When using AWS, you can leave the endpoint field empty to use the default endpoint for the region and automatically fetch available buckets, or enter an [S3 API endpoint URL](https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteEndpoints.html). Refer to the AWS Documentation for a list of [Simple Storage Service Website Endpoints](https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_website_region_endpoints%20%20target=). |
+| **Region** | (Optional) Enter an [AWS resources in a geographic area](https://docs.aws.amazon.com/general/latest/gr/rande-manage.html). Leave empty to detect the correct public region for the bucket. Entering a private region name allows interacting with Amazon buckets created in that region. For example, enter *us-gov-east-1* to discover buckets created in the eastern [AWS GovCloud](https://docs.aws.amazon.com/govcloud-us/latest/UserGuide/whatis.html) region. |
| **Disable Endpoint Region** | Select to prevent automatic detection of the bucket region. Select only if your AWS provider does not support regions. |
| **Use Signature Version 2** | Select to force using [Signature Version 2](https://docs.aws.amazon.com/general/latest/gr/signature-version-2.html) to sign API requests. Select only if your AWS provider does not support default version 4 signatures. |
{{< /truetable >}}
{{< /expand >}}
-### BackBlaze B2 Authentication Settings
-
+### BackBlaze B2 Credential
This section provides information on the BackBlaze B2 authentication settings.
-{{< expand "Click Here for Settings" "v" >}}
-
+{{< trueimage src="/images/SCALE/Credentials/CloudCredentialsBackBlazeB2Authentication.png" alt="BackBlaze B2 Authentication Settings" id="BackBlaze B2 Authentication Settings" >}}
+{{< expand "Backblaze B2 Authentication Settings" "v" >}}
{{< truetable >}}
| Setting | Description |
|---------|-------------|
@@ -114,85 +110,94 @@ This section provides information on the BackBlaze B2 authentication settings.
{{< /truetable >}}
{{< /expand >}}
-### OAuth and Access Token Authentication Settings
+### OAuth and Access Token Authentication Credentials
+Several cloud storage providers use OAuth authentication and a required access token to authenticate the cloud storage account.
+Providers using these methods are Box, Dropbox, Google Photo, pCloud, and Yandex.
-Several cloud storage providers use OAuth authentication and a required access token to authenticate the cloud storage account. Providers that use these methods are Box, Dropbox, Google Photo, pCloud, and Yandex.
-{{< expand "Click here for Settings" "v" >}}
+{{< trueimage src="/images/SCALE/Credentials/CloudCredentialsOAuthAccessTokenAuthentication.png" alt="OAuth and Access Token Authentications" id="OAuth and Access Token Authentication" >}}
-
+{{< expand "OAuth and Access Token Authentication Settings" "v" >}}
+Use **Login to Provider** to enter the account username and password.
{{< truetable >}}
| Setting | Description |
|---------|-------------|
| **OAuth Client ID** | Enter the public identifier for the cloud application. |
| **OAuth Client Secret** | Enter the secret phrase known only to the cloud application and the authorization server. |
-| **Token** | Enter a User Access Token for [Box](https://developer.box.com/). An [access token](https://developer.box.com/reference/) enables Box to verify a request belongs to an authorized session. Example token: T9cE5asGnuyYCCqIZFoWjFHvNbvVqHjl. |
-| **Hostname** | pCloud only. Optional. Enter the host name to connect to. |
+| **Token** | Enter a User Access Token for [Box](https://developer.box.com/). An [access token](https://developer.box.com/reference/) enables Box to verify a request belongs to an authorized session. Example token: *T9cE5asGnuyYCCqIZFoWjFHvNbvVqHjl*. |
+| **Hostname** | (Optional) pCloud only. Enter the host name to connect to. |
{{< /truetable >}}
-
-Use **Login to Provider** to enter the account username and password.
{{< /expand >}}
-### FTP and SMTP Authentication Settings
-
-FTP and SMTP cloud storage providers use host name, port, and user credentials to authenticate accounts. SMTP uses SSH hosts, port, and user credentials and also uses a private key.
-{{< expand "Click Here for Settings" "v" >}}
+### FTP and SFTP Credentials
+FTP and SFTP cloud storage providers use host name, port, and user credentials to authenticate accounts. SMTP uses SSH hosts, port, and user credentials and also uses a private key.
-
+{{< trueimage src="/images/SCALE/Credentials/CloudCredentialsHostPortUserCredPrivateKeyAuth.png" alt="Host, Port User Credentials Authentication" id="Host, Port User Credentials Authentication" >}}
+{{< expand "FTP and SFTP Authentication Settings" "v" >}}
{{< truetable >}}
| Setting | Description |
|---------|-------------|
-| **Host** | Enter the FTP host name or for SMTP the SSH host name to connect. For example, *ftp.example.com*. |
-| **Port** | Enter the FTP or for SMTP, the SSH port number. Leave blank to use the default port **21** for FTP or **22** for SMTP. |
-| **Username** | Enter a username on the FTP or for the SMTP host system the SSJ user name. This user must already exist on the host. |
+| **Host** | Enter the FTP host name or for SFTP the SSH host name to connect. For example, *ftp.example.com*. |
+| **Port** | Enter the FTP or for SFTPP, the SSH port number. Leave blank to use the default port **21** for FTP or **22** for SFTP. |
+| **Username** | Enter a username on the FTP or for the SFTP host system the SSJ user name. This user must already exist on the host. |
| **Password** | Enter the password for the user account. |
-| **Private Key ID** | SNMP only. Import the private key from an existing SSH keypair or, if no keypairs exist on the system, select **Add** on the **SSH Keypairs** widget to open the **SSH Keypairs** screen. Enter a name, and then click **Generate New** to create a new SSH key for this credential. |
+| **Private Key ID** | (SFTP only) Import the private key from an existing SSH keypair or, if no keypairs exist on the system, select **Add** on the **SSH Keypairs** widget to open the **SSH Keypairs** screen. Enter a name, and then click **Generate New** to create a new SSH key for this credential. |
{{< /truetable >}}
{{< /expand >}}
-### Google Cloud Storage Authentication Settings
+### Google Cloud Storage Credential
+Google Cloud Storage authentication uses a Google [service account json key credential file](https://rclone.org/googlecloudstorage/#service-account-support) to authenticate the account.
-Google Cloud Storage authentication uses a Google [service account json key credential file](https://rclone.org/googlecloudstorage/#service-account-support) generated by the [Google Cloud Platform Console](https://console.cloud.google.com/apis/credentials) to authenticate the account. Obtain the json file, download it to the system server and then upload it to the **Preview JSON Service Account Key** field. Use **Choose File** to browse to the file location on the server.
+{{< trueimage src="/images/SCALE/Credentials/CloudCredentialsGoogleCloudAuth.png" alt="Google Cloud Storage Authentication" id="Google Cloud Storage Authentication" >}}
-### Google Drive Authentication Settings
+{{< expand "Google Cloud Storage Authentication Settings" "v" >}}
+{{< truetable >}}
+| Setting | Description |
+|---------|-------------|
+| **Service Account Key** | Use **Choose File** to browse to the file location on the server. Opens a file browser to select the Google service account key credential file generated by by the [Google Cloud Platform Console](https://console.cloud.google.com/apis/credentials) to authenticate the account. |
+| **Preview JSON Service Account Key** | Shows the json file downloaded to the system server from Google Cloud Storage and uploaded with **Choose File**. |
+{{< /truetable >}}
+{{< /expand >}}
-Google Drive uses OAuth authentication, a required access token, and a team drive ID to authenticate accounts.
-{{< expand "Click Here for Settings" "v" >}}
+### Google Drive Credential
+Google Drive also uses OAuth authentication, a required access token, and a team drive ID to authenticate accounts.
+Google Drive adds one additional authentication setting to the general OAuth settings.
-
+{{< trueimage src="/images/SCALE/DataProtection/CloudCredentialsGoogleDriveAuthentication.png" alt="Google Drive Authentication" id="Google Drive Authentication" >}}
+{{< expand "Google Drive Authentication Settings" "v" >}}
+Use **Login to Provider** to enter the account username and password.
{{< truetable >}}
| Setting | Description |
|---------|-------------|
| **OAuth Client ID** | Enter the public identifier for the cloud application. |
| **OAuth Client Secret** | Enter the secret phrase known only to the cloud application and the authorization server. |
-| **Access Token** | Required. Token created with [Google Drive](https://developers.google.com/drive/api/v3/about-auth). Access Tokens expire periodically, so you must refresh them. |
-| **Team Drive ID** | Optional. Only needed when connecting to a Team Drive, and is the top-level folder ID for the Team Drive. |
+| **Access Token** | (Required) Token created with [Google Drive](https://developers.google.com/drive/api/v3/about-auth). Access Tokens expire periodically, so you must refresh them. |
+| **Team Drive ID** | (Optional) Google Drive only when connecting to a team drive, and is the top-level folder ID for the team drive. |
{{< /truetable >}}
-
-Use **Login to Provider** to enter the account username and password.
{{< /expand >}}
-### HTTP Authentication Settings
+### HTTP Credential
HTTP uses an HTTP host URL to authenticate account credentials.
-### Hubic Authentication Settings
+### Hubic Credential
-Hubic uses an access token to authenticate the account. Enter the token generated by a [Hubic account](https://api.hubic.com/sandbox/) into the **Access Token** field.
+Hubic uses an access token to authenticate the account.
+Enter the token generated by a [Hubic account](https://api.hubic.com/sandbox/) into the **Access Token** field.
-### Mega Authentication Settings
+### Mega Credential
Mega uses the username and password for the [MEGA user account](https://mega.nz/) to authenticate the account credentials.
-### Microsoft Azure Blob Storage Authentication Settings
-
+### Microsoft Azure Blob Storage Credential
Microsoft Azure Blob Storage uses the Microsoft Azure account name and account key to authenticate the account credentials.
-{{< expand "Click Here for Settings" "v" >}}
+{{< trueimage src="/images/SCALE/Credentials/CloudCredentialsNoCredentials.png" alt="Cloud Credentials Widget No Credentials" id="Cloud Credentials Widget No Credentials" >}}
+{{< expand "Microsoft Azure Blob Storage Authentication Settings" "v" >}}
{{< truetable >}}
| Setting | Description |
|---------|-------------|
@@ -202,31 +207,30 @@ Microsoft Azure Blob Storage uses the Microsoft Azure account name and account k
{{< /truetable >}}
{{< /expand >}}
-### OpenStack Swift Authentication Settings
-
-OpenStack Swift uses several required settings to authenticate credential accounts. The **AuthVersion** setting selection changes setting options displayed in **[Advanced Options](#openstack-authentication-advanced-options)**.
-{{< expand "Click Here for Settings" "v" >}}
+### OpenStack Swift Credential
+OpenStack Swift uses several required settings to authenticate credential accounts.
+The **AuthVersion** setting selection changes setting options displayed in **[Advanced Options](#openstack-authentication-advanced-options)**.
-
+{{< trueimage src="/images/SCALE/Credentials/CloudCredentialsOpenStackAuthentication.png" alt="OpenStack Swift Authentication" id="OpenStack Swift Authentications" >}}
+{{< expand "OpenStack Swift Authentication Settings" "v" >}}
{{< truetable >}}
| Setting | Description |
|---------|-------------|
-| **User Name** | Required. Enter the OpenStack user name (OS_USERNAME) from an [OpenStack credentials file](https://rclone.org/swift/#configuration-from-an-openstack-credentials-file). |
-| **API Key or Password** | Required. Enter the Openstack API key or password. This is the OS_PASSWORD from an [OpenStack credentials file](https://rclone.org/swift/#configuration-from-an-openstack-credentials-file). |
-| **Authentication URL** | Required. Enter the authentication URL for the server. This is the OS_AUTH_URL from an [OpenStack credentials file](https://rclone.org/swift/#configuration-from-an-openstack-credentials-file). |
+| **User Name** | (Required) Enter the OpenStack user name (OS_USERNAME) from an [OpenStack credentials file](https://rclone.org/swift/#configuration-from-an-openstack-credentials-file). |
+| **API Key or Password** | (Required) Enter the Openstack API key or password. This is the OS_PASSWORD from an [OpenStack credentials file](https://rclone.org/swift/#configuration-from-an-openstack-credentials-file). |
+| **Authentication URL** | (Required) Enter the authentication URL for the server. This is the OS_AUTH_URL from an [OpenStack credentials file](https://rclone.org/swift/#configuration-from-an-openstack-credentials-file). |
| **AuthVersion**| Select the authentication version from the dropdown list if your auth URL has no version ([rclone documentation](https://rclone.org/swift/#standard-options)). |
{{< /truetable >}}
{{< /expand >}}
#### OpenStack Authentication Advanced Options
+The **Authentication Advanced Options** screen shows different options based on the **AuthVersion** setting.
+**Auto(vX)**, **v1**, and **v2** use the same advanced authentication settings.
-The **AuthVersion** option selected changes the settings displayed in **Authentication Advanced Options**. **Auto(vX)**, **v1**, and **v2** use the same advanced authentication settings but **V3** displays additional settings.
-
-{{< expand "Auto(vx), V1 and V2" "v" >}}
-
-
+{{< trueimage src="/images/SCALE/Credentials/CloudCredentialsOpenStackAuthAdvanced.png" alt="OpenStack Swift Authentication Advanced" id="OpenStack Swift Authentication Advanced" >}}
+{{< expand "Auto(vx), V1 and V2 Authentication Settings" "v" >}}
{{< truetable >}}
| Setting | Description |
|---------|-------------|
@@ -239,39 +243,38 @@ The **AuthVersion** option selected changes the settings displayed in **Authenti
{{< /truetable >}}
{{< /expand >}}
-{{< expand "V3" "v" >}}
-When **v3** is the **AuthVersion** option settings **Authentication Advanced Options** displays additional settings.
+{{< expand "V3 Authentication Settings" "v" >}}
+Setting **AuthVersion** to **v3** shows additional authentication settings.
-
+{{< trueimage src="/images/SCALE/Credentials/CloudCredentialsOpenStackAuthAdvancedV3.png" alt="OpenStack Swift Authentication Advanced V3" id="OpenStack Swift Authentication Advanced V3" >}}
{{< truetable >}}
| Setting | Description |
|---------|-------------|
-| **User ID** | Optional. Enter the user ID to log in. To log into most swift systems leave this blank. For more information see [rclone documentation](https://rclone.org/swift/#standard-options). |
-| **User Domain** | Optional. Enter the user domain. For more information see [rclone documentation](https://rclone.org/swift/#standard-options). |
-| **Tenant Name** | Required. Enter the OS_TENANT_NAME from an [OpenStack credentials file](https://rclone.org/swift/#configuration-from-an-openstack-credentials-file). |
+| **User ID** | (Optional) Enter the user ID to log in. To log into most swift systems leave this blank. For more information see [rclone documentation](https://rclone.org/swift/#standard-options). |
+| **User Domain** | (Optional) Enter the user domain. For more information see [rclone documentation](https://rclone.org/swift/#standard-options). |
+| **Tenant Name** | (Required) Enter the OS_TENANT_NAME from an [OpenStack credentials file](https://rclone.org/swift/#configuration-from-an-openstack-credentials-file). |
| **Tenant ID** | Required for **v2** and **v3**. Enter the tenant ID. For more information see [rclone documentation](https://rclone.org/swift/#standard-options). |
-| **Tenant Domain** | Optional. Enter the tenant domain. For more information see [rclone documentation](https://rclone.org/swift/#standard-options). |
-| **Auth Token** | Optional. Enter the auth token from alternate authentication. For more information see [rclone documentation](https://rclone.org/swift/#standard-options). |
-| **Region Name** | Optional. Enter the region name. For more information see [rclone documentation](https://rclone.org/swift/#standard-options). |
-| **Storage URL** | Optional. Enter the storage URL. For more information see [rclone documentation](https://rclone.org/swift/#standard-options). |
+| **Tenant Domain** | (Optional) Enter the tenant domain. For more information see [rclone documentation](https://rclone.org/swift/#standard-options). |
+| **Auth Token** | (Optional) Enter the auth token from alternate authentication. For more information see [rclone documentation](https://rclone.org/swift/#standard-options). |
+| **Region Name** | (Optional) Enter the region name. For more information see [rclone documentation](https://rclone.org/swift/#standard-options). |
+| **Storage URL** | (Optional) Enter the storage URL. For more information see [rclone documentation](https://rclone.org/swift/#standard-options). |
| **Endpoint Type** | Select service catalog option from the **Endpoint Type** dropdown. Options are **Public**, **Internal** and **Admin**. **Public** is recommended. For more information see [rclone documentation](https://rclone.org/swift/#standard-options). |
{{< /truetable >}}
{{< /expand >}}
-### WebDAV Authentication Settings
-
-WebDAV uses the URL, service type and user credentials to authenticate the account credentials.
-{{< expand "Chick Here for Settings" "v" >}}
+### WebDAV Credential
+WebDAV uses a URL, service type and user credentials to authenticate account cloud account credentials.
-
+{{< trueimage src="/images/SCALE/Credentials/CloudCredentialWebDAVAuthentication.png" alt="WebDAV Authentication Settings" id="WebDAV Authentication Settings" >}}
+{{< expand "WebDAV Authentication Settings" "v" >}}
{{< truetable >}}
| Setting | Description |
|---------|-------------|
-| **URL** | Required. Enter the URL of the HTTP host to connect to. |
-| **WebDAV Service** | Required. Select the name of the WebDAV site, service, or software used from the dropdown list. Options are **NEXTCLOUD**, **OWNCLOUD**, **SHAREPOINT**, or **OTHER**. |
-| **Username** | Required. Enter the WebDAV account user name. |
-| **Password** | Required. Enter the WebDAV account password. |
+| **URL** | (Required) Enter the URL of the HTTP host to connect to. |
+| **WebDAV Service** | (Required) Select the name of the WebDAV site, service, or software used from the dropdown list. Options are **NEXTCLOUD**, **OWNCLOUD**, **SHAREPOINT**, or **OTHER**. |
+| **Username** | (Required) Enter the WebDAV account user name. |
+| **Password** | (Required) Enter the WebDAV account password. |
{{< /truetable >}}
-{{< /expand >}}
+{{< /expand >}}
\ No newline at end of file
diff --git a/content/SCALE/SCALEUIReference/Credentials/BackupCredentials/SSHCredentialScreens.md b/content/SCALE/SCALEUIReference/Credentials/BackupCredentials/SSHCredentialScreens.md
index 2914547c50..4412c469ad 100644
--- a/content/SCALE/SCALEUIReference/Credentials/BackupCredentials/SSHCredentialScreens.md
+++ b/content/SCALE/SCALEUIReference/Credentials/BackupCredentials/SSHCredentialScreens.md
@@ -1,4 +1,4 @@
----
+BackupCredentialsAllCloudSSH---
title: "SSH Screens"
description: "Provides information on the SSH Connections and SSH Keypairs screens, widgets, and settings."
weight: 20
@@ -8,6 +8,8 @@ alias:
tags:
- ssh
- credentials
+ - key pair
+ - key pairs
---
The **Backup Credentials** screen displays the **SSH Connections** and **SSH Keypairs** widgets.
@@ -16,19 +18,19 @@ You must also configure and activate the [SSH Service]({{< relref "sshservicescr
## SSH Connection and Keypairs Widgets
-The **SSH Connections** and **SSH Keypairs** widgets display a list of SSH connections and keypairs configured on the system.
+The **SSH Connections** and **SSH Keypairs** widgets display a list of SSH connections and key pairs configured on the system.
-{{< trueimage src="/images/SCALE/Credentials/BackupCredentialsAllCloudSSH.png" alt="Backup Credentials Screen" id="Backup Credentials Screen" >}}
+{{< trueimage src="/images/SCALE/Credentials/BackupCredentialsScreen.png" alt="Backup Credentials Screen" id="Backup Credentials Screen" >}}
The **SSH Connections** widget allows users to establish Secure Socket Shell (SSH) connections.
-The **SSH Keypairs** widget allows users to generate SSH keypairs required to authenticate the identity of a user or process that wants to access the system using SSH protocol.
+The **SSH Keypairs** widget allows users to generate SSH key pairs required to authenticate the identity of a user or process that wants to access the system using SSH protocol.
-**Add** button in the **SSH Connections** widget opens the **[SSH Connections](#ssh-connections-screens)** configuration window.
+**Add** in the **SSH Connections** widget opens the **[SSH Connections](#ssh-connections-screens)** configuration window.
The connection name on the widget is a link that opens the **SSH Connections** configuration screen already populated with the saved settings for the selected connection.
### SSH Connections Screens
-The settings displayed on the **SSH Connections** configuration screens are the same whether you add a new connection or edit an existing connection.
+The settings on the **SSH Connections** configuration screens are the same whether you add a new connection or edit an existing connection.
#### Name and Method Settings
@@ -37,30 +39,28 @@ The settings displayed on the **SSH Connections** configuration screens are the
{{< truetable >}}
| Name | Description |
|------|-------------|
-| **Name** | Required. Enter a unique name for this SSH connection. For example, use *ssh* and a server name or number like *sshsys1* or *sshtn121* where *sys1* or *tn121* are server designations. |
-| **Setup Method** | Default is set to **Semi-automatic (TrueNAS only)**. Select **Semi-automatic (TrueNAS only)** to simplify setting up an SSH connection with another TrueNAS or FreeNAS system without logging into that system to transfer SSH keys. Select **Manual** to enter all settings when setting up an SSH connection with a non-TrueNAS server. Displays other setting options required to [manually configure an SSH connection](#authentication-settings---manual-method). Requires copying a public encryption key from the local system to the remote system. A manual setup allows a secure connection without a password prompt. |
+| **Name** | (Required) Enter a unique name for this SSH connection. For example, use *ssh* and a server name or number like *sshsys1* or *sshtn121* where *sys1* or *tn121* are server designations. |
+| **Setup Method** | Select the setup method to use from the dropdown list of options. Options are:
**Semi-automatic (TrueNAS only)** - Select to simplify setting up an SSH connection with another TrueNAS or FreeNAS system without logging into that system to transfer SSH keys. The default is set to **Semi-automatic (TrueNAS only)**.
**Manual** - Select to enter all settings when setting up an SSH connection with a non-TrueNAS server. Displays other setting options required to [manually configure an SSH connection](#authentication-settings---manual-method). Requires copying a public encryption key from the local system to the remote system. A manual setup allows a secure connection without a password prompt. |
{{< /truetable >}}
-#### Authentication Settings - Semi-Automatic Method
-
-These authentication settings display when **Setup Method** is **Semi-automatic (TrueNAS only)**.
+#### Authentication - Semi-Automatic Method Settings
+These authentication settings show when **Setup Method** is **Semi-automatic (TrueNAS only)**.
{{< trueimage src="/images/SCALE/Credentials/NewSSHConnectAuthentication.png" alt="Authentication Settings" id="Authentication Settings" >}}
{{< truetable >}}
| Name | Description |
|------|-------------|
-| **TrueNAS URL** | Enter the host name or IP address of the remote system. Use a valid URL scheme for the remote TrueNAS URL. IP address example of *https://10.231.3.76*. |
-| **Admin Username** | Enter the user name for logging into the remote system. |
-| **Admin Password** | Enter the user account password for logging into the remote system. |
-| **One-Time Password (if necessary)** | One-Time Password if two-factor authentication is enabled. |
-| **Username** | Username on the remote system used to login via SSH. |
-| **Private Key** | Select a saved SSH keypair or you can import the private key from a previously created SSH keypair or select **Generate New** to create a new keypair to use for the connection to this remote system. |
+| **TrueNAS URL** | (Required) Enter the host name or IP address of the remote system. Use a valid URL scheme for the remote TrueNAS URL. IP address example of *https://10.231.3.76*. |
+| **Admin Username** | Enter the user name for logging into the remote system. The default is set to **root** but change this to the name of the system administrator for the remote system for this connection. |
+| **Admin Password** | (Required) Enter the administrator user account password for logging into the remote system. |
+| **One-Time Password (if necessary)** | One-time password if two-factor authentication is enabled. |
+| **Username** | (Required) Username on the remote system used to log in via SSH. |
+| **Private Key** | (Required) Select a saved SSH key pair, import the private key from a previously created SSH key pair, or select **Generate New** to create a new key pair to use for the connection to this remote system. |
{{< /truetable >}}
-#### Authentication Settings - Manual Method
-
-These authentication settings display when **Setup Method** is **Manual**. You must copy a public encryption key from the local system to the remote system.
+#### Authentication - Manual Method Settings
+These authentication settings show when **Setup Method** is **Manual**. You must copy a public encryption key from the local system to the remote system.
A manual setup allows a secure connection without a password prompt.
{{< trueimage src="/images/SCALE/Credentials/NewSSHConnectAuthenticationManual.png" alt="Manual Authentication Settings" id="Manual Authentication Settings" >}}
@@ -68,10 +68,10 @@ A manual setup allows a secure connection without a password prompt.
{{< truetable >}}
| Name | Description |
|------|-------------|
-| **Host** | Enter the host name or IP address of the remote system. A valid URL scheme is required. An IP address example is *https://10.231.3.76*. |
-| **Port** | Enter the port number on the remote system to use for the SSH connection. |
-| **Username** | Enter the user name for logging into the remote system. |
-| **Private Key** | Select a saved SSH keypair or select **Generate New** to create a new keypair to use for the connection to this remote system. |
+| **Host** | (Required) Enter the host name or IP address of the remote system. A valid URL scheme is required. An IP address example is *https://10.231.3.76*. |
+| **Port** | (Required) Enter the port number on the remote system to use for the SSH connection. |
+| **Username** | (Required) Enter the user name for logging into the remote system. |
+| **Private Key** | (Required) Select a saved SSH key pair or select **Generate New** to create a new key pair to use for the connection to this remote system. |
| **Remote Host Key** | Enter the remote system SSH key for this system to authenticate the connection. Click **Discover Remote Host Key** after properly configuring all other fields to query the remote system and automatically populate this field. |
| **Discover Remote Host Key** | Click to connect to the remote system and attempt to copy the key string to the related TrueNAS field. |
{{< /truetable >}}
@@ -83,36 +83,36 @@ A manual setup allows a secure connection without a password prompt.
{{< truetable >}}
| Name | Description |
|------|-------------|
-| **Connect Timeout** | Enter time (in seconds) before the system stops attempting to establish a connection with the remote system. |
+| **Connect Timeout** | Enter the time (in seconds) before the system stops attempting to establish a connection with the remote system. |
{{< /truetable >}}
**Save** automatically opens a connection to the remote TrueNAS and exchanges SSH keys.
### SSH Keypairs Widget
-The **SSH Keypairs** widget on the **Backup Credentials** screen lists SSH keypairs added to the TrueNAS SCALE system.
+The **SSH Keypairs** widget on the **Backup Credentials** screen lists SSH key pairs added to the TrueNAS SCALE system.
{{< trueimage src="/images/SCALE/Credentials/BackupCredentialsSSHKeypairsWidget.png" alt="SSH Keypairs Widgit" id="SSH Keypairs Widgit" >}}
-The name of the keypair listed on the widget is a link that opens the **[SSH Keypairs](#ssh-keypairs-screen)** configuration screen.
+The name of the key pair listed on the widget is a link that opens the **[SSH Keypairs](#ssh-keypairs-screen)** configuration screen.
The download icon, and the more_vert at the bottom of the **SSH Keypairs** configuration screen, download the public and private key strings as text files for later use.
-The delete delete icon opens the a delete dialog. Click **Confirm** and then **Delete** to remove the stored keypairs from the system.
+The delete delete icon opens the delete dialog. Click **Confirm** and then **Delete** to remove the stored key pairs from the system.
#### SSH Keypairs Screen
-The **SSH Keypairs** configuration screen displays the same settings for both add and edit options. Click **Add** to open a new configuration form, or click on an existing keypair to open the configuration screen populated with the settings for the selected keypair.
+The **SSH Keypairs** configuration screen displays the same settings for both add and edit options. Click **Add** to open a new configuration form, or click on an existing key pair to open the configuration screen populated with the settings for the selected key pair.
{{< trueimage src="/images/SCALE/Credentials/BackupCredentialsSSHKeypairsAdd.png" alt="SSH Keypairs Settings" id="SSH Keypairs Settings" >}}
{{< truetable >}}
| Name | Description |
|------|-------------|
-| **Name** | Required. Enter a unique name for this SSH keypair. Automatically generated keypairs are named after the object that generated the keypair with **key** appended to the name. |
-|**Generate Keypair** | Click to have TrueNAS SCALE automatically generate a new keypair and populate the **Private Key** and **Public Keys** fields with these values. |
+| **Name** | Required. Enter a unique name for this SSH key pair. Automatically generated key pairs are named after the object that generated the key pair with **key** appended to the name. |
+|**Generate Keypair** | Click to have TrueNAS SCALE automatically generate a new key pair and populate the **Private Key** and **Public Keys** fields with these values. |
| **Private Key** | See **Authentication** in [SSH/Authentication](https://man7.org/linux/man-pages/man1/ssh.1.html). |
| **Public Key** | See **Authentication** in [SSH/Authentication](https://man7.org/linux/man-pages/man1/ssh.1.html) |
{{< /truetable >}}
-**Save** adds the keypair to the widget and activates the more_vert with options to **Download Private Key** and **Download Public key**.
+**Save** adds the key pair to the widget and activates the more_vert with options to **Download Private Key** and **Download Public key**.
diff --git a/content/SCALE/SCALEUIReference/Credentials/BackupCredentials/_index.md b/content/SCALE/SCALEUIReference/Credentials/BackupCredentials/_index.md
index b56fce66cf..ca52270d7a 100644
--- a/content/SCALE/SCALEUIReference/Credentials/BackupCredentials/_index.md
+++ b/content/SCALE/SCALEUIReference/Credentials/BackupCredentials/_index.md
@@ -10,10 +10,14 @@ tags:
related: false
---
-TrueNAS stores cloud backup services credentials, SSH connections, and SSH keypairs configured using the widgets on the **Backup Credentials** screen.
+TrueNAS stores cloud backup services credentials, SSH connections, and SSH key pairs configured using the widgets on the **Backup Credentials** screen.
Users can set up backup credentials with cloud and SSH clients to back up data in case of drive failure.
-
+{{< trueimage src="/images/SCALE/Credentials/BackupCredentialsScreen.png" alt="Backup Credentials Screen" id="Backup Credentials Screen" >}}
+
+The **Backup Credentials** screen displays the **Cloud Credentials**, **SSH Connections**, and **SSH Keypairs** widgets.
+
+Click **Add** on the widget for the type of credential to add to open that configuration screen.
diff --git a/content/SCALE/SCALEUIReference/DataProtection/TrueCloudBackupTasksScreen.md b/content/SCALE/SCALEUIReference/DataProtection/TrueCloudBackupTasksScreen.md
index c649121f8e..545e7be13d 100644
--- a/content/SCALE/SCALEUIReference/DataProtection/TrueCloudBackupTasksScreen.md
+++ b/content/SCALE/SCALEUIReference/DataProtection/TrueCloudBackupTasksScreen.md
@@ -12,8 +12,9 @@ keywords:
- data backup and recovery
---
-The **TrueCloud Backup Tasks** widget on the **Data Protection** screen shows configured TrueCloud tasks, and provides access to configuration screens to add single-time or scheduled recurring transfers between TrueNAS SCALE and a Storj Ix cloud storage account.
-TrueCloud tasks are an effective method to back up data to a remote location, restore snapshots, or to perform cloud-storage-migration.
+The **TrueCloud Backup Tasks** widget on the **Data Protection** screen shows configured TrueCloud tasks, and provides access to configuration screens to add or schedule recurring transfers between TrueNAS SCALE and a cloud storage provider account like Storj iX.
+
+TrueCloud backup tasks are an effective method to back up data to a remote location, restore snapshots, or perform cloud-storage-migration.
## TrueCloud Backup Tasks Widget
The **TrueCloud Backup Tasks** widget shows a list of tasks configured on the system.
@@ -22,107 +23,113 @@ The **TrueCloud Backup Tasks** widget shows a list of tasks configured on the sy
The widget shows **No records have been added yet** until a TrueCloud task is added.
-Click on the widget header to open the [**TrueCloud Backup Tasks**](#truecloud-backup-tasks-screen) screen that lists all tasks configured on the system.
+The widget header opens the [**TrueCloud Backup Tasks**](#truecloud-backup-tasks-screen) screen that lists all TrueCloud backup tasks configured on the system.
**Add** on the widget and the **TrueCloud Backup Tasks** screen opens the **[Add TrueCloud Backup Task Screen](#add-truecloud-backup-task-screen)**.
-Each task includes four icons for various functions:
+Each task on the widget shows four icons for various functions:
+
+* edit **Edit** opens the **[Edit TrueCloud Backup Task](#edit-truecloud-backup-task-screen)** screen populated with with the settings for that task.
-* The edit **Edit** icon opens the **[Edit TrueCloud Backup Task](#edit-truecloud-backup-task-screen)** screen populated with with the settings for that task.
+* play_arrow **Run Now** starts and runs the backup task outside of the scheduled time.
-* The play_arrow **Run Now** icon starts the backup task, running it outside of the scheduled time.
+* **visibility View Details** opens the [**TrueCloud Backup Tasks**](#truecloud-backup-tasks-screen) screen that lists backup tasks configured on the system. Click on a task to see details for the selected task.
+
+* delete **Delete** opens a confirmation dialog before the system deletes the task.
-* The **visibility View Details** icon opens the [**TrueCloud Backup Tasks**](#truecloud-backup-tasks-screen) Screen with details for the selected task visible.
+**State** shows the status of the previous or current task. Possible status indications are:
-* The delete **Delete** icon opens a confirmation dialog before the system deletes the task.
+* **SUCCESS** for completed tasks.
+* **FAILED** if the task fails to complete.
+* **RUNNING** for tasks in progress.
+8 **N/A** for scheduled tasks before they run.
-**State** displays the status of the previous or current task as **SUCCESS** for completed tasks, **FAILED** if the task fails to complete, and **RUNNING** for tasks in progress.
-Tasks that have not been run yet display **N/A**.
-Click on the state oval to open the **Logs** dialog for that task.
+### TrueCloud Logs Dialog
+The state oval opens the **Logs** dialog for that task.
**Download Logs** saves a copy of the current task logs.
{{< trueimage src="/images/SCALE/DataProtection/TrueCloudLogs.png" alt="TrueCloud Logs Dialog" id="TrueCloud Logs Dialog" >}}
## TrueCloud Backup Tasks Screen
The **TrueCloud Backup Tasks** screen lists all tasks configured on the system.
+The **TrueCloud Backup Tasks open_in_new** on the widget title or **visibility View Details** on a task opens the **TrueCloud Backup Tasks** screen.
{{< trueimage src="/images/SCALE/DataProtection/TrueCloudBackupTasksScreenComplete.png" alt="TrueCloud Backup Tasks Screen" id="TrueCloud Backup Tasks Screen" >}}
-Buttons for these task options perform the same functions as the icons on the widget:
+Task options perform the same functions as the icons on the widget:
* edit **Edit** opens the **[Edit TrueCloud Backup Task](#edit-truecloud-backup-task-screen)** screen populated with with the settings for that task.
-* play_arrow **Run Now** starts the backup task, running it outside of the scheduled time.
+* play_arrow **Run Now** starts and runs the backup task outside of the scheduled time.
* delete **Delete** opens a confirmation dialog before the system deletes the task.
{{}}
-Select any task to see details on the configured task, such as the schedule, path to the dataset or directories, snapshots and other options for that task.
+Select any task to see details for the configured task, such as the schedule, path to the dataset or directories, snapshots, and other task options.
### Snapshots Widget
-
The **Snapshots** widget lists existing TrueCloud snapshots for the selected backup task.
It contains options to restore from or delete an existing snapshot.
{{< trueimage src="/images/SCALE/DataProtection/TrueCloudSnapshots.png" alt="Snapshots Widget" id="Snapshots Widget" >}}
-**history Restore** opens the **Restore from Snapshot** screen.
+**history Restore** opens the [**Restore from Snapshot**](#restore-from-snapshot-screen) screen.
delete **Delete** opens a confirmation dialog before the system deletes the snapshot.
### Restore from Snapshot Screen
-
-The **Restore from Snapshot** screen displays the date and time of the selected snapshot.
-It contains **Remote** and **Local** options to configure the TrueCloud snapshot restoration.
+The **Restore from Snapshot** screen shows the date and time of the selected snapshot.
+It shows **Remote** and **Local** configuration options to restore the TrueCloud snapshot.
{{< trueimage src="/images/SCALE/DataProtection/TrueCloudRestore.png" alt="Restore from Snapshot" id="Restore from Snapshot" >}}
#### Remote Settings
-Configure remote settings to include all data in the backup or exclude some data from the restoration
-Additional settings display depending on the **Include/Exclude** selection.
+**Remote Settings** specify all data in the backup or exclude some data from a restoration.
+Additional settings show depending on the **Include/Exclude** selection.
{{< truetable >}}
| Settings | Description |
|----------|-------------|
-| **Include Everything** | Restore all backed up data from the remote snapshot to the selected local path. |
-| **Include from subfolder** | Restore data from a subfolder within the backed up data. |
-| **Subfolder** | Displays when **Include from subfolder** is selected. Enter or browse to the subfolder within the snapshot to restore data from. |
-| **Included Paths** | Displays when **Include from subfolder** is selected. Select files and directories to include from the backup. Leave empty to include everything in the selected subfolder. |
-| **Select paths to exclude** | Exclude only certain paths from the data to restore. |
-| **Excluded Paths** | Displays when **Select paths to exclude** is selected. Enter or select files and directories to exclude from the backup. Use the checkboxes to select multiple paths or separate multiple entries with a comma. |
-| **Exclude by pattern** | Exclude files and directories matching defined glob patterns. |
-| **Pattern** | Displays when **Exclude by pattern** is selected
+| **Include Everything** | Select to restore all backed-up data from the remote snapshot to the selected local path. |
+| **Include from subfolder** | Select to restore data from a subfolder within the backed-up data. |
+| **Subfolder** | Shows when **Include from subfolder** is selected. Enter or browse to the subfolder within the snapshot to restore data from. |
+| **Included Paths** | Shows when **Include from subfolder** is selected. Select files and directories to include from the backup. Leave empty to include everything in the selected subfolder. |
+| **Select paths to exclude** | Select to exclude only certain paths from the data to restore. |
+| **Excluded Paths** | Shows when **Select paths to exclude** is selected. Enter or select files and directories to exclude from the backup. Select as many checkboxes as you want to select multiple paths or separate multiple entries with a comma. |
+| **Exclude by pattern** | Select to exclude files and directories matching defined glob patterns. |
+| **Pattern** | Shows when **Exclude by pattern** is selected. |
{{< /truetable >}}
#### Local Settings
-Use **Target** to select the local directory where files are restored.
+Use **Local** settings to select the target mount point on the current (local) system where files are restored.
Be cautious with setting the restore target to avoid overwriting existing files.
+**Target** enter the path to the dataset or directory or browse to the location to populate the field with the local directory where files are restored.
+
{{< include file="/static/includes/FileExplorerFolderIcons.md" >}}
**create_new_folder Create Dataset** opens a dialog to name and create a new dataset at the selected target.
-Click **Save** to restore data from the snapshot.
+**Save** starts restoring data from the snapshot.
-## Add TrueCloud Backup Task Screen
-
-The **Add TrueCloud Backup Task** screen contains options to configure a new backup task.
-The **Edit TrueCloud Backup Task** screen contains the same settings for an existing task.
-Settings are grouped into the Local, Remote, Task Settings, and Control, as well as Advanced and Advanced Remote Options for advanced users.
+## Add and Edit TrueCloud Backup Task Screen
+The **Add TrueCloud Backup Task** and **Edit TrueCloud Backup Task** screens contain options to configure a new backup task.
+The edit screen opens populated with the existing task settings.
+Each screen shows the **Local**, **Remote**, **Task Settings**, and **Control** basic settings.
+The **Advanced** and **Advanced Remote Options** are for use by advanced users.
{{< trueimage src="/images/SCALE/DataProtection/AddTrueCloudTaskBasicOptions.png" alt="Add TrueCloud Backup Task - Basic Options" id="Add TrueCloud Backup Task - Basic Options" >}}
### Local Settings
-**Local** settings allow selecting the dataset or directory to use in the task.
-Selecting the dataset populates the **Source Path** field.
+**Local** settings allow selecting the dataset or directory to use in the task. Selecting the dataset populates the **Source Path** field.
{{< include file="/static/includes/FileExplorerFolderIcons.md" >}}
{{< truetable >}}
| Settings | Description |
|----------|-------------|
-| **Source Path** | Enter or click the arrow_right arrow to the left of **/mnt** folder to expand and show datasets and directories within that folder. Locate the dataset or directory location to send to Storj for TrueCloud backup. Click the arrow_right arrow to the left of **/mnt** folder again to collapse the directory tree. |
+| **Source Path** | Enter or browse to the path of the dataset or directory with the data to send to the cloud backup provider used in the task. Click the arrow_right arrow to the left of the **/mnt** folder to expand and show datasets and directories within that folder. This is the dataset or directory location with the data the TrueCloud backup task sends to the cloud storage provider. Click the arrow_right arrow to the left of the **/mnt** folder again to collapse the directory tree. |
{{< /truetable >}}
### Remote Settings
@@ -131,30 +138,30 @@ The **Remote** settings specify the TrueCloud credential and destination storage
{{< truetable >}}
| Settings | Description |
|----------|-------------|
-| **Credential** | Select an exiting Storj iX credential from the dropdown list. TrueNAS automatically validates the selected credential.
Select **Add New** to open the **Cloud Credentials** screen. This is the same configuration screen as when you click **Add** on the **Credentials > Backup Credentials** screen. |
-| **Bucket** | Select the pre-defined Storj bucket to use. |
-| **Folder** | Enter or click the arrow_right arrow to the left of the folder icon and at each dataset or directory to reach the storage location to use for this task.
Enter `/name`, where *name* is a folder that does not exist, to create a new folder in the Storj bucket. |
+| **Credential** | Select an existing cloud storage provider credential, such as Storj iX from the dropdown list (default option). TrueNAS automatically validates the selected credential.
Select **Add New** to open the [**Cloud Credentials**]({{< relref "CloudCredentialScreens.md" >}}) screen. This is the same configuration screen that opens when you click **Add** on the **Credentials > Backup Credentials** screen. |
+| **Bucket** | Shows after selecting a cloud provider that uses buckets in the **Credential** field. Select a pre-defined bucket configured in the provider web UI. For example, Amazon S3 and Storj use buckets. |
+| **Folder** | Enter or browse to the dataset or directory to receive the backed-up data. Click the arrow_right arrow to the left of the folder icon and at each dataset or directory to reach the storage location to use for this task.
Enter /name, where *name* is a folder that does not exist, to create a new folder in the bucket. |
{{< /truetable >}}
### Task Settings
-**Task Settings** specify the task name, snapshot retention policy, and password.
+**Task Settings** specify the task name, snapshot retention policy, and password for the backup repository.
{{< truetable >}}
| Settings | Description |
|----------|-------------|
-| **Name** | Enter a name for the TrueCloud Backup Task. |
+| **Name** | Enter a name for the TrueCloud backup task. |
| **Keep Last** | Enter a number of past snapshot copies to retain before removing older snapshots. |
-| **Password** | Enter a password for the backup repository. Record this password in a secure location. It is needed 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. |
+| **Password** | Enter a password for the backup repository. Record this password in a secure location. Required 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. |
{{< /truetable >}}
### Control Settings
-**Control** settings establish a schedule for when the backup task occurs.
+**Control** settings establish a schedule for when to run the backup task.
{{< truetable >}}
| Settings | Description |
|----------|-------------|
| **Schedule** | Select a schedule preset or choose **Custom** to open the advanced scheduler. |
-| **Enabled** | Select to enable this TrueCloud task. Leave clear to disable the task without deleting it and keep the configuration available without allowing the specified schedule to run the task. You can use the toggle in the **Enable** column on the **TrueCloud Backup Tasks** widget to enable or disable the task. |
+| **Enabled** | Select to enable the TrueCloud task. Leave clear to disable the task without deleting it and keep the configuration available without allowing the specified schedule to run the task. The toggle in the **Enable** column on the **TrueCloud Backup Tasks** widget enables/disables the task. |
{{< /truetable >}}
{{< expand "Advanced Scheduler" "v" >}}
@@ -162,24 +169,25 @@ The **Remote** settings specify the TrueCloud credential and destination storage
{{< /expand >}}
### Advanced Options Settings
-**Advanced Options** settings are for advanced users.
+**Advanced Options** settings are intended for use by advanced users.
{{< trueimage src="/images/SCALE/DataProtection/AddTrueCloudTaskAdvancedOptions.png" alt="Add TrueCloud Backup Task - Advanced Options" id="Add TrueCloud Backup Task - Advanced Options" >}}
{{< truetable >}}
| Settings | Description |
|----------|-------------|
-| **Take Snapshot** | Select to take a snapshot before transferring data to Storj. This option is only available for datasets that have no child datasets. |
-| **Pre-Script** | For advanced users. Enter a script to execute before running the task. See the [Managing TrueCloud Backup Tasks tutorial]({{< relref "TrueCloudTasks.md #using-advanced-options" >}}) for more information. |
-| **Post-Script** | For advanced user. Enter a script to execute after running the task. See the [Managing TrueCloud Backup Tasks tutorial]({{< relref "TrueCloudTasks.md #using-advanced-options" >}}) for more information. |
-| **Exclude** | Enter a list of files and directories to exclude from the backup. Separate entries by pressing Enter.
Examples of proper syntax to exclude files/directories are:`photos` 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](https://rclone.org/filtering/) for more details about the `--exclude` option. |
+| **Take Snapshot** | Select to take a snapshot before transferring data to the specified cloud provider like Storj. This option is not available to datasets with child datasets. |
+| **Pre-Script** | (For advanced users only) Enter a script to execute before running the task. See the [Managing TrueCloud Backup Tasks tutorial]({{< relref "TrueCloudTasks.md #using-advanced-options" >}}) for more information. |
+| **Post-Script** | (For advanced users only) Enter a script to execute after running the task. See the [Managing TrueCloud Backup Tasks tutorial]({{< relref "TrueCloudTasks.md #using-advanced-options" >}}) for more information. |
+| **Exclude** | Enter a list of files and directories to exclude from the backup. Separate entries by pressing Enter. See [rclone filtering](https://rclone.org/filtering/) for more details about the `--exclude` option and proper syntax. |
{{< /truetable >}}
### Advanced Remote Options
+**Advanced Remote Options** settings are intended for use by advanced users.
{{< truetable >}}
| Settings | Description |
|----------|-------------|
-| **Transfers** | Enter the number of simultaneous file transfers. Enter a number based on the available bandwidth and destination system performance. See [rclone --transfers](https://rclone.org/docs/#transfers-n). |
+| **Transfers** | Enter the number of simultaneous file transfers to allow. Base the number on the available bandwidth and destination system performance. See [rclone --transfers](https://rclone.org/docs/#transfers-n). |
| **Bandwidth limit** | Enter a single bandwidth limit or bandwidth limit schedule in rclone format. Separate entries by pressing . 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](https://rclone.org/docs/#bwlimit-bandwidth-spec). |
{{< /truetable >}}
diff --git a/static/images/SCALE/Credentials/BackupCredentialsAllCloudSSH.png b/static/images/SCALE/Credentials/BackupCredentialsAllCloudSSH.png
deleted file mode 100644
index 444d8d9214..0000000000
Binary files a/static/images/SCALE/Credentials/BackupCredentialsAllCloudSSH.png and /dev/null differ
diff --git a/static/images/SCALE/Credentials/BackupCredentialsScreen.png b/static/images/SCALE/Credentials/BackupCredentialsScreen.png
new file mode 100644
index 0000000000..0e54b3339e
Binary files /dev/null and b/static/images/SCALE/Credentials/BackupCredentialsScreen.png differ
diff --git a/static/images/SCALE/Credentials/CloudCredentialsGoogleCloudAuth.png b/static/images/SCALE/Credentials/CloudCredentialsGoogleCloudAuth.png
new file mode 100644
index 0000000000..7f489b195c
Binary files /dev/null and b/static/images/SCALE/Credentials/CloudCredentialsGoogleCloudAuth.png differ
diff --git a/static/images/SCALE/Credentials/CloudCredentialsOAuthAccessTokeAuthentication.png b/static/images/SCALE/Credentials/CloudCredentialsOAuthAccessTokenAuthentication.png
similarity index 100%
rename from static/images/SCALE/Credentials/CloudCredentialsOAuthAccessTokeAuthentication.png
rename to static/images/SCALE/Credentials/CloudCredentialsOAuthAccessTokenAuthentication.png
diff --git a/static/includes/AddStorjCloudCredential.md b/static/includes/AddStorjCloudCredential.md
new file mode 100644
index 0000000000..32c21d8188
--- /dev/null
+++ b/static/includes/AddStorjCloudCredential.md
@@ -0,0 +1,27 @@
+
+
+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.
+
+{{< trueimage src="/images/SCALE/Credentials/AddingStorjCloudCredential.png" alt="Adding Storj Cloud Credentials" id="Adding Storj Cloud Credentials" >}}
+
+1. Enter a descriptive name to identify the credential in the **Name** field.
+
+2. Click **Signup for account** to create your Storj iX account. This opens the Storj new account screen for TrueNAS.
+
+ {{< hint type=important >}}
+ You must use this link to create your Storj account to take advantage of the benefits of the Storj iX pricing!
+ {{< /hint >}}
+
+ After setting up your Storj iX account, [create your Storj bucket](#adding-the-storj-truenas-bucket) and the [Storj S3 access](#setting-up-s3-access-to-the-bucket) for the new bucket.
+
+3. Enter the authentication information provided by Storj in the **Access Key ID** and **Secret Access Key** fields.
+
+4. Click **Verify Credentials** and wait for the system to verify the credentials.
+
+ {{< trueimage src="/images/SCALE/Credentials/CloudCredentialsVerified.png" alt="Verify Cloud Credentials" id="Verify Cloud Credentials" >}}
+
+5. Click **Save**.
diff --git a/static/includes/CloudServiceProvidersSCALE.md b/static/includes/CloudServiceProvidersSCALE.md
index 7fa8471961..f1d6c61a5b 100644
--- a/static/includes/CloudServiceProvidersSCALE.md
+++ b/static/includes/CloudServiceProvidersSCALE.md
@@ -24,5 +24,3 @@ These providers are supported for Cloud Sync tasks in TrueNAS SCALE:
* [WebDAV](http://www.webdav.org/)
* [Yandex](https://cloud.yandex.com/en/)
{{< /columns >}}
-
-*[TrueCloud Backup Tasks]({{< relref "TrueCloudTasks.md" >}}) streamline functionality for Storj iX cloud backups and restoration.
diff --git a/static/includes/CreateStorjiXAccount.md b/static/includes/CreateStorjiXAccount.md
new file mode 100644
index 0000000000..22ca75a4fb
--- /dev/null
+++ b/static/includes/CreateStorjiXAccount.md
@@ -0,0 +1,36 @@
+
+
+You can create your Storj iX cloud service account using two methods:
+
+* Go to the [TrueNAS Storj web page](https://www.truenas.com/ix-storj/) 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](https://us1.storj.io/signup?partner=ix-storj-1) 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.
+
+{{< trueimage src="/images/SCALE/DataProtection/StorjMainDashboard.png" alt="Storj Main Dashboard" id="Storj Main Dashboard" >}}
+
+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:
+
+1. 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.
+
+ {{< trueimage src="/images/SCALE/DataProtection/StorjAddBucket.png" alt="Storj Browse Buckets Screen" id="Storj Browse Buckets Screen" >}}
+
+2. 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.
+
+ {{< trueimage src="/images/SCALE/DataProtection/StorjCreateABucketScreen.png" alt="Storj New Bucket" id="Storj New Bucket" >}}
+
+3. Click on the new bucket to open the **Enter passphrase** window and configure encryption.
+ Enter a secure passphrase in **Encryption Passphrase**.
+
+ {{< trueimage src="/images/SCALE/DataProtection/StorjEncryptYourBucketScreen.png" alt="Storj Enter Passphrase" id="Storj Enter Passphrase" >}}
+
+4. Click **Continue** to complete the process and open the **Browse Files** screen with your new bucket.
+
+ {{< trueimage src="/images/SCALE/DataProtection/StorjBucketAdded.png" alt="Storj Browse Files" id="Storj Browse Files" >}}
\ No newline at end of file
diff --git a/static/includes/DownloadSystemConfigFileSCALE.md b/static/includes/DownloadSystemConfigFileSCALE.md
index 134932626b..ab764bcd1d 100644
--- a/static/includes/DownloadSystemConfigFileSCALE.md
+++ b/static/includes/DownloadSystemConfigFileSCALE.md
@@ -1,22 +1,26 @@
-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.
+When you download the configuration (config) file, you have the option to include encrypted passwords in the config file. Select **Export Password Secret Seed** to download this file.
+Downloading both the config file and the secret seed file allows you to restore the system to a different operating system device where the decryption seed is not already present.
+
+{{< hint type="warning" title="Keep Files Protected">}}
+Physically secure the config file, any encryption key files, and the secret seed file as it contains the seed to prevent unauthorized access or password decryption.
+{{< /hint >}}
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**.
+Go to System **Settings > General Settings** and click on **Manage Configuration**.
Select **Download File**.
-The **Save Configuration** dialog displays.
+The **Save Configuration** dialog opens.
-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.
+Select **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.
+To maintain a current file, download the config file anytime you change your system configuration. Keep the config file safe.
\ No newline at end of file
diff --git a/static/includes/OAuthCloudCredentialSetupSCALE.md b/static/includes/OAuthCloudCredentialSetupSCALE.md
index b657008538..2c734b1bae 100644
--- a/static/includes/OAuthCloudCredentialSetupSCALE.md
+++ b/static/includes/OAuthCloudCredentialSetupSCALE.md
@@ -1,28 +1,25 @@
-After logging into the provider with the OAuth credentials, the provider provides the access token.
-Google Drive and pCloud use one more setting to authenticate credentials.
+Open the **Cloud Credentials** screen, select the name of the cloud storage provider on the **Provider** dropdown list, enter a name for the credential, and then:
-1. Enter the name and select the cloud storage provider from the **Provider** dropdown list.
+1. Enter the provider account email in **OAuth Client ID** and the password for that user account in **OAuth Client Secret**.
-2. Enter the provider account email in **OAuth Client ID** and the password for that user account in **OAuth Client Secret**.
-
-3. Click **Log In To Provider**. The **Authentication** window opens. Click **Proceed** to open the OAuth credential account sign in window.
+2. Click **Log In To Provider**. The **Authentication** window opens. Click **Proceed** to open the OAuth credential account sign-in window.
Yandex displays a cookies message you must accept before you can enter credentials.
Enter the provider account user name and password to verify the credentials.
-4. (Optional) Enter the value for any additional authentication method.
+3. (Optional) Enter the value for any additional authentication method.
For pCloud, enter the pCloud host name for the host you connect to in **Hostname**.
For Google Drive when connecting to **Team Drive**, enter the Google Drive top-level folder ID.
-5. Enter the access token from the provider if not populated by the provider after OAuth authentication. Obtaining the access token varies by provider.
+4. Enter the access token from the provider if not populated by the provider after OAuth authentication. Obtaining the access token varies by provider.
{{< truetable >}}
| Provider | Access Token |
|----------|--------------|
- | Box | For more information the user access token for Box [click here](https://developer.box.com/). An [access token](https://developer.box.com/reference/) enables Box to verify a request belongs to an authorized session. Example token: T9cE5asGnuyYCCqIZFoWjFHvNbvVqHjl. |
+ | Box | For more information on the user access token for Box [click here](https://developer.box.com/). An [access token](https://developer.box.com/reference/) enables Box to verify a request belongs to an authorized session. Example token: T9cE5asGnuyYCCqIZFoWjFHvNbvVqHjl. |
| Dropbox | Create an access [token](https://dropbox.tech/developers/generate-an-access-token-for-your-own-account) from the [Dropbox account](https://www.dropbox.com/). |
| Google Drive | The authentication process creates the token for [Google Drive](https://developers.google.com/drive/api/v3/about-auth) and populates the **Access Token** field automatically. Access tokens expire periodically, so you must refresh them. |
| Google Photo | Does not use an access token. |
@@ -30,6 +27,6 @@ Google Drive and pCloud use one more setting to authenticate credentials.
| Yandex | Create the Yandex access token [here](https://yandex.com/dev/direct/doc/dg-v4/concepts/auth-token.html). |
{{< /truetable >}}
-6. Click **Verify Credentials** to make sure you can connect with the entered credentials.
+5. Click **Verify Credentials** to make sure you can connect with the entered credentials.
-7. Click **Save**.
\ No newline at end of file
+6. Click **Save**.
diff --git a/static/includes/SetUpStorjiXAccountS3Access.md b/static/includes/SetUpStorjiXAccountS3Access.md
new file mode 100644
index 0000000000..6973f67005
--- /dev/null
+++ b/static/includes/SetUpStorjiXAccountS3Access.md
@@ -0,0 +1,57 @@
+
+
+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.
+
+1. Click **Access Keys** to open the **Access Keys** dashboard, then click **New Access Key**.
+
+ {{< trueimage src="/images/SCALE/DataProtection/StorjAccessManagementScreen.png" alt="Storj Access Keys Screen" id="Storj Access Keys Screen" >}}
+
+ The **New Access** window opens.
+
+2. Enter the name you want to use for this credential.
+ Select **S3 Credentials** for access type, then click **Next**.
+
+ {{< trueimage src="/images/SCALE/DataProtection/StorjCreateAccessWindow.png" alt="Storj New Access Key Window" id="Storj New Access Key Window" >}}
+
+3. 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.
+
+ {{< trueimage src="/images/SCALE/DataProtection/StorjCreateAccessSelectConfig.png" alt="Storj Access Permissions Window." id="Storj Access Permissions Window." >}}
+
+ {{< hint type=note >}}
+ If you want to use the SCALE option to [add new buckets](#setting-up-the-truecloud-backup-task) in SCALE, set the access configuration to **Full Access**.
+ {{< /hint >}}
+
+4. (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**.
+
+ {{< trueimage src="/images/SCALE/DataProtection/StorjCreateAccessSelectPermissions.png" alt="Storj Access Select Permissions" id="Storj Access Select Permissions" >}}
+
+ 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**.
+
+ {{< trueimage src="/images/SCALE/DataProtection/StorjCreateAccessSelectBuckets.png" alt="Storj Access Select Buckets." id="Storj Access Select Buckets." >}}
+
+ 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.
+
+ {{< trueimage src="/images/SCALE/DataProtection/StorjCreateAccessSelectDuration.png" alt="Storj Create Access Select Duration" id="Storj Create Access Select Duration" >}}
+
+ d. Review access details and then click **Create Access**.
+
+ {{< trueimage src="/images/SCALE/DataProtection/StorjS3ConfirmDetails.png" alt="Storj Create Access Confirm Details" id="Storj Create Access Confirm Details" >}}
+
+5. 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.
+
+ {{< trueimage src="/images/SCALE/DataProtection/StorjS3CredentialsGenerated.png" alt="Storj S3 Credentials Generated" id="Storj S3 Credentials Generated" >}}
+
+6. 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](#adding-storj-cloud-credentials)** screen to complete setting up the SCALE cloud credential.
\ No newline at end of file