Skip to content

Commit dc822d5

Browse files
authored
Re-order GPG signing docs and fix code blocks (#10349)
* Move chunk and format Signed-off-by: jolheiser <[email protected]> * word Signed-off-by: jolheiser <[email protected]>
1 parent 41294b5 commit dc822d5

File tree

1 file changed

+17
-13
lines changed

1 file changed

+17
-13
lines changed

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

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,16 @@ There are a number of places where Gitea will generate commits itself:
4444
Depending on configuration and server trust you may want Gitea to
4545
sign these commits.
4646

47+
## Installing and generating a GPG key for Gitea
48+
49+
It is up to a server administrator to determine how best to install
50+
a signing key. Gitea generates all its commits using the server `git`
51+
command at present - and therefore the server `gpg` will be used for
52+
signing (if configured.) Administrators should review best-practices
53+
for gpg - in particular it is probably advisable to only install a
54+
signing secret subkey without the master signing and certifying secret
55+
key.
56+
4757
## General Configuration
4858

4959
Gitea's configuration for signing can be found with the
@@ -81,7 +91,7 @@ of the `user.signingkey`, `user.name` and `user.email` as appropriate.
8191

8292
Please note: by adjusting git's `config` file within Gitea's
8393
repositories, `SIGNING_KEY=default` could be used to provide different
84-
signing keys on a per-repository basis. However, this is cleary not an
94+
signing keys on a per-repository basis. However, this is clearly not an
8595
ideal UI and therefore subject to change.
8696

8797
### `INITIAL_COMMIT`
@@ -142,22 +152,16 @@ The possible options are:
142152
Options other than `never` and `always` can be combined as a comma
143153
separated list.
144154

145-
## Installing and generating a GPG key for Gitea
146-
147-
It is up to a server administrator to determine how best to install
148-
a signing key. Gitea generates all its commits using the server `git`
149-
command at present - and therefore the server `gpg` will be used for
150-
signing (if configured.) Administrators should review best-practices
151-
for gpg - in particular it is probably advisable to only install a
152-
signing secret subkey without the master signing and certifying secret
153-
key.
154-
155155
## Obtaining the Public Key of the Signing Key
156156

157157
The public key used to sign Gitea's commits can be obtained from the API at:
158158

159-
```/api/v1/signing-key.gpg```
159+
```
160+
/api/v1/signing-key.gpg
161+
```
160162

161163
In cases where there is a repository specific key this can be obtained from:
162164

163-
```/api/v1/repos/:username/:reponame/signing-key.gpg```
165+
```
166+
/api/v1/repos/:username/:reponame/signing-key.gpg
167+
```

0 commit comments

Comments
 (0)