Mercurial > repos > other > Puppet
diff modules/apache/manifests/vhosts.pp @ 275:d9352a684e62
Mass update of modules to remove deprecation warnings
author | IBBoard <dev@ibboard.co.uk> |
---|---|
date | Sun, 26 Jan 2020 11:36:07 +0000 |
parents | 675c1cc61eaf |
children | b8d6ada284dd |
line wrap: on
line diff
--- a/modules/apache/manifests/vhosts.pp Sat Jan 04 11:42:45 2020 +0000 +++ b/modules/apache/manifests/vhosts.pp Sun Jan 26 11:36:07 2020 +0000 @@ -1,3 +1,23 @@ +# @summary +# Creates `apache::vhost` defined types. +# +# @note See the `apache::vhost` defined type's reference for a list of all virtual +# host parameters or Configuring virtual hosts in the README section. +# +# @example To create a [name-based virtual host](https://httpd.apache.org/docs/current/vhosts/name-based.html) `custom_vhost_1` +# class { 'apache::vhosts': +# vhosts => { +# 'custom_vhost_1' => { +# 'docroot' => '/var/www/custom_vhost_1', +# 'port' => '81', +# }, +# }, +# } +# +# @param vhosts +# A hash, where the key represents the name and the value represents a hash of +# `apache::vhost` defined type's parameters. +# class apache::vhosts ( $vhosts = {}, ) {