add description for private key passphrase

This commit is contained in:
René Wagner 2021-05-27 21:38:39 +02:00
parent b155792237
commit 54a921b0cd
No known key found for this signature in database
GPG key ID: 2B8BCD69606E7F19

View file

@ -7,8 +7,6 @@ eleventyNavigation:
It is recommended to use one key per client. It means if you access your Codeberg repository from your home PC, your laptop and your office PC you should generate separate keys for each machine.
In the context of Codeberg you should decide yourself if you add a passphrase to your SSH key or not. Read the on-going discussion about that topic in this [Codeberg-Issue](https://codeberg.org/Codeberg/Documentation/issues/2).
## Generating an SSH key (pair)
1. Open a shell (e.g. `git-bash` on Windows or `bash` on Linux).
@ -31,7 +29,9 @@ In the context of Codeberg you should decide yourself if you add a passphrase to
> Enter a file in which to save the key (/c/Users/you/.ssh/id_rsa):[Press enter]
```
4. Enter a passphrase if you want. *See further [discussions](https://codeberg.org/Codeberg/Documentation/issues/2) about the necessity of a passphrase in the context of Codeberg.*
4. Enter a passphrase if you want.
The private key part of your SSH key can be protected by a passphrase. This adds an additional layer of authentication which increases security. Be aware that this will only be helpful for certain attack scenarios and does not offer 100% protection. It is recommended to keep your private key safe and - well - private.
## Add the SSH key to Codeberg
1. Copy the SSH key to your clipboard. Attention: Copy only the public part of the key not the private one. You can identify it by the `.pub` extension. By default, you can find the public key in `$HOME/.ssh/id_rsa.pub`.
@ -87,4 +87,4 @@ If you are working at the command line, you can alternatively do this directly:
$ eval `ssh-agent`
$ ssh-add
## enter your passphrase once, this is then cached.
```
```