aboutsummaryrefslogtreecommitdiff
path: root/functions
diff options
context:
space:
mode:
authorHugo Hörnquist <hugo@lysator.liu.se>2023-01-15 15:12:16 +0100
committerHugo Hörnquist <hugo@lysator.liu.se>2023-01-15 15:12:16 +0100
commit4f9e61e1536f2d74193f75cf1e3c64fff9dca277 (patch)
treed79f8346b4782ade7865ab7d6e2c49fc81702cfb /functions
parentAdd LICENSE file. (diff)
downloadhugonikanor-letsencrypt-4f9e61e1536f2d74193f75cf1e3c64fff9dca277.tar.gz
hugonikanor-letsencrypt-4f9e61e1536f2d74193f75cf1e3c64fff9dca277.tar.xz
Minor documentation cleanup.
Diffstat (limited to 'functions')
-rw-r--r--functions/conf/nginx.pp2
-rw-r--r--functions/conf/nginx/location.pp1
2 files changed, 3 insertions, 0 deletions
diff --git a/functions/conf/nginx.pp b/functions/conf/nginx.pp
index aa5f30e..f8e6123 100644
--- a/functions/conf/nginx.pp
+++ b/functions/conf/nginx.pp
@@ -1,3 +1,5 @@
+# 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.
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 84d0e82..a787013 100644
--- a/functions/conf/nginx/location.pp
+++ b/functions/conf/nginx/location.pp
@@ -1,3 +1,4 @@
+# Returns a hash to be merged into a nginx::resource::location resource.
function letsencrypt::conf::nginx::location (
String $cert_name,
) >> Letsencrypt::Ssl_conf::Nginx::Location {