realaravinth/bench-forgejo
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Re-order GPG signing docs and fix code blocks (#10349)

Browse source 
* Move chunk and format

Signed-off-by: jolheiser <john.olheiser@gmail.com>

* word

Signed-off-by: jolheiser <john.olheiser@gmail.com>
This commit is contained in:
John Olheiser 2020-02-18 19:23:45 -06:00 committed by GitHub
parent 41294b53b3
commit dc822d5291
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 17 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
docs/content/doc/advanced/signing.en-us.md
View file

@ -44,6 +44,16 @@ There are a number of places where Gitea will generate commits itself:
Depending on configuration and server trust you may want Gitea to Depending on configuration and server trust you may want Gitea to
sign these commits. sign these commits.
## Installing and generating a GPG key for Gitea
It is up to a server administrator to determine how best to install
a signing key. Gitea generates all its commits using the server `git`
command at present - and therefore the server `gpg` will be used for
signing (if configured.) Administrators should review best-practices
for gpg - in particular it is probably advisable to only install a
signing secret subkey without the master signing and certifying secret
key.
## General Configuration ## General Configuration
Gitea's configuration for signing can be found with the 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.
Please note: by adjusting git's `config` file within Gitea's Please note: by adjusting git's `config` file within Gitea's
repositories, `SIGNING_KEY=default` could be used to provide different repositories, `SIGNING_KEY=default` could be used to provide different
signing keys on a per-repository basis. However, this is cleary not an signing keys on a per-repository basis. However, this is clearly not an
ideal UI and therefore subject to change. ideal UI and therefore subject to change.
### `INITIAL_COMMIT` ### `INITIAL_COMMIT`
@ -142,22 +152,16 @@ The possible options are:
Options other than `never` and `always` can be combined as a comma Options other than `never` and `always` can be combined as a comma
separated list. separated list.
## Installing and generating a GPG key for Gitea
It is up to a server administrator to determine how best to install
a signing key. Gitea generates all its commits using the server `git`
command at present - and therefore the server `gpg` will be used for
signing (if configured.) Administrators should review best-practices
for gpg - in particular it is probably advisable to only install a
signing secret subkey without the master signing and certifying secret
key.
## Obtaining the Public Key of the Signing Key ## Obtaining the Public Key of the Signing Key
The public key used to sign Gitea's commits can be obtained from the API at: The public key used to sign Gitea's commits can be obtained from the API at:
```/api/v1/signing-key.gpg``` ```
/api/v1/signing-key.gpg
```
In cases where there is a repository specific key this can be obtained from: In cases where there is a repository specific key this can be obtained from:
```/api/v1/repos/:username/:reponame/signing-key.gpg``` ```
/api/v1/repos/:username/:reponame/signing-key.gpg
```