Skip to content

Commit ddfb161

Browse files
committed
Add documentation
1 parent 7005622 commit ddfb161

File tree

2 files changed

+38
-0
lines changed

2 files changed

+38
-0
lines changed

REFERENCE.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7756,6 +7756,7 @@ The following parameters are available in the `apache::vhost` defined type:
77567756
* [`suphp_engine`](#suphp_engine)
77577757
* [`vhost_name`](#vhost_name)
77587758
* [`virtual_docroot`](#virtual_docroot)
7759+
* [`virtual_use_default_docroot`](#virtual_use_default_docroot)
77597760
* [`wsgi_daemon_process`](#wsgi_daemon_process)
77607761
* [`wsgi_daemon_process_options`](#wsgi_daemon_process_options)
77617762
* [`wsgi_application_group`](#wsgi_application_group)
@@ -9957,6 +9958,8 @@ Data type: `Any`
99579958

99589959
Sets up a virtual host with a wildcard alias subdomain mapped to a directory with the
99599960
same name. For example, `http://example.com` would map to `/var/www/example.com`.
9961+
Note that the `DocumentRoot` directive will not be present even though there is a value
9962+
set for `docroot` in the manifest. See [`virtual_use_default_docroot`](#virtual_use_default_docroot) to change this behavior.
99609963
``` puppet
99619964
apache::vhost { 'subdomain.loc':
99629965
vhost_name => '*',
@@ -9969,6 +9972,25 @@ apache::vhost { 'subdomain.loc':
99699972

99709973
Default value: ``false``
99719974

9975+
##### <a name="virtual_use_default_docroot"></a>`virtual_use_default_docroot`
9976+
9977+
Data type: `Any`
9978+
9979+
By default, when using `virtual_docroot`, the value of `docroot` is ignored. Setting this
9980+
to `true` will mean both directives will be added to the configuration.
9981+
``` puppet
9982+
apache::vhost { 'subdomain.loc':
9983+
vhost_name => '*',
9984+
port => '80',
9985+
virtual_docroot => '/var/www/%-2+',
9986+
docroot => '/var/www',
9987+
virtual_use_default_docroot => true,
9988+
serveraliases => ['*.loc',],
9989+
}
9990+
```
9991+
9992+
Default value: ``false``
9993+
99729994
##### <a name="wsgi_daemon_process"></a>`wsgi_daemon_process`
99739995

99749996
Data type: `Optional[Variant[String,Hash]]`

manifests/vhost.pp

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1221,6 +1221,8 @@
12211221
# @param virtual_docroot
12221222
# Sets up a virtual host with a wildcard alias subdomain mapped to a directory with the
12231223
# same name. For example, `http://example.com` would map to `/var/www/example.com`.
1224+
# Note that the `DocumentRoot` directive will not be present even though there is a value
1225+
# set for `docroot` in the manifest. See [`virtual_use_default_docroot`](#virtual_use_default_docroot) to change this behavior.
12241226
# ``` puppet
12251227
# apache::vhost { 'subdomain.loc':
12261228
# vhost_name => '*',
@@ -1231,6 +1233,20 @@
12311233
# }
12321234
# ```
12331235
#
1236+
# @param virtual_use_default_docroot
1237+
# By default, when using `virtual_docroot`, the value of `docroot` is ignored. Setting this
1238+
# to `true` will mean both directives will be added to the configuration.
1239+
# ``` puppet
1240+
# apache::vhost { 'subdomain.loc':
1241+
# vhost_name => '*',
1242+
# port => '80',
1243+
# virtual_docroot => '/var/www/%-2+',
1244+
# docroot => '/var/www',
1245+
# virtual_use_default_docroot => true,
1246+
# serveraliases => ['*.loc',],
1247+
# }
1248+
# ```
1249+
#
12341250
# @param wsgi_daemon_process
12351251
# Sets up a virtual host with [WSGI](https://github.com/GrahamDumpleton/mod_wsgi) alongside
12361252
# wsgi_daemon_process_options, wsgi_process_group,

0 commit comments

Comments
 (0)