Configuring an SSH Private Key

Updated on 2024-11-22 GMT+08:00

View PDF

Run Git Bash to check whether an SSH key has been generated locally. Run the following command in Git Bash:
```
cat ~/.ssh/id_rsa.pub
```
- If No such file or directory is displayed, no SSH key has been generated on your computer. Go to 2.
- If a character string starting with ssh-rsa is returned, an SSH key has been generated on your computer. If you want to use the generated key, go to 3. If you want to generate a new key, go to 2.
Generate an SSH key. Run the following command to generate a key in Git Bash:
```
ssh-keygen -t rsa -b 4096 -C your_email@example.com
```
In the preceding command, -t rsa indicates that an RSA key is generated, -b 4096 indicates the key length (which is more secure), and -C your_email@example.com indicates that comments are added to the generated public key file to help identify the purpose of the key pair.

If you select the ED25519 algorithm, run the following command to generate a key in Git Bash:
```
ssh-keygen -t ed25519 -b 521 -C your_email@example.com
```
In the preceding command, -t ed25519 indicates that an ED25519 key is generated, -b 521 indicates the key length (which is more secure), and -C your_email@example.com indicates that comments are added to the generated public key file to help identify the purpose of the key pair.

Enter the command for generating the key and press Enter. The key is stored in ~/.ssh/id_rsa by default, and the corresponding public key file is ~/.ssh/id_rsa.pub.
Copy the SSH public key to the clipboard. Run the corresponding command based on your operating system to copy the SSH public key to your clipboard.
- Windows:
```
clip < ~/.ssh/id_rsa.pub
```
- Mac:
```
pbcopy < ~/.ssh/id_rsa.pub
```
- Linux (xclip required):
```
xclip -sel clip < ~/.ssh/id_rsa.pub
```
Log in to Repo and go to the code repository list page. Click the alias in the upper right corner and choose This Account Settings > Repo > SSH Keys. The SSH Keys page is displayed.

You can also click Set SSH Keys in the upper right corner of the code repository list page. The SSH Keys page is displayed.
In Key Name, enter a name for your new key. Paste the SSH public key copied in 3 to Key and click OK. The message "The key has been set successfully. Click Return immediately, automatically jump after 3s without operation" is displayed, indicating that the key is set successfully.

NOTE:

After an SSH key is configured on a computer and the public key is added to CodeArts Repo, all repos under the account can use the SSH key to connect to the computer. Different users usually use different computers. Therefore, before connecting to CodeArts Repo in SSH mode, you need to configure an SSH key on your computer.
When you configure an SSH key, the following message is displayed: SSH Key Already Exits, indicating that the key has been added to the account or another account. Solution: Generate a new SSH key locally by referring to the preceding steps and configure the generated key in CodeArts Repo.