diff --git a/REFERENCE.md b/REFERENCE.md index 61172c53a..2306c904e 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -21,36 +21,36 @@ ### Defined types -* [`nginx::resource::geo`](#nginx--resource--geo): Create a new geo mapping entry for NGINX -* [`nginx::resource::location`](#nginx--resource--location): Create a new location entry within a virtual host -* [`nginx::resource::mailhost`](#nginx--resource--mailhost): Define a mailhost -* [`nginx::resource::map`](#nginx--resource--map): Create a new mapping entry for NGINX -* [`nginx::resource::server`](#nginx--resource--server): Create a virtual host -* [`nginx::resource::snippet`](#nginx--resource--snippet): Create a reusable config snippet that can be included by other resources -* [`nginx::resource::streamhost`](#nginx--resource--streamhost): Create a virtual steamhost -* [`nginx::resource::upstream`](#nginx--resource--upstream): Create a new upstream proxy entry for NGINX -* [`nginx::resource::upstream::member`](#nginx--resource--upstream--member): Create an upstream member inside the upstream block. +* [`nginx::resource::geo`](#nginxresourcegeo): Create a new geo mapping entry for NGINX +* [`nginx::resource::location`](#nginxresourcelocation): Create a new location entry within a virtual host +* [`nginx::resource::mailhost`](#nginxresourcemailhost): Define a mailhost +* [`nginx::resource::map`](#nginxresourcemap): Create a new mapping entry for NGINX +* [`nginx::resource::server`](#nginxresourceserver): Create a virtual host +* [`nginx::resource::snippet`](#nginxresourcesnippet): Create a reusable config snippet that can be included by other resources +* [`nginx::resource::streamhost`](#nginxresourcestreamhost): Create a virtual steamhost +* [`nginx::resource::upstream`](#nginxresourceupstream): Create a new upstream proxy entry for NGINX +* [`nginx::resource::upstream::member`](#nginxresourceupstreammember): Create an upstream member inside the upstream block. ### Data types -* [`Nginx::DebugConnection`](#Nginx--DebugConnection) -* [`Nginx::ErrorLogSeverity`](#Nginx--ErrorLogSeverity) -* [`Nginx::GzipProxied`](#Nginx--GzipProxied): custom type for gzip_proxied -* [`Nginx::LogFormat`](#Nginx--LogFormat) -* [`Nginx::Size`](#Nginx--Size) -* [`Nginx::Time`](#Nginx--Time) -* [`Nginx::UpstreamCustomParameters`](#Nginx--UpstreamCustomParameters) -* [`Nginx::UpstreamDefaults`](#Nginx--UpstreamDefaults) -* [`Nginx::UpstreamLeastTime`](#Nginx--UpstreamLeastTime) -* [`Nginx::UpstreamLeastTimeHttp`](#Nginx--UpstreamLeastTimeHttp) -* [`Nginx::UpstreamLeastTimeStream`](#Nginx--UpstreamLeastTimeStream) -* [`Nginx::UpstreamMember`](#Nginx--UpstreamMember) -* [`Nginx::UpstreamMemberDefaults`](#Nginx--UpstreamMemberDefaults) -* [`Nginx::UpstreamMemberServer`](#Nginx--UpstreamMemberServer) -* [`Nginx::UpstreamMembers`](#Nginx--UpstreamMembers) -* [`Nginx::UpstreamSticky`](#Nginx--UpstreamSticky) -* [`Nginx::UpstreamStickyZone`](#Nginx--UpstreamStickyZone) -* [`Nginx::UpstreamZone`](#Nginx--UpstreamZone) +* [`Nginx::DebugConnection`](#nginxdebugconnection) +* [`Nginx::ErrorLogSeverity`](#nginxerrorlogseverity) +* [`Nginx::GzipProxied`](#nginxgzipproxied): custom type for gzip_proxied +* [`Nginx::LogFormat`](#nginxlogformat) +* [`Nginx::Size`](#nginxsize) +* [`Nginx::Time`](#nginxtime) +* [`Nginx::UpstreamCustomParameters`](#nginxupstreamcustomparameters) +* [`Nginx::UpstreamDefaults`](#nginxupstreamdefaults) +* [`Nginx::UpstreamLeastTime`](#nginxupstreamleasttime) +* [`Nginx::UpstreamLeastTimeHttp`](#nginxupstreamleasttimehttp) +* [`Nginx::UpstreamLeastTimeStream`](#nginxupstreamleasttimestream) +* [`Nginx::UpstreamMember`](#nginxupstreammember) +* [`Nginx::UpstreamMemberDefaults`](#nginxupstreammemberdefaults) +* [`Nginx::UpstreamMemberServer`](#nginxupstreammemberserver) +* [`Nginx::UpstreamMembers`](#nginxupstreammembers) +* [`Nginx::UpstreamSticky`](#nginxupstreamsticky) +* [`Nginx::UpstreamStickyZone`](#nginxupstreamstickyzone) +* [`Nginx::UpstreamZone`](#nginxupstreamzone) ## Classes @@ -73,179 +73,181 @@ include nginx The following parameters are available in the `nginx` class: -* [`include_modules_enabled`](#-nginx--include_modules_enabled) -* [`passenger_package_name`](#-nginx--passenger_package_name) -* [`nginx_version`](#-nginx--nginx_version) -* [`debug_connections`](#-nginx--debug_connections) -* [`service_config_check`](#-nginx--service_config_check) -* [`service_config_check_command`](#-nginx--service_config_check_command) -* [`reset_timedout_connection`](#-nginx--reset_timedout_connection) -* [`nginx_snippets`](#-nginx--nginx_snippets) -* [`nginx_snippets_defaults`](#-nginx--nginx_snippets_defaults) -* [`client_body_temp_path`](#-nginx--client_body_temp_path) -* [`confd_only`](#-nginx--confd_only) -* [`confd_purge`](#-nginx--confd_purge) -* [`conf_dir`](#-nginx--conf_dir) -* [`daemon`](#-nginx--daemon) -* [`daemon_user`](#-nginx--daemon_user) -* [`daemon_group`](#-nginx--daemon_group) -* [`dynamic_modules`](#-nginx--dynamic_modules) -* [`global_owner`](#-nginx--global_owner) -* [`global_group`](#-nginx--global_group) -* [`global_mode`](#-nginx--global_mode) -* [`limit_req_zone`](#-nginx--limit_req_zone) -* [`log_dir`](#-nginx--log_dir) -* [`manage_log_dir`](#-nginx--manage_log_dir) -* [`log_user`](#-nginx--log_user) -* [`log_group`](#-nginx--log_group) -* [`log_mode`](#-nginx--log_mode) -* [`http_access_log`](#-nginx--http_access_log) -* [`http_format_log`](#-nginx--http_format_log) -* [`nginx_error_log`](#-nginx--nginx_error_log) -* [`nginx_error_log_severity`](#-nginx--nginx_error_log_severity) -* [`pid`](#-nginx--pid) -* [`proxy_temp_path`](#-nginx--proxy_temp_path) -* [`root_group`](#-nginx--root_group) -* [`sites_available_owner`](#-nginx--sites_available_owner) -* [`sites_available_group`](#-nginx--sites_available_group) -* [`sites_available_mode`](#-nginx--sites_available_mode) -* [`super_user`](#-nginx--super_user) -* [`temp_dir`](#-nginx--temp_dir) -* [`server_purge`](#-nginx--server_purge) -* [`conf_template`](#-nginx--conf_template) -* [`fastcgi_conf_template`](#-nginx--fastcgi_conf_template) -* [`uwsgi_params_template`](#-nginx--uwsgi_params_template) -* [`absolute_redirect`](#-nginx--absolute_redirect) -* [`accept_mutex`](#-nginx--accept_mutex) -* [`accept_mutex_delay`](#-nginx--accept_mutex_delay) -* [`client_body_buffer_size`](#-nginx--client_body_buffer_size) -* [`client_max_body_size`](#-nginx--client_max_body_size) -* [`client_body_timeout`](#-nginx--client_body_timeout) -* [`send_timeout`](#-nginx--send_timeout) -* [`lingering_timeout`](#-nginx--lingering_timeout) -* [`lingering_close`](#-nginx--lingering_close) -* [`lingering_time`](#-nginx--lingering_time) -* [`etag`](#-nginx--etag) -* [`events_use`](#-nginx--events_use) -* [`fastcgi_cache_inactive`](#-nginx--fastcgi_cache_inactive) -* [`fastcgi_cache_key`](#-nginx--fastcgi_cache_key) -* [`fastcgi_cache_keys_zone`](#-nginx--fastcgi_cache_keys_zone) -* [`fastcgi_cache_levels`](#-nginx--fastcgi_cache_levels) -* [`fastcgi_cache_max_size`](#-nginx--fastcgi_cache_max_size) -* [`fastcgi_cache_path`](#-nginx--fastcgi_cache_path) -* [`fastcgi_cache_use_stale`](#-nginx--fastcgi_cache_use_stale) -* [`gzip`](#-nginx--gzip) -* [`gzip_buffers`](#-nginx--gzip_buffers) -* [`gzip_comp_level`](#-nginx--gzip_comp_level) -* [`gzip_disable`](#-nginx--gzip_disable) -* [`gzip_min_length`](#-nginx--gzip_min_length) -* [`gzip_http_version`](#-nginx--gzip_http_version) -* [`gzip_proxied`](#-nginx--gzip_proxied) -* [`gzip_types`](#-nginx--gzip_types) -* [`gzip_vary`](#-nginx--gzip_vary) -* [`gzip_static`](#-nginx--gzip_static) -* [`http_cfg_prepend`](#-nginx--http_cfg_prepend) -* [`http_cfg_append`](#-nginx--http_cfg_append) -* [`http_raw_prepend`](#-nginx--http_raw_prepend) -* [`http_raw_append`](#-nginx--http_raw_append) -* [`http_tcp_nodelay`](#-nginx--http_tcp_nodelay) -* [`http_tcp_nopush`](#-nginx--http_tcp_nopush) -* [`keepalive_timeout`](#-nginx--keepalive_timeout) -* [`keepalive_requests`](#-nginx--keepalive_requests) -* [`log_format`](#-nginx--log_format) -* [`mail`](#-nginx--mail) -* [`mime_types_path`](#-nginx--mime_types_path) -* [`stream`](#-nginx--stream) -* [`multi_accept`](#-nginx--multi_accept) -* [`names_hash_bucket_size`](#-nginx--names_hash_bucket_size) -* [`names_hash_max_size`](#-nginx--names_hash_max_size) -* [`nginx_cfg_prepend`](#-nginx--nginx_cfg_prepend) -* [`proxy_buffers`](#-nginx--proxy_buffers) -* [`proxy_buffer_size`](#-nginx--proxy_buffer_size) -* [`proxy_cache_inactive`](#-nginx--proxy_cache_inactive) -* [`proxy_cache_keys_zone`](#-nginx--proxy_cache_keys_zone) -* [`proxy_cache_levels`](#-nginx--proxy_cache_levels) -* [`proxy_cache_max_size`](#-nginx--proxy_cache_max_size) -* [`proxy_cache_path`](#-nginx--proxy_cache_path) -* [`proxy_cache_loader_files`](#-nginx--proxy_cache_loader_files) -* [`proxy_cache_loader_sleep`](#-nginx--proxy_cache_loader_sleep) -* [`proxy_cache_loader_threshold`](#-nginx--proxy_cache_loader_threshold) -* [`proxy_use_temp_path`](#-nginx--proxy_use_temp_path) -* [`proxy_connect_timeout`](#-nginx--proxy_connect_timeout) -* [`proxy_headers_hash_bucket_size`](#-nginx--proxy_headers_hash_bucket_size) -* [`proxy_http_version`](#-nginx--proxy_http_version) -* [`proxy_read_timeout`](#-nginx--proxy_read_timeout) -* [`proxy_redirect`](#-nginx--proxy_redirect) -* [`proxy_send_timeout`](#-nginx--proxy_send_timeout) -* [`proxy_set_header`](#-nginx--proxy_set_header) -* [`proxy_hide_header`](#-nginx--proxy_hide_header) -* [`proxy_pass_header`](#-nginx--proxy_pass_header) -* [`proxy_ignore_header`](#-nginx--proxy_ignore_header) -* [`proxy_max_temp_file_size`](#-nginx--proxy_max_temp_file_size) -* [`proxy_busy_buffers_size`](#-nginx--proxy_busy_buffers_size) -* [`sendfile`](#-nginx--sendfile) -* [`server_tokens`](#-nginx--server_tokens) -* [`spdy`](#-nginx--spdy) -* [`http2`](#-nginx--http2) -* [`ssl_stapling`](#-nginx--ssl_stapling) -* [`ssl_stapling_verify`](#-nginx--ssl_stapling_verify) -* [`snippets_dir`](#-nginx--snippets_dir) -* [`manage_snippets_dir`](#-nginx--manage_snippets_dir) -* [`types_hash_bucket_size`](#-nginx--types_hash_bucket_size) -* [`types_hash_max_size`](#-nginx--types_hash_max_size) -* [`worker_connections`](#-nginx--worker_connections) -* [`ssl_prefer_server_ciphers`](#-nginx--ssl_prefer_server_ciphers) -* [`worker_processes`](#-nginx--worker_processes) -* [`worker_rlimit_nofile`](#-nginx--worker_rlimit_nofile) -* [`pcre_jit`](#-nginx--pcre_jit) -* [`ssl_protocols`](#-nginx--ssl_protocols) -* [`ssl_ciphers`](#-nginx--ssl_ciphers) -* [`ssl_dhparam`](#-nginx--ssl_dhparam) -* [`ssl_ecdh_curve`](#-nginx--ssl_ecdh_curve) -* [`ssl_session_cache`](#-nginx--ssl_session_cache) -* [`ssl_session_timeout`](#-nginx--ssl_session_timeout) -* [`ssl_session_tickets`](#-nginx--ssl_session_tickets) -* [`ssl_session_ticket_key`](#-nginx--ssl_session_ticket_key) -* [`ssl_buffer_size`](#-nginx--ssl_buffer_size) -* [`ssl_crl`](#-nginx--ssl_crl) -* [`ssl_stapling_file`](#-nginx--ssl_stapling_file) -* [`ssl_stapling_responder`](#-nginx--ssl_stapling_responder) -* [`ssl_trusted_certificate`](#-nginx--ssl_trusted_certificate) -* [`ssl_verify_depth`](#-nginx--ssl_verify_depth) -* [`ssl_password_file`](#-nginx--ssl_password_file) -* [`package_ensure`](#-nginx--package_ensure) -* [`package_name`](#-nginx--package_name) -* [`package_source`](#-nginx--package_source) -* [`package_flavor`](#-nginx--package_flavor) -* [`manage_repo`](#-nginx--manage_repo) -* [`mime_types`](#-nginx--mime_types) -* [`mime_types_preserve_defaults`](#-nginx--mime_types_preserve_defaults) -* [`repo_release`](#-nginx--repo_release) -* [`passenger_package_ensure`](#-nginx--passenger_package_ensure) -* [`repo_source`](#-nginx--repo_source) -* [`service_ensure`](#-nginx--service_ensure) -* [`service_enable`](#-nginx--service_enable) -* [`service_flags`](#-nginx--service_flags) -* [`service_restart`](#-nginx--service_restart) -* [`service_name`](#-nginx--service_name) -* [`service_manage`](#-nginx--service_manage) -* [`geo_mappings`](#-nginx--geo_mappings) -* [`geo_mappings_defaults`](#-nginx--geo_mappings_defaults) -* [`string_mappings`](#-nginx--string_mappings) -* [`string_mappings_defaults`](#-nginx--string_mappings_defaults) -* [`nginx_locations`](#-nginx--nginx_locations) -* [`nginx_locations_defaults`](#-nginx--nginx_locations_defaults) -* [`nginx_mailhosts`](#-nginx--nginx_mailhosts) -* [`nginx_mailhosts_defaults`](#-nginx--nginx_mailhosts_defaults) -* [`nginx_servers`](#-nginx--nginx_servers) -* [`nginx_servers_defaults`](#-nginx--nginx_servers_defaults) -* [`nginx_streamhosts`](#-nginx--nginx_streamhosts) -* [`nginx_streamhosts_defaults`](#-nginx--nginx_streamhosts_defaults) -* [`nginx_upstreams`](#-nginx--nginx_upstreams) -* [`nginx_upstreams_defaults`](#-nginx--nginx_upstreams_defaults) -* [`purge_passenger_repo`](#-nginx--purge_passenger_repo) - -##### `include_modules_enabled` +* [`include_modules_enabled`](#include_modules_enabled) +* [`passenger_package_name`](#passenger_package_name) +* [`nginx_version`](#nginx_version) +* [`debug_connections`](#debug_connections) +* [`service_config_check`](#service_config_check) +* [`service_config_check_command`](#service_config_check_command) +* [`reset_timedout_connection`](#reset_timedout_connection) +* [`nginx_snippets`](#nginx_snippets) +* [`nginx_snippets_defaults`](#nginx_snippets_defaults) +* [`proxy_temp_mode`](#proxy_temp_mode) +* [`proxy_temp_path`](#proxy_temp_path) +* [`client_body_temp_path`](#client_body_temp_path) +* [`client_body_temp_mode`](#client_body_temp_mode) +* [`confd_only`](#confd_only) +* [`confd_purge`](#confd_purge) +* [`conf_dir`](#conf_dir) +* [`daemon`](#daemon) +* [`daemon_user`](#daemon_user) +* [`daemon_group`](#daemon_group) +* [`dynamic_modules`](#dynamic_modules) +* [`global_owner`](#global_owner) +* [`global_group`](#global_group) +* [`global_mode`](#global_mode) +* [`limit_req_zone`](#limit_req_zone) +* [`log_dir`](#log_dir) +* [`manage_log_dir`](#manage_log_dir) +* [`log_user`](#log_user) +* [`log_group`](#log_group) +* [`log_mode`](#log_mode) +* [`http_access_log`](#http_access_log) +* [`http_format_log`](#http_format_log) +* [`nginx_error_log`](#nginx_error_log) +* [`nginx_error_log_severity`](#nginx_error_log_severity) +* [`pid`](#pid) +* [`root_group`](#root_group) +* [`sites_available_owner`](#sites_available_owner) +* [`sites_available_group`](#sites_available_group) +* [`sites_available_mode`](#sites_available_mode) +* [`super_user`](#super_user) +* [`temp_dir`](#temp_dir) +* [`server_purge`](#server_purge) +* [`conf_template`](#conf_template) +* [`fastcgi_conf_template`](#fastcgi_conf_template) +* [`uwsgi_params_template`](#uwsgi_params_template) +* [`absolute_redirect`](#absolute_redirect) +* [`accept_mutex`](#accept_mutex) +* [`accept_mutex_delay`](#accept_mutex_delay) +* [`client_body_buffer_size`](#client_body_buffer_size) +* [`client_max_body_size`](#client_max_body_size) +* [`client_body_timeout`](#client_body_timeout) +* [`send_timeout`](#send_timeout) +* [`lingering_timeout`](#lingering_timeout) +* [`lingering_close`](#lingering_close) +* [`lingering_time`](#lingering_time) +* [`etag`](#etag) +* [`events_use`](#events_use) +* [`fastcgi_cache_inactive`](#fastcgi_cache_inactive) +* [`fastcgi_cache_key`](#fastcgi_cache_key) +* [`fastcgi_cache_keys_zone`](#fastcgi_cache_keys_zone) +* [`fastcgi_cache_levels`](#fastcgi_cache_levels) +* [`fastcgi_cache_max_size`](#fastcgi_cache_max_size) +* [`fastcgi_cache_path`](#fastcgi_cache_path) +* [`fastcgi_cache_use_stale`](#fastcgi_cache_use_stale) +* [`gzip`](#gzip) +* [`gzip_buffers`](#gzip_buffers) +* [`gzip_comp_level`](#gzip_comp_level) +* [`gzip_disable`](#gzip_disable) +* [`gzip_min_length`](#gzip_min_length) +* [`gzip_http_version`](#gzip_http_version) +* [`gzip_proxied`](#gzip_proxied) +* [`gzip_types`](#gzip_types) +* [`gzip_vary`](#gzip_vary) +* [`gzip_static`](#gzip_static) +* [`http_cfg_prepend`](#http_cfg_prepend) +* [`http_cfg_append`](#http_cfg_append) +* [`http_raw_prepend`](#http_raw_prepend) +* [`http_raw_append`](#http_raw_append) +* [`http_tcp_nodelay`](#http_tcp_nodelay) +* [`http_tcp_nopush`](#http_tcp_nopush) +* [`keepalive_timeout`](#keepalive_timeout) +* [`keepalive_requests`](#keepalive_requests) +* [`log_format`](#log_format) +* [`mail`](#mail) +* [`mime_types_path`](#mime_types_path) +* [`stream`](#stream) +* [`multi_accept`](#multi_accept) +* [`names_hash_bucket_size`](#names_hash_bucket_size) +* [`names_hash_max_size`](#names_hash_max_size) +* [`nginx_cfg_prepend`](#nginx_cfg_prepend) +* [`proxy_buffers`](#proxy_buffers) +* [`proxy_buffer_size`](#proxy_buffer_size) +* [`proxy_cache_inactive`](#proxy_cache_inactive) +* [`proxy_cache_keys_zone`](#proxy_cache_keys_zone) +* [`proxy_cache_levels`](#proxy_cache_levels) +* [`proxy_cache_max_size`](#proxy_cache_max_size) +* [`proxy_cache_path`](#proxy_cache_path) +* [`proxy_cache_loader_files`](#proxy_cache_loader_files) +* [`proxy_cache_loader_sleep`](#proxy_cache_loader_sleep) +* [`proxy_cache_loader_threshold`](#proxy_cache_loader_threshold) +* [`proxy_use_temp_path`](#proxy_use_temp_path) +* [`proxy_connect_timeout`](#proxy_connect_timeout) +* [`proxy_headers_hash_bucket_size`](#proxy_headers_hash_bucket_size) +* [`proxy_http_version`](#proxy_http_version) +* [`proxy_read_timeout`](#proxy_read_timeout) +* [`proxy_redirect`](#proxy_redirect) +* [`proxy_send_timeout`](#proxy_send_timeout) +* [`proxy_set_header`](#proxy_set_header) +* [`proxy_hide_header`](#proxy_hide_header) +* [`proxy_pass_header`](#proxy_pass_header) +* [`proxy_ignore_header`](#proxy_ignore_header) +* [`proxy_max_temp_file_size`](#proxy_max_temp_file_size) +* [`proxy_busy_buffers_size`](#proxy_busy_buffers_size) +* [`sendfile`](#sendfile) +* [`server_tokens`](#server_tokens) +* [`spdy`](#spdy) +* [`http2`](#http2) +* [`ssl_stapling`](#ssl_stapling) +* [`ssl_stapling_verify`](#ssl_stapling_verify) +* [`snippets_dir`](#snippets_dir) +* [`manage_snippets_dir`](#manage_snippets_dir) +* [`types_hash_bucket_size`](#types_hash_bucket_size) +* [`types_hash_max_size`](#types_hash_max_size) +* [`worker_connections`](#worker_connections) +* [`ssl_prefer_server_ciphers`](#ssl_prefer_server_ciphers) +* [`worker_processes`](#worker_processes) +* [`worker_rlimit_nofile`](#worker_rlimit_nofile) +* [`pcre_jit`](#pcre_jit) +* [`ssl_protocols`](#ssl_protocols) +* [`ssl_ciphers`](#ssl_ciphers) +* [`ssl_dhparam`](#ssl_dhparam) +* [`ssl_ecdh_curve`](#ssl_ecdh_curve) +* [`ssl_session_cache`](#ssl_session_cache) +* [`ssl_session_timeout`](#ssl_session_timeout) +* [`ssl_session_tickets`](#ssl_session_tickets) +* [`ssl_session_ticket_key`](#ssl_session_ticket_key) +* [`ssl_buffer_size`](#ssl_buffer_size) +* [`ssl_crl`](#ssl_crl) +* [`ssl_stapling_file`](#ssl_stapling_file) +* [`ssl_stapling_responder`](#ssl_stapling_responder) +* [`ssl_trusted_certificate`](#ssl_trusted_certificate) +* [`ssl_verify_depth`](#ssl_verify_depth) +* [`ssl_password_file`](#ssl_password_file) +* [`package_ensure`](#package_ensure) +* [`package_name`](#package_name) +* [`package_source`](#package_source) +* [`package_flavor`](#package_flavor) +* [`manage_repo`](#manage_repo) +* [`mime_types`](#mime_types) +* [`mime_types_preserve_defaults`](#mime_types_preserve_defaults) +* [`repo_release`](#repo_release) +* [`passenger_package_ensure`](#passenger_package_ensure) +* [`repo_source`](#repo_source) +* [`service_ensure`](#service_ensure) +* [`service_enable`](#service_enable) +* [`service_flags`](#service_flags) +* [`service_restart`](#service_restart) +* [`service_name`](#service_name) +* [`service_manage`](#service_manage) +* [`geo_mappings`](#geo_mappings) +* [`geo_mappings_defaults`](#geo_mappings_defaults) +* [`string_mappings`](#string_mappings) +* [`string_mappings_defaults`](#string_mappings_defaults) +* [`nginx_locations`](#nginx_locations) +* [`nginx_locations_defaults`](#nginx_locations_defaults) +* [`nginx_mailhosts`](#nginx_mailhosts) +* [`nginx_mailhosts_defaults`](#nginx_mailhosts_defaults) +* [`nginx_servers`](#nginx_servers) +* [`nginx_servers_defaults`](#nginx_servers_defaults) +* [`nginx_streamhosts`](#nginx_streamhosts) +* [`nginx_streamhosts_defaults`](#nginx_streamhosts_defaults) +* [`nginx_upstreams`](#nginx_upstreams) +* [`nginx_upstreams_defaults`](#nginx_upstreams_defaults) +* [`purge_passenger_repo`](#purge_passenger_repo) + +##### `include_modules_enabled` Data type: `Boolean` @@ -254,7 +256,7 @@ When set, nginx will include module configurations files installed in the Default value: `$nginx::params::include_modules_enabled` -##### `passenger_package_name` +##### `passenger_package_name` Data type: `String[1]` @@ -263,7 +265,7 @@ nginx being usable. Default value: `$nginx::params::passenger_package_name` -##### `nginx_version` +##### `nginx_version` Data type: `String[1]` @@ -276,7 +278,7 @@ configuration. Default value: `pick(fact('nginx_version'), '1.6.0')` -##### `debug_connections` +##### `debug_connections` Data type: `Array[Nginx::DebugConnection]` @@ -285,15 +287,15 @@ See http://nginx.org/en/docs/ngx_core_module.html#debug_connection Default value: `[]` -##### `service_config_check` +##### `service_config_check` Data type: `Boolean` whether to en- or disable the config check via nginx -t on config changes -Default value: `false` +Default value: ``false`` -##### `service_config_check_command` +##### `service_config_check_command` Data type: `String` @@ -301,16 +303,16 @@ Command to execute to validate the generated configuration. Default value: `'nginx -t'` -##### `reset_timedout_connection` +##### `reset_timedout_connection` Data type: `Optional[Enum['on', 'off']]` Enables or disables resetting timed out connections and connections closed with the non-standard code 444. -Default value: `undef` +Default value: ``undef`` -##### `nginx_snippets` +##### `nginx_snippets` Data type: `Hash` @@ -318,7 +320,7 @@ Specifies a hash from which to generate `nginx::resource::snippet` resources. Default value: `{}` -##### `nginx_snippets_defaults` +##### `nginx_snippets_defaults` Data type: `Hash` @@ -326,31 +328,55 @@ Can be used to define default values for the parameter `nginx_snippets`. Default value: `{}` -##### `client_body_temp_path` +##### `proxy_temp_mode` + +Data type: `Optional[Stdlib::Filemode]` + +Permissions for the $proxy_temp_path file resource. + +Default value: ``undef`` + +##### `proxy_temp_path` + +Data type: `Optional[Stdlib::Absolutepath]` + +Directory for storing temporary files with data received from proxied servers. + +Default value: ``undef`` + +##### `client_body_temp_path` Data type: `Optional[Stdlib::Absolutepath]` +Directory for storing temporary files holding client request bodies. + +Default value: ``undef`` +##### `client_body_temp_mode` -Default value: `undef` +Data type: `Optional[Stdlib::Filemode]` -##### `confd_only` +Permissions for the $client_body_temp_path file resource. + +Default value: ``undef`` + +##### `confd_only` Data type: `Boolean` -Default value: `false` +Default value: ``false`` -##### `confd_purge` +##### `confd_purge` Data type: `Boolean` -Default value: `false` +Default value: ``false`` -##### `conf_dir` +##### `conf_dir` Data type: `Any` @@ -358,15 +384,15 @@ Data type: `Any` Default value: `$nginx::params::conf_dir` -##### `daemon` +##### `daemon` Data type: `Optional[Enum['on', 'off']]` -Default value: `undef` +Default value: ``undef`` -##### `daemon_user` +##### `daemon_user` Data type: `Any` @@ -374,15 +400,15 @@ Data type: `Any` Default value: `$nginx::params::daemon_user` -##### `daemon_group` +##### `daemon_group` Data type: `Any` -Default value: `undef` +Default value: ``undef`` -##### `dynamic_modules` +##### `dynamic_modules` Data type: `Array[String]` @@ -390,7 +416,7 @@ Data type: `Array[String]` Default value: `[]` -##### `global_owner` +##### `global_owner` Data type: `Any` @@ -398,7 +424,7 @@ Data type: `Any` Default value: `$nginx::params::global_owner` -##### `global_group` +##### `global_group` Data type: `Any` @@ -406,7 +432,7 @@ Data type: `Any` Default value: `$nginx::params::global_group` -##### `global_mode` +##### `global_mode` Data type: `Any` @@ -414,15 +440,15 @@ Data type: `Any` Default value: `$nginx::params::global_mode` -##### `limit_req_zone` +##### `limit_req_zone` Data type: `Optional[Variant[String[1], Array[String[1]]]]` -Default value: `undef` +Default value: ``undef`` -##### `log_dir` +##### `log_dir` Data type: `Stdlib::Absolutepath` @@ -430,15 +456,15 @@ Data type: `Stdlib::Absolutepath` Default value: `$nginx::params::log_dir` -##### `manage_log_dir` +##### `manage_log_dir` Data type: `Boolean` -Default value: `true` +Default value: ``true`` -##### `log_user` +##### `log_user` Data type: `String[1]` @@ -446,7 +472,7 @@ Data type: `String[1]` Default value: `$nginx::params::log_user` -##### `log_group` +##### `log_group` Data type: `String[1]` @@ -454,7 +480,7 @@ Data type: `String[1]` Default value: `$nginx::params::log_group` -##### `log_mode` +##### `log_mode` Data type: `Stdlib::Filemode` @@ -462,7 +488,7 @@ Data type: `Stdlib::Filemode` Default value: `$nginx::params::log_mode` -##### `http_access_log` +##### `http_access_log` Data type: `Variant[String, Array[String]]` @@ -470,15 +496,15 @@ Data type: `Variant[String, Array[String]]` Default value: `"${log_dir}/${nginx::params::http_access_log_file}"` -##### `http_format_log` +##### `http_format_log` Data type: `Optional[String]` -Default value: `undef` +Default value: ``undef`` -##### `nginx_error_log` +##### `nginx_error_log` Data type: `Variant[String, Array[String]]` @@ -486,7 +512,7 @@ Data type: `Variant[String, Array[String]]` Default value: `"${log_dir}/${nginx::params::nginx_error_log_file}"` -##### `nginx_error_log_severity` +##### `nginx_error_log_severity` Data type: `Nginx::ErrorLogSeverity` @@ -494,7 +520,7 @@ Data type: `Nginx::ErrorLogSeverity` Default value: `'error'` -##### `pid` +##### `pid` Data type: `Any` @@ -502,15 +528,7 @@ Data type: `Any` Default value: `$nginx::params::pid` -##### `proxy_temp_path` - -Data type: `Optional[Stdlib::Absolutepath]` - - - -Default value: `undef` - -##### `root_group` +##### `root_group` Data type: `Any` @@ -518,7 +536,7 @@ Data type: `Any` Default value: `$nginx::params::root_group` -##### `sites_available_owner` +##### `sites_available_owner` Data type: `Any` @@ -526,7 +544,7 @@ Data type: `Any` Default value: `$nginx::params::sites_available_owner` -##### `sites_available_group` +##### `sites_available_group` Data type: `Any` @@ -534,7 +552,7 @@ Data type: `Any` Default value: `$nginx::params::sites_available_group` -##### `sites_available_mode` +##### `sites_available_mode` Data type: `Any` @@ -542,7 +560,7 @@ Data type: `Any` Default value: `$nginx::params::sites_available_mode` -##### `super_user` +##### `super_user` Data type: `Boolean` @@ -550,7 +568,7 @@ Data type: `Boolean` Default value: `$nginx::params::super_user` -##### `temp_dir` +##### `temp_dir` Data type: `Any` @@ -558,15 +576,15 @@ Data type: `Any` Default value: `$nginx::params::temp_dir` -##### `server_purge` +##### `server_purge` Data type: `Boolean` -Default value: `false` +Default value: ``false`` -##### `conf_template` +##### `conf_template` Data type: `String[1]` @@ -574,7 +592,7 @@ Data type: `String[1]` Default value: `'nginx/conf.d/nginx.conf.erb'` -##### `fastcgi_conf_template` +##### `fastcgi_conf_template` Data type: `String[1]` @@ -582,7 +600,7 @@ Data type: `String[1]` Default value: `'nginx/server/fastcgi.conf.erb'` -##### `uwsgi_params_template` +##### `uwsgi_params_template` Data type: `String[1]` @@ -590,15 +608,15 @@ Data type: `String[1]` Default value: `'nginx/server/uwsgi_params.erb'` -##### `absolute_redirect` +##### `absolute_redirect` Data type: `Optional[Enum['on', 'off']]` -Default value: `undef` +Default value: ``undef`` -##### `accept_mutex` +##### `accept_mutex` Data type: `Enum['on', 'off']` @@ -606,7 +624,7 @@ Data type: `Enum['on', 'off']` Default value: `'on'` -##### `accept_mutex_delay` +##### `accept_mutex_delay` Data type: `Any` @@ -614,7 +632,7 @@ Data type: `Any` Default value: `'500ms'` -##### `client_body_buffer_size` +##### `client_body_buffer_size` Data type: `Any` @@ -622,7 +640,7 @@ Data type: `Any` Default value: `'128k'` -##### `client_max_body_size` +##### `client_max_body_size` Data type: `String` @@ -630,7 +648,7 @@ Data type: `String` Default value: `'10m'` -##### `client_body_timeout` +##### `client_body_timeout` Data type: `Any` @@ -638,7 +656,7 @@ Data type: `Any` Default value: `'60s'` -##### `send_timeout` +##### `send_timeout` Data type: `Any` @@ -646,7 +664,7 @@ Data type: `Any` Default value: `'60s'` -##### `lingering_timeout` +##### `lingering_timeout` Data type: `Any` @@ -654,39 +672,39 @@ Data type: `Any` Default value: `'5s'` -##### `lingering_close` +##### `lingering_close` Data type: `Optional[Enum['on','off','always']]` -Default value: `undef` +Default value: ``undef`` -##### `lingering_time` +##### `lingering_time` Data type: `Optional[String[1]]` -Default value: `undef` +Default value: ``undef`` -##### `etag` +##### `etag` Data type: `Optional[Enum['on', 'off']]` -Default value: `undef` +Default value: ``undef`` -##### `events_use` +##### `events_use` Data type: `Optional[String]` -Default value: `undef` +Default value: ``undef`` -##### `fastcgi_cache_inactive` +##### `fastcgi_cache_inactive` Data type: `String` @@ -694,15 +712,15 @@ Data type: `String` Default value: `'20m'` -##### `fastcgi_cache_key` +##### `fastcgi_cache_key` Data type: `Optional[String]` -Default value: `undef` +Default value: ``undef`` -##### `fastcgi_cache_keys_zone` +##### `fastcgi_cache_keys_zone` Data type: `String` @@ -710,7 +728,7 @@ Data type: `String` Default value: `'d3:100m'` -##### `fastcgi_cache_levels` +##### `fastcgi_cache_levels` Data type: `String` @@ -718,7 +736,7 @@ Data type: `String` Default value: `'1'` -##### `fastcgi_cache_max_size` +##### `fastcgi_cache_max_size` Data type: `String` @@ -726,23 +744,23 @@ Data type: `String` Default value: `'500m'` -##### `fastcgi_cache_path` +##### `fastcgi_cache_path` Data type: `Optional[String]` -Default value: `undef` +Default value: ``undef`` -##### `fastcgi_cache_use_stale` +##### `fastcgi_cache_use_stale` Data type: `Optional[String]` -Default value: `undef` +Default value: ``undef`` -##### `gzip` +##### `gzip` Data type: `Enum['on', 'off']` @@ -750,15 +768,15 @@ Data type: `Enum['on', 'off']` Default value: `'off'` -##### `gzip_buffers` +##### `gzip_buffers` Data type: `Any` -Default value: `undef` +Default value: ``undef`` -##### `gzip_comp_level` +##### `gzip_comp_level` Data type: `Any` @@ -766,7 +784,7 @@ Data type: `Any` Default value: `1` -##### `gzip_disable` +##### `gzip_disable` Data type: `Any` @@ -774,7 +792,7 @@ Data type: `Any` Default value: `'msie6'` -##### `gzip_min_length` +##### `gzip_min_length` Data type: `Any` @@ -782,7 +800,7 @@ Data type: `Any` Default value: `20` -##### `gzip_http_version` +##### `gzip_http_version` Data type: `Any` @@ -790,7 +808,7 @@ Data type: `Any` Default value: `1.1` -##### `gzip_proxied` +##### `gzip_proxied` Data type: `Nginx::GzipProxied` @@ -798,15 +816,15 @@ Data type: `Nginx::GzipProxied` Default value: `'off'` -##### `gzip_types` +##### `gzip_types` Data type: `Any` -Default value: `undef` +Default value: ``undef`` -##### `gzip_vary` +##### `gzip_vary` Data type: `Enum['on', 'off']` @@ -814,47 +832,47 @@ Data type: `Enum['on', 'off']` Default value: `'off'` -##### `gzip_static` +##### `gzip_static` Data type: `Optional[Enum['on', 'off', 'always']]` -Default value: `undef` +Default value: ``undef`` -##### `http_cfg_prepend` +##### `http_cfg_prepend` Data type: `Optional[Variant[Hash, Array]]` -Default value: `undef` +Default value: ``undef`` -##### `http_cfg_append` +##### `http_cfg_append` Data type: `Optional[Variant[Hash, Array]]` -Default value: `undef` +Default value: ``undef`` -##### `http_raw_prepend` +##### `http_raw_prepend` Data type: `Optional[Variant[Array[String], String]]` -Default value: `undef` +Default value: ``undef`` -##### `http_raw_append` +##### `http_raw_append` Data type: `Optional[Variant[Array[String], String]]` -Default value: `undef` +Default value: ``undef`` -##### `http_tcp_nodelay` +##### `http_tcp_nodelay` Data type: `Enum['on', 'off']` @@ -862,7 +880,7 @@ Data type: `Enum['on', 'off']` Default value: `'on'` -##### `http_tcp_nopush` +##### `http_tcp_nopush` Data type: `Enum['on', 'off']` @@ -870,7 +888,7 @@ Data type: `Enum['on', 'off']` Default value: `'off'` -##### `keepalive_timeout` +##### `keepalive_timeout` Data type: `Any` @@ -878,7 +896,7 @@ Data type: `Any` Default value: `'65s'` -##### `keepalive_requests` +##### `keepalive_requests` Data type: `Any` @@ -886,7 +904,7 @@ Data type: `Any` Default value: `'100'` -##### `log_format` +##### `log_format` Data type: `Hash[String[1], Nginx::LogFormat]` @@ -894,15 +912,15 @@ Data type: `Hash[String[1], Nginx::LogFormat]` Default value: `{}` -##### `mail` +##### `mail` Data type: `Boolean` -Default value: `false` +Default value: ``false`` -##### `mime_types_path` +##### `mime_types_path` Data type: `Variant[String, Boolean]` @@ -910,15 +928,15 @@ Data type: `Variant[String, Boolean]` Default value: `'mime.types'` -##### `stream` +##### `stream` Data type: `Boolean` -Default value: `false` +Default value: ``false`` -##### `multi_accept` +##### `multi_accept` Data type: `String` @@ -926,7 +944,7 @@ Data type: `String` Default value: `'off'` -##### `names_hash_bucket_size` +##### `names_hash_bucket_size` Data type: `Integer` @@ -934,7 +952,7 @@ Data type: `Integer` Default value: `64` -##### `names_hash_max_size` +##### `names_hash_max_size` Data type: `Integer` @@ -942,15 +960,15 @@ Data type: `Integer` Default value: `512` -##### `nginx_cfg_prepend` +##### `nginx_cfg_prepend` Data type: `Any` -Default value: `false` +Default value: ``false`` -##### `proxy_buffers` +##### `proxy_buffers` Data type: `String` @@ -958,7 +976,7 @@ Data type: `String` Default value: `'32 4k'` -##### `proxy_buffer_size` +##### `proxy_buffer_size` Data type: `String` @@ -966,7 +984,7 @@ Data type: `String` Default value: `'8k'` -##### `proxy_cache_inactive` +##### `proxy_cache_inactive` Data type: `String` @@ -974,7 +992,7 @@ Data type: `String` Default value: `'20m'` -##### `proxy_cache_keys_zone` +##### `proxy_cache_keys_zone` Data type: `String` @@ -982,7 +1000,7 @@ Data type: `String` Default value: `'d2:100m'` -##### `proxy_cache_levels` +##### `proxy_cache_levels` Data type: `String` @@ -990,7 +1008,7 @@ Data type: `String` Default value: `'1'` -##### `proxy_cache_max_size` +##### `proxy_cache_max_size` Data type: `String` @@ -998,47 +1016,47 @@ Data type: `String` Default value: `'500m'` -##### `proxy_cache_path` +##### `proxy_cache_path` Data type: `Optional[Variant[Hash, String]]` -Default value: `undef` +Default value: ``undef`` -##### `proxy_cache_loader_files` +##### `proxy_cache_loader_files` Data type: `Optional[Integer]` -Default value: `undef` +Default value: ``undef`` -##### `proxy_cache_loader_sleep` +##### `proxy_cache_loader_sleep` Data type: `Optional[String]` -Default value: `undef` +Default value: ``undef`` -##### `proxy_cache_loader_threshold` +##### `proxy_cache_loader_threshold` Data type: `Optional[String]` -Default value: `undef` +Default value: ``undef`` -##### `proxy_use_temp_path` +##### `proxy_use_temp_path` Data type: `Optional[Enum['on', 'off']]` -Default value: `undef` +Default value: ``undef`` -##### `proxy_connect_timeout` +##### `proxy_connect_timeout` Data type: `Any` @@ -1046,7 +1064,7 @@ Data type: `Any` Default value: `'90s'` -##### `proxy_headers_hash_bucket_size` +##### `proxy_headers_hash_bucket_size` Data type: `Integer` @@ -1054,15 +1072,15 @@ Data type: `Integer` Default value: `64` -##### `proxy_http_version` +##### `proxy_http_version` Data type: `Optional[String]` -Default value: `undef` +Default value: ``undef`` -##### `proxy_read_timeout` +##### `proxy_read_timeout` Data type: `Any` @@ -1070,15 +1088,15 @@ Data type: `Any` Default value: `'90s'` -##### `proxy_redirect` +##### `proxy_redirect` Data type: `Any` -Default value: `undef` +Default value: ``undef`` -##### `proxy_send_timeout` +##### `proxy_send_timeout` Data type: `Any` @@ -1086,26 +1104,22 @@ Data type: `Any` Default value: `'90s'` -##### `proxy_set_header` +##### `proxy_set_header` Data type: `Array` -Default value: - -```puppet -[ +Default value: `[ 'Host $host', 'X-Real-IP $remote_addr', 'X-Forwarded-For $proxy_add_x_forwarded_for', 'X-Forwarded-Host $host', 'X-Forwarded-Proto $scheme', 'Proxy ""', - ] -``` + ]` -##### `proxy_hide_header` +##### `proxy_hide_header` Data type: `Array` @@ -1113,7 +1127,7 @@ Data type: `Array` Default value: `[]` -##### `proxy_pass_header` +##### `proxy_pass_header` Data type: `Array` @@ -1121,7 +1135,7 @@ Data type: `Array` Default value: `[]` -##### `proxy_ignore_header` +##### `proxy_ignore_header` Data type: `Array` @@ -1129,23 +1143,23 @@ Data type: `Array` Default value: `[]` -##### `proxy_max_temp_file_size` +##### `proxy_max_temp_file_size` Data type: `Optional[Nginx::Size]` -Default value: `undef` +Default value: ``undef`` -##### `proxy_busy_buffers_size` +##### `proxy_busy_buffers_size` Data type: `Optional[Nginx::Size]` -Default value: `undef` +Default value: ``undef`` -##### `sendfile` +##### `sendfile` Data type: `Enum['on', 'off']` @@ -1153,7 +1167,7 @@ Data type: `Enum['on', 'off']` Default value: `'on'` -##### `server_tokens` +##### `server_tokens` Data type: `Enum['on', 'off']` @@ -1161,7 +1175,7 @@ Data type: `Enum['on', 'off']` Default value: `'on'` -##### `spdy` +##### `spdy` Data type: `Enum['on', 'off']` @@ -1169,7 +1183,7 @@ Data type: `Enum['on', 'off']` Default value: `'off'` -##### `http2` +##### `http2` Data type: `Enum['on', 'off']` @@ -1177,7 +1191,7 @@ Data type: `Enum['on', 'off']` Default value: `'off'` -##### `ssl_stapling` +##### `ssl_stapling` Data type: `Enum['on', 'off']` @@ -1185,7 +1199,7 @@ Data type: `Enum['on', 'off']` Default value: `'off'` -##### `ssl_stapling_verify` +##### `ssl_stapling_verify` Data type: `Enum['on', 'off']` @@ -1193,7 +1207,7 @@ Data type: `Enum['on', 'off']` Default value: `'off'` -##### `snippets_dir` +##### `snippets_dir` Data type: `Stdlib::Absolutepath` @@ -1201,15 +1215,15 @@ Data type: `Stdlib::Absolutepath` Default value: `$nginx::params::snippets_dir` -##### `manage_snippets_dir` +##### `manage_snippets_dir` Data type: `Boolean` -Default value: `true` +Default value: ``true`` -##### `types_hash_bucket_size` +##### `types_hash_bucket_size` Data type: `Any` @@ -1217,7 +1231,7 @@ Data type: `Any` Default value: `'512'` -##### `types_hash_max_size` +##### `types_hash_max_size` Data type: `Any` @@ -1225,7 +1239,7 @@ Data type: `Any` Default value: `'1024'` -##### `worker_connections` +##### `worker_connections` Data type: `Integer` @@ -1233,7 +1247,7 @@ Data type: `Integer` Default value: `1024` -##### `ssl_prefer_server_ciphers` +##### `ssl_prefer_server_ciphers` Data type: `Enum['on', 'off']` @@ -1241,7 +1255,7 @@ Data type: `Enum['on', 'off']` Default value: `'on'` -##### `worker_processes` +##### `worker_processes` Data type: `Variant[Integer, Enum['auto']]` @@ -1249,7 +1263,7 @@ Data type: `Variant[Integer, Enum['auto']]` Default value: `'auto'` -##### `worker_rlimit_nofile` +##### `worker_rlimit_nofile` Data type: `Integer` @@ -1257,15 +1271,15 @@ Data type: `Integer` Default value: `1024` -##### `pcre_jit` +##### `pcre_jit` Data type: `Optional[Enum['on', 'off']]` -Default value: `undef` +Default value: ``undef`` -##### `ssl_protocols` +##### `ssl_protocols` Data type: `String` @@ -1273,7 +1287,7 @@ Data type: `String` Default value: `'TLSv1 TLSv1.1 TLSv1.2'` -##### `ssl_ciphers` +##### `ssl_ciphers` Data type: `String` @@ -1281,23 +1295,23 @@ Data type: `String` Default value: `'ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:DHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES256-SHA384:ECDHE-RSA-AES128-SHA:ECDHE-ECDSA-AES256-SHA384:ECDHE-ECDSA-AES256-SHA:ECDHE-RSA-AES256-SHA:DHE-RSA-AES128-SHA256:DHE-RSA-AES128-SHA:DHE-RSA-AES256-SHA256:DHE-RSA-AES256-SHA:ECDHE-ECDSA-DES-CBC3-SHA:ECDHE-RSA-DES-CBC3-SHA:EDH-RSA-DES-CBC3-SHA:AES128-GCM-SHA256:AES256-GCM-SHA384:AES128-SHA256:AES256-SHA256:AES128-SHA:AES256-SHA:DES-CBC3-SHA:!DSS'` -##### `ssl_dhparam` +##### `ssl_dhparam` Data type: `Optional[Stdlib::Unixpath]` -Default value: `undef` +Default value: ``undef`` -##### `ssl_ecdh_curve` +##### `ssl_ecdh_curve` Data type: `Optional[String]` -Default value: `undef` +Default value: ``undef`` -##### `ssl_session_cache` +##### `ssl_session_cache` Data type: `String` @@ -1305,7 +1319,7 @@ Data type: `String` Default value: `'shared:SSL:10m'` -##### `ssl_session_timeout` +##### `ssl_session_timeout` Data type: `String` @@ -1313,79 +1327,79 @@ Data type: `String` Default value: `'5m'` -##### `ssl_session_tickets` +##### `ssl_session_tickets` Data type: `Optional[Enum['on', 'off']]` -Default value: `undef` +Default value: ``undef`` -##### `ssl_session_ticket_key` +##### `ssl_session_ticket_key` Data type: `Optional[Stdlib::Absolutepath]` -Default value: `undef` +Default value: ``undef`` -##### `ssl_buffer_size` +##### `ssl_buffer_size` Data type: `Optional[String]` -Default value: `undef` +Default value: ``undef`` -##### `ssl_crl` +##### `ssl_crl` Data type: `Optional[Stdlib::Absolutepath]` -Default value: `undef` +Default value: ``undef`` -##### `ssl_stapling_file` +##### `ssl_stapling_file` Data type: `Optional[Stdlib::Absolutepath]` -Default value: `undef` +Default value: ``undef`` -##### `ssl_stapling_responder` +##### `ssl_stapling_responder` Data type: `Optional[String]` -Default value: `undef` +Default value: ``undef`` -##### `ssl_trusted_certificate` +##### `ssl_trusted_certificate` Data type: `Optional[Stdlib::Absolutepath]` -Default value: `undef` +Default value: ``undef`` -##### `ssl_verify_depth` +##### `ssl_verify_depth` Data type: `Optional[Integer]` -Default value: `undef` +Default value: ``undef`` -##### `ssl_password_file` +##### `ssl_password_file` Data type: `Optional[Stdlib::Absolutepath]` -Default value: `undef` +Default value: ``undef`` -##### `package_ensure` +##### `package_ensure` Data type: `Any` @@ -1393,7 +1407,7 @@ Data type: `Any` Default value: `installed` -##### `package_name` +##### `package_name` Data type: `Any` @@ -1401,7 +1415,7 @@ Data type: `Any` Default value: `$nginx::params::package_name` -##### `package_source` +##### `package_source` Data type: `Any` @@ -1409,15 +1423,15 @@ Data type: `Any` Default value: `'nginx'` -##### `package_flavor` +##### `package_flavor` Data type: `Any` -Default value: `undef` +Default value: ``undef`` -##### `manage_repo` +##### `manage_repo` Data type: `Boolean` @@ -1425,7 +1439,7 @@ Data type: `Boolean` Default value: `$nginx::params::manage_repo` -##### `mime_types` +##### `mime_types` Data type: `Hash[String[1], String[1]]` @@ -1433,23 +1447,23 @@ Data type: `Hash[String[1], String[1]]` Default value: `$nginx::params::mime_types` -##### `mime_types_preserve_defaults` +##### `mime_types_preserve_defaults` Data type: `Boolean` -Default value: `false` +Default value: ``false`` -##### `repo_release` +##### `repo_release` Data type: `Optional[String]` -Default value: `undef` +Default value: ``undef`` -##### `passenger_package_ensure` +##### `passenger_package_ensure` Data type: `Any` @@ -1457,15 +1471,15 @@ Data type: `Any` Default value: `installed` -##### `repo_source` +##### `repo_source` Data type: `Optional[Stdlib::HTTPUrl]` -Default value: `undef` +Default value: ``undef`` -##### `service_ensure` +##### `service_ensure` Data type: `Stdlib::Ensure::Service` @@ -1473,31 +1487,31 @@ Data type: `Stdlib::Ensure::Service` Default value: `'running'` -##### `service_enable` +##### `service_enable` Data type: `Any` -Default value: `true` +Default value: ``true`` -##### `service_flags` +##### `service_flags` Data type: `Any` -Default value: `undef` +Default value: ``undef`` -##### `service_restart` +##### `service_restart` Data type: `Any` -Default value: `undef` +Default value: ``undef`` -##### `service_name` +##### `service_name` Data type: `Any` @@ -1505,15 +1519,15 @@ Data type: `Any` Default value: `'nginx'` -##### `service_manage` +##### `service_manage` Data type: `Any` -Default value: `true` +Default value: ``true`` -##### `geo_mappings` +##### `geo_mappings` Data type: `Hash` @@ -1521,7 +1535,7 @@ Data type: `Hash` Default value: `{}` -##### `geo_mappings_defaults` +##### `geo_mappings_defaults` Data type: `Hash` @@ -1529,7 +1543,7 @@ Data type: `Hash` Default value: `{}` -##### `string_mappings` +##### `string_mappings` Data type: `Hash` @@ -1537,7 +1551,7 @@ Data type: `Hash` Default value: `{}` -##### `string_mappings_defaults` +##### `string_mappings_defaults` Data type: `Hash` @@ -1545,7 +1559,7 @@ Data type: `Hash` Default value: `{}` -##### `nginx_locations` +##### `nginx_locations` Data type: `Hash` @@ -1553,7 +1567,7 @@ Data type: `Hash` Default value: `{}` -##### `nginx_locations_defaults` +##### `nginx_locations_defaults` Data type: `Hash` @@ -1561,7 +1575,7 @@ Data type: `Hash` Default value: `{}` -##### `nginx_mailhosts` +##### `nginx_mailhosts` Data type: `Hash` @@ -1569,7 +1583,7 @@ Data type: `Hash` Default value: `{}` -##### `nginx_mailhosts_defaults` +##### `nginx_mailhosts_defaults` Data type: `Hash` @@ -1577,7 +1591,7 @@ Data type: `Hash` Default value: `{}` -##### `nginx_servers` +##### `nginx_servers` Data type: `Hash` @@ -1585,7 +1599,7 @@ Data type: `Hash` Default value: `{}` -##### `nginx_servers_defaults` +##### `nginx_servers_defaults` Data type: `Hash` @@ -1593,7 +1607,7 @@ Data type: `Hash` Default value: `{}` -##### `nginx_streamhosts` +##### `nginx_streamhosts` Data type: `Hash` @@ -1601,7 +1615,7 @@ Data type: `Hash` Default value: `{}` -##### `nginx_streamhosts_defaults` +##### `nginx_streamhosts_defaults` Data type: `Hash` @@ -1609,7 +1623,7 @@ Data type: `Hash` Default value: `{}` -##### `nginx_upstreams` +##### `nginx_upstreams` Data type: `Hash` @@ -1617,7 +1631,7 @@ Data type: `Hash` Default value: `{}` -##### `nginx_upstreams_defaults` +##### `nginx_upstreams_defaults` Data type: `Nginx::UpstreamDefaults` @@ -1625,17 +1639,17 @@ Data type: `Nginx::UpstreamDefaults` Default value: `{}` -##### `purge_passenger_repo` +##### `purge_passenger_repo` Data type: `Boolean` -Default value: `true` +Default value: ``true`` ## Defined types -### `nginx::resource::geo` +### `nginx::resource::geo` Create a new geo mapping entry for NGINX @@ -1679,31 +1693,31 @@ nginx::geo_mappings: The following parameters are available in the `nginx::resource::geo` defined type: -* [`networks`](#-nginx--resource--geo--networks) -* [`default`](#-nginx--resource--geo--default) -* [`ensure`](#-nginx--resource--geo--ensure) -* [`ranges`](#-nginx--resource--geo--ranges) -* [`address`](#-nginx--resource--geo--address) -* [`delete`](#-nginx--resource--geo--delete) -* [`proxy_recursive`](#-nginx--resource--geo--proxy_recursive) -* [`proxies`](#-nginx--resource--geo--proxies) +* [`networks`](#networks) +* [`default`](#default) +* [`ensure`](#ensure) +* [`ranges`](#ranges) +* [`address`](#address) +* [`delete`](#delete) +* [`proxy_recursive`](#proxy_recursive) +* [`proxies`](#proxies) -##### `networks` +##### `networks` Data type: `Hash` Hash of geo lookup keys and resultant values -##### `default` +##### `default` Data type: `Optional[String]` Sets the resulting value if the source value fails to match any of the variants. -Default value: `undef` +Default value: ``undef`` -##### `ensure` +##### `ensure` Data type: `Enum['present', 'absent']` @@ -1711,49 +1725,49 @@ Enables or disables the specified location Default value: `'present'` -##### `ranges` +##### `ranges` Data type: `Boolean` Indicates that lookup keys (network addresses) are specified as ranges. -Default value: `false` +Default value: ``false`` -##### `address` +##### `address` Data type: `Optional[String]` Nginx defaults to using $remote_addr for testing. This allows you to override that with another variable name (automatically prefixed with $) -Default value: `undef` +Default value: ``undef`` -##### `delete` +##### `delete` Data type: `Optional[String]` deletes the specified network (see: geo module docs) -Default value: `undef` +Default value: ``undef`` -##### `proxy_recursive` +##### `proxy_recursive` Data type: `Optional[Boolean]` Changes the behavior of address acquisition when specifying trusted proxies via 'proxies' directive -Default value: `undef` +Default value: ``undef`` -##### `proxies` +##### `proxies` Data type: `Optional[Array]` Hash of network->value mappings. -Default value: `undef` +Default value: ``undef`` -### `nginx::resource::location` +### `nginx::resource::location` Create a new location entry within a virtual host @@ -1830,80 +1844,80 @@ nginx::resource::location { 'test2.local-bob': The following parameters are available in the `nginx::resource::location` defined type: -* [`ensure`](#-nginx--resource--location--ensure) -* [`internal`](#-nginx--resource--location--internal) -* [`server`](#-nginx--resource--location--server) -* [`location`](#-nginx--resource--location--location) -* [`location_satisfy`](#-nginx--resource--location--location_satisfy) -* [`location_allow`](#-nginx--resource--location--location_allow) -* [`location_deny`](#-nginx--resource--location--location_deny) -* [`www_root`](#-nginx--resource--location--www_root) -* [`autoindex`](#-nginx--resource--location--autoindex) -* [`autoindex_exact_size`](#-nginx--resource--location--autoindex_exact_size) -* [`autoindex_format`](#-nginx--resource--location--autoindex_format) -* [`autoindex_localtime`](#-nginx--resource--location--autoindex_localtime) -* [`index_files`](#-nginx--resource--location--index_files) -* [`proxy`](#-nginx--resource--location--proxy) -* [`proxy_redirect`](#-nginx--resource--location--proxy_redirect) -* [`proxy_read_timeout`](#-nginx--resource--location--proxy_read_timeout) -* [`proxy_connect_timeout`](#-nginx--resource--location--proxy_connect_timeout) -* [`proxy_send_timeout`](#-nginx--resource--location--proxy_send_timeout) -* [`proxy_set_header`](#-nginx--resource--location--proxy_set_header) -* [`proxy_hide_header`](#-nginx--resource--location--proxy_hide_header) -* [`proxy_pass_header`](#-nginx--resource--location--proxy_pass_header) -* [`proxy_ignore_header`](#-nginx--resource--location--proxy_ignore_header) -* [`proxy_next_upstream`](#-nginx--resource--location--proxy_next_upstream) -* [`fastcgi`](#-nginx--resource--location--fastcgi) -* [`fastcgi_param`](#-nginx--resource--location--fastcgi_param) -* [`fastcgi_params`](#-nginx--resource--location--fastcgi_params) -* [`fastcgi_script`](#-nginx--resource--location--fastcgi_script) -* [`fastcgi_split_path`](#-nginx--resource--location--fastcgi_split_path) -* [`uwsgi`](#-nginx--resource--location--uwsgi) -* [`uwsgi_param`](#-nginx--resource--location--uwsgi_param) -* [`uwsgi_params`](#-nginx--resource--location--uwsgi_params) -* [`uwsgi_read_timeout`](#-nginx--resource--location--uwsgi_read_timeout) -* [`ssl`](#-nginx--resource--location--ssl) -* [`ssl_only`](#-nginx--resource--location--ssl_only) -* [`location_alias`](#-nginx--resource--location--location_alias) -* [`stub_status`](#-nginx--resource--location--stub_status) -* [`raw_prepend`](#-nginx--resource--location--raw_prepend) -* [`raw_append`](#-nginx--resource--location--raw_append) -* [`limit_zone`](#-nginx--resource--location--limit_zone) -* [`location_custom_cfg`](#-nginx--resource--location--location_custom_cfg) -* [`location_cfg_prepend`](#-nginx--resource--location--location_cfg_prepend) -* [`location_custom_cfg_prepend`](#-nginx--resource--location--location_custom_cfg_prepend) -* [`location_custom_cfg_append`](#-nginx--resource--location--location_custom_cfg_append) -* [`location_cfg_append`](#-nginx--resource--location--location_cfg_append) -* [`include`](#-nginx--resource--location--include) -* [`try_files`](#-nginx--resource--location--try_files) -* [`proxy_cache`](#-nginx--resource--location--proxy_cache) -* [`proxy_cache_key`](#-nginx--resource--location--proxy_cache_key) -* [`proxy_cache_use_stale`](#-nginx--resource--location--proxy_cache_use_stale) -* [`proxy_cache_valid`](#-nginx--resource--location--proxy_cache_valid) -* [`proxy_cache_lock`](#-nginx--resource--location--proxy_cache_lock) -* [`proxy_cache_bypass`](#-nginx--resource--location--proxy_cache_bypass) -* [`proxy_method`](#-nginx--resource--location--proxy_method) -* [`proxy_http_version`](#-nginx--resource--location--proxy_http_version) -* [`proxy_set_body`](#-nginx--resource--location--proxy_set_body) -* [`proxy_buffering`](#-nginx--resource--location--proxy_buffering) -* [`proxy_request_buffering`](#-nginx--resource--location--proxy_request_buffering) -* [`proxy_max_temp_file_size`](#-nginx--resource--location--proxy_max_temp_file_size) -* [`proxy_busy_buffers_size`](#-nginx--resource--location--proxy_busy_buffers_size) -* [`absolute_redirect`](#-nginx--resource--location--absolute_redirect) -* [`auth_basic`](#-nginx--resource--location--auth_basic) -* [`auth_basic_user_file`](#-nginx--resource--location--auth_basic_user_file) -* [`auth_request`](#-nginx--resource--location--auth_request) -* [`priority`](#-nginx--resource--location--priority) -* [`mp4`](#-nginx--resource--location--mp4) -* [`flv`](#-nginx--resource--location--flv) -* [`expires`](#-nginx--resource--location--expires) -* [`add_header`](#-nginx--resource--location--add_header) -* [`gzip_static`](#-nginx--resource--location--gzip_static) -* [`reset_timedout_connection`](#-nginx--resource--location--reset_timedout_connection) -* [`fastcgi_index`](#-nginx--resource--location--fastcgi_index) -* [`rewrite_rules`](#-nginx--resource--location--rewrite_rules) - -##### `ensure` +* [`ensure`](#ensure) +* [`internal`](#internal) +* [`server`](#server) +* [`location`](#location) +* [`location_satisfy`](#location_satisfy) +* [`location_allow`](#location_allow) +* [`location_deny`](#location_deny) +* [`www_root`](#www_root) +* [`autoindex`](#autoindex) +* [`autoindex_exact_size`](#autoindex_exact_size) +* [`autoindex_format`](#autoindex_format) +* [`autoindex_localtime`](#autoindex_localtime) +* [`index_files`](#index_files) +* [`proxy`](#proxy) +* [`proxy_redirect`](#proxy_redirect) +* [`proxy_read_timeout`](#proxy_read_timeout) +* [`proxy_connect_timeout`](#proxy_connect_timeout) +* [`proxy_send_timeout`](#proxy_send_timeout) +* [`proxy_set_header`](#proxy_set_header) +* [`proxy_hide_header`](#proxy_hide_header) +* [`proxy_pass_header`](#proxy_pass_header) +* [`proxy_ignore_header`](#proxy_ignore_header) +* [`proxy_next_upstream`](#proxy_next_upstream) +* [`fastcgi`](#fastcgi) +* [`fastcgi_param`](#fastcgi_param) +* [`fastcgi_params`](#fastcgi_params) +* [`fastcgi_script`](#fastcgi_script) +* [`fastcgi_split_path`](#fastcgi_split_path) +* [`uwsgi`](#uwsgi) +* [`uwsgi_param`](#uwsgi_param) +* [`uwsgi_params`](#uwsgi_params) +* [`uwsgi_read_timeout`](#uwsgi_read_timeout) +* [`ssl`](#ssl) +* [`ssl_only`](#ssl_only) +* [`location_alias`](#location_alias) +* [`stub_status`](#stub_status) +* [`raw_prepend`](#raw_prepend) +* [`raw_append`](#raw_append) +* [`limit_zone`](#limit_zone) +* [`location_custom_cfg`](#location_custom_cfg) +* [`location_cfg_prepend`](#location_cfg_prepend) +* [`location_custom_cfg_prepend`](#location_custom_cfg_prepend) +* [`location_custom_cfg_append`](#location_custom_cfg_append) +* [`location_cfg_append`](#location_cfg_append) +* [`include`](#include) +* [`try_files`](#try_files) +* [`proxy_cache`](#proxy_cache) +* [`proxy_cache_key`](#proxy_cache_key) +* [`proxy_cache_use_stale`](#proxy_cache_use_stale) +* [`proxy_cache_valid`](#proxy_cache_valid) +* [`proxy_cache_lock`](#proxy_cache_lock) +* [`proxy_cache_bypass`](#proxy_cache_bypass) +* [`proxy_method`](#proxy_method) +* [`proxy_http_version`](#proxy_http_version) +* [`proxy_set_body`](#proxy_set_body) +* [`proxy_buffering`](#proxy_buffering) +* [`proxy_request_buffering`](#proxy_request_buffering) +* [`proxy_max_temp_file_size`](#proxy_max_temp_file_size) +* [`proxy_busy_buffers_size`](#proxy_busy_buffers_size) +* [`absolute_redirect`](#absolute_redirect) +* [`auth_basic`](#auth_basic) +* [`auth_basic_user_file`](#auth_basic_user_file) +* [`auth_request`](#auth_request) +* [`priority`](#priority) +* [`mp4`](#mp4) +* [`flv`](#flv) +* [`expires`](#expires) +* [`add_header`](#add_header) +* [`gzip_static`](#gzip_static) +* [`reset_timedout_connection`](#reset_timedout_connection) +* [`fastcgi_index`](#fastcgi_index) +* [`rewrite_rules`](#rewrite_rules) + +##### `ensure` Data type: `Enum['present', 'absent']` @@ -1912,24 +1926,24 @@ Enables or disables the specified location Default value: `'present'` -##### `internal` +##### `internal` Data type: `Boolean` Indicates whether or not this location can be used for internal requests only. Default: false -Default value: `false` +Default value: ``false`` -##### `server` +##### `server` Data type: `Variant[String[1],Array[String[1],1]]` Defines a server or list of servers that include this location -Default value: `undef` +Default value: ``undef`` -##### `location` +##### `location` Data type: `String` @@ -1938,99 +1952,95 @@ entry Default value: `$name` -##### `location_satisfy` +##### `location_satisfy` Data type: `Optional[Enum['any', 'all']]` Allows access if all (all) or at least one (any) of the auth modules allow access. -Default value: `undef` +Default value: ``undef`` -##### `location_allow` +##### `location_allow` Data type: `Optional[Array]` Locations to allow connections from. -Default value: `undef` +Default value: ``undef`` -##### `location_deny` +##### `location_deny` Data type: `Optional[Array]` Locations to deny connections from. -Default value: `undef` +Default value: ``undef`` -##### `www_root` +##### `www_root` Data type: `Optional[String]` Specifies the location on disk for files to be read from. Cannot be set in conjunction with $proxy -Default value: `undef` +Default value: ``undef`` -##### `autoindex` +##### `autoindex` Data type: `Optional[String]` Set it on 'on' to activate autoindex directory listing. -Default value: `undef` +Default value: ``undef`` -##### `autoindex_exact_size` +##### `autoindex_exact_size` Data type: `Optional[Enum['on', 'off']]` Set it on 'on' or 'off' to activate/deactivate autoindex displaying exact filesize, or rounded to kilobytes, megabytes and gigabytes. -Default value: `undef` +Default value: ``undef`` -##### `autoindex_format` +##### `autoindex_format` Data type: `Optional[Enum['html', 'xml', 'json', 'jsonp']]` Sets the format of a directory listing. -Default value: `undef` +Default value: ``undef`` -##### `autoindex_localtime` +##### `autoindex_localtime` Data type: `Optional[Enum['on', 'off']]` Specifies whether times in the directory listing should be output in the local time zone or UTC. -Default value: `undef` +Default value: ``undef`` -##### `index_files` +##### `index_files` Data type: `Array` Default index files for NGINX to read when traversing a directory -Default value: - -```puppet -[ +Default value: `[ 'index.html', 'index.htm', 'index.php', - ] -``` + ]` -##### `proxy` +##### `proxy` Data type: `Optional[String]` Proxy server(s) for a location to connect to. Accepts a single value, can be used in conjunction with nginx::resource::upstream -Default value: `undef` +Default value: ``undef`` -##### `proxy_redirect` +##### `proxy_redirect` Data type: `Optional[String]` @@ -2039,7 +2049,7 @@ sets the text, which must be changed in response-header "Location" and Default value: `$nginx::proxy_redirect` -##### `proxy_read_timeout` +##### `proxy_read_timeout` Data type: `String` @@ -2047,7 +2057,7 @@ Override the default the proxy read timeout value of 90 seconds Default value: `$nginx::proxy_read_timeout` -##### `proxy_connect_timeout` +##### `proxy_connect_timeout` Data type: `String` @@ -2055,7 +2065,7 @@ Override the default the proxy connect timeout value of 90 seconds Default value: `$nginx::proxy_connect_timeout` -##### `proxy_send_timeout` +##### `proxy_send_timeout` Data type: `String` @@ -2064,7 +2074,7 @@ value of 90 seconds Default value: `$nginx::proxy_send_timeout` -##### `proxy_set_header` +##### `proxy_set_header` Data type: `Array` @@ -2072,7 +2082,7 @@ Array of server headers to set Default value: `$nginx::proxy_set_header` -##### `proxy_hide_header` +##### `proxy_hide_header` Data type: `Array` @@ -2080,7 +2090,7 @@ Array of server headers to hide Default value: `$nginx::proxy_hide_header` -##### `proxy_pass_header` +##### `proxy_pass_header` Data type: `Array` @@ -2088,7 +2098,7 @@ Array of server headers to pass Default value: `$nginx::proxy_pass_header` -##### `proxy_ignore_header` +##### `proxy_ignore_header` Data type: `Array` @@ -2096,31 +2106,31 @@ Array of server headers to ignore Default value: `$nginx::proxy_ignore_header` -##### `proxy_next_upstream` +##### `proxy_next_upstream` Data type: `Optional[String]` Specify cases a request should be passed to the next server in the upstream. -Default value: `undef` +Default value: ``undef`` -##### `fastcgi` +##### `fastcgi` Data type: `Optional[String]` location of fastcgi (host:port) -Default value: `undef` +Default value: ``undef`` -##### `fastcgi_param` +##### `fastcgi_param` Data type: `Optional[Hash]` Set additional custom fastcgi_params -Default value: `undef` +Default value: ``undef`` -##### `fastcgi_params` +##### `fastcgi_params` Data type: `String` @@ -2128,40 +2138,40 @@ optional alternative fastcgi_params file to use Default value: `"${nginx::conf_dir}/fastcgi.conf"` -##### `fastcgi_script` +##### `fastcgi_script` Data type: `Optional[String]` optional SCRIPT_FILE parameter -Default value: `undef` +Default value: ``undef`` -##### `fastcgi_split_path` +##### `fastcgi_split_path` Data type: `Optional[String]` Allows settings of fastcgi_split_path_info so that you can split the script_name and path_info via regex -Default value: `undef` +Default value: ``undef`` -##### `uwsgi` +##### `uwsgi` Data type: `Optional[String]` location of uwsgi (host:port) -Default value: `undef` +Default value: ``undef`` -##### `uwsgi_param` +##### `uwsgi_param` Data type: `Optional[Hash]` Set additional custom uwsgi_params -Default value: `undef` +Default value: ``undef`` -##### `uwsgi_params` +##### `uwsgi_params` Data type: `String` @@ -2169,48 +2179,48 @@ optional alternative uwsgi_params file to use Default value: `"${nginx::config::conf_dir}/uwsgi_params"` -##### `uwsgi_read_timeout` +##### `uwsgi_read_timeout` Data type: `Optional[String]` optional value for uwsgi_read_timeout -Default value: `undef` +Default value: ``undef`` -##### `ssl` +##### `ssl` Data type: `Boolean` Indicates whether to setup SSL bindings for this location. -Default value: `false` +Default value: ``false`` -##### `ssl_only` +##### `ssl_only` Data type: `Boolean` Required if the SSL and normal server have the same port. -Default value: `false` +Default value: ``false`` -##### `location_alias` +##### `location_alias` Data type: `Optional[String]` Path to be used as basis for serving requests for this location -Default value: `undef` +Default value: ``undef`` -##### `stub_status` +##### `stub_status` Data type: `Optional[Boolean]` If true it will point configure module stub_status to provide nginx stats on location -Default value: `undef` +Default value: ``undef`` -##### `raw_prepend` +##### `raw_prepend` Data type: `Optional[Variant[String, Array]]` @@ -2218,9 +2228,9 @@ A single string, or an array of strings to prepend to the location directive (after custom_cfg directives). NOTE: YOU are responsible for a semicolon on each line that requires one. -Default value: `undef` +Default value: ``undef`` -##### `raw_append` +##### `raw_append` Data type: `Optional[Variant[String, Array]]` @@ -2228,36 +2238,36 @@ A single string, or an array of strings to append to the location directive (after custom_cfg directives). NOTE: YOU are responsible for a semicolon on each line that requires one. -Default value: `undef` +Default value: ``undef`` -##### `limit_zone` +##### `limit_zone` Data type: `Optional[String[1]]` Apply a limit_req_zone to the location. Expects a string indicating a previously defined limit_req_zone in the main nginx configuration -Default value: `undef` +Default value: ``undef`` -##### `location_custom_cfg` +##### `location_custom_cfg` Data type: `Optional[Hash]` Expects a hash with custom directives, cannot be used with other location types (proxy, fastcgi, root, or stub_status) -Default value: `undef` +Default value: ``undef`` -##### `location_cfg_prepend` +##### `location_cfg_prepend` Data type: `Optional[Hash]` Expects a hash with extra directives to put before anything else inside location (used with all other types except custom_cfg) -Default value: `undef` +Default value: ``undef`` -##### `location_custom_cfg_prepend` +##### `location_custom_cfg_prepend` Data type: `Optional[Hash]` @@ -2265,9 +2275,9 @@ Expects a array with extra directives to put before anything else inside location (used with all other types except custom_cfg). Used for logical structures such as if. -Default value: `undef` +Default value: ``undef`` -##### `location_custom_cfg_append` +##### `location_custom_cfg_append` Data type: `Optional[Hash]` @@ -2275,9 +2285,9 @@ Expects a array with extra directives to put after anything else inside location (used with all other types except custom_cfg). Used for logical structures such as if. -Default value: `undef` +Default value: ``undef`` -##### `location_cfg_append` +##### `location_cfg_append` Data type: `Optional[Hash]` @@ -2285,165 +2295,165 @@ Expects a hash with extra directives to put after everything else inside location (used with all other types except custom_cfg) -Default value: `undef` +Default value: ``undef`` -##### `include` +##### `include` Data type: `Optional[Array]` An array of files to include for this location -Default value: `undef` +Default value: ``undef`` -##### `try_files` +##### `try_files` Data type: `Optional[Array]` An array of file locations to try -Default value: `undef` +Default value: ``undef`` -##### `proxy_cache` +##### `proxy_cache` Data type: `Optional[String]` This directive sets name of zone for caching. The same zone can be used in multiple places. -Default value: `undef` +Default value: ``undef`` -##### `proxy_cache_key` +##### `proxy_cache_key` Data type: `Optional[String]` Override the default proxy_cache_key of $scheme$proxy_host$request_uri -Default value: `undef` +Default value: ``undef`` -##### `proxy_cache_use_stale` +##### `proxy_cache_use_stale` Data type: `Optional[String]` Override the default proxy_cache_use_stale value of off. -Default value: `undef` +Default value: ``undef`` -##### `proxy_cache_valid` +##### `proxy_cache_valid` Data type: `Optional[Variant[Array, String]]` This directive sets the time for caching different replies. -Default value: `undef` +Default value: ``undef`` -##### `proxy_cache_lock` +##### `proxy_cache_lock` Data type: `Optional[Enum['on', 'off']]` This directive sets the locking mechanism for pouplating cache. -Default value: `undef` +Default value: ``undef`` -##### `proxy_cache_bypass` +##### `proxy_cache_bypass` Data type: `Optional[Variant[Array, String]]` Defines conditions which the response will not be cached -Default value: `undef` +Default value: ``undef`` -##### `proxy_method` +##### `proxy_method` Data type: `Optional[String]` If defined, overrides the HTTP method of the request to be passed to the backend. -Default value: `undef` +Default value: ``undef`` -##### `proxy_http_version` +##### `proxy_http_version` Data type: `Optional[String]` Sets the proxy http version -Default value: `undef` +Default value: ``undef`` -##### `proxy_set_body` +##### `proxy_set_body` Data type: `Optional[String]` If defined, sets the body passed to the backend. -Default value: `undef` +Default value: ``undef`` -##### `proxy_buffering` +##### `proxy_buffering` Data type: `Optional[Enum['on', 'off']]` If defined, sets the proxy_buffering to the passed value. -Default value: `undef` +Default value: ``undef`` -##### `proxy_request_buffering` +##### `proxy_request_buffering` Data type: `Optional[Enum['on', 'off']]` If defined, sets the proxy_request_buffering to the passed value. -Default value: `undef` +Default value: ``undef`` -##### `proxy_max_temp_file_size` +##### `proxy_max_temp_file_size` Data type: `Optional[Nginx::Size]` Sets the maximum size of the temporary buffer file. -Default value: `undef` +Default value: ``undef`` -##### `proxy_busy_buffers_size` +##### `proxy_busy_buffers_size` Data type: `Optional[Nginx::Size]` Sets the total size of buffers that can be busy sending a response to the client while the response is not yet fully read. -Default value: `undef` +Default value: ``undef`` -##### `absolute_redirect` +##### `absolute_redirect` Data type: `Optional[Enum['on', 'off']]` Enables or disables the absolute redirect functionality of nginx -Default value: `undef` +Default value: ``undef`` -##### `auth_basic` +##### `auth_basic` Data type: `Optional[String]` This directive includes testing name and password with HTTP Basic Authentication. -Default value: `undef` +Default value: ``undef`` -##### `auth_basic_user_file` +##### `auth_basic_user_file` Data type: `Optional[String]` This directive sets the htpasswd filename for the authentication realm. -Default value: `undef` +Default value: ``undef`` -##### `auth_request` +##### `auth_request` Data type: `Optional[String]` This allows you to specify a custom auth endpoint -Default value: `undef` +Default value: ``undef`` -##### `priority` +##### `priority` Data type: `Integer[401,599]` @@ -2453,33 +2463,33 @@ root, or before root. Default value: `500` -##### `mp4` +##### `mp4` Data type: `Boolean` Indicates whether or not this loation can be used for mp4 streaming. Default: false -Default value: `false` +Default value: ``false`` -##### `flv` +##### `flv` Data type: `Boolean` Indicates whether or not this loation can be used for flv streaming. Default: false -Default value: `false` +Default value: ``false`` -##### `expires` +##### `expires` Data type: `Optional[String]` Setup expires time for locations content -Default value: `undef` +Default value: ``undef`` -##### `add_header` +##### `add_header` Data type: `Hash` @@ -2488,32 +2498,32 @@ no longer inherit headers from the parent server context Default value: `{}` -##### `gzip_static` +##### `gzip_static` Data type: `Optional[Enum['on', 'off', 'always']]` Defines gzip_static, nginx default is off -Default value: `undef` +Default value: ``undef`` -##### `reset_timedout_connection` +##### `reset_timedout_connection` Data type: `Optional[Enum['on', 'off']]` Enables or disables resetting timed out connections and connections closed with the non-standard code 444. -Default value: `undef` +Default value: ``undef`` -##### `fastcgi_index` +##### `fastcgi_index` Data type: `Optional[String]` -Default value: `undef` +Default value: ``undef`` -##### `rewrite_rules` +##### `rewrite_rules` Data type: `Array` @@ -2521,7 +2531,7 @@ Data type: `Array` Default value: `[]` -### `nginx::resource::mailhost` +### `nginx::resource::mailhost` Define a mailhost @@ -2548,52 +2558,52 @@ nginx::resource::mailhost { 'domain1.example': The following parameters are available in the `nginx::resource::mailhost` defined type: -* [`ensure`](#-nginx--resource--mailhost--ensure) -* [`listen_ip`](#-nginx--resource--mailhost--listen_ip) -* [`listen_port`](#-nginx--resource--mailhost--listen_port) -* [`listen_options`](#-nginx--resource--mailhost--listen_options) -* [`ipv6_enable`](#-nginx--resource--mailhost--ipv6_enable) -* [`ipv6_listen_ip`](#-nginx--resource--mailhost--ipv6_listen_ip) -* [`ipv6_listen_port`](#-nginx--resource--mailhost--ipv6_listen_port) -* [`ipv6_listen_options`](#-nginx--resource--mailhost--ipv6_listen_options) -* [`ssl`](#-nginx--resource--mailhost--ssl) -* [`ssl_cert`](#-nginx--resource--mailhost--ssl_cert) -* [`ssl_ciphers`](#-nginx--resource--mailhost--ssl_ciphers) -* [`ssl_client_cert`](#-nginx--resource--mailhost--ssl_client_cert) -* [`ssl_crl`](#-nginx--resource--mailhost--ssl_crl) -* [`ssl_dhparam`](#-nginx--resource--mailhost--ssl_dhparam) -* [`ssl_ecdh_curve`](#-nginx--resource--mailhost--ssl_ecdh_curve) -* [`ssl_key`](#-nginx--resource--mailhost--ssl_key) -* [`ssl_password_file`](#-nginx--resource--mailhost--ssl_password_file) -* [`ssl_port`](#-nginx--resource--mailhost--ssl_port) -* [`ssl_prefer_server_ciphers`](#-nginx--resource--mailhost--ssl_prefer_server_ciphers) -* [`ssl_protocols`](#-nginx--resource--mailhost--ssl_protocols) -* [`ssl_session_cache`](#-nginx--resource--mailhost--ssl_session_cache) -* [`ssl_session_ticket_key`](#-nginx--resource--mailhost--ssl_session_ticket_key) -* [`ssl_session_tickets`](#-nginx--resource--mailhost--ssl_session_tickets) -* [`ssl_session_timeout`](#-nginx--resource--mailhost--ssl_session_timeout) -* [`ssl_trusted_cert`](#-nginx--resource--mailhost--ssl_trusted_cert) -* [`ssl_verify_depth`](#-nginx--resource--mailhost--ssl_verify_depth) -* [`starttls`](#-nginx--resource--mailhost--starttls) -* [`protocol`](#-nginx--resource--mailhost--protocol) -* [`auth_http`](#-nginx--resource--mailhost--auth_http) -* [`xclient`](#-nginx--resource--mailhost--xclient) -* [`imap_auth`](#-nginx--resource--mailhost--imap_auth) -* [`imap_capabilities`](#-nginx--resource--mailhost--imap_capabilities) -* [`imap_client_buffer`](#-nginx--resource--mailhost--imap_client_buffer) -* [`pop3_auth`](#-nginx--resource--mailhost--pop3_auth) -* [`pop3_capabilities`](#-nginx--resource--mailhost--pop3_capabilities) -* [`smtp_auth`](#-nginx--resource--mailhost--smtp_auth) -* [`smtp_capabilities`](#-nginx--resource--mailhost--smtp_capabilities) -* [`proxy_pass_error_message`](#-nginx--resource--mailhost--proxy_pass_error_message) -* [`server_name`](#-nginx--resource--mailhost--server_name) -* [`raw_prepend`](#-nginx--resource--mailhost--raw_prepend) -* [`raw_append`](#-nginx--resource--mailhost--raw_append) -* [`mailhost_cfg_append`](#-nginx--resource--mailhost--mailhost_cfg_append) -* [`mailhost_cfg_prepend`](#-nginx--resource--mailhost--mailhost_cfg_prepend) -* [`auth_http_header`](#-nginx--resource--mailhost--auth_http_header) - -##### `ensure` +* [`ensure`](#ensure) +* [`listen_ip`](#listen_ip) +* [`listen_port`](#listen_port) +* [`listen_options`](#listen_options) +* [`ipv6_enable`](#ipv6_enable) +* [`ipv6_listen_ip`](#ipv6_listen_ip) +* [`ipv6_listen_port`](#ipv6_listen_port) +* [`ipv6_listen_options`](#ipv6_listen_options) +* [`ssl`](#ssl) +* [`ssl_cert`](#ssl_cert) +* [`ssl_ciphers`](#ssl_ciphers) +* [`ssl_client_cert`](#ssl_client_cert) +* [`ssl_crl`](#ssl_crl) +* [`ssl_dhparam`](#ssl_dhparam) +* [`ssl_ecdh_curve`](#ssl_ecdh_curve) +* [`ssl_key`](#ssl_key) +* [`ssl_password_file`](#ssl_password_file) +* [`ssl_port`](#ssl_port) +* [`ssl_prefer_server_ciphers`](#ssl_prefer_server_ciphers) +* [`ssl_protocols`](#ssl_protocols) +* [`ssl_session_cache`](#ssl_session_cache) +* [`ssl_session_ticket_key`](#ssl_session_ticket_key) +* [`ssl_session_tickets`](#ssl_session_tickets) +* [`ssl_session_timeout`](#ssl_session_timeout) +* [`ssl_trusted_cert`](#ssl_trusted_cert) +* [`ssl_verify_depth`](#ssl_verify_depth) +* [`starttls`](#starttls) +* [`protocol`](#protocol) +* [`auth_http`](#auth_http) +* [`xclient`](#xclient) +* [`imap_auth`](#imap_auth) +* [`imap_capabilities`](#imap_capabilities) +* [`imap_client_buffer`](#imap_client_buffer) +* [`pop3_auth`](#pop3_auth) +* [`pop3_capabilities`](#pop3_capabilities) +* [`smtp_auth`](#smtp_auth) +* [`smtp_capabilities`](#smtp_capabilities) +* [`proxy_pass_error_message`](#proxy_pass_error_message) +* [`server_name`](#server_name) +* [`raw_prepend`](#raw_prepend) +* [`raw_append`](#raw_append) +* [`mailhost_cfg_append`](#mailhost_cfg_append) +* [`mailhost_cfg_prepend`](#mailhost_cfg_prepend) +* [`auth_http_header`](#auth_http_header) + +##### `ensure` Data type: `Enum['absent', 'present']` @@ -2601,7 +2611,7 @@ Enables or disables the specified mailhost Default value: `'present'` -##### `listen_ip` +##### `listen_ip` Data type: `Variant[Array[String], String]` @@ -2609,30 +2619,30 @@ Default IP Address for NGINX to listen with this server on. Defaults to all inte Default value: `'*'` -##### `listen_port` +##### `listen_port` Data type: `Stdlib::Port` Default IP Port for NGINX to listen with this server on. -##### `listen_options` +##### `listen_options` Data type: `Optional[String]` Extra options for listen directive like 'default' to catchall. -Default value: `undef` +Default value: ``undef`` -##### `ipv6_enable` +##### `ipv6_enable` Data type: `Boolean` value to enable/disable IPv6 support (false|true). Module will check to see if IPv6 support exists on your system before enabling. -Default value: `false` +Default value: ``false`` -##### `ipv6_listen_ip` +##### `ipv6_listen_ip` Data type: `Variant[Array[String], String]` @@ -2641,7 +2651,7 @@ all interfaces (::) Default value: `'::'` -##### `ipv6_listen_port` +##### `ipv6_listen_port` Data type: `Stdlib::Port` @@ -2649,7 +2659,7 @@ Default IPv6 Port for NGINX to listen with this server on. Default value: `$listen_port` -##### `ipv6_listen_options` +##### `ipv6_listen_options` Data type: `String` @@ -2657,24 +2667,24 @@ Extra options for listen directive like 'default' to catchall. Default value: `'default ipv6only=on'` -##### `ssl` +##### `ssl` Data type: `Boolean` Indicates whether to setup SSL bindings for this mailhost. -Default value: `false` +Default value: ``false`` -##### `ssl_cert` +##### `ssl_cert` Data type: `Optional[String]` Pre-generated SSL Certificate file to reference for SSL Support. This is not generated by this module. -Default value: `undef` +Default value: ``undef`` -##### `ssl_ciphers` +##### `ssl_ciphers` Data type: `String` @@ -2682,24 +2692,24 @@ Override default SSL ciphers. Default value: `$nginx::ssl_ciphers` -##### `ssl_client_cert` +##### `ssl_client_cert` Data type: `Optional[String]` Pre-generated SSL Certificate file to reference for client verify SSL Support. This is not generated by this module. -Default value: `undef` +Default value: ``undef`` -##### `ssl_crl` +##### `ssl_crl` Data type: `Optional[String]` String: Specifies CRL path in file system -Default value: `undef` +Default value: ``undef`` -##### `ssl_dhparam` +##### `ssl_dhparam` Data type: `Optional[String]` @@ -2709,40 +2719,40 @@ session keys between server and client. Default value: `$nginx::ssl_dhparam` -##### `ssl_ecdh_curve` +##### `ssl_ecdh_curve` Data type: `Optional[String]` This directive specifies a curve for ECDHE ciphers. -Default value: `undef` +Default value: ``undef`` -##### `ssl_key` +##### `ssl_key` Data type: `Optional[String]` Pre-generated SSL Key file to reference for SSL Support. This is not generated by this module. -Default value: `undef` +Default value: ``undef`` -##### `ssl_password_file` +##### `ssl_password_file` Data type: `Optional[String]` This directive specifies a file containing passphrases for secret keys. -Default value: `undef` +Default value: ``undef`` -##### `ssl_port` +##### `ssl_port` Data type: `Optional[Stdlib::Port]` Default IP Port for NGINX to listen with this SSL server on. -Default value: `undef` +Default value: ``undef`` -##### `ssl_prefer_server_ciphers` +##### `ssl_prefer_server_ciphers` Data type: `Enum['on', 'off']` @@ -2751,7 +2761,7 @@ using the SSLv3 and TLS protocols. Default value: `$nginx::ssl_prefer_server_ciphers` -##### `ssl_protocols` +##### `ssl_protocols` Data type: `String` @@ -2759,32 +2769,32 @@ SSL protocols enabled. Default value: `$nginx::ssl_protocols` -##### `ssl_session_cache` +##### `ssl_session_cache` Data type: `Optional[String]` Sets the type and size of the session cache. -Default value: `undef` +Default value: ``undef`` -##### `ssl_session_ticket_key` +##### `ssl_session_ticket_key` Data type: `Optional[String]` This directive specifies a file containing secret key used to encrypt and decrypt TLS session tickets. -Default value: `undef` +Default value: ``undef`` -##### `ssl_session_tickets` +##### `ssl_session_tickets` Data type: `Optional[String]` Whether to enable or disable session resumption through TLS session tickets. -Default value: `undef` +Default value: ``undef`` -##### `ssl_session_timeout` +##### `ssl_session_timeout` Data type: `String` @@ -2793,24 +2803,24 @@ stored in a cache. Default value: `'5m'` -##### `ssl_trusted_cert` +##### `ssl_trusted_cert` Data type: `Optional[String]` Specifies a file with trusted CA certificates in the PEM format used to verify client certificates and OCSP responses if ssl_stapling is enabled. -Default value: `undef` +Default value: ``undef`` -##### `ssl_verify_depth` +##### `ssl_verify_depth` Data type: `Optional[Integer]` Sets the verification depth in the client certificates chain. -Default value: `undef` +Default value: ``undef`` -##### `starttls` +##### `starttls` Data type: `Enum['on', 'off', 'only']` @@ -2818,24 +2828,24 @@ Enable STARTTLS support Default value: `'off'` -##### `protocol` +##### `protocol` Data type: `Optional[Enum['imap', 'pop3', 'sieve', 'smtp']]` Mail protocol to use -Default value: `undef` +Default value: ``undef`` -##### `auth_http` +##### `auth_http` Data type: `Optional[String]` With this directive you can set the URL to the external HTTP-like server for authorization. -Default value: `undef` +Default value: ``undef`` -##### `xclient` +##### `xclient` Data type: `Enum['on', 'off']` @@ -2843,66 +2853,66 @@ Whether to use xclient for smtp Default value: `'on'` -##### `imap_auth` +##### `imap_auth` Data type: `Optional[String]` Sets permitted methods of authentication for IMAP clients. -Default value: `undef` +Default value: ``undef`` -##### `imap_capabilities` +##### `imap_capabilities` Data type: `Optional[Array]` Sets the IMAP protocol extensions list that is passed to the client in response to the CAPA command. -Default value: `undef` +Default value: ``undef`` -##### `imap_client_buffer` +##### `imap_client_buffer` Data type: `Optional[String]` Sets the IMAP commands read buffer size. -Default value: `undef` +Default value: ``undef`` -##### `pop3_auth` +##### `pop3_auth` Data type: `Optional[String]` Sets permitted methods of authentication for POP3 clients. -Default value: `undef` +Default value: ``undef`` -##### `pop3_capabilities` +##### `pop3_capabilities` Data type: `Optional[Array]` Sets the POP3 protocol extensions list that is passed to the client in response to the CAPA command. -Default value: `undef` +Default value: ``undef`` -##### `smtp_auth` +##### `smtp_auth` Data type: `Optional[String]` Sets permitted methods of SASL authentication for SMTP clients. -Default value: `undef` +Default value: ``undef`` -##### `smtp_capabilities` +##### `smtp_capabilities` Data type: `Optional[Array]` Sets the SMTP protocol extensions list that is passed to the client in response to the EHLO command. -Default value: `undef` +Default value: ``undef`` -##### `proxy_pass_error_message` +##### `proxy_pass_error_message` Data type: `String` @@ -2911,7 +2921,7 @@ authentication on the backend to the client. Default value: `'off'` -##### `server_name` +##### `server_name` Data type: `Array` @@ -2919,7 +2929,7 @@ List of mailhostnames for which this mailhost will respond. Default value: `[$name]` -##### `raw_prepend` +##### `raw_prepend` Data type: `Optional[Variant[Array, String]]` @@ -2927,9 +2937,9 @@ A single string, or an array of strings to prepend to the server directive (after mailhost_cfg_prepend directive). NOTE: YOU are responsible for a semicolon on each line that requires one. -Default value: `undef` +Default value: ``undef`` -##### `raw_append` +##### `raw_append` Data type: `Optional[Variant[Array, String]]` @@ -2937,35 +2947,35 @@ A single string, or an array of strings to append to the server directive (after mailhost_cfg_append directive). NOTE: YOU are responsible for a semicolon on each line that requires one. -Default value: `undef` +Default value: ``undef`` -##### `mailhost_cfg_append` +##### `mailhost_cfg_append` Data type: `Optional[Hash]` It expects a hash with custom directives to put after everything else inside server -Default value: `undef` +Default value: ``undef`` -##### `mailhost_cfg_prepend` +##### `mailhost_cfg_prepend` Data type: `Optional[Hash]` It expects a hash with custom directives to put before everything else inside server -Default value: `undef` +Default value: ``undef`` -##### `auth_http_header` +##### `auth_http_header` Data type: `Optional[String]` -Default value: `undef` +Default value: ``undef`` -### `nginx::resource::map` +### `nginx::resource::map` Create a new mapping entry for NGINX @@ -3037,15 +3047,15 @@ nginx::string_mappings: The following parameters are available in the `nginx::resource::map` defined type: -* [`ensure`](#-nginx--resource--map--ensure) -* [`default`](#-nginx--resource--map--default) -* [`string`](#-nginx--resource--map--string) -* [`mappings`](#-nginx--resource--map--mappings) -* [`hostnames`](#-nginx--resource--map--hostnames) -* [`include_files`](#-nginx--resource--map--include_files) -* [`context`](#-nginx--resource--map--context) +* [`ensure`](#ensure) +* [`default`](#default) +* [`string`](#string) +* [`mappings`](#mappings) +* [`hostnames`](#hostnames) +* [`include_files`](#include_files) +* [`context`](#context) -##### `ensure` +##### `ensure` Data type: `Enum['absent', 'present']` @@ -3053,36 +3063,36 @@ Enables or disables the specified location Default value: `'present'` -##### `default` +##### `default` Data type: `Optional[String]` Sets the resulting value if the source values fails to match any of the variants. -Default value: `undef` +Default value: ``undef`` -##### `string` +##### `string` Data type: `String[2]` Source string or variable to provide mapping for -##### `mappings` +##### `mappings` Data type: `Variant[Array, Hash]` Hash of map lookup keys and resultant values -##### `hostnames` +##### `hostnames` Data type: `Boolean` Indicates that source values can be hostnames with a prefix or suffix mask. -Default value: `false` +Default value: ``false`` -##### `include_files` +##### `include_files` Data type: `Array[String]` @@ -3090,7 +3100,7 @@ An array of external files to include Default value: `[]` -##### `context` +##### `context` Data type: `Enum['http', 'stream']` @@ -3098,7 +3108,7 @@ Specify if mapping is for http or stream context Default value: `'http'` -### `nginx::resource::server` +### `nginx::resource::server` Create a virtual host @@ -3120,137 +3130,137 @@ nginx::resource::server { 'test2.local': The following parameters are available in the `nginx::resource::server` defined type: -* [`ensure`](#-nginx--resource--server--ensure) -* [`listen_ip`](#-nginx--resource--server--listen_ip) -* [`listen_port`](#-nginx--resource--server--listen_port) -* [`listen_options`](#-nginx--resource--server--listen_options) -* [`listen_unix_socket_enable`](#-nginx--resource--server--listen_unix_socket_enable) -* [`listen_unix_socket`](#-nginx--resource--server--listen_unix_socket) -* [`listen_unix_socket_options`](#-nginx--resource--server--listen_unix_socket_options) -* [`location_satisfy`](#-nginx--resource--server--location_satisfy) -* [`location_allow`](#-nginx--resource--server--location_allow) -* [`location_deny`](#-nginx--resource--server--location_deny) -* [`ipv6_enable`](#-nginx--resource--server--ipv6_enable) -* [`ipv6_listen_ip`](#-nginx--resource--server--ipv6_listen_ip) -* [`ipv6_listen_port`](#-nginx--resource--server--ipv6_listen_port) -* [`ipv6_listen_options`](#-nginx--resource--server--ipv6_listen_options) -* [`add_header`](#-nginx--resource--server--add_header) -* [`index_files`](#-nginx--resource--server--index_files) -* [`autoindex`](#-nginx--resource--server--autoindex) -* [`autoindex_exact_size`](#-nginx--resource--server--autoindex_exact_size) -* [`autoindex_format`](#-nginx--resource--server--autoindex_format) -* [`autoindex_localtime`](#-nginx--resource--server--autoindex_localtime) -* [`reset_timedout_connection`](#-nginx--resource--server--reset_timedout_connection) -* [`proxy`](#-nginx--resource--server--proxy) -* [`proxy_read_timeout`](#-nginx--resource--server--proxy_read_timeout) -* [`proxy_send_timeout`](#-nginx--resource--server--proxy_send_timeout) -* [`proxy_redirect`](#-nginx--resource--server--proxy_redirect) -* [`proxy_buffering`](#-nginx--resource--server--proxy_buffering) -* [`proxy_request_buffering`](#-nginx--resource--server--proxy_request_buffering) -* [`proxy_max_temp_file_size`](#-nginx--resource--server--proxy_max_temp_file_size) -* [`proxy_busy_buffers_size`](#-nginx--resource--server--proxy_busy_buffers_size) -* [`resolver`](#-nginx--resource--server--resolver) -* [`fastcgi`](#-nginx--resource--server--fastcgi) -* [`fastcgi_param`](#-nginx--resource--server--fastcgi_param) -* [`fastcgi_params`](#-nginx--resource--server--fastcgi_params) -* [`fastcgi_index`](#-nginx--resource--server--fastcgi_index) -* [`fastcgi_script`](#-nginx--resource--server--fastcgi_script) -* [`uwsgi_read_timeout`](#-nginx--resource--server--uwsgi_read_timeout) -* [`ssl`](#-nginx--resource--server--ssl) -* [`ssl_cert`](#-nginx--resource--server--ssl_cert) -* [`ssl_client_cert`](#-nginx--resource--server--ssl_client_cert) -* [`ssl_verify_client`](#-nginx--resource--server--ssl_verify_client) -* [`ssl_crl`](#-nginx--resource--server--ssl_crl) -* [`ssl_dhparam`](#-nginx--resource--server--ssl_dhparam) -* [`ssl_ecdh_curve`](#-nginx--resource--server--ssl_ecdh_curve) -* [`ssl_prefer_server_ciphers`](#-nginx--resource--server--ssl_prefer_server_ciphers) -* [`ssl_redirect`](#-nginx--resource--server--ssl_redirect) -* [`ssl_redirect_port`](#-nginx--resource--server--ssl_redirect_port) -* [`ssl_key`](#-nginx--resource--server--ssl_key) -* [`ssl_port`](#-nginx--resource--server--ssl_port) -* [`ssl_protocols`](#-nginx--resource--server--ssl_protocols) -* [`ssl_buffer_size`](#-nginx--resource--server--ssl_buffer_size) -* [`ssl_ciphers`](#-nginx--resource--server--ssl_ciphers) -* [`ssl_stapling`](#-nginx--resource--server--ssl_stapling) -* [`ssl_stapling_file`](#-nginx--resource--server--ssl_stapling_file) -* [`ssl_stapling_responder`](#-nginx--resource--server--ssl_stapling_responder) -* [`ssl_stapling_verify`](#-nginx--resource--server--ssl_stapling_verify) -* [`ssl_session_timeout`](#-nginx--resource--server--ssl_session_timeout) -* [`ssl_session_tickets`](#-nginx--resource--server--ssl_session_tickets) -* [`ssl_session_ticket_key`](#-nginx--resource--server--ssl_session_ticket_key) -* [`ssl_trusted_cert`](#-nginx--resource--server--ssl_trusted_cert) -* [`ssl_verify_depth`](#-nginx--resource--server--ssl_verify_depth) -* [`ssl_password_file`](#-nginx--resource--server--ssl_password_file) -* [`spdy`](#-nginx--resource--server--spdy) -* [`http2`](#-nginx--resource--server--http2) -* [`server_name`](#-nginx--resource--server--server_name) -* [`www_root`](#-nginx--resource--server--www_root) -* [`rewrite_www_to_non_www`](#-nginx--resource--server--rewrite_www_to_non_www) -* [`rewrite_non_www_to_www`](#-nginx--resource--server--rewrite_non_www_to_www) -* [`try_files`](#-nginx--resource--server--try_files) -* [`proxy_cache`](#-nginx--resource--server--proxy_cache) -* [`proxy_cache_key`](#-nginx--resource--server--proxy_cache_key) -* [`proxy_cache_use_stale`](#-nginx--resource--server--proxy_cache_use_stale) -* [`proxy_cache_valid`](#-nginx--resource--server--proxy_cache_valid) -* [`proxy_cache_lock`](#-nginx--resource--server--proxy_cache_lock) -* [`proxy_cache_bypass`](#-nginx--resource--server--proxy_cache_bypass) -* [`proxy_method`](#-nginx--resource--server--proxy_method) -* [`proxy_http_version`](#-nginx--resource--server--proxy_http_version) -* [`proxy_set_body`](#-nginx--resource--server--proxy_set_body) -* [`absolute_redirect`](#-nginx--resource--server--absolute_redirect) -* [`auth_basic`](#-nginx--resource--server--auth_basic) -* [`auth_basic_user_file`](#-nginx--resource--server--auth_basic_user_file) -* [`auth_request`](#-nginx--resource--server--auth_request) -* [`client_max_body_size`](#-nginx--resource--server--client_max_body_size) -* [`client_body_timeout`](#-nginx--resource--server--client_body_timeout) -* [`client_header_timeout`](#-nginx--resource--server--client_header_timeout) -* [`raw_prepend`](#-nginx--resource--server--raw_prepend) -* [`raw_append`](#-nginx--resource--server--raw_append) -* [`location_raw_prepend`](#-nginx--resource--server--location_raw_prepend) -* [`location_raw_append`](#-nginx--resource--server--location_raw_append) -* [`server_cfg_append`](#-nginx--resource--server--server_cfg_append) -* [`server_cfg_prepend`](#-nginx--resource--server--server_cfg_prepend) -* [`server_cfg_ssl_append`](#-nginx--resource--server--server_cfg_ssl_append) -* [`server_cfg_ssl_prepend`](#-nginx--resource--server--server_cfg_ssl_prepend) -* [`include_files`](#-nginx--resource--server--include_files) -* [`access_log`](#-nginx--resource--server--access_log) -* [`error_log`](#-nginx--resource--server--error_log) -* [`passenger_cgi_param`](#-nginx--resource--server--passenger_cgi_param) -* [`passenger_set_header`](#-nginx--resource--server--passenger_set_header) -* [`passenger_env_var`](#-nginx--resource--server--passenger_env_var) -* [`passenger_pre_start`](#-nginx--resource--server--passenger_pre_start) -* [`log_by_lua`](#-nginx--resource--server--log_by_lua) -* [`log_by_lua_file`](#-nginx--resource--server--log_by_lua_file) -* [`gzip_types`](#-nginx--resource--server--gzip_types) -* [`gzip_static`](#-nginx--resource--server--gzip_static) -* [`owner`](#-nginx--resource--server--owner) -* [`group`](#-nginx--resource--server--group) -* [`mode`](#-nginx--resource--server--mode) -* [`maintenance`](#-nginx--resource--server--maintenance) -* [`maintenance_value`](#-nginx--resource--server--maintenance_value) -* [`error_pages`](#-nginx--resource--server--error_pages) -* [`locations`](#-nginx--resource--server--locations) -* [`locations_defaults`](#-nginx--resource--server--locations_defaults) -* [`ssl_listen_option`](#-nginx--resource--server--ssl_listen_option) -* [`ssl_cache`](#-nginx--resource--server--ssl_cache) -* [`proxy_connect_timeout`](#-nginx--resource--server--proxy_connect_timeout) -* [`proxy_set_header`](#-nginx--resource--server--proxy_set_header) -* [`proxy_hide_header`](#-nginx--resource--server--proxy_hide_header) -* [`proxy_pass_header`](#-nginx--resource--server--proxy_pass_header) -* [`uwsgi`](#-nginx--resource--server--uwsgi) -* [`uwsgi_params`](#-nginx--resource--server--uwsgi_params) -* [`location_custom_cfg`](#-nginx--resource--server--location_custom_cfg) -* [`location_cfg_prepend`](#-nginx--resource--server--location_cfg_prepend) -* [`location_cfg_append`](#-nginx--resource--server--location_cfg_append) -* [`location_custom_cfg_prepend`](#-nginx--resource--server--location_custom_cfg_prepend) -* [`location_custom_cfg_append`](#-nginx--resource--server--location_custom_cfg_append) -* [`format_log`](#-nginx--resource--server--format_log) -* [`use_default_location`](#-nginx--resource--server--use_default_location) -* [`rewrite_rules`](#-nginx--resource--server--rewrite_rules) -* [`string_mappings`](#-nginx--resource--server--string_mappings) -* [`geo_mappings`](#-nginx--resource--server--geo_mappings) - -##### `ensure` +* [`ensure`](#ensure) +* [`listen_ip`](#listen_ip) +* [`listen_port`](#listen_port) +* [`listen_options`](#listen_options) +* [`listen_unix_socket_enable`](#listen_unix_socket_enable) +* [`listen_unix_socket`](#listen_unix_socket) +* [`listen_unix_socket_options`](#listen_unix_socket_options) +* [`location_satisfy`](#location_satisfy) +* [`location_allow`](#location_allow) +* [`location_deny`](#location_deny) +* [`ipv6_enable`](#ipv6_enable) +* [`ipv6_listen_ip`](#ipv6_listen_ip) +* [`ipv6_listen_port`](#ipv6_listen_port) +* [`ipv6_listen_options`](#ipv6_listen_options) +* [`add_header`](#add_header) +* [`index_files`](#index_files) +* [`autoindex`](#autoindex) +* [`autoindex_exact_size`](#autoindex_exact_size) +* [`autoindex_format`](#autoindex_format) +* [`autoindex_localtime`](#autoindex_localtime) +* [`reset_timedout_connection`](#reset_timedout_connection) +* [`proxy`](#proxy) +* [`proxy_read_timeout`](#proxy_read_timeout) +* [`proxy_send_timeout`](#proxy_send_timeout) +* [`proxy_redirect`](#proxy_redirect) +* [`proxy_buffering`](#proxy_buffering) +* [`proxy_request_buffering`](#proxy_request_buffering) +* [`proxy_max_temp_file_size`](#proxy_max_temp_file_size) +* [`proxy_busy_buffers_size`](#proxy_busy_buffers_size) +* [`resolver`](#resolver) +* [`fastcgi`](#fastcgi) +* [`fastcgi_param`](#fastcgi_param) +* [`fastcgi_params`](#fastcgi_params) +* [`fastcgi_index`](#fastcgi_index) +* [`fastcgi_script`](#fastcgi_script) +* [`uwsgi_read_timeout`](#uwsgi_read_timeout) +* [`ssl`](#ssl) +* [`ssl_cert`](#ssl_cert) +* [`ssl_client_cert`](#ssl_client_cert) +* [`ssl_verify_client`](#ssl_verify_client) +* [`ssl_crl`](#ssl_crl) +* [`ssl_dhparam`](#ssl_dhparam) +* [`ssl_ecdh_curve`](#ssl_ecdh_curve) +* [`ssl_prefer_server_ciphers`](#ssl_prefer_server_ciphers) +* [`ssl_redirect`](#ssl_redirect) +* [`ssl_redirect_port`](#ssl_redirect_port) +* [`ssl_key`](#ssl_key) +* [`ssl_port`](#ssl_port) +* [`ssl_protocols`](#ssl_protocols) +* [`ssl_buffer_size`](#ssl_buffer_size) +* [`ssl_ciphers`](#ssl_ciphers) +* [`ssl_stapling`](#ssl_stapling) +* [`ssl_stapling_file`](#ssl_stapling_file) +* [`ssl_stapling_responder`](#ssl_stapling_responder) +* [`ssl_stapling_verify`](#ssl_stapling_verify) +* [`ssl_session_timeout`](#ssl_session_timeout) +* [`ssl_session_tickets`](#ssl_session_tickets) +* [`ssl_session_ticket_key`](#ssl_session_ticket_key) +* [`ssl_trusted_cert`](#ssl_trusted_cert) +* [`ssl_verify_depth`](#ssl_verify_depth) +* [`ssl_password_file`](#ssl_password_file) +* [`spdy`](#spdy) +* [`http2`](#http2) +* [`server_name`](#server_name) +* [`www_root`](#www_root) +* [`rewrite_www_to_non_www`](#rewrite_www_to_non_www) +* [`rewrite_non_www_to_www`](#rewrite_non_www_to_www) +* [`try_files`](#try_files) +* [`proxy_cache`](#proxy_cache) +* [`proxy_cache_key`](#proxy_cache_key) +* [`proxy_cache_use_stale`](#proxy_cache_use_stale) +* [`proxy_cache_valid`](#proxy_cache_valid) +* [`proxy_cache_lock`](#proxy_cache_lock) +* [`proxy_cache_bypass`](#proxy_cache_bypass) +* [`proxy_method`](#proxy_method) +* [`proxy_http_version`](#proxy_http_version) +* [`proxy_set_body`](#proxy_set_body) +* [`absolute_redirect`](#absolute_redirect) +* [`auth_basic`](#auth_basic) +* [`auth_basic_user_file`](#auth_basic_user_file) +* [`auth_request`](#auth_request) +* [`client_max_body_size`](#client_max_body_size) +* [`client_body_timeout`](#client_body_timeout) +* [`client_header_timeout`](#client_header_timeout) +* [`raw_prepend`](#raw_prepend) +* [`raw_append`](#raw_append) +* [`location_raw_prepend`](#location_raw_prepend) +* [`location_raw_append`](#location_raw_append) +* [`server_cfg_append`](#server_cfg_append) +* [`server_cfg_prepend`](#server_cfg_prepend) +* [`server_cfg_ssl_append`](#server_cfg_ssl_append) +* [`server_cfg_ssl_prepend`](#server_cfg_ssl_prepend) +* [`include_files`](#include_files) +* [`access_log`](#access_log) +* [`error_log`](#error_log) +* [`passenger_cgi_param`](#passenger_cgi_param) +* [`passenger_set_header`](#passenger_set_header) +* [`passenger_env_var`](#passenger_env_var) +* [`passenger_pre_start`](#passenger_pre_start) +* [`log_by_lua`](#log_by_lua) +* [`log_by_lua_file`](#log_by_lua_file) +* [`gzip_types`](#gzip_types) +* [`gzip_static`](#gzip_static) +* [`owner`](#owner) +* [`group`](#group) +* [`mode`](#mode) +* [`maintenance`](#maintenance) +* [`maintenance_value`](#maintenance_value) +* [`error_pages`](#error_pages) +* [`locations`](#locations) +* [`locations_defaults`](#locations_defaults) +* [`ssl_listen_option`](#ssl_listen_option) +* [`ssl_cache`](#ssl_cache) +* [`proxy_connect_timeout`](#proxy_connect_timeout) +* [`proxy_set_header`](#proxy_set_header) +* [`proxy_hide_header`](#proxy_hide_header) +* [`proxy_pass_header`](#proxy_pass_header) +* [`uwsgi`](#uwsgi) +* [`uwsgi_params`](#uwsgi_params) +* [`location_custom_cfg`](#location_custom_cfg) +* [`location_cfg_prepend`](#location_cfg_prepend) +* [`location_cfg_append`](#location_cfg_append) +* [`location_custom_cfg_prepend`](#location_custom_cfg_prepend) +* [`location_custom_cfg_append`](#location_custom_cfg_append) +* [`format_log`](#format_log) +* [`use_default_location`](#use_default_location) +* [`rewrite_rules`](#rewrite_rules) +* [`string_mappings`](#string_mappings) +* [`geo_mappings`](#geo_mappings) + +##### `ensure` Data type: `Enum['absent', 'present']` @@ -3258,7 +3268,7 @@ Enables or disables the specified server Default value: `'present'` -##### `listen_ip` +##### `listen_ip` Data type: `Variant[Array, String]` @@ -3267,7 +3277,7 @@ interfaces (*) Default value: `'*'` -##### `listen_port` +##### `listen_port` Data type: `Stdlib::Port` @@ -3275,23 +3285,23 @@ Default TCP Port for NGINX to listen with this server on. Default value: `80` -##### `listen_options` +##### `listen_options` Data type: `Optional[String]` Extra options for listen directive like 'default_server' to catchall. -Default value: `undef` +Default value: ``undef`` -##### `listen_unix_socket_enable` +##### `listen_unix_socket_enable` Data type: `Boolean` value to enable/disable UNIX socket listening support. -Default value: `false` +Default value: ``false`` -##### `listen_unix_socket` +##### `listen_unix_socket` Data type: `Variant[Array[Stdlib::Absolutepath], Stdlib::Absolutepath]` @@ -3299,24 +3309,24 @@ Default unix socket for NGINX to listen with this server on. Default value: `'/var/run/nginx.sock'` -##### `listen_unix_socket_options` +##### `listen_unix_socket_options` Data type: `Optional[String]` Extra options for listen directive like 'default' to catchall. -Default value: `undef` +Default value: ``undef`` -##### `location_satisfy` +##### `location_satisfy` Data type: `Optional[Enum['any', 'all']]` Allows access if all (all) or at least one (any) of the auth modules allow access. -Default value: `undef` +Default value: ``undef`` -##### `location_allow` +##### `location_allow` Data type: `Array` @@ -3324,7 +3334,7 @@ Locations to allow connections from. Default value: `[]` -##### `location_deny` +##### `location_deny` Data type: `Array` @@ -3332,16 +3342,16 @@ Locations to deny connections from. Default value: `[]` -##### `ipv6_enable` +##### `ipv6_enable` Data type: `Boolean` value to enable/disable IPv6 support (false|true). Module will check to see if IPv6 support exists on your system before enabling. -Default value: `false` +Default value: ``false`` -##### `ipv6_listen_ip` +##### `ipv6_listen_ip` Data type: `Variant[Array, String]` @@ -3349,7 +3359,7 @@ Default IPv6 Address for NGINX to listen with this server on. Defaults to all in Default value: `'::'` -##### `ipv6_listen_port` +##### `ipv6_listen_port` Data type: `Stdlib::Port` @@ -3357,7 +3367,7 @@ Default IPv6 Port for NGINX to listen with this server on. Defaults to TCP 80 Default value: `$listen_port` -##### `ipv6_listen_options` +##### `ipv6_listen_options` Data type: `String` @@ -3365,7 +3375,7 @@ Extra options for listen directive like 'default' to catchall. Default value: `'default ipv6only=on'` -##### `add_header` +##### `add_header` Data type: `Hash` @@ -3374,75 +3384,71 @@ Adds headers to the HTTP response when response code is equal to 200, 204, Default value: `{}` -##### `index_files` +##### `index_files` Data type: `Array` Default index files for NGINX to read when traversing a directory -Default value: - -```puppet -[ +Default value: `[ 'index.html', 'index.htm', 'index.php', - ] -``` + ]` -##### `autoindex` +##### `autoindex` Data type: `Optional[String]` Set it on 'on' or 'off 'to activate/deactivate autoindex directory listing. -Default value: `undef` +Default value: ``undef`` -##### `autoindex_exact_size` +##### `autoindex_exact_size` Data type: `Optional[Enum['on', 'off']]` Set it on 'on' or 'off' to activate/deactivate autoindex displaying exact filesize, or rounded to kilobytes, megabytes and gigabytes. -Default value: `undef` +Default value: ``undef`` -##### `autoindex_format` +##### `autoindex_format` Data type: `Optional[Enum['html', 'xml', 'json', 'jsonp']]` Sets the format of a directory listing. -Default value: `undef` +Default value: ``undef`` -##### `autoindex_localtime` +##### `autoindex_localtime` Data type: `Optional[Enum['on', 'off']]` Specifies whether times in the directory listing should be output in the local time zone or UTC. -Default value: `undef` +Default value: ``undef`` -##### `reset_timedout_connection` +##### `reset_timedout_connection` Data type: `Optional[Enum['on', 'off']]` Enables or disables resetting timed out connections and connections closed with the non-standard code 444. -Default value: `undef` +Default value: ``undef`` -##### `proxy` +##### `proxy` Data type: `Optional[String]` Proxy server(s) for the root location to connect to. Accepts a single value, can be used in conjunction with nginx::resource::upstream -Default value: `undef` +Default value: ``undef`` -##### `proxy_read_timeout` +##### `proxy_read_timeout` Data type: `String` @@ -3450,7 +3456,7 @@ Override the default proxy read timeout value of 90 seconds Default value: `$nginx::proxy_read_timeout` -##### `proxy_send_timeout` +##### `proxy_send_timeout` Data type: `String` @@ -3458,48 +3464,48 @@ Override the default proxy send timeout value of 90 seconds Default value: `$nginx::proxy_send_timeout` -##### `proxy_redirect` +##### `proxy_redirect` Data type: `Optional[String]` Override the default proxy_redirect value of off. -Default value: `undef` +Default value: ``undef`` -##### `proxy_buffering` +##### `proxy_buffering` Data type: `Optional[String]` If defined, sets the proxy_buffering to the passed value. -Default value: `undef` +Default value: ``undef`` -##### `proxy_request_buffering` +##### `proxy_request_buffering` Data type: `Optional[String]` If defined, sets the proxy_request_buffering to the passed value. -Default value: `undef` +Default value: ``undef`` -##### `proxy_max_temp_file_size` +##### `proxy_max_temp_file_size` Data type: `Optional[Nginx::Size]` Sets the maximum size of the temporary buffer file. -Default value: `undef` +Default value: ``undef`` -##### `proxy_busy_buffers_size` +##### `proxy_busy_buffers_size` Data type: `Optional[Nginx::Size]` Sets the total size of buffers that can be busy sending a response to the client while the response is not yet fully read. -Default value: `undef` +Default value: ``undef`` -##### `resolver` +##### `resolver` Data type: `Array` @@ -3507,23 +3513,23 @@ Configures name servers used to resolve names of upstream servers into addresses Default value: `[]` -##### `fastcgi` +##### `fastcgi` Data type: `Optional[String]` location of fastcgi (host:port) -Default value: `undef` +Default value: ``undef`` -##### `fastcgi_param` +##### `fastcgi_param` Data type: `Any` Set additional custom fastcgi_params -Default value: `undef` +Default value: ``undef`` -##### `fastcgi_params` +##### `fastcgi_params` Data type: `String` @@ -3531,39 +3537,39 @@ optional alternative fastcgi_params file to use Default value: `"${nginx::conf_dir}/fastcgi.conf"` -##### `fastcgi_index` +##### `fastcgi_index` Data type: `Optional[String]` optional FastCGI index page -Default value: `undef` +Default value: ``undef`` -##### `fastcgi_script` +##### `fastcgi_script` Data type: `Optional[String]` optional SCRIPT_FILE parameter -Default value: `undef` +Default value: ``undef`` -##### `uwsgi_read_timeout` +##### `uwsgi_read_timeout` Data type: `Optional[String]` optional value for uwsgi_read_timeout -Default value: `undef` +Default value: ``undef`` -##### `ssl` +##### `ssl` Data type: `Boolean` Indicates whether to setup SSL bindings for this server. -Default value: `false` +Default value: ``false`` -##### `ssl_cert` +##### `ssl_cert` Data type: `Optional[Variant[String, Boolean, Array[String]]]` @@ -3572,18 +3578,18 @@ not generated by this module. Set to `false` to inherit from the http section, which improves performance by conserving memory. Use an array to add multiple SSL Certificates. -Default value: `undef` +Default value: ``undef`` -##### `ssl_client_cert` +##### `ssl_client_cert` Data type: `Optional[String]` Pre-generated SSL Certificate file to reference for client verify SSL Support. This is not generated by this module. -Default value: `undef` +Default value: ``undef`` -##### `ssl_verify_client` +##### `ssl_verify_client` Data type: `String` @@ -3591,15 +3597,15 @@ Enables verification of client certificates. Default value: `'on'` -##### `ssl_crl` +##### `ssl_crl` Data type: `Optional[String]` Specifies CRL path in file system -Default value: `undef` +Default value: ``undef`` -##### `ssl_dhparam` +##### `ssl_dhparam` Data type: `Optional[String]` @@ -3607,43 +3613,43 @@ This directive specifies a file containing Diffie-Hellman key agreement protocol cryptographic parameters, in PEM format, utilized for exchanging session keys between server and client. -Default value: `undef` +Default value: ``undef`` -##### `ssl_ecdh_curve` +##### `ssl_ecdh_curve` Data type: `Optional[String]` This directive specifies a curve for ECDHE ciphers. -Default value: `undef` +Default value: ``undef`` -##### `ssl_prefer_server_ciphers` +##### `ssl_prefer_server_ciphers` Data type: `Optional[Enum['on', 'off']]` String: Specifies that server ciphers should be preferred over client ciphers when using the SSLv3 and TLS protocols. -Default value: `undef` +Default value: ``undef`` -##### `ssl_redirect` +##### `ssl_redirect` Data type: `Boolean` Adds a server directive and return statement to force ssl redirect. Will honor ssl_port if it's set. -Default value: `false` +Default value: ``false`` -##### `ssl_redirect_port` +##### `ssl_redirect_port` Data type: `Optional[Integer]` Overrides $ssl_port in the SSL redirect set by ssl_redirect -Default value: `undef` +Default value: ``undef`` -##### `ssl_key` +##### `ssl_key` Data type: `Optional[Variant[String, Boolean, Array[String]]]` @@ -3652,9 +3658,9 @@ generated by this module. Set to `false` to inherit from the http section, which improves performance by conserving memory. Use an array to add multiple SSL Keys. -Default value: `undef` +Default value: ``undef`` -##### `ssl_port` +##### `ssl_port` Data type: `Integer` @@ -3662,115 +3668,115 @@ Default IP Port for NGINX to listen with this SSL server on. Default value: `443` -##### `ssl_protocols` +##### `ssl_protocols` Data type: `Optional[String]` SSL protocols enabled. Defaults to 'TLSv1 TLSv1.1 TLSv1.2'. -Default value: `undef` +Default value: ``undef`` -##### `ssl_buffer_size` +##### `ssl_buffer_size` Data type: `Optional[String]` Sets the size of the buffer used for sending data. -Default value: `undef` +Default value: ``undef`` -##### `ssl_ciphers` +##### `ssl_ciphers` Data type: `Optional[String]` SSL ciphers enabled. -Default value: `undef` +Default value: ``undef`` -##### `ssl_stapling` +##### `ssl_stapling` Data type: `Boolean` Enables or disables stapling of OCSP responses by the server. -Default value: `false` +Default value: ``false`` -##### `ssl_stapling_file` +##### `ssl_stapling_file` Data type: `Optional[String]` When set, the stapled OCSP response will be taken from the specified file instead of querying the OCSP responder specified in the server certificate. -Default value: `undef` +Default value: ``undef`` -##### `ssl_stapling_responder` +##### `ssl_stapling_responder` Data type: `Optional[String]` Overrides the URL of the OCSP responder specified in the Authority Information Access certificate extension. -Default value: `undef` +Default value: ``undef`` -##### `ssl_stapling_verify` +##### `ssl_stapling_verify` Data type: `Boolean` Enables or disables verification of OCSP responses by the server. Defaults to false. -Default value: `false` +Default value: ``false`` -##### `ssl_session_timeout` +##### `ssl_session_timeout` Data type: `Optional[String]` Specifies a time during which a client may reuse the session parameters stored in a cache. Defaults to 5m. -Default value: `undef` +Default value: ``undef`` -##### `ssl_session_tickets` +##### `ssl_session_tickets` Data type: `Optional[Enum['on', 'off']]` Enables or disables session resumption through TLS session tickets. -Default value: `undef` +Default value: ``undef`` -##### `ssl_session_ticket_key` +##### `ssl_session_ticket_key` Data type: `Optional[String]` Sets a file with the secret key used to encrypt and decrypt TLS session tickets. -Default value: `undef` +Default value: ``undef`` -##### `ssl_trusted_cert` +##### `ssl_trusted_cert` Data type: `Optional[String]` Specifies a file with trusted CA certificates in the PEM format used to verify client certificates and OCSP responses if ssl_stapling is enabled. -Default value: `undef` +Default value: ``undef`` -##### `ssl_verify_depth` +##### `ssl_verify_depth` Data type: `Optional[Integer]` Sets the verification depth in the client certificates chain. -Default value: `undef` +Default value: ``undef`` -##### `ssl_password_file` +##### `ssl_password_file` Data type: `Optional[Stdlib::Absolutepath]` File containing the password for the SSL Key file. -Default value: `undef` +Default value: ``undef`` -##### `spdy` +##### `spdy` Data type: `Enum['on', 'off']` @@ -3778,7 +3784,7 @@ Toggles SPDY protocol. Default value: `$nginx::spdy` -##### `http2` +##### `http2` Data type: `Enum['on', 'off']` @@ -3786,7 +3792,7 @@ Toggles HTTP/2 protocol. Default value: `$nginx::http2` -##### `server_name` +##### `server_name` Data type: `Array[String]` @@ -3794,169 +3800,169 @@ List of servernames for which this server will respond. Default [$name]. Default value: `[$name]` -##### `www_root` +##### `www_root` Data type: `Optional[String]` Specifies the location on disk for files to be read from. Cannot be set in conjunction with $proxy -Default value: `undef` +Default value: ``undef`` -##### `rewrite_www_to_non_www` +##### `rewrite_www_to_non_www` Data type: `Boolean` Adds a server directive and rewrite rule to rewrite www.domain.com to domain.com in order to avoid duplicate content (SEO); -Default value: `false` +Default value: ``false`` -##### `rewrite_non_www_to_www` +##### `rewrite_non_www_to_www` Data type: `Boolean` Adds a server directive and rewrite rule to rewrite domain.com to www.domain.com in order to avoid duplicate content (SEO); -Default value: `false` +Default value: ``false`` -##### `try_files` +##### `try_files` Data type: `Optional[Array[String]]` Specifies the locations for files to be checked as an array. Cannot be used in conjuction with $proxy. -Default value: `undef` +Default value: ``undef`` -##### `proxy_cache` +##### `proxy_cache` Data type: `Optional[String]` This directive sets name of zone for caching. The same zone can be used in multiple places. -Default value: `undef` +Default value: ``undef`` -##### `proxy_cache_key` +##### `proxy_cache_key` Data type: `Optional[String]` Override the default proxy_cache_key of $scheme$proxy_host$request_uri -Default value: `undef` +Default value: ``undef`` -##### `proxy_cache_use_stale` +##### `proxy_cache_use_stale` Data type: `Optional[String]` Override the default proxy_cache_use_stale value of off. -Default value: `undef` +Default value: ``undef`` -##### `proxy_cache_valid` +##### `proxy_cache_valid` Data type: `Optional[Variant[Array[String], String]]` This directive sets the time for caching different replies. -Default value: `undef` +Default value: ``undef`` -##### `proxy_cache_lock` +##### `proxy_cache_lock` Data type: `Optional[Enum['on', 'off']]` This directive sets the locking mechanism for pouplating cache. -Default value: `undef` +Default value: ``undef`` -##### `proxy_cache_bypass` +##### `proxy_cache_bypass` Data type: `Optional[Variant[Array[String], String]]` Defines conditions which the response will not be cached -Default value: `undef` +Default value: ``undef`` -##### `proxy_method` +##### `proxy_method` Data type: `Optional[String]` If defined, overrides the HTTP method of the request to be passed to the backend. -Default value: `undef` +Default value: ``undef`` -##### `proxy_http_version` +##### `proxy_http_version` Data type: `Optional[String]` Sets the proxy http version -Default value: `undef` +Default value: ``undef`` -##### `proxy_set_body` +##### `proxy_set_body` Data type: `Optional[String]` If defined, sets the body passed to the backend. -Default value: `undef` +Default value: ``undef`` -##### `absolute_redirect` +##### `absolute_redirect` Data type: `Optional[Enum['on', 'off']]` Enables or disables the absolute redirect functionality of nginx -Default value: `undef` +Default value: ``undef`` -##### `auth_basic` +##### `auth_basic` Data type: `Optional[String]` This directive includes testing name and password with HTTP Basic Authentication. -Default value: `undef` +Default value: ``undef`` -##### `auth_basic_user_file` +##### `auth_basic_user_file` Data type: `Optional[String]` This directive sets the htpasswd filename for the authentication realm. -Default value: `undef` +Default value: ``undef`` -##### `auth_request` +##### `auth_request` Data type: `Optional[String]` This allows you to specify a custom auth endpoint -Default value: `undef` +Default value: ``undef`` -##### `client_max_body_size` +##### `client_max_body_size` Data type: `Any` This directive sets client_max_body_size. -Default value: `undef` +Default value: ``undef`` -##### `client_body_timeout` +##### `client_body_timeout` Data type: `Optional[String]` Sets how long the server will wait for a client body. Default is 60s -Default value: `undef` +Default value: ``undef`` -##### `client_header_timeout` +##### `client_header_timeout` Data type: `Optional[String]` Sets how long the server will wait for a client header. Default is 60s -Default value: `undef` +Default value: ``undef`` -##### `raw_prepend` +##### `raw_prepend` Data type: `Optional[Variant[Array[String], String]]` @@ -3964,9 +3970,9 @@ A single string, or an array of strings to prepend to the server directive (after cfg prepend directives). NOTE: YOU are responsible for a semicolon on each line that requires one. -Default value: `undef` +Default value: ``undef`` -##### `raw_append` +##### `raw_append` Data type: `Optional[Variant[Array[String], String]]` @@ -3974,9 +3980,9 @@ A single string, or an array of strings to append to the server directive (after cfg append directives). NOTE: YOU are responsible for a semicolon on each line that requires one. -Default value: `undef` +Default value: ``undef`` -##### `location_raw_prepend` +##### `location_raw_prepend` Data type: `Optional[Variant[Array[String], String]]` @@ -3984,9 +3990,9 @@ A single string, or an array of strings to prepend to the location directive (after custom_cfg directives). NOTE: YOU are responsible for a semicolon on each line that requires one. -Default value: `undef` +Default value: ``undef`` -##### `location_raw_append` +##### `location_raw_append` Data type: `Optional[Variant[Array[String], String]]` @@ -3994,49 +4000,49 @@ A single string, or an array of strings to append to the location directive (after custom_cfg directives). NOTE: YOU are responsible for a semicolon on each line that requires one. -Default value: `undef` +Default value: ``undef`` -##### `server_cfg_append` +##### `server_cfg_append` Data type: `Optional[Hash]` It expects a hash with custom directives to put after everything else inside server -Default value: `undef` +Default value: ``undef`` -##### `server_cfg_prepend` +##### `server_cfg_prepend` Data type: `Optional[Hash]` It expects a hash with custom directives to put before everything else inside server -Default value: `undef` +Default value: ``undef`` -##### `server_cfg_ssl_append` +##### `server_cfg_ssl_append` Data type: `Optional[Hash]` It expects a hash with custom directives to put after everything else inside server ssl -Default value: `undef` +Default value: ``undef`` -##### `server_cfg_ssl_prepend` +##### `server_cfg_ssl_prepend` Data type: `Optional[Hash]` It expects a hash with custom directives to put before everything else inside server ssl -Default value: `undef` +Default value: ``undef`` -##### `include_files` +##### `include_files` Data type: `Optional[Array[String]]` Adds include files to server -Default value: `undef` +Default value: ``undef`` -##### `access_log` +##### `access_log` Data type: `Optional[Variant[String, Array]]` @@ -4047,9 +4053,9 @@ be created. Additionally, unlike the earlier behavior, setting it to server stanza, rather than setting a default. Can also be disabled for this server with the string 'off'. -Default value: `undef` +Default value: ``undef`` -##### `error_log` +##### `error_log` Data type: `Optional[Variant[String, Array]]` @@ -4057,33 +4063,33 @@ Where to write error log. May add additional options like error level to the end. May set to 'absent', in which case it will be omitted in this server stanza (and default to nginx.conf setting) -Default value: `undef` +Default value: ``undef`` -##### `passenger_cgi_param` +##### `passenger_cgi_param` Data type: `Optional[Hash]` Allows one to define additional CGI environment variables to pass to the backend application -Default value: `undef` +Default value: ``undef`` -##### `passenger_set_header` +##### `passenger_set_header` Data type: `Optional[Hash]` Allows one to set headers to pass to the backend application (Passenger 5.0+) -Default value: `undef` +Default value: ``undef`` -##### `passenger_env_var` +##### `passenger_env_var` Data type: `Optional[Hash]` Allows one to set environment variables to pass to the backend application (Passenger 5.0+) -Default value: `undef` +Default value: ``undef`` -##### `passenger_pre_start` +##### `passenger_pre_start` Data type: `Optional[Variant[Array[String], String]]` @@ -4091,9 +4097,9 @@ Allows setting a URL to pre-warm the host. Per Passenger docs, the "domain part of the URL" must match a value of server_name. If this is an array, multiple URLs can be specified. -Default value: `undef` +Default value: ``undef`` -##### `log_by_lua` +##### `log_by_lua` Data type: `Optional[String]` @@ -4101,9 +4107,9 @@ Run the Lua source code inlined as the at the log request processing phase. This does not replace the current access logs, but runs after. -Default value: `undef` +Default value: ``undef`` -##### `log_by_lua_file` +##### `log_by_lua_file` Data type: `Optional[String]` @@ -4111,25 +4117,25 @@ Equivalent to log_by_lua, except that the file specified by contains the Lua code, or, as from the v0.5.0rc32 release, the Lua/LuaJIT bytecode to be executed. -Default value: `undef` +Default value: ``undef`` -##### `gzip_types` +##### `gzip_types` Data type: `Optional[String]` Defines gzip_types, nginx default is text/html -Default value: `undef` +Default value: ``undef`` -##### `gzip_static` +##### `gzip_static` Data type: `Optional[String]` Defines gzip_static, nginx default is off -Default value: `undef` +Default value: ``undef`` -##### `owner` +##### `owner` Data type: `String` @@ -4137,7 +4143,7 @@ Defines owner of the .conf file Default value: `$nginx::global_owner` -##### `group` +##### `group` Data type: `String` @@ -4145,7 +4151,7 @@ Defines group of the .conf file Default value: `$nginx::global_group` -##### `mode` +##### `mode` Data type: `String` @@ -4153,15 +4159,15 @@ Defines mode of the .conf file Default value: `$nginx::global_mode` -##### `maintenance` +##### `maintenance` Data type: `Boolean` A boolean value to set a server in maintenance -Default value: `false` +Default value: ``false`` -##### `maintenance_value` +##### `maintenance_value` Data type: `String` @@ -4169,15 +4175,15 @@ Value to return when maintenance is on. Default value: `'return 503'` -##### `error_pages` +##### `error_pages` Data type: `Any` Setup errors pages, hash key is the http code and hash value the page -Default value: `undef` +Default value: ``undef`` -##### `locations` +##### `locations` Data type: `Hash` @@ -4185,7 +4191,7 @@ Hash of location resources used by this server Default value: `{}` -##### `locations_defaults` +##### `locations_defaults` Data type: `Hash` @@ -4193,23 +4199,23 @@ Hash of location default settings Default value: `{}` -##### `ssl_listen_option` +##### `ssl_listen_option` Data type: `Boolean` -Default value: `true` +Default value: ``true`` -##### `ssl_cache` +##### `ssl_cache` Data type: `Optional[String]` -Default value: `undef` +Default value: ``undef`` -##### `proxy_connect_timeout` +##### `proxy_connect_timeout` Data type: `Any` @@ -4217,7 +4223,7 @@ Data type: `Any` Default value: `$nginx::proxy_connect_timeout` -##### `proxy_set_header` +##### `proxy_set_header` Data type: `Array[String]` @@ -4225,7 +4231,7 @@ Data type: `Array[String]` Default value: `$nginx::proxy_set_header` -##### `proxy_hide_header` +##### `proxy_hide_header` Data type: `Array[String]` @@ -4233,7 +4239,7 @@ Data type: `Array[String]` Default value: `$nginx::proxy_hide_header` -##### `proxy_pass_header` +##### `proxy_pass_header` Data type: `Array[String]` @@ -4241,15 +4247,15 @@ Data type: `Array[String]` Default value: `$nginx::proxy_pass_header` -##### `uwsgi` +##### `uwsgi` Data type: `Optional[String]` -Default value: `undef` +Default value: ``undef`` -##### `uwsgi_params` +##### `uwsgi_params` Data type: `String` @@ -4257,47 +4263,47 @@ Data type: `String` Default value: `"${nginx::config::conf_dir}/uwsgi_params"` -##### `location_custom_cfg` +##### `location_custom_cfg` Data type: `Optional[Hash]` -Default value: `undef` +Default value: ``undef`` -##### `location_cfg_prepend` +##### `location_cfg_prepend` Data type: `Optional[Hash]` -Default value: `undef` +Default value: ``undef`` -##### `location_cfg_append` +##### `location_cfg_append` Data type: `Optional[Hash]` -Default value: `undef` +Default value: ``undef`` -##### `location_custom_cfg_prepend` +##### `location_custom_cfg_prepend` Data type: `Optional[Hash]` -Default value: `undef` +Default value: ``undef`` -##### `location_custom_cfg_append` +##### `location_custom_cfg_append` Data type: `Optional[Hash]` -Default value: `undef` +Default value: ``undef`` -##### `format_log` +##### `format_log` Data type: `Optional[String]` @@ -4305,15 +4311,15 @@ Data type: `Optional[String]` Default value: `$nginx::http_format_log` -##### `use_default_location` +##### `use_default_location` Data type: `Any` -Default value: `true` +Default value: ``true`` -##### `rewrite_rules` +##### `rewrite_rules` Data type: `Any` @@ -4321,7 +4327,7 @@ Data type: `Any` Default value: `[]` -##### `string_mappings` +##### `string_mappings` Data type: `Any` @@ -4329,7 +4335,7 @@ Data type: `Any` Default value: `{}` -##### `geo_mappings` +##### `geo_mappings` Data type: `Any` @@ -4337,7 +4343,7 @@ Data type: `Any` Default value: `{}` -### `nginx::resource::snippet` +### `nginx::resource::snippet` Create a reusable config snippet that can be included by other resources @@ -4345,13 +4351,13 @@ Create a reusable config snippet that can be included by other resources The following parameters are available in the `nginx::resource::snippet` defined type: -* [`ensure`](#-nginx--resource--snippet--ensure) -* [`owner`](#-nginx--resource--snippet--owner) -* [`group`](#-nginx--resource--snippet--group) -* [`mode`](#-nginx--resource--snippet--mode) -* [`raw_content`](#-nginx--resource--snippet--raw_content) +* [`ensure`](#ensure) +* [`owner`](#owner) +* [`group`](#group) +* [`mode`](#mode) +* [`raw_content`](#raw_content) -##### `ensure` +##### `ensure` Data type: `Enum['absent', 'present']` @@ -4359,7 +4365,7 @@ Enables or disables the specified snippet Default value: `'present'` -##### `owner` +##### `owner` Data type: `String` @@ -4367,7 +4373,7 @@ Defines owner of the .conf file Default value: `$nginx::global_owner` -##### `group` +##### `group` Data type: `String` @@ -4375,7 +4381,7 @@ Defines group of the .conf file Default value: `$nginx::global_group` -##### `mode` +##### `mode` Data type: `Stdlib::Filemode` @@ -4383,13 +4389,13 @@ Defines mode of the .conf file Default value: `$nginx::global_mode` -##### `raw_content` +##### `raw_content` Data type: `String[1]` Raw content that will be inserted into the snipped as-is -### `nginx::resource::streamhost` +### `nginx::resource::streamhost` Create a virtual steamhost @@ -4407,25 +4413,25 @@ nginx::resource::streamhost { 'test2.local': The following parameters are available in the `nginx::resource::streamhost` defined type: -* [`ensure`](#-nginx--resource--streamhost--ensure) -* [`listen_ip`](#-nginx--resource--streamhost--listen_ip) -* [`listen_port`](#-nginx--resource--streamhost--listen_port) -* [`listen_options`](#-nginx--resource--streamhost--listen_options) -* [`ipv6_enable`](#-nginx--resource--streamhost--ipv6_enable) -* [`ipv6_listen_ip`](#-nginx--resource--streamhost--ipv6_listen_ip) -* [`ipv6_listen_port`](#-nginx--resource--streamhost--ipv6_listen_port) -* [`ipv6_listen_options`](#-nginx--resource--streamhost--ipv6_listen_options) -* [`proxy`](#-nginx--resource--streamhost--proxy) -* [`proxy_read_timeout`](#-nginx--resource--streamhost--proxy_read_timeout) -* [`resolver`](#-nginx--resource--streamhost--resolver) -* [`raw_prepend`](#-nginx--resource--streamhost--raw_prepend) -* [`raw_append`](#-nginx--resource--streamhost--raw_append) -* [`owner`](#-nginx--resource--streamhost--owner) -* [`group`](#-nginx--resource--streamhost--group) -* [`mode`](#-nginx--resource--streamhost--mode) -* [`proxy_connect_timeout`](#-nginx--resource--streamhost--proxy_connect_timeout) - -##### `ensure` +* [`ensure`](#ensure) +* [`listen_ip`](#listen_ip) +* [`listen_port`](#listen_port) +* [`listen_options`](#listen_options) +* [`ipv6_enable`](#ipv6_enable) +* [`ipv6_listen_ip`](#ipv6_listen_ip) +* [`ipv6_listen_port`](#ipv6_listen_port) +* [`ipv6_listen_options`](#ipv6_listen_options) +* [`proxy`](#proxy) +* [`proxy_read_timeout`](#proxy_read_timeout) +* [`resolver`](#resolver) +* [`raw_prepend`](#raw_prepend) +* [`raw_append`](#raw_append) +* [`owner`](#owner) +* [`group`](#group) +* [`mode`](#mode) +* [`proxy_connect_timeout`](#proxy_connect_timeout) + +##### `ensure` Data type: `Enum['absent', 'present']` @@ -4433,7 +4439,7 @@ Enables or disables the specified streamhost Default value: `'present'` -##### `listen_ip` +##### `listen_ip` Data type: `Variant[Array, String]` @@ -4442,7 +4448,7 @@ all interfaces (*) Default value: `'*'` -##### `listen_port` +##### `listen_port` Data type: `Integer` @@ -4450,24 +4456,24 @@ Default TCP Port for NGINX to listen with this streamhost on. Default value: `80` -##### `listen_options` +##### `listen_options` Data type: `Optional[String]` Extra options for listen directive like 'default' to catchall. -Default value: `undef` +Default value: ``undef`` -##### `ipv6_enable` +##### `ipv6_enable` Data type: `Boolean` Value to enable/disable IPv6 support Module will check to see if IPv6 support exists on your system before enabling. -Default value: `false` +Default value: ``false`` -##### `ipv6_listen_ip` +##### `ipv6_listen_ip` Data type: `Variant[Array, String]` @@ -4476,7 +4482,7 @@ to all interfaces (::) Default value: `'::'` -##### `ipv6_listen_port` +##### `ipv6_listen_port` Data type: `Integer` @@ -4484,7 +4490,7 @@ Default IPv6 Port for NGINX to listen with this streamhost on. Default value: `$listen_port` -##### `ipv6_listen_options` +##### `ipv6_listen_options` Data type: `String` @@ -4493,16 +4499,16 @@ catchall. Default value: `'default ipv6only=on'` -##### `proxy` +##### `proxy` Data type: `Any` Proxy server(s) for the root location to connect to. Accepts a single value, can be used in conjunction with nginx::resource::upstream -Default value: `undef` +Default value: ``undef`` -##### `proxy_read_timeout` +##### `proxy_read_timeout` Data type: `String` @@ -4510,7 +4516,7 @@ Override the default the proxy read timeout value of 90 seconds Default value: `$nginx::proxy_read_timeout` -##### `resolver` +##### `resolver` Data type: `Array` @@ -4519,7 +4525,7 @@ addresses. Default value: `[]` -##### `raw_prepend` +##### `raw_prepend` Data type: `Variant[Array[String], String]` @@ -4529,7 +4535,7 @@ on each line that requires one. Default value: `[]` -##### `raw_append` +##### `raw_append` Data type: `Variant[Array[String], String]` @@ -4539,7 +4545,7 @@ each line that requires one. Default value: `[]` -##### `owner` +##### `owner` Data type: `String` @@ -4547,7 +4553,7 @@ Defines owner of the .conf file Default value: `$nginx::global_owner` -##### `group` +##### `group` Data type: `String` @@ -4555,7 +4561,7 @@ Defines group of the .conf file Default value: `$nginx::global_group` -##### `mode` +##### `mode` Data type: `String` @@ -4563,7 +4569,7 @@ Defines mode of the .conf file Default to return 503 Default value: `$nginx::global_mode` -##### `proxy_connect_timeout` +##### `proxy_connect_timeout` Data type: `Any` @@ -4571,7 +4577,7 @@ Data type: `Any` Default value: `$nginx::proxy_connect_timeout` -### `nginx::resource::upstream` +### `nginx::resource::upstream` Create a new upstream proxy entry for NGINX @@ -4627,29 +4633,29 @@ nginx::resource::upstream { 'proxypass': The following parameters are available in the `nginx::resource::upstream` defined type: -* [`ensure`](#-nginx--resource--upstream--ensure) -* [`context`](#-nginx--resource--upstream--context) -* [`members`](#-nginx--resource--upstream--members) -* [`members_tag`](#-nginx--resource--upstream--members_tag) -* [`member_defaults`](#-nginx--resource--upstream--member_defaults) -* [`hash`](#-nginx--resource--upstream--hash) -* [`ip_hash`](#-nginx--resource--upstream--ip_hash) -* [`keepalive`](#-nginx--resource--upstream--keepalive) -* [`keepalive_requests`](#-nginx--resource--upstream--keepalive_requests) -* [`keepalive_timeout`](#-nginx--resource--upstream--keepalive_timeout) -* [`least_conn`](#-nginx--resource--upstream--least_conn) -* [`least_time`](#-nginx--resource--upstream--least_time) -* [`ntlm`](#-nginx--resource--upstream--ntlm) -* [`queue_max`](#-nginx--resource--upstream--queue_max) -* [`queue_timeout`](#-nginx--resource--upstream--queue_timeout) -* [`random`](#-nginx--resource--upstream--random) -* [`statefile`](#-nginx--resource--upstream--statefile) -* [`sticky`](#-nginx--resource--upstream--sticky) -* [`zone`](#-nginx--resource--upstream--zone) -* [`cfg_append`](#-nginx--resource--upstream--cfg_append) -* [`cfg_prepend`](#-nginx--resource--upstream--cfg_prepend) - -##### `ensure` +* [`ensure`](#ensure) +* [`context`](#context) +* [`members`](#members) +* [`members_tag`](#members_tag) +* [`member_defaults`](#member_defaults) +* [`hash`](#hash) +* [`ip_hash`](#ip_hash) +* [`keepalive`](#keepalive) +* [`keepalive_requests`](#keepalive_requests) +* [`keepalive_timeout`](#keepalive_timeout) +* [`least_conn`](#least_conn) +* [`least_time`](#least_time) +* [`ntlm`](#ntlm) +* [`queue_max`](#queue_max) +* [`queue_timeout`](#queue_timeout) +* [`random`](#random) +* [`statefile`](#statefile) +* [`sticky`](#sticky) +* [`zone`](#zone) +* [`cfg_append`](#cfg_append) +* [`cfg_prepend`](#cfg_prepend) + +##### `ensure` Data type: `Enum['present', 'absent']` @@ -4657,7 +4663,7 @@ Enables or disables the specified location Default value: `'present'` -##### `context` +##### `context` Data type: `Enum['http', 'stream']` @@ -4665,7 +4671,7 @@ Set the type of this upstream. Default value: `'http'` -##### `members` +##### `members` Data type: `Nginx::UpstreamMembers` @@ -4675,15 +4681,15 @@ nginx::resource::upstream::member Default value: `{}` -##### `members_tag` +##### `members_tag` Data type: `Optional[String[1]]` Restrict collecting the exported members for this upstream with a tag. -Default value: `undef` +Default value: ``undef`` -##### `member_defaults` +##### `member_defaults` Data type: `Nginx::UpstreamMemberDefaults` @@ -4691,34 +4697,34 @@ Specify default settings added to each member of this upstream. Default value: `{}` -##### `hash` +##### `hash` Data type: `Optional[String[1]]` Activate the hash load balancing method (https://nginx.org/en/docs/http/ngx_http_upstream_module.html#hash). -Default value: `undef` +Default value: ``undef`` -##### `ip_hash` +##### `ip_hash` Data type: `Boolean` Activate ip_hash for this upstream (https://nginx.org/en/docs/http/ngx_http_upstream_module.html#ip_hash). -Default value: `false` +Default value: ``false`` -##### `keepalive` +##### `keepalive` Data type: `Optional[Integer[1]]` Set the maximum number of idle keepalive connections (https://nginx.org/en/docs/http/ngx_http_upstream_module.html#keepalive). -Default value: `undef` +Default value: ``undef`` -##### `keepalive_requests` +##### `keepalive_requests` Data type: `Optional[Integer[1]]` @@ -4726,9 +4732,9 @@ Sets the maximum number of requests that can be served through one keepalive connection (https://nginx.org/en/docs/http/ngx_http_upstream_module.html#keepalive_requests). -Default value: `undef` +Default value: ``undef`` -##### `keepalive_timeout` +##### `keepalive_timeout` Data type: `Optional[Nginx::Time]` @@ -4736,90 +4742,90 @@ Sets a timeout during which an idle keepalive connection to an upstream server will stay open (https://nginx.org/en/docs/http/ngx_http_upstream_module.html#keepalive_timeout). -Default value: `undef` +Default value: ``undef`` -##### `least_conn` +##### `least_conn` Data type: `Boolean` Activate the least_conn load balancing method (https://nginx.org/en/docs/http/ngx_http_upstream_module.html#least_conn). -Default value: `false` +Default value: ``false`` -##### `least_time` +##### `least_time` Data type: `Optional[Nginx::UpstreamLeastTime]` Activate the least_time load balancing method (https://nginx.org/en/docs/http/ngx_http_upstream_module.html#least_time). -Default value: `undef` +Default value: ``undef`` -##### `ntlm` +##### `ntlm` Data type: `Boolean` Allow NTLM authentication (https://nginx.org/en/docs/http/ngx_http_upstream_module.html#ntlm). -Default value: `false` +Default value: ``false`` -##### `queue_max` +##### `queue_max` Data type: `Optional[Integer]` Set the maximum number of queued requests (https://nginx.org/en/docs/http/ngx_http_upstream_module.html#queue). -Default value: `undef` +Default value: ``undef`` -##### `queue_timeout` +##### `queue_timeout` Data type: `Optional[Nginx::Time]` Set the timeout for the queue (https://nginx.org/en/docs/http/ngx_http_upstream_module.html#queue). -Default value: `undef` +Default value: ``undef`` -##### `random` +##### `random` Data type: `Optional[String[1]]` Activate the random load balancing method (https://nginx.org/en/docs/http/ngx_http_upstream_module.html#random). -Default value: `undef` +Default value: ``undef`` -##### `statefile` +##### `statefile` Data type: `Optional[Stdlib::Unixpath]` Specifies a file that keeps the state of the dynamically configurable group (https://nginx.org/en/docs/http/ngx_http_upstream_module.html#state). -Default value: `undef` +Default value: ``undef`` -##### `sticky` +##### `sticky` Data type: `Optional[Nginx::UpstreamSticky]` Enables session affinity (https://nginx.org/en/docs/http/ngx_http_upstream_module.html#sticky). -Default value: `undef` +Default value: ``undef`` -##### `zone` +##### `zone` Data type: `Optional[Nginx::UpstreamZone]` Defines the name and optional the size of the shared memory zone (https://nginx.org/en/docs/http/ngx_http_upstream_module.html#zone). -Default value: `undef` +Default value: ``undef`` -##### `cfg_append` +##### `cfg_append` Data type: `Nginx::UpstreamCustomParameters` @@ -4827,7 +4833,7 @@ Hash of custom directives to put after other directives in upstream Default value: `{}` -##### `cfg_prepend` +##### `cfg_prepend` Data type: `Nginx::UpstreamCustomParameters` @@ -4836,7 +4842,7 @@ upstream Default value: `{}` -### `nginx::resource::upstream::member` +### `nginx::resource::upstream::member` Export this resource in all upstream member servers and collect them on the NGINX server. Exporting resources requires storeconfigs on the Puppetserver @@ -4867,32 +4873,32 @@ nginx::resource::upstream { 'proxypass': The following parameters are available in the `nginx::resource::upstream::member` defined type: -* [`upstream`](#-nginx--resource--upstream--member--upstream) -* [`ensure`](#-nginx--resource--upstream--member--ensure) -* [`context`](#-nginx--resource--upstream--member--context) -* [`server`](#-nginx--resource--upstream--member--server) -* [`port`](#-nginx--resource--upstream--member--port) -* [`weight`](#-nginx--resource--upstream--member--weight) -* [`max_conns`](#-nginx--resource--upstream--member--max_conns) -* [`max_fails`](#-nginx--resource--upstream--member--max_fails) -* [`fail_timeout`](#-nginx--resource--upstream--member--fail_timeout) -* [`backup`](#-nginx--resource--upstream--member--backup) -* [`resolve`](#-nginx--resource--upstream--member--resolve) -* [`route`](#-nginx--resource--upstream--member--route) -* [`service`](#-nginx--resource--upstream--member--service) -* [`slow_start`](#-nginx--resource--upstream--member--slow_start) -* [`state`](#-nginx--resource--upstream--member--state) -* [`params_prepend`](#-nginx--resource--upstream--member--params_prepend) -* [`params_append`](#-nginx--resource--upstream--member--params_append) -* [`comment`](#-nginx--resource--upstream--member--comment) - -##### `upstream` +* [`upstream`](#upstream) +* [`ensure`](#ensure) +* [`context`](#context) +* [`server`](#server) +* [`port`](#port) +* [`weight`](#weight) +* [`max_conns`](#max_conns) +* [`max_fails`](#max_fails) +* [`fail_timeout`](#fail_timeout) +* [`backup`](#backup) +* [`resolve`](#resolve) +* [`route`](#route) +* [`service`](#service) +* [`slow_start`](#slow_start) +* [`state`](#state) +* [`params_prepend`](#params_prepend) +* [`params_append`](#params_append) +* [`comment`](#comment) + +##### `upstream` Data type: `String[1]` The name of the upstream resource -##### `ensure` +##### `ensure` Data type: `Enum['present', 'absent']` @@ -4900,7 +4906,7 @@ Enables or disables the specified member Default value: `'present'` -##### `context` +##### `context` Data type: `Enum['http', 'stream']` @@ -4908,7 +4914,7 @@ Set the type of this upstream Default value: `'http'` -##### `server` +##### `server` Data type: `Optional[Nginx::UpstreamMemberServer]` @@ -4916,7 +4922,7 @@ Hostname or IP of the upstream member server Default value: `$name` -##### `port` +##### `port` Data type: `Stdlib::Port` @@ -4924,134 +4930,146 @@ Port of the listening service on the upstream member Default value: `80` -##### `weight` +##### `weight` Data type: `Optional[Integer[1]]` Set the weight for this upstream member -Default value: `undef` +Default value: ``undef`` -##### `max_conns` +##### `max_conns` Data type: `Optional[Integer[1]]` Set the max_conns for this upstream member -Default value: `undef` +Default value: ``undef`` -##### `max_fails` +##### `max_fails` Data type: `Optional[Integer[0]]` Set the max_fails for this upstream member -Default value: `undef` +Default value: ``undef`` -##### `fail_timeout` +##### `fail_timeout` Data type: `Optional[Nginx::Time]` Set the fail_timeout for this upstream member -Default value: `undef` +Default value: ``undef`` -##### `backup` +##### `backup` Data type: `Boolean` Activate backup for this upstream member -Default value: `false` +Default value: ``false`` -##### `resolve` +##### `resolve` Data type: `Boolean` Activate resolve for this upstream member -Default value: `false` +Default value: ``false`` -##### `route` +##### `route` Data type: `Optional[String[1]]` Set the route for this upstream member -Default value: `undef` +Default value: ``undef`` -##### `service` +##### `service` Data type: `Optional[String[1]]` Set the service for this upstream member -Default value: `undef` +Default value: ``undef`` -##### `slow_start` +##### `slow_start` Data type: `Optional[Nginx::Time]` Set the slow_start for this upstream member -Default value: `undef` +Default value: ``undef`` -##### `state` +##### `state` Data type: `Optional[Enum['drain','down']]` Set the state for this upstream member -Default value: `undef` +Default value: ``undef`` -##### `params_prepend` +##### `params_prepend` Data type: `Optional[String[1]]` prepend a parameter for this upstream member -Default value: `undef` +Default value: ``undef`` -##### `params_append` +##### `params_append` Data type: `Optional[String[1]]` append a paremeter for this upstream member -Default value: `undef` +Default value: ``undef`` -##### `comment` +##### `comment` Data type: `Optional[String[1]]` Add a comment for this upstream member -Default value: `undef` +Default value: ``undef`` ## Data types -### `Nginx::DebugConnection` +### `Nginx::DebugConnection` The Nginx::DebugConnection data type. -Alias of `Variant[Stdlib::Host, Stdlib::IP::Address, Enum['unix:']]` +Alias of -### `Nginx::ErrorLogSeverity` +```puppet +Variant[Stdlib::Host, Stdlib::IP::Address, Enum['unix:']] +``` + +### `Nginx::ErrorLogSeverity` The Nginx::ErrorLogSeverity data type. -Alias of `Enum['debug', 'info', 'notice', 'warn', 'error', 'crit', 'alert', 'emerg']` +Alias of -### `Nginx::GzipProxied` +```puppet +Enum['debug', 'info', 'notice', 'warn', 'error', 'crit', 'alert', 'emerg'] +``` + +### `Nginx::GzipProxied` custom type for gzip_proxied * **See also** * http://nginx.org/en/docs/http/ngx_http_gzip_module.html#gzip_proxied -Alias of `Enum['off', 'expired', 'no-cache', 'no-store', 'private', 'no_last_modified', 'no_etag', 'auth', 'any']` +Alias of + +```puppet +Enum['off', 'expired', 'no-cache', 'no-store', 'private', 'no_last_modified', 'no_etag', 'auth', 'any'] +``` -### `Nginx::LogFormat` +### `Nginx::LogFormat` The Nginx::LogFormat data type. @@ -5064,19 +5082,27 @@ Variant[String[1], Struct[{ }]] ``` -### `Nginx::Size` +### `Nginx::Size` The Nginx::Size data type. -Alias of `Pattern[/^\d+[k|K|m|M]?$/]` +Alias of + +```puppet +Pattern[/^\d+[k|K|m|M]?$/] +``` -### `Nginx::Time` +### `Nginx::Time` The Nginx::Time data type. -Alias of `Pattern[/^\d+(ms|s|m|h|d|w|M|y)?$/]` +Alias of + +```puppet +Pattern[/^\d+(ms|s|m|h|d|w|M|y)?$/] +``` -### `Nginx::UpstreamCustomParameters` +### `Nginx::UpstreamCustomParameters` The Nginx::UpstreamCustomParameters data type. @@ -5107,7 +5133,7 @@ Hash[String[1], Variant[ ]] ``` -### `Nginx::UpstreamDefaults` +### `Nginx::UpstreamDefaults` The Nginx::UpstreamDefaults data type. @@ -5136,25 +5162,37 @@ Struct[{ }] ``` -### `Nginx::UpstreamLeastTime` +### `Nginx::UpstreamLeastTime` The Nginx::UpstreamLeastTime data type. -Alias of `Variant[Nginx::UpstreamLeastTimeHttp, Nginx::UpstreamLeastTimeStream]` +Alias of + +```puppet +Variant[Nginx::UpstreamLeastTimeHttp, Nginx::UpstreamLeastTimeStream] +``` -### `Nginx::UpstreamLeastTimeHttp` +### `Nginx::UpstreamLeastTimeHttp` The Nginx::UpstreamLeastTimeHttp data type. -Alias of `Enum['header', 'header inflight', 'last_byte', 'last_byte inflight']` +Alias of -### `Nginx::UpstreamLeastTimeStream` +```puppet +Enum['header', 'header inflight', 'last_byte', 'last_byte inflight'] +``` + +### `Nginx::UpstreamLeastTimeStream` The Nginx::UpstreamLeastTimeStream data type. -Alias of `Enum['connect', 'connect inflight', 'first_byte', 'first_byte inflight', 'last_byte', 'last_byte inflight']` +Alias of -### `Nginx::UpstreamMember` +```puppet +Enum['connect', 'connect inflight', 'first_byte', 'first_byte inflight', 'last_byte', 'last_byte inflight'] +``` + +### `Nginx::UpstreamMember` The Nginx::UpstreamMember data type. @@ -5180,7 +5218,7 @@ Struct[{ }] ``` -### `Nginx::UpstreamMemberDefaults` +### `Nginx::UpstreamMemberDefaults` The Nginx::UpstreamMemberDefaults data type. @@ -5205,19 +5243,27 @@ Struct[{ }] ``` -### `Nginx::UpstreamMemberServer` +### `Nginx::UpstreamMemberServer` The Nginx::UpstreamMemberServer data type. -Alias of `Variant[Stdlib::Host, Pattern[/^unix:\/([^\/\0]+\/*)[^:]*$/]]` +Alias of + +```puppet +Variant[Stdlib::Host, Pattern[/^unix:\/([^\/\0]+\/*)[^:]*$/]] +``` -### `Nginx::UpstreamMembers` +### `Nginx::UpstreamMembers` The Nginx::UpstreamMembers data type. -Alias of `Hash[String, Nginx::UpstreamMember]` +Alias of -### `Nginx::UpstreamSticky` +```puppet +Hash[String, Nginx::UpstreamMember] +``` + +### `Nginx::UpstreamSticky` The Nginx::UpstreamSticky data type. @@ -5250,15 +5296,23 @@ Variant[Hash[ ]] ``` -### `Nginx::UpstreamStickyZone` +### `Nginx::UpstreamStickyZone` The Nginx::UpstreamStickyZone data type. -Alias of `Pattern[/^[-_\.A-Za-z0-9]*:\d+[k|K|m|M]$/]` +Alias of + +```puppet +Pattern[/^[-_\.A-Za-z0-9]*:\d+[k|K|m|M]$/] +``` -### `Nginx::UpstreamZone` +### `Nginx::UpstreamZone` The Nginx::UpstreamZone data type. -Alias of `Pattern[/^[-_\.A-Za-z0-9]* \d+[k|K|m|M]$/]` +Alias of + +```puppet +Pattern[/^[-_\.A-Za-z0-9]* \d+[k|K|m|M]$/] +``` diff --git a/manifests/config.pp b/manifests/config.pp index 1b6e747d6..820d2c3d7 100644 --- a/manifests/config.pp +++ b/manifests/config.pp @@ -206,7 +206,7 @@ file { $client_body_temp_path: ensure => directory, owner => $daemon_user, - mode => '0700', + mode => $nginx::client_body_temp_mode, } } @@ -214,7 +214,7 @@ file { $proxy_temp_path: ensure => directory, owner => $daemon_user, - mode => '0700', + mode => $nginx::proxy_temp_mode, } } diff --git a/manifests/init.pp b/manifests/init.pp index 0a1c93830..a1bf5547a 100644 --- a/manifests/init.pp +++ b/manifests/init.pp @@ -44,9 +44,22 @@ # @param nginx_snippets_defaults # Can be used to define default values for the parameter `nginx_snippets`. # +# @param proxy_temp_mode +# Permissions for the $proxy_temp_path file resource. +# +# @param proxy_temp_path +# Directory for storing temporary files with data received from proxied servers. +# +# @param client_body_temp_path +# Directory for storing temporary files holding client request bodies. +# +# @param client_body_temp_mode +# Permissions for the $client_body_temp_path file resource. +# class nginx ( ### START Nginx Configuration ### Optional[Stdlib::Absolutepath] $client_body_temp_path = undef, + Optional[Stdlib::Filemode] $client_body_temp_mode = undef, Boolean $confd_only = false, Boolean $confd_purge = false, $conf_dir = $nginx::params::conf_dir, @@ -69,6 +82,7 @@ Nginx::ErrorLogSeverity $nginx_error_log_severity = 'error', $pid = $nginx::params::pid, Optional[Stdlib::Absolutepath] $proxy_temp_path = undef, + Optional[Stdlib::Filemode] $proxy_temp_mode = undef, $root_group = $nginx::params::root_group, $sites_available_owner = $nginx::params::sites_available_owner, $sites_available_group = $nginx::params::sites_available_group, diff --git a/spec/classes/nginx_spec.rb b/spec/classes/nginx_spec.rb index 4c417540f..8f255b3d4 100644 --- a/spec/classes/nginx_spec.rb +++ b/spec/classes/nginx_spec.rb @@ -1427,6 +1427,52 @@ it { is_expected.to contain_file('/var/log/nginx').with(mode: '0771') } end + context 'when proxy_temp_path is non-default' do + let(:params) { { proxy_temp_path: '/tmp/nginx_proxy' } } + + it do + is_expected.to contain_file('/tmp/nginx_proxy'). + without('mode') + end + end + + context 'when proxy_temp_mode is non-default' do + let(:params) do + { + proxy_temp_path: '/tmp/nginx_proxy', + proxy_temp_mode: '0771', + } + end + + it do + is_expected.to contain_file('/tmp/nginx_proxy'). + with_mode('0771') + end + end + + context 'when client_body_temp_path is non-default' do + let(:params) { { client_body_temp_path: '/tmp/nginx_client' } } + + it do + is_expected.to contain_file('/tmp/nginx_client'). + without('mode') + end + end + + context 'when client_body_temp_mode is non-default' do + let(:params) do + { + client_body_temp_path: '/tmp/nginx_client', + client_body_temp_mode: '0771', + } + end + + it do + is_expected.to contain_file('/tmp/nginx_client'). + with_mode('0771') + end + end + context 'when gzip is non-default (on) test gzip defaults' do let(:params) { { gzip: 'on' } }