aboutsummaryrefslogtreecommitdiff
path: root/types
diff options
context:
space:
mode:
authorHugo Hörnquist <hugo@lysator.liu.se>2023-01-15 15:20:01 +0100
committerHugo Hörnquist <hugo@lysator.liu.se>2023-01-15 15:20:01 +0100
commitaba6be9a5386e30600e63eec0043276290be360b (patch)
tree2cc7740968771856f0615eae74addca0e0bcb266 /types
parentAdd README. (diff)
downloadhugonikanor-letsencrypt-aba6be9a5386e30600e63eec0043276290be360b.tar.gz
hugonikanor-letsencrypt-aba6be9a5386e30600e63eec0043276290be360b.tar.xz
Documentaion.
Diffstat (limited to 'types')
-rw-r--r--types/authenticator.pp1
-rw-r--r--types/renewal_provider.pp2
-rw-r--r--types/ssl_conf/nginx.pp3
-rw-r--r--types/ssl_conf/nginx/location.pp1
4 files changed, 7 insertions, 0 deletions
diff --git a/types/authenticator.pp b/types/authenticator.pp
index 8593213..dbd57d5 100644
--- a/types/authenticator.pp
+++ b/types/authenticator.pp
@@ -1 +1,2 @@
+# @summary Known authenticator types
type Letsencrypt::Authenticator = Enum['nginx']
diff --git a/types/renewal_provider.pp b/types/renewal_provider.pp
index bfa3077..c63f340 100644
--- a/types/renewal_provider.pp
+++ b/types/renewal_provider.pp
@@ -1 +1,3 @@
+# Known backends which can keep track of when to issue renewal
+# requests.
type Letsencrypt::Renewal_provider = Enum['systemd', 'cron']
diff --git a/types/ssl_conf/nginx.pp b/types/ssl_conf/nginx.pp
index fb2187d..333093f 100644
--- a/types/ssl_conf/nginx.pp
+++ b/types/ssl_conf/nginx.pp
@@ -1,3 +1,6 @@
+# @summary SSL configuration hash for nginx
+# Will either have ssl set to false, or ssl set to true, along with
+# appropriate ssl parameters.
type Letsencrypt::Ssl_conf::Nginx = Variant[
Struct[{
ssl => Boolean,
diff --git a/types/ssl_conf/nginx/location.pp b/types/ssl_conf/nginx/location.pp
index 25941d0..d3bfc32 100644
--- a/types/ssl_conf/nginx/location.pp
+++ b/types/ssl_conf/nginx/location.pp
@@ -1,3 +1,4 @@
+# SSL configuration for a single nginx location.
type Letsencrypt::Ssl_conf::Nginx::Location = Variant[
Struct[{
ssl => Boolean,