Skip to content

Commit

Permalink
README: add warning about internet access (#596)
Browse files Browse the repository at this point in the history
gitsign differs from GPG in that it requires an internet access on every
commit. This breaks the git model of working offline. So, probably worth
calling out.

Signed-off-by: Brandon Philips <[email protected]>
  • Loading branch information
philips authored Nov 30, 2024
1 parent 953807c commit 6914495
Showing 1 changed file with 12 additions and 4 deletions.
16 changes: 12 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,19 +32,27 @@ Single Repository:

```sh
cd /path/to/my/repository
git config --local commit.gpgsign true # Sign all commits
git config --local tag.gpgsign true # Sign all tags
git config --local gpg.x509.program gitsign # Use gitsign for signing
git config --local gpg.format x509 # gitsign expects x509 args

# Warning: Setting this will make git commit/tag reliant on internet.
# Alternatively, don't use these settings and add the -S flag instead.
git config --local commit.gpgsign true # Sign all commits
git config --local tag.gpgsign true # Sign all tags

```

All respositories:

```sh
git config --global commit.gpgsign true # Sign all commits
git config --global tag.gpgsign true # Sign all tags
git config --global gpg.x509.program gitsign # Use gitsign for signing
git config --global gpg.format x509 # gitsign expects x509 args


# Warning: Setting this will make git commit/tag reliant on internet.
# Alternatively, don't use these settings and add the -S flag instead.
git config --global commit.gpgsign true # Sign all commits
git config --global tag.gpgsign true # Sign all tags
```

To learn more about these options, see
Expand Down

0 comments on commit 6914495

Please sign in to comment.