summaryrefslogtreecommitdiff
path: root/modules/caddytls/automation.go
diff options
context:
space:
mode:
authorMatthew Holt <mholt@users.noreply.github.com>2023-06-04 22:15:50 -0600
committerMatthew Holt <mholt@users.noreply.github.com>2023-06-04 22:15:50 -0600
commit4ba03c9d38aae134bd8616178315086589b69ba8 (patch)
tree212924fa866d6c2d9658e3160977260b41dd1d3f /modules/caddytls/automation.go
parent078f130a51b1546d63d770acdcbdec64cc7323a6 (diff)
caddytls: Clarify some JSON config docs
Diffstat (limited to 'modules/caddytls/automation.go')
-rw-r--r--modules/caddytls/automation.go7
1 files changed, 7 insertions, 0 deletions
diff --git a/modules/caddytls/automation.go b/modules/caddytls/automation.go
index 1664762..de88201 100644
--- a/modules/caddytls/automation.go
+++ b/modules/caddytls/automation.go
@@ -85,6 +85,13 @@ type AutomationConfig struct {
// TLS app to properly provision a new policy.
type AutomationPolicy struct {
// Which subjects (hostnames or IP addresses) this policy applies to.
+ //
+ // This list is a filter, not a command. In other words, it is used
+ // only to filter whether this policy should apply to a subject that
+ // needs a certificate; it does NOT command the TLS app to manage a
+ // certificate for that subject. To have Caddy automate a certificate
+ // or specific subjects, use the "automate" certificate loader module
+ // of the TLS app.
SubjectsRaw []string `json:"subjects,omitempty"`
// The modules that may issue certificates. Default: internal if all