s83/YubiKey-Guide
1
0
Fork 0
mirror of https://github.com/drduh/YubiKey-Guide.git synced 2025-05-08 18:03:46 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #497 from mattborja/readme-gpgsign

Browse source 
Update instructions for commit signing
This commit is contained in:
drduh 2025-05-06 23:55:03 +00:00 • committed by GitHub
commit a7b9a972c5
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 20 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
README.md
View file

@ -1663,15 +1663,32 @@ The path must be set according to `gpgconf --list-dirs agent-ssh-socket` on *rem
YubiKey can be used to sign commits and tags, and authenticate SSH to GitHub when configured in [Settings](https://github.com/settings/keys).
Configure a signing key:
Configure the signing key:
```console
git config --global user.signingkey $KEYID
```
Configure the `user.email` option to match the email address associated with the PGP identity.
Alternatively, if you are using the aforementioned `IdentityFile` (SSH key) for signing:
To sign commits or tags, use the `-S` option.
```console
git config --global gpg.format ssh
git config --global user.signingkey ~/.ssh/id_rsa_yubikey.pub
```
Configure the `user.name` and `user.email` option to match the email address associated with the PGP identity:
```console
git config --global user.name 'YubiKey User'
git config --global user.email yubikey@example
```
To sign commits or tags, use the `-S` option, or consider enabling commit and tag signing by default:
```console
git config --global commit.gpgsign true
git config --global tag.gpgSign true
```
**Windows**