From 7f589742fd3e4e46c24f8be07643f1c28e0cf210 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Hugo=20H=C3=B6rnquist?= Date: Fri, 2 Jun 2023 20:27:45 +0200 Subject: Document. --- manifests/init.pp | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/manifests/init.pp b/manifests/init.pp index 7d067b4..2063849 100644 --- a/manifests/init.pp +++ b/manifests/init.pp @@ -1,3 +1,37 @@ +# @summary Configures a webdav server under nginx +# +# Configures a WebDAV server under a pre-configured nginx instance. +# +# Currently doesn't manage the package, but instead depends on +# nginx-minline-mod-dav-ext being installed. +# +# Also manages basic authentication for those pages. +# +# @param $nginx_server +# Name of the nginx server resource to create location under. +# @param $file_path +# Local path used as webdav root +# @param $location +# Prefix to web-path which will be exported as WebDAV +# @param $passwd_file +# Path to the user/password file for basic authentication +# @param $owner +# Owner of created files +# @param $group +# Group of created file +# @param $users +# List of [user, password] pairs. +# Refer to the +# [Nginx documentation](https://nginx.org/en/docs/http/ngx_http_auth_basic_module.html) +# for the format of the password field. +# @param $dav_methods +# Dav methods which should be supported, are are implemented by +# nginxcore. +# @param $dav_ext_methods +# Extended dav methods which should be supported, as is implemented +# by the dav_ext module. +# @param $dav_access +# Default access rules for the dav methods. define webdav_server ( String $nginx_server, String $file_path, -- cgit v1.2.3