diff --git a/manifests/resource/vhost.pp b/manifests/resource/vhost.pp index 41ba7427d..4349038e5 100644 --- a/manifests/resource/vhost.pp +++ b/manifests/resource/vhost.pp @@ -1,19 +1,19 @@ -# define: nginx::resource::location +# define: nginx::resource::vhost # -# This definition creates a new location entry within a virtual host +# This definition creates a virtual host # # Parameters: -# [*ensure*] - Enables or disables the specified location (present|absent) +# [*ensure*] - Enables or disables the specified vhost (present|absent) # [*listen_ip*] - Default IP Address for NGINX to listen with this vHost on. Defaults to all interfaces (*) # [*listen_port*] - Default IP Port for NGINX to listen with this vHost on. Defaults to TCP 80 # [*ipv6_enable*] - BOOL value to enable/disable IPv6 support (false|true). Module will check to see if IPv6 # support exists on your system before enabling. # [*ipv6_listen_ip*] - Default IPv6 Address for NGINX to listen with this vHost on. Defaults to all interfaces (::) # [*ipv6_listen_port*] - Default IPv6 Port for NGINX to listen with this vHost on. Defaults to TCP 80 -# [*index_files*] - Default index files for NGINX to read when traversing a directory -# [*proxy*] - Proxy server(s) for a location to connect to. Accepts a single value, can be used in conjunction -# with nginx::resource::upstream -# [*ssl*] - Indicates whether to setup SSL bindings for this location. +# [*index_files*] - Default index files for NGINX to read when traversing a directory +# [*proxy*] - Proxy server(s) for the root location to connect to. Accepts a single value, can be used in +# conjunction with nginx::resource::upstream +# [*ssl*] - Indicates whether to setup SSL bindings for this vhost. # [*ssl_cert*] - Pre-generated SSL Certificate file to reference for SSL Support. This is not generated by this module. # [*ssl_key*] - Pre-generated SSL Key file to reference for SSL Support. This is not generated by this module. # [*www_root*] - Specifies the location on disk for files to be read from. Cannot be set in conjunction with $proxy