diff options
author | Matthew Holt <mholt@users.noreply.github.com> | 2021-09-24 18:31:01 -0600 |
---|---|---|
committer | Matthew Holt <mholt@users.noreply.github.com> | 2021-09-24 18:31:01 -0600 |
commit | 501da21f209c9fad92c65c8ba02a969a03ec5379 (patch) | |
tree | c60876dc13b4277bb933feea19b4494a26f639ed /modules/caddypki | |
parent | 3336faf25466b1b2d9a007f5468d05a887e16775 (diff) |
General minor improvements to docs
Diffstat (limited to 'modules/caddypki')
-rw-r--r-- | modules/caddypki/pki.go | 11 |
1 files changed, 8 insertions, 3 deletions
diff --git a/modules/caddypki/pki.go b/modules/caddypki/pki.go index b6f08b1..012eaaf 100644 --- a/modules/caddypki/pki.go +++ b/modules/caddypki/pki.go @@ -26,10 +26,15 @@ func init() { } // PKI provides Public Key Infrastructure facilities for Caddy. +// +// This app can define certificate authorities (CAs) which are capable +// of signing certificates. Other modules can be configured to use +// the CAs defined by this app for issuing certificates or getting +// key information needed for establishing trust. type PKI struct { - // The CAs to manage. Each CA is keyed by an ID that is used - // to uniquely identify it from other CAs. The default CA ID - // is "local". + // The certificate authorities to manage. Each CA is keyed by an + // ID that is used to uniquely identify it from other CAs. + // The default CA ID is "local". CAs map[string]*CA `json:"certificate_authorities,omitempty"` ctx caddy.Context |