Skip to content

Commit

Permalink
Update AddSSHConnectionKeyPair.md
Browse files Browse the repository at this point in the history
  • Loading branch information
tonyriv3 authored Aug 23, 2024
1 parent 6f2a0e0 commit 7a795d3
Showing 1 changed file with 6 additions and 6 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ This procedure uses the semi-automatic setup method for creating an SSH connecti
**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 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:

Expand All @@ -58,7 +58,7 @@ Using the **SSH Connections** configuration screen:

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**.

Expand Down Expand Up @@ -94,7 +94,7 @@ 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.

Expand Down Expand Up @@ -139,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**.
Expand All @@ -152,7 +152,7 @@ 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 key pairs on the **SSH Keypairs** widget found on the **Credentials > Backup Credentials** screen.
Keypairs are generally used when configuring **SSH Connections** or SFTP **Cloud Credentials**.
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 key pairs as needed when creating new **SSH Connections** or **Replication** tasks.
Expand All @@ -161,7 +161,7 @@ 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 key pair a unique name and click **Save**.
The keypair displays on the **SSH Keypairs** widget.
The key pair displays on the **SSH Keypairs** widget.

{{< trueimage src="/images/SCALE/Credentials/BackupCredentialsSSHKeypairsAdd.png" alt="SSH Keypairs Form" id="SSH Keypairs Form" >}}

Expand Down

0 comments on commit 7a795d3

Please sign in to comment.