aboutsummaryrefslogtreecommitdiff
path: root/functions
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 /functions
parentAdd README. (diff)
downloadhugonikanor-letsencrypt-aba6be9a5386e30600e63eec0043276290be360b.tar.gz
hugonikanor-letsencrypt-aba6be9a5386e30600e63eec0043276290be360b.tar.xz
Documentaion.
Diffstat (limited to 'functions')
-rw-r--r--functions/conf/nginx.pp5
-rw-r--r--functions/conf/nginx/location.pp4
2 files changed, 8 insertions, 1 deletions
diff --git a/functions/conf/nginx.pp b/functions/conf/nginx.pp
index f8e6123..9e7b392 100644
--- a/functions/conf/nginx.pp
+++ b/functions/conf/nginx.pp
@@ -1,5 +1,8 @@
# Returns a hash to be merged into a nginx::resource::server resources
-# parameters. The cert_name parameter should be the name of the domain in question, and NOT the local certificate name.
+# parameters.
+# @param cert_name
+# name of the domain in question, NOT the local certificate name.
+# @return hash usable with nginx::resource::server
function letsencrypt::conf::nginx (
String $cert_name,
) >> Letsencrypt::Ssl_conf::Nginx {
diff --git a/functions/conf/nginx/location.pp b/functions/conf/nginx/location.pp
index a787013..19572f3 100644
--- a/functions/conf/nginx/location.pp
+++ b/functions/conf/nginx/location.pp
@@ -1,4 +1,8 @@
# Returns a hash to be merged into a nginx::resource::location resource.
+# @param cert_name
+# Domain for which we want the configuration.
+# NOT the local certificate name.
+# @return hash usable with nginx::resource::location
function letsencrypt::conf::nginx::location (
String $cert_name,
) >> Letsencrypt::Ssl_conf::Nginx::Location {