mirror of
https://github.com/caddyserver/caddy.git
synced 2024-12-16 21:56:40 -05:00
pki: Add docs to some struct fields
This commit is contained in:
parent
483e31b978
commit
c47ddbeffb
2 changed files with 14 additions and 3 deletions
|
@ -51,7 +51,10 @@ type CA struct {
|
|||
// and Mozilla Firefox trust stores. Default: true.
|
||||
InstallTrust *bool `json:"install_trust,omitempty"`
|
||||
|
||||
// The root certificate to use; if empty, one will be generated.
|
||||
Root *KeyPair `json:"root,omitempty"`
|
||||
|
||||
// The intermediate (signing) certificate; if empty, one will be generated.
|
||||
Intermediate *KeyPair `json:"intermediate,omitempty"`
|
||||
|
||||
// Optionally configure a separate storage module associated with this
|
||||
|
|
|
@ -120,8 +120,16 @@ func trusted(cert *x509.Certificate) bool {
|
|||
// KeyPair represents a public-private key pair, where the
|
||||
// public key is also called a certificate.
|
||||
type KeyPair struct {
|
||||
// The certificate. By default, this should be the path to
|
||||
// a PEM file unless format is something else.
|
||||
Certificate string `json:"certificate,omitempty"`
|
||||
|
||||
// The private key. By default, this should be the path to
|
||||
// a PEM file unless format is something else.
|
||||
PrivateKey string `json:"private_key,omitempty"`
|
||||
|
||||
// The format in which the certificate and private
|
||||
// key are provided. Default: pem_file
|
||||
Format string `json:"format,omitempty"`
|
||||
}
|
||||
|
||||
|
|
Loading…
Reference in a new issue