Skip to content

Commit 64959f0

Browse files
committed
update document for commit signing with Gitea's internal gitconfig
1 parent a8f2999 commit 64959f0

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

docs/content/doc/advanced/signing.en-us.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -83,8 +83,7 @@ The first option to discuss is the `SIGNING_KEY`. There are three main
8383
options:
8484

8585
- `none` - this prevents Gitea from signing any commits
86-
- `default` - Gitea will default to the key configured within
87-
`git config`
86+
- `default` - Gitea will default to the key configured within `git config`
8887
- `KEYID` - Gitea will sign commits with the gpg key with the ID
8988
`KEYID`. In this case you should provide a `SIGNING_NAME` and
9089
`SIGNING_EMAIL` to be displayed for this key.
@@ -98,6 +97,11 @@ repositories, `SIGNING_KEY=default` could be used to provide different
9897
signing keys on a per-repository basis. However, this is clearly not an
9998
ideal UI and therefore subject to change.
10099

100+
**Since 1.17**, Gitea uses its internal git config (instead of current user's `{UserHome}/.gitconfig` for < 1.17).
101+
If you have your own customized git config for Gitea, you should set these configs in system git config (aka `/etc/gitconfig`)
102+
or the Gitea internal git config (aka `{[repository].ROOT}/.gitconfig`).
103+
104+
101105
### `INITIAL_COMMIT`
102106

103107
This option determines whether Gitea should sign the initial commit
@@ -118,7 +122,7 @@ The possible values are:
118122

119123
- `never`: Never sign
120124
- `pubkey`: Only sign if the user has a public key
121-
- `twofa`: Only sign if the user logs in with two factor authentication
125+
- `twofa`: Only sign if the user logs in with two-factor authentication
122126
- `parentsigned`: Only sign if the parent commit is signed.
123127
- `always`: Always sign
124128

@@ -132,7 +136,7 @@ editor or API CRUD actions. The possible values are:
132136

133137
- `never`: Never sign
134138
- `pubkey`: Only sign if the user has a public key
135-
- `twofa`: Only sign if the user logs in with two factor authentication
139+
- `twofa`: Only sign if the user logs in with two-factor authentication
136140
- `parentsigned`: Only sign if the parent commit is signed.
137141
- `always`: Always sign
138142

@@ -146,7 +150,7 @@ The possible options are:
146150

147151
- `never`: Never sign
148152
- `pubkey`: Only sign if the user has a public key
149-
- `twofa`: Only sign if the user logs in with two factor authentication
153+
- `twofa`: Only sign if the user logs in with two-factor authentication
150154
- `basesigned`: Only sign if the parent commit in the base repo is signed.
151155
- `headsigned`: Only sign if the head commit in the head branch is signed.
152156
- `commitssigned`: Only sign if all the commits in the head branch to the merge point are signed.

0 commit comments

Comments
 (0)