dallasgroot/Documentation
1
0
Fork 0
mirror of https://codeberg.org/Codeberg/Documentation.git synced 2026-06-16 05:13:54 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated paragraph "Telling Git about your SSH key" (#470)

Browse source 
I don't know, if it makes a difference, but  for the "user.signingKey" option it should probably say "<PATH TO PUBLIC SSH KEY>".

The official git documenation says, that git expects a public key.
https://git-scm.com/docs/git-config#Documentation/git-config.txt-gpgsshdefaultKeyCommand

Also some other guides use the public key:
https://blog.dbrgn.ch/2021/11/16/git-ssh-signatures/
https://dev.to/ccoveille/git-the-complete-guide-to-sign-your-commits-with-an-ssh-key-35bg

So, I updated the paragraph accordingly.

Signed-off-by: egnun <egnun@mailbox.org>

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/470
Reviewed-by: Panagiotis "Ivory" Vasilopoulos <git@n0toose.net>
Co-authored-by: egnun <egnun@mailbox.org>
Co-committed-by: egnun <egnun@mailbox.org>
This commit is contained in:
egnun 2024-08-19 22:39:01 +00:00 committed by Panagiotis "Ivory" Vasilopoulos
parent c483b66ffb
commit 3bd7c665c7
1 changed files with 1 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
content/security/ssh-key.md
View file

@ -138,7 +138,7 @@ SSH commit signing is available in Git 2.34 or later. To update your version of
1. Open your terminal.
2. Type `git config --global gpg.format ssh`.
3. Type `git config --global user.signingKey <PATH TO SSH KEY>`, substituting `<PATH TO SSH KEY>` with the path to the key you'd like to use, for example _~/.ssh/id_ed25519_.
3. Type `git config --global user.signingKey <PATH TO PUBLIC SSH KEY>`, substituting `<PATH TO PUBLIC SSH KEY>` with the path to the public key you'd like to use, for example _~/.ssh/id_ed25519.pub_.
4. Type `git config --global commit.gpgSign true`.
## Avoid re-typing the passphrase