From c8062b4102192b3b0b9ae0864498c96ad49796ff Mon Sep 17 00:00:00 2001 From: Ramesh Sencha Date: Wed, 13 Sep 2023 15:32:47 +0530 Subject: [PATCH 1/2] (CAT-1417) Nested require support for authz_core mod --- .rubocop_todo.yml | 5 + README.md | 2 + REFERENCE.md | 5485 +++++++++-------- .../functions/apache/authz_core_config.rb | 78 + manifests/default_mods.pp | 12 +- manifests/mod/authz_core.pp | 8 + manifests/vhost.pp | 27 + spec/functions/authz_core_config_spec.rb | 53 + templates/vhost/_authz_core.epp | 3 + templates/vhost/_directories.erb | 3 + 10 files changed, 3000 insertions(+), 2676 deletions(-) create mode 100644 lib/puppet/functions/apache/authz_core_config.rb create mode 100644 manifests/mod/authz_core.pp create mode 100644 spec/functions/authz_core_config_spec.rb create mode 100644 templates/vhost/_authz_core.epp diff --git a/.rubocop_todo.yml b/.rubocop_todo.yml index 7295fd9d68..7d247b81e7 100644 --- a/.rubocop_todo.yml +++ b/.rubocop_todo.yml @@ -156,3 +156,8 @@ RSpec/RepeatedExampleGroupDescription: RSpec/StubbedMock: Exclude: - 'spec/util/apache_mod_platform_compatibility_spec.rb' + +# Offense count: 1 +Metrics/BlockLength: + Exclude: + - 'lib/puppet/functions/apache/authz_core_config.rb' diff --git a/README.md b/README.md index 0df2fd1c6b..5cabff0831 100644 --- a/README.md +++ b/README.md @@ -39,6 +39,7 @@ [`apache::mod::auth_mellon`]: https://forge.puppet.com/modules/puppetlabs/apache/reference#apachemodauth_mellon [`apache::mod::authn_dbd`]: https://forge.puppet.com/modules/puppetlabs/apache/reference#apachemodauthn_dbd [`apache::mod::authnz_ldap`]: https://forge.puppet.com/modules/puppetlabs/apache/reference#apachemodauthnz_ldap +[`apache::mod::authz_core`]: https://forge.puppet.com/modules/puppetlabs/apache/reference#apachemodauthz_core [`apache::mod::cluster`]: https://forge.puppet.com/modules/puppetlabs/apache/reference#apachemodcluster [`apache::mod::data]: https://forge.puppet.com/modules/puppetlabs/apache/reference#apachemoddata [`apache::mod::disk_cache`]: https://forge.puppet.com/modules/puppetlabs/apache/reference#apachemoddisk_cache @@ -157,6 +158,7 @@ [`mod_authnz_external`]: https://github.com/phokz/mod-auth-external [`mod_auth_dbd`]: http://httpd.apache.org/docs/current/mod/mod_authn_dbd.html [`mod_auth_mellon`]: https://github.com/UNINETT/mod_auth_mellon +[`mod_authz_core`]: https://httpd.apache.org/docs/current/mod/mod_authz_core.html [`mod_dbd`]: http://httpd.apache.org/docs/current/mod/mod_dbd.html [`mod_disk_cache`]: https://httpd.apache.org/docs/2.2/mod/mod_disk_cache.html [`mod_dumpio`]: https://httpd.apache.org/docs/2.4/mod/mod_dumpio.html diff --git a/REFERENCE.md b/REFERENCE.md index b758385acf..de492908db 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -9,107 +9,110 @@ #### Public Classes * [`apache`](#apache): Guides the basic setup and installation of Apache on your system. -* [`apache::dev`](#apache--dev): Installs Apache development libraries. -* [`apache::mod::actions`](#apache--mod--actions): Installs Apache mod_actions -* [`apache::mod::alias`](#apache--mod--alias): Installs and configures `mod_alias`. -* [`apache::mod::apreq2`](#apache--mod--apreq2): Installs `mod_apreq2`. -* [`apache::mod::auth_basic`](#apache--mod--auth_basic): Installs `mod_auth_basic` -* [`apache::mod::auth_cas`](#apache--mod--auth_cas): Installs and configures `mod_auth_cas`. -* [`apache::mod::auth_gssapi`](#apache--mod--auth_gssapi): Installs `mod_auth_gsappi`. -* [`apache::mod::auth_kerb`](#apache--mod--auth_kerb): Installs `mod_auth_kerb` -* [`apache::mod::auth_mellon`](#apache--mod--auth_mellon): Installs and configures `mod_auth_mellon`. -* [`apache::mod::auth_openidc`](#apache--mod--auth_openidc): Installs and configures `mod_auth_openidc`. -* [`apache::mod::authn_core`](#apache--mod--authn_core): Installs `mod_authn_core`. -* [`apache::mod::authn_dbd`](#apache--mod--authn_dbd): Installs `mod_authn_dbd`. -* [`apache::mod::authn_file`](#apache--mod--authn_file): Installs `mod_authn_file`. -* [`apache::mod::authnz_ldap`](#apache--mod--authnz_ldap): Installs `mod_authnz_ldap`. -* [`apache::mod::authnz_pam`](#apache--mod--authnz_pam): Installs `mod_authnz_pam`. -* [`apache::mod::authz_groupfile`](#apache--mod--authz_groupfile): Installs `mod_authz_groupfile` -* [`apache::mod::authz_user`](#apache--mod--authz_user): Installs `mod_authz_user` -* [`apache::mod::autoindex`](#apache--mod--autoindex): Installs `mod_autoindex` -* [`apache::mod::cache`](#apache--mod--cache): Installs `mod_cache` -* [`apache::mod::cgi`](#apache--mod--cgi): Installs `mod_cgi`. -* [`apache::mod::cgid`](#apache--mod--cgid): Installs `mod_cgid`. -* [`apache::mod::cluster`](#apache--mod--cluster): Installs `mod_cluster`. -* [`apache::mod::data`](#apache--mod--data): Installs and configures `mod_data`. -* [`apache::mod::dav`](#apache--mod--dav): Installs `mod_dav`. -* [`apache::mod::dav_fs`](#apache--mod--dav_fs): Installs `mod_dav_fs`. -* [`apache::mod::dav_svn`](#apache--mod--dav_svn): Installs and configures `mod_dav_svn`. -* [`apache::mod::dbd`](#apache--mod--dbd): Installs `mod_dbd`. -* [`apache::mod::deflate`](#apache--mod--deflate): Installs and configures `mod_deflate`. -* [`apache::mod::dev`](#apache--mod--dev): Installs `mod_dev`. -* [`apache::mod::dir`](#apache--mod--dir): Installs and configures `mod_dir`. -* [`apache::mod::disk_cache`](#apache--mod--disk_cache): Installs and configures `mod_disk_cache`. -* [`apache::mod::dumpio`](#apache--mod--dumpio): Installs and configures `mod_dumpio`. -* [`apache::mod::env`](#apache--mod--env): Installs `mod_env`. -* [`apache::mod::event`](#apache--mod--event): Installs and configures `mod_event`. -* [`apache::mod::expires`](#apache--mod--expires): Installs and configures `mod_expires`. -* [`apache::mod::ext_filter`](#apache--mod--ext_filter): Installs and configures `mod_ext_filter`. -* [`apache::mod::fcgid`](#apache--mod--fcgid): Installs and configures `mod_fcgid`. -* [`apache::mod::filter`](#apache--mod--filter): Installs `mod_filter`. -* [`apache::mod::geoip`](#apache--mod--geoip): Installs and configures `mod_geoip`. -* [`apache::mod::headers`](#apache--mod--headers): Installs and configures `mod_headers`. -* [`apache::mod::http2`](#apache--mod--http2): Installs and configures `mod_http2`. -* [`apache::mod::include`](#apache--mod--include): Installs `mod_include`. -* [`apache::mod::info`](#apache--mod--info): Installs and configures `mod_info`. -* [`apache::mod::intercept_form_submit`](#apache--mod--intercept_form_submit): Installs `mod_intercept_form_submit`. -* [`apache::mod::itk`](#apache--mod--itk): Installs MPM `mod_itk`. -* [`apache::mod::jk`](#apache--mod--jk): Installs `mod_jk`. -* [`apache::mod::lbmethod_bybusyness`](#apache--mod--lbmethod_bybusyness): Installs `lbmethod_bybusyness`. -* [`apache::mod::lbmethod_byrequests`](#apache--mod--lbmethod_byrequests): Installs `lbmethod_byrequests`. -* [`apache::mod::lbmethod_bytraffic`](#apache--mod--lbmethod_bytraffic): Installs `lbmethod_bytraffic`. -* [`apache::mod::lbmethod_heartbeat`](#apache--mod--lbmethod_heartbeat): Installs `lbmethod_heartbeat`. -* [`apache::mod::ldap`](#apache--mod--ldap): Installs and configures `mod_ldap`. -* [`apache::mod::lookup_identity`](#apache--mod--lookup_identity): Installs `mod_lookup_identity` -* [`apache::mod::macro`](#apache--mod--macro): Installs `mod_macro`. -* [`apache::mod::md`](#apache--mod--md): Installs and configures `mod_md`. -* [`apache::mod::mime`](#apache--mod--mime): Installs and configures `mod_mime`. -* [`apache::mod::mime_magic`](#apache--mod--mime_magic): Installs and configures `mod_mime_magic`. -* [`apache::mod::negotiation`](#apache--mod--negotiation): Installs and configures `mod_negotiation`. -* [`apache::mod::nss`](#apache--mod--nss): Installs and configures `mod_nss`. -* [`apache::mod::pagespeed`](#apache--mod--pagespeed): Installs and manages mod_pagespeed, which is a Google module that rewrites web pages to reduce latency and bandwidth. +* [`apache::dev`](#apachedev): Installs Apache development libraries. +* [`apache::mod::actions`](#apachemodactions): Installs Apache mod_actions +* [`apache::mod::alias`](#apachemodalias): Installs and configures `mod_alias`. +* [`apache::mod::apreq2`](#apachemodapreq2): Installs `mod_apreq2`. +* [`apache::mod::auth_basic`](#apachemodauth_basic): Installs `mod_auth_basic` +* [`apache::mod::auth_cas`](#apachemodauth_cas): Installs and configures `mod_auth_cas`. +* [`apache::mod::auth_gssapi`](#apachemodauth_gssapi): Installs `mod_auth_gsappi`. +* [`apache::mod::auth_kerb`](#apachemodauth_kerb): Installs `mod_auth_kerb` +* [`apache::mod::auth_mellon`](#apachemodauth_mellon): Installs and configures `mod_auth_mellon`. +* [`apache::mod::auth_openidc`](#apachemodauth_openidc): Installs and configures `mod_auth_openidc`. +* [`apache::mod::authn_core`](#apachemodauthn_core): Installs `mod_authn_core`. +* [`apache::mod::authn_dbd`](#apachemodauthn_dbd): Installs `mod_authn_dbd`. +* [`apache::mod::authn_file`](#apachemodauthn_file): Installs `mod_authn_file`. +* [`apache::mod::authnz_ldap`](#apachemodauthnz_ldap): Installs `mod_authnz_ldap`. +* [`apache::mod::authnz_pam`](#apachemodauthnz_pam): Installs `mod_authnz_pam`. +* [`apache::mod::authz_core`](#apachemodauthz_core): Installs `mod_authz_core`. +* [`apache::mod::authz_groupfile`](#apachemodauthz_groupfile): Installs `mod_authz_groupfile` +* [`apache::mod::authz_user`](#apachemodauthz_user): Installs `mod_authz_user` +* [`apache::mod::autoindex`](#apachemodautoindex): Installs `mod_autoindex` +* [`apache::mod::cache`](#apachemodcache): Installs `mod_cache` +* [`apache::mod::cgi`](#apachemodcgi): Installs `mod_cgi`. +* [`apache::mod::cgid`](#apachemodcgid): Installs `mod_cgid`. +* [`apache::mod::cluster`](#apachemodcluster): Installs `mod_cluster`. +* [`apache::mod::data`](#apachemoddata): Installs and configures `mod_data`. +* [`apache::mod::dav`](#apachemoddav): Installs `mod_dav`. +* [`apache::mod::dav_fs`](#apachemoddav_fs): Installs `mod_dav_fs`. +* [`apache::mod::dav_svn`](#apachemoddav_svn): Installs and configures `mod_dav_svn`. +* [`apache::mod::dbd`](#apachemoddbd): Installs `mod_dbd`. +* [`apache::mod::deflate`](#apachemoddeflate): Installs and configures `mod_deflate`. +* [`apache::mod::dev`](#apachemoddev): Installs `mod_dev`. +* [`apache::mod::dir`](#apachemoddir): Installs and configures `mod_dir`. +* [`apache::mod::disk_cache`](#apachemoddisk_cache): Installs and configures `mod_disk_cache`. +* [`apache::mod::dumpio`](#apachemoddumpio): Installs and configures `mod_dumpio`. +* [`apache::mod::env`](#apachemodenv): Installs `mod_env`. +* [`apache::mod::event`](#apachemodevent): Installs and configures `mod_event`. +* [`apache::mod::expires`](#apachemodexpires): Installs and configures `mod_expires`. +* [`apache::mod::ext_filter`](#apachemodext_filter): Installs and configures `mod_ext_filter`. +* [`apache::mod::fcgid`](#apachemodfcgid): Installs and configures `mod_fcgid`. +* [`apache::mod::filter`](#apachemodfilter): Installs `mod_filter`. +* [`apache::mod::geoip`](#apachemodgeoip): Installs and configures `mod_geoip`. +* [`apache::mod::headers`](#apachemodheaders): Installs and configures `mod_headers`. +* [`apache::mod::http2`](#apachemodhttp2): Installs and configures `mod_http2`. +* [`apache::mod::include`](#apachemodinclude): Installs `mod_include`. +* [`apache::mod::info`](#apachemodinfo): Installs and configures `mod_info`. +* [`apache::mod::intercept_form_submit`](#apachemodintercept_form_submit): Installs `mod_intercept_form_submit`. +* [`apache::mod::itk`](#apachemoditk): Installs MPM `mod_itk`. +* [`apache::mod::jk`](#apachemodjk): Installs `mod_jk`. +* [`apache::mod::lbmethod_bybusyness`](#apachemodlbmethod_bybusyness): Installs `lbmethod_bybusyness`. +* [`apache::mod::lbmethod_byrequests`](#apachemodlbmethod_byrequests): Installs `lbmethod_byrequests`. +* [`apache::mod::lbmethod_bytraffic`](#apachemodlbmethod_bytraffic): Installs `lbmethod_bytraffic`. +* [`apache::mod::lbmethod_heartbeat`](#apachemodlbmethod_heartbeat): Installs `lbmethod_heartbeat`. +* [`apache::mod::ldap`](#apachemodldap): Installs and configures `mod_ldap`. +* [`apache::mod::log_forensic`](#apachemodlog_forensic): Installs `mod_log_forensic` +* [`apache::mod::lookup_identity`](#apachemodlookup_identity): Installs `mod_lookup_identity` +* [`apache::mod::macro`](#apachemodmacro): Installs `mod_macro`. +* [`apache::mod::md`](#apachemodmd): Installs and configures `mod_md`. +* [`apache::mod::mime`](#apachemodmime): Installs and configures `mod_mime`. +* [`apache::mod::mime_magic`](#apachemodmime_magic): Installs and configures `mod_mime_magic`. +* [`apache::mod::negotiation`](#apachemodnegotiation): Installs and configures `mod_negotiation`. +* [`apache::mod::nss`](#apachemodnss): Installs and configures `mod_nss`. +* [`apache::mod::pagespeed`](#apachemodpagespeed): Installs and manages mod_pagespeed, which is a Google module that rewrites web pages to reduce latency and bandwidth. This module does *not* manage the software repositories needed to automatically install the mod-pagespeed-stable package. The module does however require that the package be installed, or be installable using the system's default package provider. You should ensure that this pre-requisite is met or declaring `apache::mod::pagespeed` will cause the puppet run to fail. -* [`apache::mod::passenger`](#apache--mod--passenger): Installs `mod_pasenger`. -* [`apache::mod::perl`](#apache--mod--perl): Installs `mod_perl`. -* [`apache::mod::peruser`](#apache--mod--peruser): Installs `mod_peruser`. -* [`apache::mod::php`](#apache--mod--php): Installs `mod_php`. -* [`apache::mod::prefork`](#apache--mod--prefork): Installs and configures MPM `prefork`. -* [`apache::mod::proxy`](#apache--mod--proxy): Installs and configures `mod_proxy`. -* [`apache::mod::proxy_ajp`](#apache--mod--proxy_ajp): Installs `mod_proxy_ajp`. -* [`apache::mod::proxy_balancer`](#apache--mod--proxy_balancer): Installs and configures `mod_proxy_balancer`. -* [`apache::mod::proxy_connect`](#apache--mod--proxy_connect): Installs `mod_proxy_connect`. -* [`apache::mod::proxy_fcgi`](#apache--mod--proxy_fcgi): Installs `mod_proxy_fcgi`. -* [`apache::mod::proxy_html`](#apache--mod--proxy_html): Installs `mod_proxy_html`. -* [`apache::mod::proxy_http`](#apache--mod--proxy_http): Installs `mod_proxy_http`. -* [`apache::mod::proxy_wstunnel`](#apache--mod--proxy_wstunnel): Installs `mod_proxy_wstunnel`. -* [`apache::mod::python`](#apache--mod--python): Installs and configures `mod_python`. -* [`apache::mod::remoteip`](#apache--mod--remoteip): Installs and configures `mod_remoteip`. -* [`apache::mod::reqtimeout`](#apache--mod--reqtimeout): Installs and configures `mod_reqtimeout`. -* [`apache::mod::rewrite`](#apache--mod--rewrite): Installs `mod_rewrite`. -* [`apache::mod::rpaf`](#apache--mod--rpaf): Installs and configures `mod_rpaf`. -* [`apache::mod::security`](#apache--mod--security): Installs and configures `mod_security`. -* [`apache::mod::setenvif`](#apache--mod--setenvif): Installs `mod_setenvif`. -* [`apache::mod::shib`](#apache--mod--shib): Installs and configures `mod_shib`. -* [`apache::mod::socache_shmcb`](#apache--mod--socache_shmcb): Installs `mod_socache_shmcb`. -* [`apache::mod::speling`](#apache--mod--speling): Installs `mod_spelling`. -* [`apache::mod::ssl`](#apache--mod--ssl): Installs `mod_ssl`. -* [`apache::mod::status`](#apache--mod--status): Installs and configures `mod_status`. -* [`apache::mod::suexec`](#apache--mod--suexec): Installs `mod_suexec`. -* [`apache::mod::userdir`](#apache--mod--userdir): Installs and configures `mod_userdir`. -* [`apache::mod::version`](#apache--mod--version): Installs `mod_version`. -* [`apache::mod::vhost_alias`](#apache--mod--vhost_alias): Installs Apache `mod_vhost_alias`. -* [`apache::mod::watchdog`](#apache--mod--watchdog): Installs and configures `mod_watchdog`. -* [`apache::mod::worker`](#apache--mod--worker): Installs and manages the MPM `worker`. -* [`apache::mod::wsgi`](#apache--mod--wsgi): Installs and configures `mod_wsgi`. -* [`apache::mod::xsendfile`](#apache--mod--xsendfile): Installs `mod_xsendfile`. -* [`apache::mpm::disable_mpm_event`](#apache--mpm--disable_mpm_event): disable Apache-Module event -* [`apache::mpm::disable_mpm_prefork`](#apache--mpm--disable_mpm_prefork): disable Apache-Module prefork -* [`apache::mpm::disable_mpm_worker`](#apache--mpm--disable_mpm_worker): disable Apache-Module worker -* [`apache::vhosts`](#apache--vhosts): Creates `apache::vhost` defined types. +* [`apache::mod::passenger`](#apachemodpassenger): Installs `mod_pasenger`. +* [`apache::mod::perl`](#apachemodperl): Installs `mod_perl`. +* [`apache::mod::peruser`](#apachemodperuser): Installs `mod_peruser`. +* [`apache::mod::php`](#apachemodphp): Installs `mod_php`. +* [`apache::mod::prefork`](#apachemodprefork): Installs and configures MPM `prefork`. +* [`apache::mod::proxy`](#apachemodproxy): Installs and configures `mod_proxy`. +* [`apache::mod::proxy_ajp`](#apachemodproxy_ajp): Installs `mod_proxy_ajp`. +* [`apache::mod::proxy_balancer`](#apachemodproxy_balancer): Installs and configures `mod_proxy_balancer`. +* [`apache::mod::proxy_connect`](#apachemodproxy_connect): Installs `mod_proxy_connect`. +* [`apache::mod::proxy_fcgi`](#apachemodproxy_fcgi): Installs `mod_proxy_fcgi`. +* [`apache::mod::proxy_html`](#apachemodproxy_html): Installs `mod_proxy_html`. +* [`apache::mod::proxy_http`](#apachemodproxy_http): Installs `mod_proxy_http`. +* [`apache::mod::proxy_http2`](#apachemodproxy_http2): Installs `mod_proxy_http2`. +* [`apache::mod::proxy_wstunnel`](#apachemodproxy_wstunnel): Installs `mod_proxy_wstunnel`. +* [`apache::mod::python`](#apachemodpython): Installs and configures `mod_python`. +* [`apache::mod::remoteip`](#apachemodremoteip): Installs and configures `mod_remoteip`. +* [`apache::mod::reqtimeout`](#apachemodreqtimeout): Installs and configures `mod_reqtimeout`. +* [`apache::mod::rewrite`](#apachemodrewrite): Installs `mod_rewrite`. +* [`apache::mod::rpaf`](#apachemodrpaf): Installs and configures `mod_rpaf`. +* [`apache::mod::security`](#apachemodsecurity): Installs and configures `mod_security`. +* [`apache::mod::setenvif`](#apachemodsetenvif): Installs `mod_setenvif`. +* [`apache::mod::shib`](#apachemodshib): Installs and configures `mod_shib`. +* [`apache::mod::socache_shmcb`](#apachemodsocache_shmcb): Installs `mod_socache_shmcb`. +* [`apache::mod::speling`](#apachemodspeling): Installs `mod_spelling`. +* [`apache::mod::ssl`](#apachemodssl): Installs `mod_ssl`. +* [`apache::mod::status`](#apachemodstatus): Installs and configures `mod_status`. +* [`apache::mod::suexec`](#apachemodsuexec): Installs `mod_suexec`. +* [`apache::mod::userdir`](#apachemoduserdir): Installs and configures `mod_userdir`. +* [`apache::mod::version`](#apachemodversion): Installs `mod_version`. +* [`apache::mod::vhost_alias`](#apachemodvhost_alias): Installs Apache `mod_vhost_alias`. +* [`apache::mod::watchdog`](#apachemodwatchdog): Installs and configures `mod_watchdog`. +* [`apache::mod::worker`](#apachemodworker): Installs and manages the MPM `worker`. +* [`apache::mod::wsgi`](#apachemodwsgi): Installs and configures `mod_wsgi`. +* [`apache::mod::xsendfile`](#apachemodxsendfile): Installs `mod_xsendfile`. +* [`apache::mpm::disable_mpm_event`](#apachempmdisable_mpm_event): disable Apache-Module event +* [`apache::mpm::disable_mpm_prefork`](#apachempmdisable_mpm_prefork): disable Apache-Module prefork +* [`apache::mpm::disable_mpm_worker`](#apachempmdisable_mpm_worker): disable Apache-Module worker +* [`apache::vhosts`](#apachevhosts): Creates `apache::vhost` defined types. #### Private Classes @@ -130,22 +133,22 @@ pre-requisite is met or declaring `apache::mod::pagespeed` will cause the puppet #### Public Defined types -* [`apache::balancer`](#apache--balancer): This type will create an apache balancer cluster file inside the conf.d +* [`apache::balancer`](#apachebalancer): This type will create an apache balancer cluster file inside the conf.d directory. -* [`apache::balancermember`](#apache--balancermember): Defines members of `mod_proxy_balancer` -* [`apache::custom_config`](#apache--custom_config): Adds a custom configuration file to the Apache server's `conf.d` directory. -* [`apache::fastcgi::server`](#apache--fastcgi--server): Defines one or more external FastCGI servers to handle specific file types. Use this +* [`apache::balancermember`](#apachebalancermember): Defines members of `mod_proxy_balancer` +* [`apache::custom_config`](#apachecustom_config): Adds a custom configuration file to the Apache server's `conf.d` directory. +* [`apache::fastcgi::server`](#apachefastcgiserver): Defines one or more external FastCGI servers to handle specific file types. Use this defined type with `mod_fastcgi`. -* [`apache::listen`](#apache--listen): Adds `Listen` directives to `ports.conf` that define the +* [`apache::listen`](#apachelisten): Adds `Listen` directives to `ports.conf` that define the Apache server's or a virtual host's listening address and port. -* [`apache::mod`](#apache--mod): Installs packages for an Apache module that doesn't have a corresponding +* [`apache::mod`](#apachemod): Installs packages for an Apache module that doesn't have a corresponding `apache::mod::` class. -* [`apache::namevirtualhost`](#apache--namevirtualhost): Enables name-based virtual hosts -* [`apache::vhost`](#apache--vhost): Allows specialised configurations for virtual hosts that possess requirements +* [`apache::namevirtualhost`](#apachenamevirtualhost): Enables name-based virtual hosts +* [`apache::vhost`](#apachevhost): Allows specialised configurations for virtual hosts that possess requirements outside of the defaults. -* [`apache::vhost::custom`](#apache--vhost--custom): A wrapper around the `apache::custom_config` defined type. -* [`apache::vhost::fragment`](#apache--vhost--fragment): Define a fragment within a vhost -* [`apache::vhost::proxy`](#apache--vhost--proxy): Configure a reverse proxy for a vhost +* [`apache::vhost::custom`](#apachevhostcustom): A wrapper around the `apache::custom_config` defined type. +* [`apache::vhost::fragment`](#apachevhostfragment): Define a fragment within a vhost +* [`apache::vhost::proxy`](#apachevhostproxy): Configure a reverse proxy for a vhost #### Private Defined types @@ -157,20 +160,22 @@ outside of the defaults. ### Functions -* [`apache::apache_pw_hash`](#apache--apache_pw_hash): DEPRECATED. Use the function [`apache::pw_hash`](#apachepw_hash) instead. -* [`apache::bool2httpd`](#apache--bool2httpd): Transform a supposed boolean to On or Off. Passes all other values through. -* [`apache::pw_hash`](#apache--pw_hash): Hashes a password in a format suitable for htpasswd files read by apache. +* [`apache::apache_pw_hash`](#apacheapache_pw_hash): DEPRECATED. Use the function [`apache::pw_hash`](#apachepw_hash) instead. +* [`apache::authz_core_config`](#apacheauthz_core_config): Function to generate the authz_core configuration directives. +* [`apache::bool2httpd`](#apachebool2httpd): Transform a supposed boolean to On or Off. Passes all other values through. +* [`apache::pw_hash`](#apachepw_hash): Hashes a password in a format suitable for htpasswd files read by apache. * [`apache_pw_hash`](#apache_pw_hash): DEPRECATED. Use the namespaced function [`apache::pw_hash`](#apachepw_hash) instead. * [`bool2httpd`](#bool2httpd): DEPRECATED. Use the namespaced function [`apache::bool2httpd`](#apachebool2httpd) instead. ### Data types -* [`Apache::LogLevel`](#Apache--LogLevel): A string that conforms to the Apache `LogLevel` syntax. -* [`Apache::ModProxyProtocol`](#Apache--ModProxyProtocol): Supported protocols / schemes by mod_proxy -* [`Apache::OIDCSettings`](#Apache--OIDCSettings): https://github.com/zmartzone/mod_auth_openidc/blob/master/auth_openidc.conf -* [`Apache::ServerTokens`](#Apache--ServerTokens): A string that conforms to the Apache `ServerTokens` syntax. -* [`Apache::Vhost::Priority`](#Apache--Vhost--Priority): The priority on vhost -* [`Apache::Vhost::ProxyPass`](#Apache--Vhost--ProxyPass): Struct representing reverse proxy configuration for an Apache vhost, used by the Apache::Vhost::Proxy defined resource type. +* [`Apache::LogLevel`](#apacheloglevel): A string that conforms to the Apache `LogLevel` syntax. +* [`Apache::ModProxyProtocol`](#apachemodproxyprotocol): Supported protocols / schemes by mod_proxy +* [`Apache::OIDCSettings`](#apacheoidcsettings): https://github.com/zmartzone/mod_auth_openidc/blob/master/auth_openidc.conf +* [`Apache::OnOff`](#apacheonoff): A string that is accepted in Apache config to turn something on or off +* [`Apache::ServerTokens`](#apacheservertokens): A string that conforms to the Apache `ServerTokens` syntax. +* [`Apache::Vhost::Priority`](#apachevhostpriority): The priority on vhost +* [`Apache::Vhost::ProxyPass`](#apachevhostproxypass): Struct representing reverse proxy configuration for an Apache vhost, used by the Apache::Vhost::Proxy defined resource type. ### Tasks @@ -201,105 +206,105 @@ class { 'apache': } The following parameters are available in the `apache` class: -* [`allow_encoded_slashes`](#-apache--allow_encoded_slashes) -* [`conf_dir`](#-apache--conf_dir) -* [`conf_template`](#-apache--conf_template) -* [`confd_dir`](#-apache--confd_dir) -* [`default_charset`](#-apache--default_charset) -* [`default_confd_files`](#-apache--default_confd_files) -* [`default_mods`](#-apache--default_mods) -* [`default_ssl_ca`](#-apache--default_ssl_ca) -* [`default_ssl_cert`](#-apache--default_ssl_cert) -* [`default_ssl_chain`](#-apache--default_ssl_chain) -* [`default_ssl_crl`](#-apache--default_ssl_crl) -* [`default_ssl_crl_path`](#-apache--default_ssl_crl_path) -* [`default_ssl_crl_check`](#-apache--default_ssl_crl_check) -* [`default_ssl_key`](#-apache--default_ssl_key) -* [`default_ssl_reload_on_change`](#-apache--default_ssl_reload_on_change) -* [`default_ssl_vhost`](#-apache--default_ssl_vhost) -* [`default_type`](#-apache--default_type) -* [`default_vhost`](#-apache--default_vhost) -* [`dev_packages`](#-apache--dev_packages) -* [`docroot`](#-apache--docroot) -* [`error_documents`](#-apache--error_documents) -* [`group`](#-apache--group) -* [`httpd_dir`](#-apache--httpd_dir) -* [`http_protocol_options`](#-apache--http_protocol_options) -* [`keepalive`](#-apache--keepalive) -* [`keepalive_timeout`](#-apache--keepalive_timeout) -* [`max_keepalive_requests`](#-apache--max_keepalive_requests) -* [`hostname_lookups`](#-apache--hostname_lookups) -* [`ldap_trusted_mode`](#-apache--ldap_trusted_mode) -* [`ldap_verify_server_cert`](#-apache--ldap_verify_server_cert) -* [`lib_path`](#-apache--lib_path) -* [`log_level`](#-apache--log_level) -* [`log_formats`](#-apache--log_formats) -* [`logroot`](#-apache--logroot) -* [`logroot_mode`](#-apache--logroot_mode) -* [`manage_group`](#-apache--manage_group) -* [`supplementary_groups`](#-apache--supplementary_groups) -* [`manage_user`](#-apache--manage_user) -* [`mod_dir`](#-apache--mod_dir) -* [`mod_libs`](#-apache--mod_libs) -* [`mod_packages`](#-apache--mod_packages) -* [`mpm_module`](#-apache--mpm_module) -* [`package_ensure`](#-apache--package_ensure) -* [`pidfile`](#-apache--pidfile) -* [`ports_file`](#-apache--ports_file) -* [`protocols`](#-apache--protocols) -* [`protocols_honor_order`](#-apache--protocols_honor_order) -* [`purge_configs`](#-apache--purge_configs) -* [`purge_vhost_dir`](#-apache--purge_vhost_dir) -* [`sendfile`](#-apache--sendfile) -* [`serveradmin`](#-apache--serveradmin) -* [`servername`](#-apache--servername) -* [`server_root`](#-apache--server_root) -* [`server_signature`](#-apache--server_signature) -* [`server_tokens`](#-apache--server_tokens) -* [`service_enable`](#-apache--service_enable) -* [`service_ensure`](#-apache--service_ensure) -* [`service_name`](#-apache--service_name) -* [`service_manage`](#-apache--service_manage) -* [`service_restart`](#-apache--service_restart) -* [`timeout`](#-apache--timeout) -* [`trace_enable`](#-apache--trace_enable) -* [`use_canonical_name`](#-apache--use_canonical_name) -* [`use_systemd`](#-apache--use_systemd) -* [`file_mode`](#-apache--file_mode) -* [`root_directory_options`](#-apache--root_directory_options) -* [`root_directory_secured`](#-apache--root_directory_secured) -* [`vhost_dir`](#-apache--vhost_dir) -* [`vhost_include_pattern`](#-apache--vhost_include_pattern) -* [`user`](#-apache--user) -* [`apache_name`](#-apache--apache_name) -* [`error_log`](#-apache--error_log) -* [`scriptalias`](#-apache--scriptalias) -* [`access_log_file`](#-apache--access_log_file) -* [`limitreqfields`](#-apache--limitreqfields) -* [`limitreqfieldsize`](#-apache--limitreqfieldsize) -* [`limitreqline`](#-apache--limitreqline) -* [`ip`](#-apache--ip) -* [`purge_vdir`](#-apache--purge_vdir) -* [`conf_enabled`](#-apache--conf_enabled) -* [`vhost_enable_dir`](#-apache--vhost_enable_dir) -* [`manage_vhost_enable_dir`](#-apache--manage_vhost_enable_dir) -* [`mod_enable_dir`](#-apache--mod_enable_dir) -* [`ssl_file`](#-apache--ssl_file) -* [`file_e_tag`](#-apache--file_e_tag) -* [`use_optional_includes`](#-apache--use_optional_includes) -* [`mime_types_additional`](#-apache--mime_types_additional) - -##### `allow_encoded_slashes` - -Data type: `Optional[Enum['on', 'off', 'nodecode']]` +* [`allow_encoded_slashes`](#allow_encoded_slashes) +* [`conf_dir`](#conf_dir) +* [`conf_template`](#conf_template) +* [`confd_dir`](#confd_dir) +* [`default_charset`](#default_charset) +* [`default_confd_files`](#default_confd_files) +* [`default_mods`](#default_mods) +* [`default_ssl_ca`](#default_ssl_ca) +* [`default_ssl_cert`](#default_ssl_cert) +* [`default_ssl_chain`](#default_ssl_chain) +* [`default_ssl_crl`](#default_ssl_crl) +* [`default_ssl_crl_path`](#default_ssl_crl_path) +* [`default_ssl_crl_check`](#default_ssl_crl_check) +* [`default_ssl_key`](#default_ssl_key) +* [`default_ssl_reload_on_change`](#default_ssl_reload_on_change) +* [`default_ssl_vhost`](#default_ssl_vhost) +* [`default_type`](#default_type) +* [`default_vhost`](#default_vhost) +* [`dev_packages`](#dev_packages) +* [`docroot`](#docroot) +* [`error_documents`](#error_documents) +* [`group`](#group) +* [`httpd_dir`](#httpd_dir) +* [`http_protocol_options`](#http_protocol_options) +* [`keepalive`](#keepalive) +* [`keepalive_timeout`](#keepalive_timeout) +* [`max_keepalive_requests`](#max_keepalive_requests) +* [`hostname_lookups`](#hostname_lookups) +* [`ldap_trusted_mode`](#ldap_trusted_mode) +* [`ldap_verify_server_cert`](#ldap_verify_server_cert) +* [`lib_path`](#lib_path) +* [`log_level`](#log_level) +* [`log_formats`](#log_formats) +* [`logroot`](#logroot) +* [`logroot_mode`](#logroot_mode) +* [`manage_group`](#manage_group) +* [`supplementary_groups`](#supplementary_groups) +* [`manage_user`](#manage_user) +* [`mod_dir`](#mod_dir) +* [`mod_libs`](#mod_libs) +* [`mod_packages`](#mod_packages) +* [`mpm_module`](#mpm_module) +* [`package_ensure`](#package_ensure) +* [`pidfile`](#pidfile) +* [`ports_file`](#ports_file) +* [`protocols`](#protocols) +* [`protocols_honor_order`](#protocols_honor_order) +* [`purge_configs`](#purge_configs) +* [`purge_vhost_dir`](#purge_vhost_dir) +* [`sendfile`](#sendfile) +* [`serveradmin`](#serveradmin) +* [`servername`](#servername) +* [`server_root`](#server_root) +* [`server_signature`](#server_signature) +* [`server_tokens`](#server_tokens) +* [`service_enable`](#service_enable) +* [`service_ensure`](#service_ensure) +* [`service_name`](#service_name) +* [`service_manage`](#service_manage) +* [`service_restart`](#service_restart) +* [`timeout`](#timeout) +* [`trace_enable`](#trace_enable) +* [`use_canonical_name`](#use_canonical_name) +* [`use_systemd`](#use_systemd) +* [`file_mode`](#file_mode) +* [`root_directory_options`](#root_directory_options) +* [`root_directory_secured`](#root_directory_secured) +* [`vhost_dir`](#vhost_dir) +* [`vhost_include_pattern`](#vhost_include_pattern) +* [`user`](#user) +* [`apache_name`](#apache_name) +* [`error_log`](#error_log) +* [`scriptalias`](#scriptalias) +* [`access_log_file`](#access_log_file) +* [`limitreqfields`](#limitreqfields) +* [`limitreqfieldsize`](#limitreqfieldsize) +* [`limitreqline`](#limitreqline) +* [`ip`](#ip) +* [`purge_vdir`](#purge_vdir) +* [`conf_enabled`](#conf_enabled) +* [`vhost_enable_dir`](#vhost_enable_dir) +* [`manage_vhost_enable_dir`](#manage_vhost_enable_dir) +* [`mod_enable_dir`](#mod_enable_dir) +* [`ssl_file`](#ssl_file) +* [`file_e_tag`](#file_e_tag) +* [`use_optional_includes`](#use_optional_includes) +* [`mime_types_additional`](#mime_types_additional) + +##### `allow_encoded_slashes` + +Data type: `Optional[Variant[Apache::OnOff, Enum['nodecode']]]` Sets the server default for the `AllowEncodedSlashes` declaration, which modifies the responses to URLs containing '\' and '/' characters. If not specified, this parameter omits the declaration from the server's configuration and uses Apache's default setting of 'off'. -Default value: `undef` +Default value: ``undef`` -##### `conf_dir` +##### `conf_dir` Data type: `Stdlib::Absolutepath` @@ -307,7 +312,7 @@ Sets the directory where the Apache server's main configuration file is located. Default value: `$apache::params::conf_dir` -##### `conf_template` +##### `conf_template` Data type: `String` @@ -317,7 +322,7 @@ configuration file customized by `conf.d` entries. Default value: `$apache::params::conf_template` -##### `confd_dir` +##### `confd_dir` Data type: `Stdlib::Absolutepath` @@ -325,15 +330,15 @@ Sets the location of the Apache server's custom configuration directory. Default value: `$apache::params::confd_dir` -##### `default_charset` +##### `default_charset` Data type: `Optional[String]` Used as the `AddDefaultCharset` directive in the main configuration file. -Default value: `undef` +Default value: ``undef`` -##### `default_confd_files` +##### `default_confd_files` Data type: `Boolean` @@ -342,9 +347,9 @@ in the directory defined by the `confd_dir` parameter. These configuration files correspond to what is typically installed with the Apache package on the server's operating system. -Default value: `true` +Default value: ``true`` -##### `default_mods` +##### `default_mods` Data type: `Variant[Array[String[1]], Boolean]` @@ -356,18 +361,11 @@ on your operating system, and you can declare any other modules separately using If `true`, Puppet installs additional modules, depending on the operating system and the value of the `mpm_module` parameter. Because these lists of modules can change frequently, consult the Puppet module's code for up-to-date lists.
-If this parameter contains an array, Puppet will enable all the Apache modules passed in it. -Passing the values as an array of strings provides the flexibility to override the default mods and install modules defined in `$default_mods`. -For example, with array of string:
-```puppet -class { 'apache': - default_mods => ['cache', 'info', 'mime_magic'] -} -``` +If this parameter contains an array, Puppet instead enables all passed Apache modules. -Default value: `true` +Default value: ``true`` -##### `default_ssl_ca` +##### `default_ssl_ca` Data type: `Optional[Stdlib::Absolutepath]` @@ -376,9 +374,9 @@ Although the default value results in a functioning Apache server, you **must** this parameter with your certificate authority information before deploying this server in a production environment. -Default value: `undef` +Default value: ``undef`` -##### `default_ssl_cert` +##### `default_ssl_cert` Data type: `Stdlib::Absolutepath` @@ -388,7 +386,7 @@ parameter with your certificate location before deploying this server in a produ Default value: `$apache::params::default_ssl_cert` -##### `default_ssl_chain` +##### `default_ssl_chain` Data type: `Optional[Stdlib::Absolutepath]` @@ -396,9 +394,9 @@ Sets the default SSL chain location.
Although this default value results in a functioning Apache server, you **must** update this parameter with your SSL chain before deploying this server in a production environment. -Default value: `undef` +Default value: ``undef`` -##### `default_ssl_crl` +##### `default_ssl_crl` Data type: `Optional[Stdlib::Absolutepath]` @@ -407,9 +405,9 @@ Although this default value results in a functioning Apache server, you **must** this parameter with the CRL file path before deploying this server in a production environment. You can use this parameter with or in place of the `default_ssl_crl_path`. -Default value: `undef` +Default value: ``undef`` -##### `default_ssl_crl_path` +##### `default_ssl_crl_path` Data type: `Optional[Stdlib::Absolutepath]` @@ -417,9 +415,9 @@ Sets the server's certificate revocation list path, which contains your CRLs.
`default_ssl_crl_check` +##### `default_ssl_crl_check` Data type: `Optional[String]` @@ -428,9 +426,9 @@ This parameter applies only to Apache 2.4 or higher and is ignored on older vers Although this default value results in a functioning Apache server, you **must** specify this parameter when using certificate revocation lists in a production environment. -Default value: `undef` +Default value: ``undef`` -##### `default_ssl_key` +##### `default_ssl_key` Data type: `Stdlib::Absolutepath` @@ -441,15 +439,15 @@ environment. Default value: `$apache::params::default_ssl_key` -##### `default_ssl_reload_on_change` +##### `default_ssl_reload_on_change` Data type: `Boolean` Enable reloading of apache if the content of ssl files have changed. -Default value: `false` +Default value: ``false`` -##### `default_ssl_vhost` +##### `default_ssl_vhost` Data type: `Boolean` @@ -468,9 +466,9 @@ apache::vhost { 'default-ssl': ``` **Note**: SSL virtual hosts only respond to HTTPS queries. -Default value: `false` +Default value: ``false`` -##### `default_type` +##### `default_type` Data type: `String` @@ -480,7 +478,7 @@ newer, and is only for backwards compatibility in configuration files. Default value: `'none'` -##### `default_vhost` +##### `default_vhost` Data type: `Boolean` @@ -490,9 +488,9 @@ value to `false`.
> **Note**: Apache will not start without at least one virtual host. If you set this to `false` you must configure a virtual host elsewhere. -Default value: `true` +Default value: ``true`` -##### `dev_packages` +##### `dev_packages` Data type: `Optional[Variant[Array, String]]` @@ -508,7 +506,7 @@ class { 'apache': Default value: `$apache::params::dev_packages` -##### `docroot` +##### `docroot` Data type: `Stdlib::Absolutepath` @@ -516,15 +514,15 @@ Sets the default `DocumentRoot` location. Default value: `$apache::params::docroot` -##### `error_documents` +##### `error_documents` Data type: `Boolean` Determines whether to enable [custom error documents](https://httpd.apache.org/docs/current/custom-error.html) on the Apache server. -Default value: `false` +Default value: ``false`` -##### `group` +##### `group` Data type: `String` @@ -539,7 +537,7 @@ process. Default value: `$apache::params::group` -##### `httpd_dir` +##### `httpd_dir` Data type: `Stdlib::Absolutepath` @@ -549,7 +547,7 @@ with the default distribution packages. Default value: `$apache::params::httpd_dir` -##### `http_protocol_options` +##### `http_protocol_options` Data type: `Optional[String]` @@ -559,9 +557,9 @@ Valid options: any sequence of the following alternative values: `Strict` or `Un Default value: `$apache::params::http_protocol_options` -##### `keepalive` +##### `keepalive` -Data type: `Enum['On', 'Off']` +Data type: `Apache::OnOff` Determines whether to enable persistent HTTP connections with the `KeepAlive` directive. If you set this to `On`, use the `keepalive_timeout` and `max_keepalive_requests` parameters @@ -569,7 +567,7 @@ to set relevant options.
Default value: `$apache::params::keepalive` -##### `keepalive_timeout` +##### `keepalive_timeout` Data type: `Integer` @@ -579,7 +577,7 @@ only relevant if the `keepalive` parameter is enabled. Default value: `$apache::params::keepalive_timeout` -##### `max_keepalive_requests` +##### `max_keepalive_requests` Data type: `Integer` @@ -587,9 +585,9 @@ Limits the number of requests allowed per connection when the `keepalive` parame Default value: `$apache::params::max_keepalive_requests` -##### `hostname_lookups` +##### `hostname_lookups` -Data type: `Enum['Off', 'On', 'Double', 'off', 'on', 'double']` +Data type: `Variant[Apache::OnOff, Enum['Double', 'double']]` This directive enables DNS lookups so that host names can be logged and passed to CGIs/SSIs in REMOTE_HOST.
@@ -597,7 +595,7 @@ CGIs/SSIs in REMOTE_HOST.
Default value: `$apache::params::hostname_lookups` -##### `ldap_trusted_mode` +##### `ldap_trusted_mode` Data type: `Optional[String]` @@ -609,19 +607,19 @@ The following modes are supported: Not all LDAP toolkits support all the above modes. An error message will be logged at runtime if a mode is not supported, and the connection to the LDAP server will fail. -Default value: `undef` +Default value: ``undef`` -##### `ldap_verify_server_cert` +##### `ldap_verify_server_cert` -Data type: `Optional[Enum['On', 'Off', 'on', 'off']]` +Data type: `Optional[Apache::OnOff]` Specifies whether to force the verification of a server certificate when establishing an SSL connection to the LDAP server. On|Off -Default value: `undef` +Default value: ``undef`` -##### `lib_path` +##### `lib_path` Data type: `String` @@ -630,7 +628,7 @@ Specifies the location whereApache module files are stored.
Default value: `$apache::params::lib_path` -##### `log_level` +##### `log_level` Data type: `Apache::LogLevel` @@ -639,7 +637,7 @@ which adjusts the verbosity of the messages recorded in the error logs. Default value: `$apache::params::log_level` -##### `log_formats` +##### `log_formats` Data type: `Hash` @@ -659,7 +657,7 @@ If your `log_formats` parameter contains one of those, it will be overwritten wi Default value: `{}` -##### `logroot` +##### `logroot` Data type: `Stdlib::Absolutepath` @@ -667,7 +665,7 @@ Changes the directory of Apache log files for the virtual host. Default value: `$apache::params::logroot` -##### `logroot_mode` +##### `logroot_mode` Data type: `Optional[Stdlib::Filemode]` @@ -678,7 +676,7 @@ for details. Default value: `$apache::params::logroot_mode` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -687,9 +685,9 @@ If you have a group created from another Puppet module that you want to use to r set this to `false`. Without this parameter, attempting to use a previously established group results in a duplicate resource error. -Default value: `true` +Default value: ``true`` -##### `supplementary_groups` +##### `supplementary_groups` Data type: `Array` @@ -698,7 +696,7 @@ Notice: This option only has an effect when `manage_user` is set to true. Default value: `[]` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -707,9 +705,9 @@ This is for instances when you have a user, created from another Puppet module, to use to run Apache. Without this parameter, attempting to use a previously established user would result in a duplicate resource error. -Default value: `true` +Default value: ``true`` -##### `mod_dir` +##### `mod_dir` Data type: `Stdlib::Absolutepath` @@ -717,7 +715,7 @@ Sets where Puppet places configuration files for your Apache modules. Default value: `$apache::params::mod_dir` -##### `mod_libs` +##### `mod_libs` Data type: `Hash` @@ -733,7 +731,7 @@ class { 'apache': Default value: `$apache::params::mod_libs` -##### `mod_packages` +##### `mod_packages` Data type: `Hash` @@ -749,7 +747,7 @@ class { 'apache': Default value: `$apache::params::mod_packages` -##### `mpm_module` +##### `mpm_module` Data type: `Variant[Boolean, Enum['event', 'itk', 'peruser', 'prefork', 'worker']]` @@ -764,7 +762,7 @@ You must set this to `false` to explicitly declare the following classes with cu Default value: `$apache::params::mpm_module` -##### `package_ensure` +##### `package_ensure` Data type: `String` @@ -773,7 +771,7 @@ Controls the `package` resource's `ensure` attribute. Valid values are: `absent` Default value: `'installed'` -##### `pidfile` +##### `pidfile` Data type: `String` @@ -781,7 +779,7 @@ Allows settting a custom location for the pid file. Useful if using a custom-bui Default value: `$apache::params::pidfile` -##### `ports_file` +##### `ports_file` Data type: `Stdlib::Absolutepath` @@ -789,7 +787,7 @@ Sets the path to the file containing Apache ports configuration. Default value: `$apache::params::ports_file` -##### `protocols` +##### `protocols` Data type: `Array[Enum['h2', 'h2c', 'http/1.1']]` @@ -798,16 +796,16 @@ directive, which lists available protocols for the server. Default value: `[]` -##### `protocols_honor_order` +##### `protocols_honor_order` Data type: `Optional[Boolean]` Sets the [ProtocolsHonorOrder](https://httpd.apache.org/docs/current/en/mod/core.html#protocolshonororder) directive which determines whether the order of Protocols sets precedence during negotiation. -Default value: `undef` +Default value: ``undef`` -##### `purge_configs` +##### `purge_configs` Data type: `Boolean` @@ -816,9 +814,9 @@ Setting this to `false` is a stopgap measure to allow the apache module to coexi existing or unmanaged configurations. We recommend moving your configuration to resources within this module. For virtual host configurations, see `purge_vhost_dir`. -Default value: `true` +Default value: ``true`` -##### `purge_vhost_dir` +##### `purge_vhost_dir` Data type: `Optional[Boolean]` @@ -828,26 +826,26 @@ by Puppet.
Setting `purge_vhost_dir` to `false` is a stopgap measure to allow the apache module to coexist with existing or otherwise unmanaged configurations within `vhost_dir`. -Default value: `undef` +Default value: ``undef`` -##### `sendfile` +##### `sendfile` -Data type: `Enum['On', 'Off', 'on', 'off']` +Data type: `Apache::OnOff` Forces Apache to use the Linux kernel's `sendfile` support to serve static files, via the `EnableSendfile` directive. Default value: `'On'` -##### `serveradmin` +##### `serveradmin` Data type: `Optional[String[1]]` Sets the Apache server administrator's contact information via Apache's `ServerAdmin` directive. -Default value: `undef` +Default value: ``undef`` -##### `servername` +##### `servername` Data type: `Optional[String]` @@ -856,7 +854,7 @@ Setting to `false` will not set ServerName at all. Default value: `$apache::params::servername` -##### `server_root` +##### `server_root` Data type: `Stdlib::Absolutepath` @@ -864,9 +862,9 @@ Sets the Apache server's root directory via Apache's `ServerRoot` directive. Default value: `$apache::params::server_root` -##### `server_signature` +##### `server_signature` -Data type: `Variant[Enum['On', 'Off'], String]` +Data type: `Variant[Apache::OnOff, String]` Configures a trailing footer line to display at the bottom of server-generated documents, such as error documents and output of certain Apache modules, via Apache's `ServerSignature` @@ -874,7 +872,7 @@ directive. Valid values are: `On` or `Off`. Default value: `'On'` -##### `server_tokens` +##### `server_tokens` Data type: `Apache::ServerTokens` @@ -883,15 +881,15 @@ system, via Apache's `ServerTokens` directive. Default value: `'Prod'` -##### `service_enable` +##### `service_enable` Data type: `Boolean` Determines whether Puppet enables the Apache HTTPD service when the system is booted. -Default value: `true` +Default value: ``true`` -##### `service_ensure` +##### `service_ensure` Data type: `Variant[Stdlib::Ensure::Service, Boolean]` @@ -903,7 +901,7 @@ application, such as Pacemaker.
Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String` @@ -911,24 +909,24 @@ Sets the name of the Apache service. Default value: `$apache::params::service_name` -##### `service_manage` +##### `service_manage` Data type: `Boolean` Determines whether Puppet manages the HTTPD service's state. -Default value: `true` +Default value: ``true`` -##### `service_restart` +##### `service_restart` Data type: `Optional[String]` Determines whether Puppet should use a specific command to restart the HTTPD service. Values: a command to restart the Apache service. -Default value: `undef` +Default value: ``undef`` -##### `timeout` +##### `timeout` Data type: `Integer[0]` @@ -937,25 +935,25 @@ certain events before failing a request. Default value: `60` -##### `trace_enable` +##### `trace_enable` -Data type: `Enum['On', 'Off', 'extended']` +Data type: `Variant[Apache::OnOff, Enum['extended']]` Controls how Apache handles `TRACE` requests (per RFC 2616) via the `TraceEnable` directive. Default value: `'On'` -##### `use_canonical_name` +##### `use_canonical_name` -Data type: `Optional[Enum['On', 'on', 'Off', 'off', 'DNS', 'dns']]` +Data type: `Optional[Variant[Apache::OnOff, Enum['DNS', 'dns']]]` Controls Apache's `UseCanonicalName` directive which controls how Apache handles self-referential URLs. If not specified, this parameter omits the declaration from the server's configuration and uses Apache's default setting of 'off'. -Default value: `undef` +Default value: ``undef`` -##### `use_systemd` +##### `use_systemd` Data type: `Boolean` @@ -964,7 +962,7 @@ especially useful if using custom-built RPMs. Default value: `$apache::params::use_systemd` -##### `file_mode` +##### `file_mode` Data type: `Stdlib::Filemode` @@ -973,7 +971,7 @@ Valid values are: a string, with permissions mode in symbolic or numeric notatio Default value: `$apache::params::file_mode` -##### `root_directory_options` +##### `root_directory_options` Data type: `Array` @@ -981,7 +979,7 @@ Array of the desired options for the `/` directory in httpd.conf. Default value: `$apache::params::root_directory_options` -##### `root_directory_secured` +##### `root_directory_secured` Data type: `Boolean` @@ -991,9 +989,9 @@ allows access to all resources that are missing a more specific access policy. A used to allow access to these resources (for example, in a directory block using the `directories` parameter). -Default value: `false` +Default value: ``false`` -##### `vhost_dir` +##### `vhost_dir` Data type: `Stdlib::Absolutepath` @@ -1001,7 +999,7 @@ Changes your virtual host configuration files' location. Default value: `$apache::params::vhost_dir` -##### `vhost_include_pattern` +##### `vhost_include_pattern` Data type: `String` @@ -1014,7 +1012,7 @@ files ending in `.conf`. Default value: `$apache::params::vhost_include_pattern` -##### `user` +##### `user` Data type: `String` @@ -1024,7 +1022,7 @@ To prevent Puppet from managing the user, set the `manage_user` parameter to `fa Default value: `$apache::params::user` -##### `apache_name` +##### `apache_name` Data type: `String` @@ -1034,7 +1032,7 @@ For CentOS/RHEL Software Collections (SCL), you can also use `apache::version::s Default value: `$apache::params::apache_name` -##### `error_log` +##### `error_log` Data type: `String` @@ -1044,7 +1042,7 @@ The name of the error log file for the main server instance. If the string start Default value: `$apache::params::error_log` -##### `scriptalias` +##### `scriptalias` Data type: `String` @@ -1052,7 +1050,7 @@ Directory to use for global script alias Default value: `$apache::params::scriptalias` -##### `access_log_file` +##### `access_log_file` Data type: `String` @@ -1060,7 +1058,7 @@ The name of the access log file for the main server instance. Default value: `$apache::params::access_log_file` -##### `limitreqfields` +##### `limitreqfields` Data type: `Integer` @@ -1072,7 +1070,7 @@ response from the server that indicates too many fields were sent in the request Default value: `100` -##### `limitreqfieldsize` +##### `limitreqfieldsize` Data type: `Integer` @@ -1081,32 +1079,32 @@ be allowed within a request header. Default value: `8190` -##### `limitreqline` +##### `limitreqline` Data type: `Optional[Integer]` The 'limitreqline' parameter sets the limit on the allowed size of a client's HTTP request-line -Default value: `undef` +Default value: ``undef`` -##### `ip` +##### `ip` Data type: `Optional[String]` Specifies the ip address -Default value: `undef` +Default value: ``undef`` -##### `purge_vdir` +##### `purge_vdir` Data type: `Boolean` Removes all other Apache configs and virtual hosts.
> **Note**: This parameter is deprecated in favor of the `purge_configs` parameter.
-Default value: `false` +Default value: ``false`` -##### `conf_enabled` +##### `conf_enabled` Data type: `Optional[Stdlib::Absolutepath]` @@ -1114,7 +1112,7 @@ Whether the additional config files in `/etc/apache2/conf-enabled` should be man Default value: `$apache::params::conf_enabled` -##### `vhost_enable_dir` +##### `vhost_enable_dir` Data type: `Optional[Stdlib::Absolutepath]` @@ -1123,15 +1121,15 @@ they will be symlinked to and from sites-enabled. Default value: `$apache::params::vhost_enable_dir` -##### `manage_vhost_enable_dir` +##### `manage_vhost_enable_dir` Data type: `Boolean` Overides the vhost_enable_dir inherited parameters and allows it to be disabled -Default value: `true` +Default value: ``true`` -##### `mod_enable_dir` +##### `mod_enable_dir` Data type: `Optional[Stdlib::Absolutepath]` @@ -1139,25 +1137,25 @@ Set's whether the mods-enabled directory should be managed. Default value: `$apache::params::mod_enable_dir` -##### `ssl_file` +##### `ssl_file` Data type: `Optional[String]` This parameter allows you to set an ssl.conf file to be managed in order to implement an SSL Certificate. -Default value: `undef` +Default value: ``undef`` -##### `file_e_tag` +##### `file_e_tag` Data type: `Optional[String]` Sets the server default for the `FileETag` declaration, which modifies the response header field for static files. -Default value: `undef` +Default value: ``undef`` -##### `use_optional_includes` +##### `use_optional_includes` Data type: `Boolean` @@ -1166,7 +1164,7 @@ Specifies whether Apache uses the `IncludeOptional` directive instead of `Includ Default value: `$apache::params::use_optional_includes` -##### `mime_types_additional` +##### `mime_types_additional` Data type: `Hash` @@ -1174,7 +1172,7 @@ Specifies any idditional Internet media (mime) types that you wish to be configu Default value: `$apache::params::mime_types_additional` -### `apache::dev` +### `apache::dev` The libraries installed depends on the `dev_packages` parameter of the `apache::params` class, based on your operating system: @@ -1183,7 +1181,7 @@ class, based on your operating system: - **Gentoo**: `undef`. - **Red Hat**: `httpd-devel`. -### `apache::mod::actions` +### `apache::mod::actions` Installs Apache mod_actions @@ -1191,7 +1189,7 @@ Installs Apache mod_actions * https://httpd.apache.org/docs/current/mod/mod_actions.html * for additional documentation. -### `apache::mod::alias` +### `apache::mod::alias` Installs and configures `mod_alias`. @@ -1203,11 +1201,11 @@ Installs and configures `mod_alias`. The following parameters are available in the `apache::mod::alias` class: -* [`icons_options`](#-apache--mod--alias--icons_options) -* [`icons_path`](#-apache--mod--alias--icons_path) -* [`icons_prefix`](#-apache--mod--alias--icons_prefix) +* [`icons_options`](#icons_options) +* [`icons_path`](#icons_path) +* [`icons_prefix`](#icons_prefix) -##### `icons_options` +##### `icons_options` Data type: `String` @@ -1216,7 +1214,7 @@ directive. Default value: `'Indexes MultiViews'` -##### `icons_path` +##### `icons_path` Data type: `Variant[Boolean, Stdlib::Absolutepath]` @@ -1229,7 +1227,7 @@ Set to 'false' to disable the alias Default value: `$apache::params::alias_icons_path` -##### `icons_prefix` +##### `icons_prefix` Data type: `String` @@ -1237,7 +1235,7 @@ Change the alias for /icons/. Default value: `$apache::params::icons_prefix` -### `apache::mod::apreq2` +### `apache::mod::apreq2` Installs `mod_apreq2`. @@ -1247,7 +1245,7 @@ Installs `mod_apreq2`. * http://httpd.apache.org/apreq/docs/libapreq2/group__mod__apreq2.html * for additional documentation. -### `apache::mod::auth_basic` +### `apache::mod::auth_basic` Installs `mod_auth_basic` @@ -1255,7 +1253,7 @@ Installs `mod_auth_basic` * https://httpd.apache.org/docs/current/mod/mod_auth_basic.html * for additional documentation. -### `apache::mod::auth_cas` +### `apache::mod::auth_cas` Installs and configures `mod_auth_cas`. @@ -1269,45 +1267,45 @@ Installs and configures `mod_auth_cas`. The following parameters are available in the `apache::mod::auth_cas` class: -* [`cas_login_url`](#-apache--mod--auth_cas--cas_login_url) -* [`cas_validate_url`](#-apache--mod--auth_cas--cas_validate_url) -* [`cas_cookie_path`](#-apache--mod--auth_cas--cas_cookie_path) -* [`cas_cookie_path_mode`](#-apache--mod--auth_cas--cas_cookie_path_mode) -* [`cas_version`](#-apache--mod--auth_cas--cas_version) -* [`cas_debug`](#-apache--mod--auth_cas--cas_debug) -* [`cas_validate_server`](#-apache--mod--auth_cas--cas_validate_server) -* [`cas_validate_depth`](#-apache--mod--auth_cas--cas_validate_depth) -* [`cas_certificate_path`](#-apache--mod--auth_cas--cas_certificate_path) -* [`cas_proxy_validate_url`](#-apache--mod--auth_cas--cas_proxy_validate_url) -* [`cas_root_proxied_as`](#-apache--mod--auth_cas--cas_root_proxied_as) -* [`cas_cookie_entropy`](#-apache--mod--auth_cas--cas_cookie_entropy) -* [`cas_timeout`](#-apache--mod--auth_cas--cas_timeout) -* [`cas_idle_timeout`](#-apache--mod--auth_cas--cas_idle_timeout) -* [`cas_cache_clean_interval`](#-apache--mod--auth_cas--cas_cache_clean_interval) -* [`cas_cookie_domain`](#-apache--mod--auth_cas--cas_cookie_domain) -* [`cas_cookie_http_only`](#-apache--mod--auth_cas--cas_cookie_http_only) -* [`cas_authoritative`](#-apache--mod--auth_cas--cas_authoritative) -* [`cas_validate_saml`](#-apache--mod--auth_cas--cas_validate_saml) -* [`cas_sso_enabled`](#-apache--mod--auth_cas--cas_sso_enabled) -* [`cas_attribute_prefix`](#-apache--mod--auth_cas--cas_attribute_prefix) -* [`cas_attribute_delimiter`](#-apache--mod--auth_cas--cas_attribute_delimiter) -* [`cas_scrub_request_headers`](#-apache--mod--auth_cas--cas_scrub_request_headers) -* [`suppress_warning`](#-apache--mod--auth_cas--suppress_warning) - -##### `cas_login_url` +* [`cas_login_url`](#cas_login_url) +* [`cas_validate_url`](#cas_validate_url) +* [`cas_cookie_path`](#cas_cookie_path) +* [`cas_cookie_path_mode`](#cas_cookie_path_mode) +* [`cas_version`](#cas_version) +* [`cas_debug`](#cas_debug) +* [`cas_validate_server`](#cas_validate_server) +* [`cas_validate_depth`](#cas_validate_depth) +* [`cas_certificate_path`](#cas_certificate_path) +* [`cas_proxy_validate_url`](#cas_proxy_validate_url) +* [`cas_root_proxied_as`](#cas_root_proxied_as) +* [`cas_cookie_entropy`](#cas_cookie_entropy) +* [`cas_timeout`](#cas_timeout) +* [`cas_idle_timeout`](#cas_idle_timeout) +* [`cas_cache_clean_interval`](#cas_cache_clean_interval) +* [`cas_cookie_domain`](#cas_cookie_domain) +* [`cas_cookie_http_only`](#cas_cookie_http_only) +* [`cas_authoritative`](#cas_authoritative) +* [`cas_validate_saml`](#cas_validate_saml) +* [`cas_sso_enabled`](#cas_sso_enabled) +* [`cas_attribute_prefix`](#cas_attribute_prefix) +* [`cas_attribute_delimiter`](#cas_attribute_delimiter) +* [`cas_scrub_request_headers`](#cas_scrub_request_headers) +* [`suppress_warning`](#suppress_warning) + +##### `cas_login_url` Data type: `String` Sets the URL to which the module redirects users when they attempt to access a CAS-protected resource and don't have an active session. -##### `cas_validate_url` +##### `cas_validate_url` Data type: `String` Sets the URL to use when validating a client-presented ticket in an HTTP query string. -##### `cas_cookie_path` +##### `cas_cookie_path` Data type: `String` @@ -1316,7 +1314,7 @@ be writable by the web server only. Default value: `$apache::params::cas_cookie_path` -##### `cas_cookie_path_mode` +##### `cas_cookie_path_mode` Data type: `Stdlib::Filemode` @@ -1324,7 +1322,7 @@ The mode of cas_cookie_path. Default value: `'0750'` -##### `cas_version` +##### `cas_version` Data type: `Integer` @@ -1332,7 +1330,7 @@ The version of the CAS protocol to adhere to. Default value: `2` -##### `cas_debug` +##### `cas_debug` Data type: `String` @@ -1340,156 +1338,156 @@ Whether to enable or disable debug mode. Default value: `'Off'` -##### `cas_validate_server` +##### `cas_validate_server` Data type: `Optional[String]` Whether to validate the presented certificate. This has been deprecated and removed from Version 1.1-RC1 onward. -Default value: `undef` +Default value: ``undef`` -##### `cas_validate_depth` +##### `cas_validate_depth` Data type: `Optional[String]` The maximum depth for chained certificate validation. -Default value: `undef` +Default value: ``undef`` -##### `cas_certificate_path` +##### `cas_certificate_path` Data type: `Optional[String]` The path leading to the certificate -Default value: `undef` +Default value: ``undef`` -##### `cas_proxy_validate_url` +##### `cas_proxy_validate_url` Data type: `Optional[String]` The URL to use when performing a proxy validation. -Default value: `undef` +Default value: ``undef`` -##### `cas_root_proxied_as` +##### `cas_root_proxied_as` Data type: `Optional[String]` Sets the URL end users see when access to this Apache server is proxied per vhost. This URL should not include a trailing slash. -Default value: `undef` +Default value: ``undef`` -##### `cas_cookie_entropy` +##### `cas_cookie_entropy` Data type: `Optional[String]` When creating a local session, this many random bytes are used to create a unique session identifier. -Default value: `undef` +Default value: ``undef`` -##### `cas_timeout` +##### `cas_timeout` Data type: `Optional[Integer[0]]` The hard limit, in seconds, for a mod_auth_cas session. -Default value: `undef` +Default value: ``undef`` -##### `cas_idle_timeout` +##### `cas_idle_timeout` Data type: `Optional[Integer[0]]` The limit, in seconds, of how long a mod_auth_cas session can be idle. -Default value: `undef` +Default value: ``undef`` -##### `cas_cache_clean_interval` +##### `cas_cache_clean_interval` Data type: `Optional[String]` The minimum amount of time that must pass inbetween cache cleanings. -Default value: `undef` +Default value: ``undef`` -##### `cas_cookie_domain` +##### `cas_cookie_domain` Data type: `Optional[String]` The value for the 'Domain=' parameter in the Set-Cookie header. -Default value: `undef` +Default value: ``undef`` -##### `cas_cookie_http_only` +##### `cas_cookie_http_only` Data type: `Optional[String]` Setting this flag prevents the mod_auth_cas cookies from being accessed by client side Javascript. -Default value: `undef` +Default value: ``undef`` -##### `cas_authoritative` +##### `cas_authoritative` Data type: `Optional[String]` Determines whether an optional authorization directive is authoritative and thus binding. -Default value: `undef` +Default value: ``undef`` -##### `cas_validate_saml` +##### `cas_validate_saml` Data type: `Optional[String]` Parse response from CAS server for SAML. -Default value: `undef` +Default value: ``undef`` -##### `cas_sso_enabled` +##### `cas_sso_enabled` Data type: `Optional[String]` Enables experimental support for single sign out (may mangle POST data). -Default value: `undef` +Default value: ``undef`` -##### `cas_attribute_prefix` +##### `cas_attribute_prefix` Data type: `Optional[String]` Adds a header with the value of this header being the attribute values when SAML validation is enabled. -Default value: `undef` +Default value: ``undef`` -##### `cas_attribute_delimiter` +##### `cas_attribute_delimiter` Data type: `Optional[String]` Sets the delimiter between attribute values in the header created by `cas_attribute_prefix`. -Default value: `undef` +Default value: ``undef`` -##### `cas_scrub_request_headers` +##### `cas_scrub_request_headers` Data type: `Optional[String]` Remove inbound request headers that may have special meaning within mod_auth_cas. -Default value: `undef` +Default value: ``undef`` -##### `suppress_warning` +##### `suppress_warning` Data type: `Boolean` Suppress warning about being on RedHat (mod_auth_cas package is now available in epel-testing repo). -Default value: `false` +Default value: ``false`` -### `apache::mod::auth_gssapi` +### `apache::mod::auth_gssapi` Installs `mod_auth_gsappi`. @@ -1497,7 +1495,7 @@ Installs `mod_auth_gsappi`. * https://github.com/modauthgssapi/mod_auth_gssapi * for additional documentation. -### `apache::mod::auth_kerb` +### `apache::mod::auth_kerb` Installs `mod_auth_kerb` @@ -1505,7 +1503,7 @@ Installs `mod_auth_kerb` * http://modauthkerb.sourceforge.net * for additional documentation. -### `apache::mod::auth_mellon` +### `apache::mod::auth_mellon` Installs and configures `mod_auth_mellon`. @@ -1517,15 +1515,15 @@ Installs and configures `mod_auth_mellon`. The following parameters are available in the `apache::mod::auth_mellon` class: -* [`mellon_cache_size`](#-apache--mod--auth_mellon--mellon_cache_size) -* [`mellon_lock_file`](#-apache--mod--auth_mellon--mellon_lock_file) -* [`mellon_post_directory`](#-apache--mod--auth_mellon--mellon_post_directory) -* [`mellon_cache_entry_size`](#-apache--mod--auth_mellon--mellon_cache_entry_size) -* [`mellon_post_ttl`](#-apache--mod--auth_mellon--mellon_post_ttl) -* [`mellon_post_size`](#-apache--mod--auth_mellon--mellon_post_size) -* [`mellon_post_count`](#-apache--mod--auth_mellon--mellon_post_count) +* [`mellon_cache_size`](#mellon_cache_size) +* [`mellon_lock_file`](#mellon_lock_file) +* [`mellon_post_directory`](#mellon_post_directory) +* [`mellon_cache_entry_size`](#mellon_cache_entry_size) +* [`mellon_post_ttl`](#mellon_post_ttl) +* [`mellon_post_size`](#mellon_post_size) +* [`mellon_post_count`](#mellon_post_count) -##### `mellon_cache_size` +##### `mellon_cache_size` Data type: `Optional[Integer]` @@ -1533,7 +1531,7 @@ Maximum number of sessions which can be active at once. Default value: `$apache::params::mellon_cache_size` -##### `mellon_lock_file` +##### `mellon_lock_file` Data type: `Optional[Stdlib::Absolutepath]` @@ -1541,7 +1539,7 @@ Full path to a file used for synchronizing access to the session data. Default value: `$apache::params::mellon_lock_file` -##### `mellon_post_directory` +##### `mellon_post_directory` Data type: `Optional[Stdlib::Absolutepath]` @@ -1549,39 +1547,39 @@ Full path of a directory where POST requests are saved during authentication. Default value: `$apache::params::mellon_post_directory` -##### `mellon_cache_entry_size` +##### `mellon_cache_entry_size` Data type: `Optional[Integer]` Maximum size for a single session entry in bytes. -Default value: `undef` +Default value: ``undef`` -##### `mellon_post_ttl` +##### `mellon_post_ttl` Data type: `Optional[Integer]` Delay in seconds before a saved POST request can be flushed. -Default value: `undef` +Default value: ``undef`` -##### `mellon_post_size` +##### `mellon_post_size` Data type: `Optional[Integer]` Maximum size for saved POST requests. -Default value: `undef` +Default value: ``undef`` -##### `mellon_post_count` +##### `mellon_post_count` Data type: `Optional[Integer]` Maximum amount of saved POST requests. -Default value: `undef` +Default value: ``undef`` -### `apache::mod::auth_openidc` +### `apache::mod::auth_openidc` Installs and configures `mod_auth_openidc`. @@ -1595,19 +1593,19 @@ Installs and configures `mod_auth_openidc`. The following parameters are available in the `apache::mod::auth_openidc` class: -* [`manage_dnf_module`](#-apache--mod--auth_openidc--manage_dnf_module) -* [`dnf_module_ensure`](#-apache--mod--auth_openidc--dnf_module_ensure) -* [`dnf_module_name`](#-apache--mod--auth_openidc--dnf_module_name) +* [`manage_dnf_module`](#manage_dnf_module) +* [`dnf_module_ensure`](#dnf_module_ensure) +* [`dnf_module_name`](#dnf_module_name) -##### `manage_dnf_module` +##### `manage_dnf_module` Data type: `Boolean` Whether to manage the DNF module -Default value: `$facts['os']['family'] == 'RedHat' and $facts['os']['release']['major'] == '8'` +Default value: `and` -##### `dnf_module_ensure` +##### `dnf_module_ensure` Data type: `String[1]` @@ -1615,7 +1613,7 @@ The DNF module name to ensure. Only relevant if manage_dnf_module is set to true Default value: `'present'` -##### `dnf_module_name` +##### `dnf_module_name` Data type: `String[1]` @@ -1623,7 +1621,7 @@ The DNF module name to manage. Only relevant if manage_dnf_module is set to true Default value: `'mod_auth_openidc'` -### `apache::mod::authn_core` +### `apache::mod::authn_core` Installs `mod_authn_core`. @@ -1631,7 +1629,7 @@ Installs `mod_authn_core`. * https://httpd.apache.org/docs/current/mod/mod_authn_core.html * for additional documentation. -### `apache::mod::authn_dbd` +### `apache::mod::authn_dbd` Installs `mod_authn_dbd`. @@ -1643,22 +1641,22 @@ Installs `mod_authn_dbd`. The following parameters are available in the `apache::mod::authn_dbd` class: -* [`authn_dbd_params`](#-apache--mod--authn_dbd--authn_dbd_params) -* [`authn_dbd_dbdriver`](#-apache--mod--authn_dbd--authn_dbd_dbdriver) -* [`authn_dbd_query`](#-apache--mod--authn_dbd--authn_dbd_query) -* [`authn_dbd_min`](#-apache--mod--authn_dbd--authn_dbd_min) -* [`authn_dbd_max`](#-apache--mod--authn_dbd--authn_dbd_max) -* [`authn_dbd_keep`](#-apache--mod--authn_dbd--authn_dbd_keep) -* [`authn_dbd_exptime`](#-apache--mod--authn_dbd--authn_dbd_exptime) -* [`authn_dbd_alias`](#-apache--mod--authn_dbd--authn_dbd_alias) +* [`authn_dbd_params`](#authn_dbd_params) +* [`authn_dbd_dbdriver`](#authn_dbd_dbdriver) +* [`authn_dbd_query`](#authn_dbd_query) +* [`authn_dbd_min`](#authn_dbd_min) +* [`authn_dbd_max`](#authn_dbd_max) +* [`authn_dbd_keep`](#authn_dbd_keep) +* [`authn_dbd_exptime`](#authn_dbd_exptime) +* [`authn_dbd_alias`](#authn_dbd_alias) -##### `authn_dbd_params` +##### `authn_dbd_params` Data type: `Optional[String]` The params needed for the mod to function. -##### `authn_dbd_dbdriver` +##### `authn_dbd_dbdriver` Data type: `String` @@ -1666,15 +1664,15 @@ Selects an apr_dbd driver by name. Default value: `'mysql'` -##### `authn_dbd_query` +##### `authn_dbd_query` Data type: `Optional[String]` -Default value: `undef` +Default value: ``undef`` -##### `authn_dbd_min` +##### `authn_dbd_min` Data type: `Integer` @@ -1682,7 +1680,7 @@ Set the minimum number of connections per process. Default value: `4` -##### `authn_dbd_max` +##### `authn_dbd_max` Data type: `Integer` @@ -1690,7 +1688,7 @@ Set the maximum number of connections per process. Default value: `20` -##### `authn_dbd_keep` +##### `authn_dbd_keep` Data type: `Integer` @@ -1698,7 +1696,7 @@ Set the maximum number of connections per process to be sustained. Default value: `8` -##### `authn_dbd_exptime` +##### `authn_dbd_exptime` Data type: `Integer` @@ -1707,15 +1705,15 @@ connections specified in DBDKeep has been exceeded. Default value: `300` -##### `authn_dbd_alias` +##### `authn_dbd_alias` Data type: `Optional[String]` Sets an alias for `AuthnProvider. -Default value: `undef` +Default value: ``undef`` -### `apache::mod::authn_file` +### `apache::mod::authn_file` Installs `mod_authn_file`. @@ -1723,7 +1721,7 @@ Installs `mod_authn_file`. * https://httpd.apache.org/docs/2.4/mod/mod_authn_file.html * for additional documentation. -### `apache::mod::authnz_ldap` +### `apache::mod::authnz_ldap` Installs `mod_authnz_ldap`. @@ -1737,26 +1735,26 @@ Installs `mod_authnz_ldap`. The following parameters are available in the `apache::mod::authnz_ldap` class: -* [`verify_server_cert`](#-apache--mod--authnz_ldap--verify_server_cert) -* [`package_name`](#-apache--mod--authnz_ldap--package_name) +* [`verify_server_cert`](#verify_server_cert) +* [`package_name`](#package_name) -##### `verify_server_cert` +##### `verify_server_cert` Data type: `Boolean` Whether to force te verification of a server cert or not. -Default value: `true` +Default value: ``true`` -##### `package_name` +##### `package_name` Data type: `Optional[String]` The name of the ldap package. -Default value: `undef` +Default value: ``undef`` -### `apache::mod::authnz_pam` +### `apache::mod::authnz_pam` Installs `mod_authnz_pam`. @@ -1764,7 +1762,15 @@ Installs `mod_authnz_pam`. * https://www.adelton.com/apache/mod_authnz_pam * for additional documentation. -### `apache::mod::authz_groupfile` +### `apache::mod::authz_core` + +Installs `mod_authz_core`. + +* **See also** + * https://httpd.apache.org/docs/current/mod/mod_authz_core.html + * for additional documentation. + +### `apache::mod::authz_groupfile` Installs `mod_authz_groupfile` @@ -1772,7 +1778,7 @@ Installs `mod_authz_groupfile` * https://httpd.apache.org/docs/current/mod/mod_authz_groupfile.html * for additional documentation. -### `apache::mod::authz_user` +### `apache::mod::authz_user` Installs `mod_authz_user` @@ -1780,7 +1786,7 @@ Installs `mod_authz_user` * https://httpd.apache.org/docs/current/mod/mod_authz_user.html * for additional documentation. -### `apache::mod::autoindex` +### `apache::mod::autoindex` Installs `mod_autoindex` @@ -1792,9 +1798,9 @@ Installs `mod_autoindex` The following parameters are available in the `apache::mod::autoindex` class: -* [`icons_prefix`](#-apache--mod--autoindex--icons_prefix) +* [`icons_prefix`](#icons_prefix) -##### `icons_prefix` +##### `icons_prefix` Data type: `String` @@ -1802,7 +1808,7 @@ Change the alias for /icons/. Default value: `$apache::params::icons_prefix` -### `apache::mod::cache` +### `apache::mod::cache` Installs `mod_cache` @@ -1810,7 +1816,7 @@ Installs `mod_cache` * https://httpd.apache.org/docs/current/mod/mod_cache.html * for additional documentation. -### `apache::mod::cgi` +### `apache::mod::cgi` Installs `mod_cgi`. @@ -1818,14 +1824,14 @@ Installs `mod_cgi`. * https://httpd.apache.org/docs/current/mod/mod_cgi.html * for additional documentation. -### `apache::mod::cgid` +### `apache::mod::cgid` Installs `mod_cgid`. * **See also** * https://httpd.apache.org/docs/current/mod/mod_cgid.html -### `apache::mod::cluster` +### `apache::mod::cluster` Installs `mod_cluster`. @@ -1853,51 +1859,51 @@ class { '::apache::mod::cluster': The following parameters are available in the `apache::mod::cluster` class: -* [`allowed_network`](#-apache--mod--cluster--allowed_network) -* [`balancer_name`](#-apache--mod--cluster--balancer_name) -* [`ip`](#-apache--mod--cluster--ip) -* [`version`](#-apache--mod--cluster--version) -* [`enable_mcpm_receive`](#-apache--mod--cluster--enable_mcpm_receive) -* [`port`](#-apache--mod--cluster--port) -* [`keep_alive_timeout`](#-apache--mod--cluster--keep_alive_timeout) -* [`manager_allowed_network`](#-apache--mod--cluster--manager_allowed_network) -* [`max_keep_alive_requests`](#-apache--mod--cluster--max_keep_alive_requests) -* [`server_advertise`](#-apache--mod--cluster--server_advertise) -* [`advertise_frequency`](#-apache--mod--cluster--advertise_frequency) +* [`allowed_network`](#allowed_network) +* [`balancer_name`](#balancer_name) +* [`ip`](#ip) +* [`version`](#version) +* [`enable_mcpm_receive`](#enable_mcpm_receive) +* [`port`](#port) +* [`keep_alive_timeout`](#keep_alive_timeout) +* [`manager_allowed_network`](#manager_allowed_network) +* [`max_keep_alive_requests`](#max_keep_alive_requests) +* [`server_advertise`](#server_advertise) +* [`advertise_frequency`](#advertise_frequency) -##### `allowed_network` +##### `allowed_network` Data type: `String` Balanced members network. -##### `balancer_name` +##### `balancer_name` Data type: `String` Name of balancer. -##### `ip` +##### `ip` Data type: `Stdlib::IP::Address` Specifies the IP address to listen to. -##### `version` +##### `version` Data type: `String` Specifies the mod_cluster version. Version 1.3.0 or greater is required for httpd 2.4. -##### `enable_mcpm_receive` +##### `enable_mcpm_receive` Data type: `Boolean` Whether MCPM should be enabled. -Default value: `true` +Default value: ``true`` -##### `port` +##### `port` Data type: `Stdlib::Port` @@ -1905,7 +1911,7 @@ mod_cluster listen port. Default value: `6666` -##### `keep_alive_timeout` +##### `keep_alive_timeout` Data type: `Integer` @@ -1913,7 +1919,7 @@ Specifies how long Apache should wait for a request, in seconds. Default value: `60` -##### `manager_allowed_network` +##### `manager_allowed_network` Data type: `Stdlib::IP::Address` @@ -1921,7 +1927,7 @@ Whether to allow the network to access the mod_cluster_manager. Default value: `'127.0.0.1'` -##### `max_keep_alive_requests` +##### `max_keep_alive_requests` Data type: `Integer` @@ -1929,23 +1935,23 @@ Maximum number of requests kept alive. Default value: `0` -##### `server_advertise` +##### `server_advertise` Data type: `Boolean` Whether the server should advertise. -Default value: `true` +Default value: ``true`` -##### `advertise_frequency` +##### `advertise_frequency` Data type: `Optional[String]` Sets the interval between advertise messages in seconds. -Default value: `undef` +Default value: ``undef`` -### `apache::mod::data` +### `apache::mod::data` Installs and configures `mod_data`. @@ -1953,7 +1959,7 @@ Installs and configures `mod_data`. * https://httpd.apache.org/docs/current/mod/mod_data.html * for additional documentation. -### `apache::mod::dav` +### `apache::mod::dav` Installs `mod_dav`. @@ -1961,7 +1967,7 @@ Installs `mod_dav`. * https://httpd.apache.org/docs/current/mod/mod_dav.html * for additional documentation. -### `apache::mod::dav_fs` +### `apache::mod::dav_fs` Installs `mod_dav_fs`. @@ -1969,7 +1975,7 @@ Installs `mod_dav_fs`. * https://httpd.apache.org/docs/current/mod/mod_dav_fs.html * for additional documentation. -### `apache::mod::dav_svn` +### `apache::mod::dav_svn` Installs and configures `mod_dav_svn`. @@ -1981,17 +1987,17 @@ Installs and configures `mod_dav_svn`. The following parameters are available in the `apache::mod::dav_svn` class: -* [`authz_svn_enabled`](#-apache--mod--dav_svn--authz_svn_enabled) +* [`authz_svn_enabled`](#authz_svn_enabled) -##### `authz_svn_enabled` +##### `authz_svn_enabled` Data type: `Boolean` Specifies whether to install Apache mod_authz_svn -Default value: `false` +Default value: ``false`` -### `apache::mod::dbd` +### `apache::mod::dbd` Installs `mod_dbd`. @@ -1999,7 +2005,7 @@ Installs `mod_dbd`. * https://httpd.apache.org/docs/current/mod/mod_dbd.html * for additional documentation. -### `apache::mod::deflate` +### `apache::mod::deflate` Installs and configures `mod_deflate`. @@ -2011,50 +2017,42 @@ Installs and configures `mod_deflate`. The following parameters are available in the `apache::mod::deflate` class: -* [`types`](#-apache--mod--deflate--types) -* [`notes`](#-apache--mod--deflate--notes) +* [`types`](#types) +* [`notes`](#notes) -##### `types` +##### `types` Data type: `Array[String]` An array of MIME types to be deflated. See https://www.iana.org/assignments/media-types/media-types.xhtml. -Default value: - -```puppet -[ +Default value: `[ 'text/html text/plain text/xml', 'text/css', 'application/x-javascript application/javascript application/ecmascript', 'application/rss+xml', 'application/json', - ] -``` + ]` -##### `notes` +##### `notes` Data type: `Hash` A Hash where the key represents the type and the value represents the note name. -Default value: - -```puppet -{ +Default value: `{ 'Input' => 'instream', 'Output' => 'outstream', 'Ratio' => 'ratio', - } -``` + }` -### `apache::mod::dev` +### `apache::mod::dev` Installs `mod_dev`. * **Note** This module is deprecated. Please use `apache::dev`. -### `apache::mod::dir` +### `apache::mod::dir` Installs and configures `mod_dir`. @@ -2069,10 +2067,10 @@ DirectoryIndex statements in a vhost configuration The following parameters are available in the `apache::mod::dir` class: -* [`dir`](#-apache--mod--dir--dir) -* [`indexes`](#-apache--mod--dir--indexes) +* [`dir`](#dir) +* [`indexes`](#indexes) -##### `dir` +##### `dir` Data type: `String` @@ -2080,26 +2078,22 @@ Data type: `String` Default value: `'public_html'` -##### `indexes` +##### `indexes` Data type: `Array[String]` Provides a string for the DirectoryIndex directive -Default value: - -```puppet -[ +Default value: `[ 'index.html', 'index.html.var', 'index.cgi', 'index.pl', 'index.php', 'index.xhtml', - ] -``` + ]` -### `apache::mod::disk_cache` +### `apache::mod::disk_cache` Installs and configures `mod_disk_cache`. @@ -2113,11 +2107,11 @@ Installs and configures `mod_disk_cache`. The following parameters are available in the `apache::mod::disk_cache` class: -* [`cache_root`](#-apache--mod--disk_cache--cache_root) -* [`cache_ignore_headers`](#-apache--mod--disk_cache--cache_ignore_headers) -* [`default_cache_enable`](#-apache--mod--disk_cache--default_cache_enable) +* [`cache_root`](#cache_root) +* [`cache_ignore_headers`](#cache_ignore_headers) +* [`default_cache_enable`](#default_cache_enable) -##### `cache_root` +##### `cache_root` Data type: `Optional[Stdlib::Absolutepath]` @@ -2127,17 +2121,17 @@ Default depends on the Apache version and operating system: - FreeBSD: /var/cache/mod_cache_disk - Red Hat: /var/cache/httpd/proxy -Default value: `undef` +Default value: ``undef`` -##### `cache_ignore_headers` +##### `cache_ignore_headers` Data type: `Optional[String]` Specifies HTTP header(s) that should not be stored in the cache. -Default value: `undef` +Default value: ``undef`` -##### `default_cache_enable` +##### `default_cache_enable` Data type: `Boolean` @@ -2145,9 +2139,9 @@ Default value is true, which enables "CacheEnable disk /" in disk_cache.conf for every request to apache by default for every vhost. If set to false the default cache all behaviour is supressed. You can then control this behaviour in individual vhosts by explicitly defining CacheEnable. -Default value: `true` +Default value: ``true`` -### `apache::mod::dumpio` +### `apache::mod::dumpio` Installs and configures `mod_dumpio`. @@ -2174,26 +2168,26 @@ class{'apache::mod::dumpio': The following parameters are available in the `apache::mod::dumpio` class: -* [`dump_io_input`](#-apache--mod--dumpio--dump_io_input) -* [`dump_io_output`](#-apache--mod--dumpio--dump_io_output) +* [`dump_io_input`](#dump_io_input) +* [`dump_io_output`](#dump_io_output) -##### `dump_io_input` +##### `dump_io_input` -Data type: `Enum['Off', 'On', 'off', 'on']` +Data type: `Apache::OnOff` Dump all input data to the error log Default value: `'Off'` -##### `dump_io_output` +##### `dump_io_output` -Data type: `Enum['Off', 'On', 'off', 'on']` +Data type: `Apache::OnOff` Dump all output data to the error log Default value: `'Off'` -### `apache::mod::env` +### `apache::mod::env` Installs `mod_env`. @@ -2201,7 +2195,7 @@ Installs `mod_env`. * https://httpd.apache.org/docs/current/mod/mod_env.html * for additional documentation. -### `apache::mod::event` +### `apache::mod::event` Installs and configures `mod_event`. @@ -2216,17 +2210,17 @@ apache::mod::worker on the same server. The following parameters are available in the `apache::mod::event` class: -* [`startservers`](#-apache--mod--event--startservers) -* [`maxrequestworkers`](#-apache--mod--event--maxrequestworkers) -* [`minsparethreads`](#-apache--mod--event--minsparethreads) -* [`maxsparethreads`](#-apache--mod--event--maxsparethreads) -* [`threadsperchild`](#-apache--mod--event--threadsperchild) -* [`maxconnectionsperchild`](#-apache--mod--event--maxconnectionsperchild) -* [`serverlimit`](#-apache--mod--event--serverlimit) -* [`threadlimit`](#-apache--mod--event--threadlimit) -* [`listenbacklog`](#-apache--mod--event--listenbacklog) +* [`startservers`](#startservers) +* [`maxrequestworkers`](#maxrequestworkers) +* [`minsparethreads`](#minsparethreads) +* [`maxsparethreads`](#maxsparethreads) +* [`threadsperchild`](#threadsperchild) +* [`maxconnectionsperchild`](#maxconnectionsperchild) +* [`serverlimit`](#serverlimit) +* [`threadlimit`](#threadlimit) +* [`listenbacklog`](#listenbacklog) -##### `startservers` +##### `startservers` Data type: `Variant[Integer, Boolean]` @@ -2235,16 +2229,16 @@ removes the parameter. Default value: `2` -##### `maxrequestworkers` +##### `maxrequestworkers` Data type: `Optional[Variant[Integer, Boolean]]` Sets the maximum number of connections Apache can simultaneously process, via the module's `MaxRequestWorkers` directive. Setting these to `false` removes the parameters. -Default value: `undef` +Default value: ``undef`` -##### `minsparethreads` +##### `minsparethreads` Data type: `Variant[Integer, Boolean]` @@ -2252,7 +2246,7 @@ Sets the minimum number of idle threads, via the `MinSpareThreads` directive. Se Default value: `25` -##### `maxsparethreads` +##### `maxsparethreads` Data type: `Variant[Integer, Boolean]` @@ -2260,7 +2254,7 @@ Sets the maximum number of idle threads, via the `MaxSpareThreads` directive. Se Default value: `75` -##### `threadsperchild` +##### `threadsperchild` Data type: `Variant[Integer, Boolean]` @@ -2268,15 +2262,15 @@ Number of threads created by each child process. Default value: `25` -##### `maxconnectionsperchild` +##### `maxconnectionsperchild` Data type: `Optional[Variant[Integer, Boolean]]` Limit on the number of connections that an individual child server will handle during its life. -Default value: `undef` +Default value: ``undef`` -##### `serverlimit` +##### `serverlimit` Data type: `Variant[Integer, Boolean]` @@ -2284,7 +2278,7 @@ Limits the configurable number of processes via the `ServerLimit` directive. Set Default value: `25` -##### `threadlimit` +##### `threadlimit` Data type: `Variant[Integer, Boolean]` @@ -2292,7 +2286,7 @@ Limits the number of event threads via the module's `ThreadLimit` directive. Set Default value: `64` -##### `listenbacklog` +##### `listenbacklog` Data type: `Variant[Integer, Boolean]` @@ -2301,7 +2295,7 @@ the parameter. Default value: `511` -### `apache::mod::expires` +### `apache::mod::expires` Installs and configures `mod_expires`. @@ -2313,27 +2307,27 @@ Installs and configures `mod_expires`. The following parameters are available in the `apache::mod::expires` class: -* [`expires_active`](#-apache--mod--expires--expires_active) -* [`expires_default`](#-apache--mod--expires--expires_default) -* [`expires_by_type`](#-apache--mod--expires--expires_by_type) +* [`expires_active`](#expires_active) +* [`expires_default`](#expires_default) +* [`expires_by_type`](#expires_by_type) -##### `expires_active` +##### `expires_active` Data type: `Boolean` Enables generation of Expires headers. -Default value: `true` +Default value: ``true`` -##### `expires_default` +##### `expires_default` Data type: `Optional[String]` Specifies the default algorithm for calculating expiration time using ExpiresByType syntax or interval syntax. -Default value: `undef` +Default value: ``undef`` -##### `expires_by_type` +##### `expires_by_type` Data type: `Optional[Array[Hash]]` @@ -2341,9 +2335,9 @@ Describes a set of [MIME content-types](https://www.iana.org/assignments/media-t times. This should be used as an array of Hashes, with each Hash's key a valid MIME content-type (i.e. 'text/json') and its value following valid interval syntax. -Default value: `undef` +Default value: ``undef`` -### `apache::mod::ext_filter` +### `apache::mod::ext_filter` Installs and configures `mod_ext_filter`. @@ -2368,17 +2362,17 @@ class { 'apache::mod::ext_filter': The following parameters are available in the `apache::mod::ext_filter` class: -* [`ext_filter_define`](#-apache--mod--ext_filter--ext_filter_define) +* [`ext_filter_define`](#ext_filter_define) -##### `ext_filter_define` +##### `ext_filter_define` Data type: `Optional[Hash]` Hash of filter names and their parameters. -Default value: `undef` +Default value: ``undef`` -### `apache::mod::fcgid` +### `apache::mod::fcgid` loaded first; Puppet will not automatically enable it if you set the fcgiwrapper parameter in apache::vhost. include apache::mod::fcgid @@ -2421,9 +2415,9 @@ class { 'apache::mod::fcgid': The following parameters are available in the `apache::mod::fcgid` class: -* [`options`](#-apache--mod--fcgid--options) +* [`options`](#options) -##### `options` +##### `options` Data type: `Hash` @@ -2437,7 +2431,7 @@ expires_by_type Default value: `{}` -### `apache::mod::filter` +### `apache::mod::filter` Installs `mod_filter`. @@ -2445,7 +2439,7 @@ Installs `mod_filter`. * https://httpd.apache.org/docs/current/mod/mod_filter.html * for additional documentation. -### `apache::mod::geoip` +### `apache::mod::geoip` Installs and configures `mod_geoip`. @@ -2457,24 +2451,24 @@ Installs and configures `mod_geoip`. The following parameters are available in the `apache::mod::geoip` class: -* [`enable`](#-apache--mod--geoip--enable) -* [`db_file`](#-apache--mod--geoip--db_file) -* [`flag`](#-apache--mod--geoip--flag) -* [`output`](#-apache--mod--geoip--output) -* [`enable_utf8`](#-apache--mod--geoip--enable_utf8) -* [`scan_proxy_headers`](#-apache--mod--geoip--scan_proxy_headers) -* [`scan_proxy_header_field`](#-apache--mod--geoip--scan_proxy_header_field) -* [`use_last_xforwarededfor_ip`](#-apache--mod--geoip--use_last_xforwarededfor_ip) +* [`enable`](#enable) +* [`db_file`](#db_file) +* [`flag`](#flag) +* [`output`](#output) +* [`enable_utf8`](#enable_utf8) +* [`scan_proxy_headers`](#scan_proxy_headers) +* [`scan_proxy_header_field`](#scan_proxy_header_field) +* [`use_last_xforwarededfor_ip`](#use_last_xforwarededfor_ip) -##### `enable` +##### `enable` Data type: `Boolean` Toggles whether to enable geoip. -Default value: `false` +Default value: ``false`` -##### `db_file` +##### `db_file` Data type: `Stdlib::Absolutepath` @@ -2482,7 +2476,7 @@ Path to database for GeoIP to use. Default value: `'/usr/share/GeoIP/GeoIP.dat'` -##### `flag` +##### `flag` Data type: `String` @@ -2490,7 +2484,7 @@ Caching directive to use. Values: 'CheckCache', 'IndexCache', 'MemoryCache', 'St Default value: `'Standard'` -##### `output` +##### `output` Data type: `String` @@ -2498,39 +2492,39 @@ Output variable locations. Values: 'All', 'Env', 'Request', 'Notes'. Default value: `'All'` -##### `enable_utf8` +##### `enable_utf8` Data type: `Optional[String]` Changes the output from ISO88591 (Latin1) to UTF8. -Default value: `undef` +Default value: ``undef`` -##### `scan_proxy_headers` +##### `scan_proxy_headers` Data type: `Optional[String]` Enables the GeoIPScanProxyHeaders option. -Default value: `undef` +Default value: ``undef`` -##### `scan_proxy_header_field` +##### `scan_proxy_header_field` Data type: `Optional[String]` Specifies the header mod_geoip uses to determine the client's IP address. -Default value: `undef` +Default value: ``undef`` -##### `use_last_xforwarededfor_ip` +##### `use_last_xforwarededfor_ip` Data type: `Optional[String]` Determines whether to use the first or last IP address for the client's IP in a comma-separated list of IP addresses is found. -Default value: `undef` +Default value: ``undef`` -### `apache::mod::headers` +### `apache::mod::headers` Installs and configures `mod_headers`. @@ -2538,7 +2532,7 @@ Installs and configures `mod_headers`. * https://httpd.apache.org/docs/current/mod/mod_headers.html * for additional documentation. -### `apache::mod::http2` +### `apache::mod::http2` Installs and configures `mod_http2`. @@ -2550,106 +2544,106 @@ Installs and configures `mod_http2`. The following parameters are available in the `apache::mod::http2` class: -* [`h2_copy_files`](#-apache--mod--http2--h2_copy_files) -* [`h2_direct`](#-apache--mod--http2--h2_direct) -* [`h2_early_hints`](#-apache--mod--http2--h2_early_hints) -* [`h2_max_session_streams`](#-apache--mod--http2--h2_max_session_streams) -* [`h2_max_worker_idle_seconds`](#-apache--mod--http2--h2_max_worker_idle_seconds) -* [`h2_max_workers`](#-apache--mod--http2--h2_max_workers) -* [`h2_min_workers`](#-apache--mod--http2--h2_min_workers) -* [`h2_modern_tls_only`](#-apache--mod--http2--h2_modern_tls_only) -* [`h2_push`](#-apache--mod--http2--h2_push) -* [`h2_push_diary_size`](#-apache--mod--http2--h2_push_diary_size) -* [`h2_push_priority`](#-apache--mod--http2--h2_push_priority) -* [`h2_push_resource`](#-apache--mod--http2--h2_push_resource) -* [`h2_serialize_headers`](#-apache--mod--http2--h2_serialize_headers) -* [`h2_stream_max_mem_size`](#-apache--mod--http2--h2_stream_max_mem_size) -* [`h2_tls_cool_down_secs`](#-apache--mod--http2--h2_tls_cool_down_secs) -* [`h2_tls_warm_up_size`](#-apache--mod--http2--h2_tls_warm_up_size) -* [`h2_upgrade`](#-apache--mod--http2--h2_upgrade) -* [`h2_window_size`](#-apache--mod--http2--h2_window_size) - -##### `h2_copy_files` +* [`h2_copy_files`](#h2_copy_files) +* [`h2_direct`](#h2_direct) +* [`h2_early_hints`](#h2_early_hints) +* [`h2_max_session_streams`](#h2_max_session_streams) +* [`h2_max_worker_idle_seconds`](#h2_max_worker_idle_seconds) +* [`h2_max_workers`](#h2_max_workers) +* [`h2_min_workers`](#h2_min_workers) +* [`h2_modern_tls_only`](#h2_modern_tls_only) +* [`h2_push`](#h2_push) +* [`h2_push_diary_size`](#h2_push_diary_size) +* [`h2_push_priority`](#h2_push_priority) +* [`h2_push_resource`](#h2_push_resource) +* [`h2_serialize_headers`](#h2_serialize_headers) +* [`h2_stream_max_mem_size`](#h2_stream_max_mem_size) +* [`h2_tls_cool_down_secs`](#h2_tls_cool_down_secs) +* [`h2_tls_warm_up_size`](#h2_tls_warm_up_size) +* [`h2_upgrade`](#h2_upgrade) +* [`h2_window_size`](#h2_window_size) + +##### `h2_copy_files` Data type: `Optional[Boolean]` Determine file handling in responses. -Default value: `undef` +Default value: ``undef`` -##### `h2_direct` +##### `h2_direct` Data type: `Optional[Boolean]` H2 Direct Protocol Switch. -Default value: `undef` +Default value: ``undef`` -##### `h2_early_hints` +##### `h2_early_hints` Data type: `Optional[Boolean]` Determine sending of 103 status codes. -Default value: `undef` +Default value: ``undef`` -##### `h2_max_session_streams` +##### `h2_max_session_streams` Data type: `Optional[Integer]` Sets maximum number of active streams per HTTP/2 session. -Default value: `undef` +Default value: ``undef`` -##### `h2_max_worker_idle_seconds` +##### `h2_max_worker_idle_seconds` Data type: `Optional[Integer]` Sets maximum number of seconds h2 workers remain idle until shut down. -Default value: `undef` +Default value: ``undef`` -##### `h2_max_workers` +##### `h2_max_workers` Data type: `Optional[Integer]` Sets maximum number of worker threads to use per child process. -Default value: `undef` +Default value: ``undef`` -##### `h2_min_workers` +##### `h2_min_workers` Data type: `Optional[Integer]` Sets minimal number of worker threads to use per child process. -Default value: `undef` +Default value: ``undef`` -##### `h2_modern_tls_only` +##### `h2_modern_tls_only` Data type: `Optional[Boolean]` Toggles the security checks on HTTP/2 connections in TLS mode -Default value: `undef` +Default value: ``undef`` -##### `h2_push` +##### `h2_push` Data type: `Optional[Boolean]` Toggles the usage of the HTTP/2 server push protocol feature. -Default value: `undef` +Default value: ``undef`` -##### `h2_push_diary_size` +##### `h2_push_diary_size` Data type: `Optional[Integer]` Sets maximum number of HTTP/2 server pushes that are remembered per HTTP/2 connection. -Default value: `undef` +Default value: ``undef`` -##### `h2_push_priority` +##### `h2_push_priority` Data type: `Array[String]` @@ -2657,7 +2651,7 @@ Require HTTP/2 connections to be "modern TLS" only Default value: `[]` -##### `h2_push_resource` +##### `h2_push_resource` Data type: `Array[String]` @@ -2666,59 +2660,59 @@ via this directive Default value: `[]` -##### `h2_serialize_headers` +##### `h2_serialize_headers` Data type: `Optional[Boolean]` Toggles if HTTP/2 requests shall be serialized in HTTP/1.1 format for processing by httpd core or if received binary data shall be passed into the request_recs directly. -Default value: `undef` +Default value: ``undef`` -##### `h2_stream_max_mem_size` +##### `h2_stream_max_mem_size` Data type: `Optional[Integer]` Sets the maximum number of outgoing data bytes buffered in memory for an active streams. -Default value: `undef` +Default value: ``undef`` -##### `h2_tls_cool_down_secs` +##### `h2_tls_cool_down_secs` Data type: `Optional[Integer]` Sets the number of seconds of idle time on a TLS connection before the TLS write size falls back to small (~1300 bytes) length. -Default value: `undef` +Default value: ``undef`` -##### `h2_tls_warm_up_size` +##### `h2_tls_warm_up_size` Data type: `Optional[Integer]` Sets the number of bytes to be sent in small TLS records (~1300 bytes) until doing maximum sized writes (16k) on https: HTTP/2 connections. -Default value: `undef` +Default value: ``undef`` -##### `h2_upgrade` +##### `h2_upgrade` Data type: `Optional[Boolean]` Toggles the usage of the HTTP/1.1 Upgrade method for switching to HTTP/2. -Default value: `undef` +Default value: ``undef`` -##### `h2_window_size` +##### `h2_window_size` Data type: `Optional[Integer]` Sets the size of the window that is used for flow control from client to server and limits the amount of data the server has to buffer. -Default value: `undef` +Default value: ``undef`` -### `apache::mod::include` +### `apache::mod::include` Installs `mod_include`. @@ -2726,7 +2720,7 @@ Installs `mod_include`. * https://httpd.apache.org/docs/current/mod/mod_include.html * for additional documentation. -### `apache::mod::info` +### `apache::mod::info` Installs and configures `mod_info`. @@ -2738,11 +2732,11 @@ Installs and configures `mod_info`. The following parameters are available in the `apache::mod::info` class: -* [`allow_from`](#-apache--mod--info--allow_from) -* [`restrict_access`](#-apache--mod--info--restrict_access) -* [`info_path`](#-apache--mod--info--info_path) +* [`allow_from`](#allow_from) +* [`restrict_access`](#restrict_access) +* [`info_path`](#info_path) -##### `allow_from` +##### `allow_from` Data type: `Array[Stdlib::IP::Address]` @@ -2750,16 +2744,16 @@ Allowlist of IPv4 or IPv6 addresses or ranges that can access the info path. Default value: `['127.0.0.1', '::1']` -##### `restrict_access` +##### `restrict_access` Data type: `Boolean` Toggles whether to restrict access to info path. If `false`, the `allow_from` allowlist is ignored and any IP address can access the info path. -Default value: `true` +Default value: ``true`` -##### `info_path` +##### `info_path` Data type: `Stdlib::Unixpath` @@ -2767,7 +2761,7 @@ Path on server to file containing server configuration information. Default value: `'/server-info'` -### `apache::mod::intercept_form_submit` +### `apache::mod::intercept_form_submit` Installs `mod_intercept_form_submit`. @@ -2775,7 +2769,7 @@ Installs `mod_intercept_form_submit`. * https://www.adelton.com/apache/mod_intercept_form_submit * for additional documentation. -### `apache::mod::itk` +### `apache::mod::itk` Installs MPM `mod_itk`. @@ -2789,15 +2783,15 @@ Installs MPM `mod_itk`. The following parameters are available in the `apache::mod::itk` class: -* [`startservers`](#-apache--mod--itk--startservers) -* [`minspareservers`](#-apache--mod--itk--minspareservers) -* [`maxspareservers`](#-apache--mod--itk--maxspareservers) -* [`serverlimit`](#-apache--mod--itk--serverlimit) -* [`maxclients`](#-apache--mod--itk--maxclients) -* [`maxrequestsperchild`](#-apache--mod--itk--maxrequestsperchild) -* [`enablecapabilities`](#-apache--mod--itk--enablecapabilities) +* [`startservers`](#startservers) +* [`minspareservers`](#minspareservers) +* [`maxspareservers`](#maxspareservers) +* [`serverlimit`](#serverlimit) +* [`maxclients`](#maxclients) +* [`maxrequestsperchild`](#maxrequestsperchild) +* [`enablecapabilities`](#enablecapabilities) -##### `startservers` +##### `startservers` Data type: `Integer` @@ -2805,7 +2799,7 @@ Number of child server processes created on startup. Default value: `8` -##### `minspareservers` +##### `minspareservers` Data type: `Integer` @@ -2813,7 +2807,7 @@ Minimum number of idle child server processes. Default value: `5` -##### `maxspareservers` +##### `maxspareservers` Data type: `Integer` @@ -2821,7 +2815,7 @@ Maximum number of idle child server processes. Default value: `20` -##### `serverlimit` +##### `serverlimit` Data type: `Integer` @@ -2829,7 +2823,7 @@ Maximum configured value for `MaxRequestWorkers` for the lifetime of the Apache Default value: `256` -##### `maxclients` +##### `maxclients` Data type: `Integer` @@ -2837,7 +2831,7 @@ Limit on the number of simultaneous requests that will be served. Default value: `256` -##### `maxrequestsperchild` +##### `maxrequestsperchild` Data type: `Integer` @@ -2845,7 +2839,7 @@ Limit on the number of connections that an individual child server process will Default value: `4000` -##### `enablecapabilities` +##### `enablecapabilities` Data type: `Optional[Variant[Boolean, String]]` @@ -2853,9 +2847,9 @@ Drop most root capabilities in the parent process, and instead run as the user g capabilities (in particular setuid). Somewhat more secure, but can cause problems when serving from filesystems that do not honor capabilities, such as NFS. -Default value: `undef` +Default value: ``undef`` -### `apache::mod::jk` +### `apache::mod::jk` Installs `mod_jk`. @@ -2904,59 +2898,59 @@ class { '::apache::mod::jk': The following parameters are available in the `apache::mod::jk` class: -* [`ip`](#-apache--mod--jk--ip) -* [`port`](#-apache--mod--jk--port) -* [`add_listen`](#-apache--mod--jk--add_listen) -* [`workers_file`](#-apache--mod--jk--workers_file) -* [`worker_property`](#-apache--mod--jk--worker_property) -* [`logroot`](#-apache--mod--jk--logroot) -* [`shm_file`](#-apache--mod--jk--shm_file) -* [`shm_size`](#-apache--mod--jk--shm_size) -* [`mount_file`](#-apache--mod--jk--mount_file) -* [`mount_file_reload`](#-apache--mod--jk--mount_file_reload) -* [`mount`](#-apache--mod--jk--mount) -* [`un_mount`](#-apache--mod--jk--un_mount) -* [`auto_alias`](#-apache--mod--jk--auto_alias) -* [`mount_copy`](#-apache--mod--jk--mount_copy) -* [`worker_indicator`](#-apache--mod--jk--worker_indicator) -* [`watchdog_interval`](#-apache--mod--jk--watchdog_interval) -* [`log_file`](#-apache--mod--jk--log_file) -* [`log_level`](#-apache--mod--jk--log_level) -* [`log_stamp_format`](#-apache--mod--jk--log_stamp_format) -* [`request_log_format`](#-apache--mod--jk--request_log_format) -* [`extract_ssl`](#-apache--mod--jk--extract_ssl) -* [`https_indicator`](#-apache--mod--jk--https_indicator) -* [`sslprotocol_indicator`](#-apache--mod--jk--sslprotocol_indicator) -* [`certs_indicator`](#-apache--mod--jk--certs_indicator) -* [`cipher_indicator`](#-apache--mod--jk--cipher_indicator) -* [`certchain_prefix`](#-apache--mod--jk--certchain_prefix) -* [`session_indicator`](#-apache--mod--jk--session_indicator) -* [`keysize_indicator`](#-apache--mod--jk--keysize_indicator) -* [`local_name_indicator`](#-apache--mod--jk--local_name_indicator) -* [`ignore_cl_indicator`](#-apache--mod--jk--ignore_cl_indicator) -* [`local_addr_indicator`](#-apache--mod--jk--local_addr_indicator) -* [`local_port_indicator`](#-apache--mod--jk--local_port_indicator) -* [`remote_host_indicator`](#-apache--mod--jk--remote_host_indicator) -* [`remote_addr_indicator`](#-apache--mod--jk--remote_addr_indicator) -* [`remote_port_indicator`](#-apache--mod--jk--remote_port_indicator) -* [`remote_user_indicator`](#-apache--mod--jk--remote_user_indicator) -* [`auth_type_indicator`](#-apache--mod--jk--auth_type_indicator) -* [`options`](#-apache--mod--jk--options) -* [`env_var`](#-apache--mod--jk--env_var) -* [`strip_session`](#-apache--mod--jk--strip_session) -* [`location_list`](#-apache--mod--jk--location_list) -* [`workers_file_content`](#-apache--mod--jk--workers_file_content) -* [`mount_file_content`](#-apache--mod--jk--mount_file_content) - -##### `ip` +* [`ip`](#ip) +* [`port`](#port) +* [`add_listen`](#add_listen) +* [`workers_file`](#workers_file) +* [`worker_property`](#worker_property) +* [`logroot`](#logroot) +* [`shm_file`](#shm_file) +* [`shm_size`](#shm_size) +* [`mount_file`](#mount_file) +* [`mount_file_reload`](#mount_file_reload) +* [`mount`](#mount) +* [`un_mount`](#un_mount) +* [`auto_alias`](#auto_alias) +* [`mount_copy`](#mount_copy) +* [`worker_indicator`](#worker_indicator) +* [`watchdog_interval`](#watchdog_interval) +* [`log_file`](#log_file) +* [`log_level`](#log_level) +* [`log_stamp_format`](#log_stamp_format) +* [`request_log_format`](#request_log_format) +* [`extract_ssl`](#extract_ssl) +* [`https_indicator`](#https_indicator) +* [`sslprotocol_indicator`](#sslprotocol_indicator) +* [`certs_indicator`](#certs_indicator) +* [`cipher_indicator`](#cipher_indicator) +* [`certchain_prefix`](#certchain_prefix) +* [`session_indicator`](#session_indicator) +* [`keysize_indicator`](#keysize_indicator) +* [`local_name_indicator`](#local_name_indicator) +* [`ignore_cl_indicator`](#ignore_cl_indicator) +* [`local_addr_indicator`](#local_addr_indicator) +* [`local_port_indicator`](#local_port_indicator) +* [`remote_host_indicator`](#remote_host_indicator) +* [`remote_addr_indicator`](#remote_addr_indicator) +* [`remote_port_indicator`](#remote_port_indicator) +* [`remote_user_indicator`](#remote_user_indicator) +* [`auth_type_indicator`](#auth_type_indicator) +* [`options`](#options) +* [`env_var`](#env_var) +* [`strip_session`](#strip_session) +* [`location_list`](#location_list) +* [`workers_file_content`](#workers_file_content) +* [`mount_file_content`](#mount_file_content) + +##### `ip` Data type: `Optional[Stdlib::IP::Address]` IP for binding to mod_jk. Useful when the binding address is not the primary network interface IP. -Default value: `undef` +Default value: ``undef`` -##### `port` +##### `port` Data type: `Stdlib::Port` @@ -2965,7 +2959,7 @@ needs to forward them to Apache at a different port. Default value: `80` -##### `add_listen` +##### `add_listen` Data type: `Boolean` @@ -2973,17 +2967,17 @@ Defines if a Listen directive according to parameters ip and port (see below), s and redirect to mod_jk. Useful when another Listen directive, like Listen *: or Listen , can conflict with the one necessary for mod_jk binding. -Default value: `true` +Default value: ``true`` -##### `workers_file` +##### `workers_file` Data type: `Optional[String]` The name of a worker file for the Tomcat servlet containers. -Default value: `undef` +Default value: ``undef`` -##### `worker_property` +##### `worker_property` Data type: `Hash` @@ -2991,16 +2985,16 @@ Enables setting worker properties inside Apache configuration file. Default value: `{}` -##### `logroot` +##### `logroot` Data type: `Optional[Stdlib::Absolutepath]` The base directory for shm_file and log_file is determined by the logroot parameter. If unspecified, defaults to apache::params::logroot. The default logroot is sane enough therefore it is not recommended to override it. -Default value: `undef` +Default value: ``undef`` -##### `shm_file` +##### `shm_file` Data type: `String` @@ -3008,31 +3002,31 @@ Shared memory file name. Default value: `'jk-runtime-status'` -##### `shm_size` +##### `shm_size` Data type: `Optional[String]` Size of the shared memory file name. -Default value: `undef` +Default value: ``undef`` -##### `mount_file` +##### `mount_file` Data type: `Optional[String]` File containing multiple mappings from a context to a Tomcat worker. -Default value: `undef` +Default value: ``undef`` -##### `mount_file_reload` +##### `mount_file_reload` Data type: `Optional[String]` This directive configures the reload check interval in seconds. -Default value: `undef` +Default value: ``undef`` -##### `mount` +##### `mount` Data type: `Hash` @@ -3040,7 +3034,7 @@ A mount point from a context to a Tomcat worker. Default value: `{}` -##### `un_mount` +##### `un_mount` Data type: `Hash` @@ -3048,41 +3042,41 @@ An exclusion mount point from a context to a Tomcat worker. Default value: `{}` -##### `auto_alias` +##### `auto_alias` Data type: `Optional[String]` Automatically Alias webapp context directories into the Apache document space -Default value: `undef` +Default value: ``undef`` -##### `mount_copy` +##### `mount_copy` Data type: `Optional[String]` If this directive is set to "On" in some virtual server, the mounts from the global server will be copied to this virtual server, more precisely all mounts defined by JkMount or JkUnMount. -Default value: `undef` +Default value: ``undef`` -##### `worker_indicator` +##### `worker_indicator` Data type: `Optional[String]` Name of the Apache environment variable that can be used to set worker names in combination with SetHandler jakarta-servlet. -Default value: `undef` +Default value: ``undef`` -##### `watchdog_interval` +##### `watchdog_interval` Data type: `Optional[Integer]` This directive configures the watchdog thread interval in seconds. -Default value: `undef` +Default value: ``undef`` -##### `log_file` +##### `log_file` Data type: `String` @@ -3090,167 +3084,167 @@ Full or server relative path to the mod_jk log file. Default value: `'mod_jk.log'` -##### `log_level` +##### `log_level` Data type: `Optional[String]` The mod_jk log level, can be debug, info, warn error or trace. -Default value: `undef` +Default value: ``undef`` -##### `log_stamp_format` +##### `log_stamp_format` Data type: `Optional[String]` The mod_jk date log format, using an extended strftime syntax. -Default value: `undef` +Default value: ``undef`` -##### `request_log_format` +##### `request_log_format` Data type: `Optional[String]` Request log format string. -Default value: `undef` +Default value: ``undef`` -##### `extract_ssl` +##### `extract_ssl` Data type: `Optional[String]` Turns on SSL processing and information gathering by mod_jk. -Default value: `undef` +Default value: ``undef`` -##### `https_indicator` +##### `https_indicator` Data type: `Optional[String]` Name of the Apache environment variable that contains SSL indication. -Default value: `undef` +Default value: ``undef`` -##### `sslprotocol_indicator` +##### `sslprotocol_indicator` Data type: `Optional[String]` Name of the Apache environment variable that contains the SSL protocol name. -Default value: `undef` +Default value: ``undef`` -##### `certs_indicator` +##### `certs_indicator` Data type: `Optional[String]` Name of the Apache environment variable that contains SSL client certificates. -Default value: `undef` +Default value: ``undef`` -##### `cipher_indicator` +##### `cipher_indicator` Data type: `Optional[String]` Name of the Apache environment variable that contains SSL client cipher. -Default value: `undef` +Default value: ``undef`` -##### `certchain_prefix` +##### `certchain_prefix` Data type: `Optional[String]` Name of the Apache environment (prefix) that contains SSL client chain certificates. -Default value: `undef` +Default value: ``undef`` -##### `session_indicator` +##### `session_indicator` Data type: `Optional[String]` Name of the Apache environment variable that contains SSL session. -Default value: `undef` +Default value: ``undef`` -##### `keysize_indicator` +##### `keysize_indicator` Data type: `Optional[String]` Name of the Apache environment variable that contains SSL key size in use. -Default value: `undef` +Default value: ``undef`` -##### `local_name_indicator` +##### `local_name_indicator` Data type: `Optional[String]` Name of the Apache environment variable which can be used to overwrite the forwarded local name. -Default value: `undef` +Default value: ``undef`` -##### `ignore_cl_indicator` +##### `ignore_cl_indicator` Data type: `Optional[String]` Name of the Apache environment variable which forces to ignore an existing Content-Length request header. -Default value: `undef` +Default value: ``undef`` -##### `local_addr_indicator` +##### `local_addr_indicator` Data type: `Optional[String]` Name of the Apache environment variable which can be used to overwrite the forwarded local IP address. -Default value: `undef` +Default value: ``undef`` -##### `local_port_indicator` +##### `local_port_indicator` Data type: `Optional[String]` Name of the Apache environment variable which can be used to overwrite the forwarded local port. -Default value: `undef` +Default value: ``undef`` -##### `remote_host_indicator` +##### `remote_host_indicator` Data type: `Optional[String]` Name of the Apache environment variable which can be used to overwrite the forwarded remote (client) host name. -Default value: `undef` +Default value: ``undef`` -##### `remote_addr_indicator` +##### `remote_addr_indicator` Data type: `Optional[String]` Name of the Apache environment variable which can be used to overwrite the forwarded remote (client) IP address. -Default value: `undef` +Default value: ``undef`` -##### `remote_port_indicator` +##### `remote_port_indicator` Data type: `Optional[String]` Name of the Apache environment variable which can be used to overwrite the forwarded remote (client) IP address. -Default value: `undef` +Default value: ``undef`` -##### `remote_user_indicator` +##### `remote_user_indicator` Data type: `Optional[String]` Name of the Apache environment variable which can be used to overwrite the forwarded user name. -Default value: `undef` +Default value: ``undef`` -##### `auth_type_indicator` +##### `auth_type_indicator` Data type: `Optional[String]` Name of the Apache environment variable which can be used to overwrite the forwarded authentication type. -Default value: `undef` +Default value: ``undef`` -##### `options` +##### `options` Data type: `Array` @@ -3258,7 +3252,7 @@ Set one of more options to configure the mod_jk module. Default value: `[]` -##### `env_var` +##### `env_var` Data type: `Hash` @@ -3266,16 +3260,16 @@ Adds a name and an optional default value of environment variable that should be Default value: `{}` -##### `strip_session` +##### `strip_session` Data type: `Optional[String]` If this directive is set to On in some virtual server, the session IDs ;jsessionid=... will be removed for URLs which are not forwarded but instead are handled by the local server. -Default value: `undef` +Default value: ``undef`` -##### `location_list` +##### `location_list` Data type: `Array` @@ -3308,7 +3302,7 @@ location_list = [ Default value: `[]` -##### `workers_file_content` +##### `workers_file_content` Data type: `Hash` @@ -3352,7 +3346,7 @@ $workers_file_content = { Default value: `{}` -##### `mount_file_content` +##### `mount_file_content` Data type: `Hash` @@ -3389,7 +3383,7 @@ $mount_file_content = { Default value: `{}` -### `apache::mod::lbmethod_bybusyness` +### `apache::mod::lbmethod_bybusyness` Installs `lbmethod_bybusyness`. @@ -3401,9 +3395,9 @@ Installs `lbmethod_bybusyness`. The following parameters are available in the `apache::mod::lbmethod_bybusyness` class: -* [`apache_version`](#-apache--mod--lbmethod_bybusyness--apache_version) +* [`apache_version`](#apache_version) -##### `apache_version` +##### `apache_version` Data type: `Optional[String]` @@ -3411,7 +3405,7 @@ Version of Apache to install module on. Default value: `$apache::apache_version` -### `apache::mod::lbmethod_byrequests` +### `apache::mod::lbmethod_byrequests` Installs `lbmethod_byrequests`. @@ -3423,9 +3417,9 @@ Installs `lbmethod_byrequests`. The following parameters are available in the `apache::mod::lbmethod_byrequests` class: -* [`apache_version`](#-apache--mod--lbmethod_byrequests--apache_version) +* [`apache_version`](#apache_version) -##### `apache_version` +##### `apache_version` Data type: `Optional[String]` @@ -3433,7 +3427,7 @@ Version of Apache to install module on. Default value: `$apache::apache_version` -### `apache::mod::lbmethod_bytraffic` +### `apache::mod::lbmethod_bytraffic` Installs `lbmethod_bytraffic`. @@ -3445,9 +3439,9 @@ Installs `lbmethod_bytraffic`. The following parameters are available in the `apache::mod::lbmethod_bytraffic` class: -* [`apache_version`](#-apache--mod--lbmethod_bytraffic--apache_version) +* [`apache_version`](#apache_version) -##### `apache_version` +##### `apache_version` Data type: `Optional[String]` @@ -3455,7 +3449,7 @@ Version of Apache to install module on. Default value: `$apache::apache_version` -### `apache::mod::lbmethod_heartbeat` +### `apache::mod::lbmethod_heartbeat` Installs `lbmethod_heartbeat`. @@ -3467,9 +3461,9 @@ Installs `lbmethod_heartbeat`. The following parameters are available in the `apache::mod::lbmethod_heartbeat` class: -* [`apache_version`](#-apache--mod--lbmethod_heartbeat--apache_version) +* [`apache_version`](#apache_version) -##### `apache_version` +##### `apache_version` Data type: `Optional[String]` @@ -3477,7 +3471,7 @@ Version of Apache to install module on. Default value: `$apache::apache_version` -### `apache::mod::ldap` +### `apache::mod::ldap` Installs and configures `mod_ldap`. @@ -3508,34 +3502,34 @@ class { 'apache::mod::ldap': The following parameters are available in the `apache::mod::ldap` class: -* [`package_name`](#-apache--mod--ldap--package_name) -* [`ldap_trusted_global_cert_file`](#-apache--mod--ldap--ldap_trusted_global_cert_file) -* [`ldap_trusted_global_cert_type`](#-apache--mod--ldap--ldap_trusted_global_cert_type) -* [`ldap_shared_cache_size`](#-apache--mod--ldap--ldap_shared_cache_size) -* [`ldap_cache_entries`](#-apache--mod--ldap--ldap_cache_entries) -* [`ldap_cache_ttl`](#-apache--mod--ldap--ldap_cache_ttl) -* [`ldap_opcache_entries`](#-apache--mod--ldap--ldap_opcache_entries) -* [`ldap_opcache_ttl`](#-apache--mod--ldap--ldap_opcache_ttl) -* [`ldap_trusted_mode`](#-apache--mod--ldap--ldap_trusted_mode) -* [`ldap_path`](#-apache--mod--ldap--ldap_path) +* [`package_name`](#package_name) +* [`ldap_trusted_global_cert_file`](#ldap_trusted_global_cert_file) +* [`ldap_trusted_global_cert_type`](#ldap_trusted_global_cert_type) +* [`ldap_shared_cache_size`](#ldap_shared_cache_size) +* [`ldap_cache_entries`](#ldap_cache_entries) +* [`ldap_cache_ttl`](#ldap_cache_ttl) +* [`ldap_opcache_entries`](#ldap_opcache_entries) +* [`ldap_opcache_ttl`](#ldap_opcache_ttl) +* [`ldap_trusted_mode`](#ldap_trusted_mode) +* [`ldap_path`](#ldap_path) -##### `package_name` +##### `package_name` Data type: `Optional[String]` Specifies the custom package name. -Default value: `undef` +Default value: ``undef`` -##### `ldap_trusted_global_cert_file` +##### `ldap_trusted_global_cert_file` Data type: `Optional[String]` Sets the file or database containing global trusted Certificate Authority or global client certificates. -Default value: `undef` +Default value: ``undef`` -##### `ldap_trusted_global_cert_type` +##### `ldap_trusted_global_cert_type` Data type: `String` @@ -3543,55 +3537,55 @@ Sets the certificate parameter of the global trusted Certificate Authority or gl Default value: `'CA_BASE64'` -##### `ldap_shared_cache_size` +##### `ldap_shared_cache_size` Data type: `Optional[Integer]` Size in bytes of the shared-memory cache -Default value: `undef` +Default value: ``undef`` -##### `ldap_cache_entries` +##### `ldap_cache_entries` Data type: `Optional[Integer]` Maximum number of entries in the primary LDAP cache -Default value: `undef` +Default value: ``undef`` -##### `ldap_cache_ttl` +##### `ldap_cache_ttl` Data type: `Optional[Integer]` Time that cached items remain valid (in seconds). -Default value: `undef` +Default value: ``undef`` -##### `ldap_opcache_entries` +##### `ldap_opcache_entries` Data type: `Optional[Integer]` Number of entries used to cache LDAP compare operations -Default value: `undef` +Default value: ``undef`` -##### `ldap_opcache_ttl` +##### `ldap_opcache_ttl` Data type: `Optional[Integer]` Time that entries in the operation cache remain valid (in seconds). -Default value: `undef` +Default value: ``undef`` -##### `ldap_trusted_mode` +##### `ldap_trusted_mode` Data type: `Optional[String]` Specifies the SSL/TLS mode to be used when connecting to an LDAP server. -Default value: `undef` +Default value: ``undef`` -##### `ldap_path` +##### `ldap_path` Data type: `String` @@ -3599,7 +3593,15 @@ The server location of the ldap status page. Default value: `'/ldap-status'` -### `apache::mod::lookup_identity` +### `apache::mod::log_forensic` + +Installs `mod_log_forensic` + +* **See also** + * https://httpd.apache.org/docs/current/mod/mod_log_forensic.html + * for additional documentation. + +### `apache::mod::lookup_identity` Installs `mod_lookup_identity` @@ -3607,7 +3609,7 @@ Installs `mod_lookup_identity` * https://www.adelton.com/apache/mod_lookup_identity * for additional documentation. -### `apache::mod::macro` +### `apache::mod::macro` Installs `mod_macro`. @@ -3615,7 +3617,7 @@ Installs `mod_macro`. * https://httpd.apache.org/docs/current/mod/mod_macro.html * for additional documentation. -### `apache::mod::md` +### `apache::mod::md` Installs and configures `mod_md`. @@ -3629,264 +3631,264 @@ Installs and configures `mod_md`. The following parameters are available in the `apache::mod::md` class: -* [`md_activation_delay`](#-apache--mod--md--md_activation_delay) -* [`md_base_server`](#-apache--mod--md--md_base_server) -* [`md_ca_challenges`](#-apache--mod--md--md_ca_challenges) -* [`md_certificate_agreement`](#-apache--mod--md--md_certificate_agreement) -* [`md_certificate_authority`](#-apache--mod--md--md_certificate_authority) -* [`md_certificate_check`](#-apache--mod--md--md_certificate_check) -* [`md_certificate_monitor`](#-apache--mod--md--md_certificate_monitor) -* [`md_certificate_protocol`](#-apache--mod--md--md_certificate_protocol) -* [`md_certificate_status`](#-apache--mod--md--md_certificate_status) -* [`md_challenge_dns01`](#-apache--mod--md--md_challenge_dns01) -* [`md_contact_email`](#-apache--mod--md--md_contact_email) -* [`md_http_proxy`](#-apache--mod--md--md_http_proxy) -* [`md_members`](#-apache--mod--md--md_members) -* [`md_message_cmd`](#-apache--mod--md--md_message_cmd) -* [`md_must_staple`](#-apache--mod--md--md_must_staple) -* [`md_notify_cmd`](#-apache--mod--md--md_notify_cmd) -* [`md_port_map`](#-apache--mod--md--md_port_map) -* [`md_private_keys`](#-apache--mod--md--md_private_keys) -* [`md_renew_mode`](#-apache--mod--md--md_renew_mode) -* [`md_renew_window`](#-apache--mod--md--md_renew_window) -* [`md_require_https`](#-apache--mod--md--md_require_https) -* [`md_server_status`](#-apache--mod--md--md_server_status) -* [`md_staple_others`](#-apache--mod--md--md_staple_others) -* [`md_stapling`](#-apache--mod--md--md_stapling) -* [`md_stapling_keep_response`](#-apache--mod--md--md_stapling_keep_response) -* [`md_stapling_renew_window`](#-apache--mod--md--md_stapling_renew_window) -* [`md_store_dir`](#-apache--mod--md--md_store_dir) -* [`md_warn_window`](#-apache--mod--md--md_warn_window) - -##### `md_activation_delay` +* [`md_activation_delay`](#md_activation_delay) +* [`md_base_server`](#md_base_server) +* [`md_ca_challenges`](#md_ca_challenges) +* [`md_certificate_agreement`](#md_certificate_agreement) +* [`md_certificate_authority`](#md_certificate_authority) +* [`md_certificate_check`](#md_certificate_check) +* [`md_certificate_monitor`](#md_certificate_monitor) +* [`md_certificate_protocol`](#md_certificate_protocol) +* [`md_certificate_status`](#md_certificate_status) +* [`md_challenge_dns01`](#md_challenge_dns01) +* [`md_contact_email`](#md_contact_email) +* [`md_http_proxy`](#md_http_proxy) +* [`md_members`](#md_members) +* [`md_message_cmd`](#md_message_cmd) +* [`md_must_staple`](#md_must_staple) +* [`md_notify_cmd`](#md_notify_cmd) +* [`md_port_map`](#md_port_map) +* [`md_private_keys`](#md_private_keys) +* [`md_renew_mode`](#md_renew_mode) +* [`md_renew_window`](#md_renew_window) +* [`md_require_https`](#md_require_https) +* [`md_server_status`](#md_server_status) +* [`md_staple_others`](#md_staple_others) +* [`md_stapling`](#md_stapling) +* [`md_stapling_keep_response`](#md_stapling_keep_response) +* [`md_stapling_renew_window`](#md_stapling_renew_window) +* [`md_store_dir`](#md_store_dir) +* [`md_warn_window`](#md_warn_window) + +##### `md_activation_delay` Data type: `Optional[String]` - -Default value: `undef` +Default value: ``undef`` -##### `md_base_server` +##### `md_base_server` -Data type: `Optional[Enum['on', 'off']]` +Data type: `Optional[Apache::OnOff]` Control if base server may be managed or only virtual hosts. -Default value: `undef` +Default value: ``undef`` -##### `md_ca_challenges` +##### `md_ca_challenges` Data type: `Optional[Array[Enum['dns-01', 'http-01', 'tls-alpn-01']]]` Type of ACME challenge used to prove domain ownership. -Default value: `undef` +Default value: ``undef`` -##### `md_certificate_agreement` +##### `md_certificate_agreement` Data type: `Optional[Enum['accepted']]` You confirm that you accepted the Terms of Service of the Certificate Authority. -Default value: `undef` +Default value: ``undef`` -##### `md_certificate_authority` +##### `md_certificate_authority` Data type: `Optional[Stdlib::HTTPUrl]` The URL of the ACME Certificate Authority service. -Default value: `undef` +Default value: ``undef`` -##### `md_certificate_check` +##### `md_certificate_check` Data type: `Optional[String]` - -Default value: `undef` +Default value: ``undef`` -##### `md_certificate_monitor` +##### `md_certificate_monitor` Data type: `Optional[String]` The URL of a certificate log monitor. -Default value: `undef` +Default value: ``undef`` -##### `md_certificate_protocol` +##### `md_certificate_protocol` Data type: `Optional[Enum['ACME']]` The protocol to use with the Certificate Authority. -Default value: `undef` +Default value: ``undef`` -##### `md_certificate_status` +##### `md_certificate_status` -Data type: `Optional[Enum['on', 'off']]` +Data type: `Optional[Apache::OnOff]` Exposes public certificate information in JSON. -Default value: `undef` +Default value: ``undef`` -##### `md_challenge_dns01` +##### `md_challenge_dns01` Data type: `Optional[Stdlib::Absolutepath]` Define a program to be called when the `dns-01` challenge needs to be setup/torn down. -Default value: `undef` +Default value: ``undef`` -##### `md_contact_email` +##### `md_contact_email` Data type: `Optional[String]` The ACME protocol requires you to give a contact url when you sign up. -Default value: `undef` +Default value: ``undef`` -##### `md_http_proxy` +##### `md_http_proxy` Data type: `Optional[Stdlib::HTTPUrl]` Define a proxy for outgoing connections. -Default value: `undef` +Default value: ``undef`` -##### `md_members` +##### `md_members` Data type: `Optional[Enum['auto', 'manual']]` Control if the alias domain names are automatically added. -Default value: `undef` +Default value: ``undef`` -##### `md_message_cmd` +##### `md_message_cmd` Data type: `Optional[Stdlib::Absolutepath]` Handle events for Manage Domains. -Default value: `undef` +Default value: ``undef`` -##### `md_must_staple` +##### `md_must_staple` -Data type: `Optional[Enum['on', 'off']]` +Data type: `Optional[Apache::OnOff]` Control if new certificates carry the OCSP Must Staple flag. -Default value: `undef` +Default value: ``undef`` -##### `md_notify_cmd` +##### `md_notify_cmd` Data type: `Optional[Stdlib::Absolutepath]` Run a program when a Managed Domain is ready. -Default value: `undef` +Default value: ``undef`` -##### `md_port_map` +##### `md_port_map` Data type: `Optional[String]` Map external to internal ports for domain ownership verification. -Default value: `undef` +Default value: ``undef`` -##### `md_private_keys` +##### `md_private_keys` Data type: `Optional[String]` Set type and size of the private keys generated. -Default value: `undef` +Default value: ``undef`` -##### `md_renew_mode` +##### `md_renew_mode` Data type: `Optional[Enum['always', 'auto', 'manual']]` Controls if certificates shall be renewed. -Default value: `undef` +Default value: ``undef`` -##### `md_renew_window` +##### `md_renew_window` Data type: `Optional[String]` Control when a certificate will be renewed. -Default value: `undef` +Default value: ``undef`` -##### `md_require_https` +##### `md_require_https` Data type: `Optional[Enum['off', 'permanent', 'temporary']]` Redirects http: traffic to https: for Managed Domains. An http: Virtual Host must nevertheless be setup for that domain. -Default value: `undef` +Default value: ``undef`` -##### `md_server_status` +##### `md_server_status` -Data type: `Optional[Enum['on', 'off']]` +Data type: `Optional[Apache::OnOff]` Control if Managed Domain information is added to server-status. -Default value: `undef` +Default value: ``undef`` -##### `md_staple_others` +##### `md_staple_others` -Data type: `Optional[Enum['on', 'off']]` +Data type: `Optional[Apache::OnOff]` Enable stapling for certificates not managed by mod_md. -Default value: `undef` +Default value: ``undef`` -##### `md_stapling` +##### `md_stapling` -Data type: `Optional[Enum['on', 'off']]` +Data type: `Optional[Apache::OnOff]` Enable stapling for all or a particular MDomain. -Default value: `undef` +Default value: ``undef`` -##### `md_stapling_keep_response` +##### `md_stapling_keep_response` Data type: `Optional[String]` Controls when old responses should be removed. -Default value: `undef` +Default value: ``undef`` -##### `md_stapling_renew_window` +##### `md_stapling_renew_window` Data type: `Optional[String]` Control when the stapling responses will be renewed. -Default value: `undef` +Default value: ``undef`` -##### `md_store_dir` +##### `md_store_dir` Data type: `Optional[Stdlib::Absolutepath]` Path on the local file system to store the Managed Domains data. -Default value: `undef` +Default value: ``undef`` -##### `md_warn_window` +##### `md_warn_window` Data type: `Optional[String]` Define the time window when you want to be warned about an expiring certificate. -Default value: `undef` +Default value: ``undef`` -### `apache::mod::mime` +### `apache::mod::mime` Installs and configures `mod_mime`. @@ -3898,11 +3900,11 @@ Installs and configures `mod_mime`. The following parameters are available in the `apache::mod::mime` class: -* [`mime_support_package`](#-apache--mod--mime--mime_support_package) -* [`mime_types_config`](#-apache--mod--mime--mime_types_config) -* [`mime_types_additional`](#-apache--mod--mime--mime_types_additional) +* [`mime_support_package`](#mime_support_package) +* [`mime_types_config`](#mime_types_config) +* [`mime_types_additional`](#mime_types_additional) -##### `mime_support_package` +##### `mime_support_package` Data type: `String` @@ -3910,7 +3912,7 @@ Name of the MIME package to be installed. Default value: `$apache::params::mime_support_package` -##### `mime_types_config` +##### `mime_types_config` Data type: `String` @@ -3918,15 +3920,15 @@ The location of the mime.types file. Default value: `$apache::params::mime_types_config` -##### `mime_types_additional` +##### `mime_types_additional` Data type: `Optional[Hash]` List of additional MIME types to include. -Default value: `undef` +Default value: ``undef`` -### `apache::mod::mime_magic` +### `apache::mod::mime_magic` Installs and configures `mod_mime_magic`. @@ -3938,17 +3940,17 @@ Installs and configures `mod_mime_magic`. The following parameters are available in the `apache::mod::mime_magic` class: -* [`magic_file`](#-apache--mod--mime_magic--magic_file) +* [`magic_file`](#magic_file) -##### `magic_file` +##### `magic_file` Data type: `Optional[String]` Enable MIME-type determination based on file contents using the specified magic file. -Default value: `undef` +Default value: ``undef`` -### `apache::mod::negotiation` +### `apache::mod::negotiation` Installs and configures `mod_negotiation`. @@ -3960,10 +3962,10 @@ Installs and configures `mod_negotiation`. The following parameters are available in the `apache::mod::negotiation` class: -* [`force_language_priority`](#-apache--mod--negotiation--force_language_priority) -* [`language_priority`](#-apache--mod--negotiation--language_priority) +* [`force_language_priority`](#force_language_priority) +* [`language_priority`](#language_priority) -##### `force_language_priority` +##### `force_language_priority` Data type: `Variant[Array[String], String]` @@ -3971,22 +3973,18 @@ Action to take if a single acceptable document is not found. Default value: `'Prefer Fallback'` -##### `language_priority` +##### `language_priority` Data type: `Variant[Array[String], String]` The precedence of language variants for cases where the client does not express a preference. -Default value: - -```puppet -['en', 'ca', 'cs', 'da', 'de', 'el', 'eo', 'es', 'et', +Default value: `['en', 'ca', 'cs', 'da', 'de', 'el', 'eo', 'es', 'et', 'fr', 'he', 'hr', 'it', 'ja', 'ko', 'ltz', 'nl', 'nn', 'no', 'pl', 'pt', 'pt-BR', 'ru', 'sv', 'zh-CN', - 'zh-TW'] -``` + 'zh-TW']` -### `apache::mod::nss` +### `apache::mod::nss` Installs and configures `mod_nss`. @@ -3998,12 +3996,12 @@ Installs and configures `mod_nss`. The following parameters are available in the `apache::mod::nss` class: -* [`transfer_log`](#-apache--mod--nss--transfer_log) -* [`error_log`](#-apache--mod--nss--error_log) -* [`passwd_file`](#-apache--mod--nss--passwd_file) -* [`port`](#-apache--mod--nss--port) +* [`transfer_log`](#transfer_log) +* [`error_log`](#error_log) +* [`passwd_file`](#passwd_file) +* [`port`](#port) -##### `transfer_log` +##### `transfer_log` Data type: `Stdlib::Absolutepath` @@ -4011,7 +4009,7 @@ Path to `access.log`. Default value: `"${apache::params::logroot}/access.log"` -##### `error_log` +##### `error_log` Data type: `Stdlib::Absolutepath` @@ -4019,15 +4017,15 @@ Path to `error.log` Default value: `"${apache::params::logroot}/error.log"` -##### `passwd_file` +##### `passwd_file` Data type: `Optional[String]` Path to file containing token passwords used for NSSPassPhraseDialog. -Default value: `undef` +Default value: ``undef`` -##### `port` +##### `port` Data type: `Stdlib::Port` @@ -4035,7 +4033,7 @@ Sets the SSL port that should be used by mod_nss. Default value: `8443` -### `apache::mod::pagespeed` +### `apache::mod::pagespeed` Installs and manages mod_pagespeed, which is a Google module that rewrites web pages to reduce latency and bandwidth. @@ -4100,42 +4098,42 @@ class { 'apache::mod::pagespeed': The following parameters are available in the `apache::mod::pagespeed` class: -* [`inherit_vhost_config`](#-apache--mod--pagespeed--inherit_vhost_config) -* [`filter_xhtml`](#-apache--mod--pagespeed--filter_xhtml) -* [`cache_path`](#-apache--mod--pagespeed--cache_path) -* [`log_dir`](#-apache--mod--pagespeed--log_dir) -* [`memcache_servers`](#-apache--mod--pagespeed--memcache_servers) -* [`rewrite_level`](#-apache--mod--pagespeed--rewrite_level) -* [`disable_filters`](#-apache--mod--pagespeed--disable_filters) -* [`enable_filters`](#-apache--mod--pagespeed--enable_filters) -* [`forbid_filters`](#-apache--mod--pagespeed--forbid_filters) -* [`rewrite_deadline_per_flush_ms`](#-apache--mod--pagespeed--rewrite_deadline_per_flush_ms) -* [`additional_domains`](#-apache--mod--pagespeed--additional_domains) -* [`file_cache_size_kb`](#-apache--mod--pagespeed--file_cache_size_kb) -* [`file_cache_clean_interval_ms`](#-apache--mod--pagespeed--file_cache_clean_interval_ms) -* [`lru_cache_per_process`](#-apache--mod--pagespeed--lru_cache_per_process) -* [`lru_cache_byte_limit`](#-apache--mod--pagespeed--lru_cache_byte_limit) -* [`css_flatten_max_bytes`](#-apache--mod--pagespeed--css_flatten_max_bytes) -* [`css_inline_max_bytes`](#-apache--mod--pagespeed--css_inline_max_bytes) -* [`css_image_inline_max_bytes`](#-apache--mod--pagespeed--css_image_inline_max_bytes) -* [`image_inline_max_bytes`](#-apache--mod--pagespeed--image_inline_max_bytes) -* [`js_inline_max_bytes`](#-apache--mod--pagespeed--js_inline_max_bytes) -* [`css_outline_min_bytes`](#-apache--mod--pagespeed--css_outline_min_bytes) -* [`js_outline_min_bytes`](#-apache--mod--pagespeed--js_outline_min_bytes) -* [`inode_limit`](#-apache--mod--pagespeed--inode_limit) -* [`image_max_rewrites_at_once`](#-apache--mod--pagespeed--image_max_rewrites_at_once) -* [`num_rewrite_threads`](#-apache--mod--pagespeed--num_rewrite_threads) -* [`num_expensive_rewrite_threads`](#-apache--mod--pagespeed--num_expensive_rewrite_threads) -* [`collect_statistics`](#-apache--mod--pagespeed--collect_statistics) -* [`statistics_logging`](#-apache--mod--pagespeed--statistics_logging) -* [`allow_view_stats`](#-apache--mod--pagespeed--allow_view_stats) -* [`allow_pagespeed_console`](#-apache--mod--pagespeed--allow_pagespeed_console) -* [`allow_pagespeed_message`](#-apache--mod--pagespeed--allow_pagespeed_message) -* [`message_buffer_size`](#-apache--mod--pagespeed--message_buffer_size) -* [`additional_configuration`](#-apache--mod--pagespeed--additional_configuration) -* [`package_ensure`](#-apache--mod--pagespeed--package_ensure) - -##### `inherit_vhost_config` +* [`inherit_vhost_config`](#inherit_vhost_config) +* [`filter_xhtml`](#filter_xhtml) +* [`cache_path`](#cache_path) +* [`log_dir`](#log_dir) +* [`memcache_servers`](#memcache_servers) +* [`rewrite_level`](#rewrite_level) +* [`disable_filters`](#disable_filters) +* [`enable_filters`](#enable_filters) +* [`forbid_filters`](#forbid_filters) +* [`rewrite_deadline_per_flush_ms`](#rewrite_deadline_per_flush_ms) +* [`additional_domains`](#additional_domains) +* [`file_cache_size_kb`](#file_cache_size_kb) +* [`file_cache_clean_interval_ms`](#file_cache_clean_interval_ms) +* [`lru_cache_per_process`](#lru_cache_per_process) +* [`lru_cache_byte_limit`](#lru_cache_byte_limit) +* [`css_flatten_max_bytes`](#css_flatten_max_bytes) +* [`css_inline_max_bytes`](#css_inline_max_bytes) +* [`css_image_inline_max_bytes`](#css_image_inline_max_bytes) +* [`image_inline_max_bytes`](#image_inline_max_bytes) +* [`js_inline_max_bytes`](#js_inline_max_bytes) +* [`css_outline_min_bytes`](#css_outline_min_bytes) +* [`js_outline_min_bytes`](#js_outline_min_bytes) +* [`inode_limit`](#inode_limit) +* [`image_max_rewrites_at_once`](#image_max_rewrites_at_once) +* [`num_rewrite_threads`](#num_rewrite_threads) +* [`num_expensive_rewrite_threads`](#num_expensive_rewrite_threads) +* [`collect_statistics`](#collect_statistics) +* [`statistics_logging`](#statistics_logging) +* [`allow_view_stats`](#allow_view_stats) +* [`allow_pagespeed_console`](#allow_pagespeed_console) +* [`allow_pagespeed_message`](#allow_pagespeed_message) +* [`message_buffer_size`](#message_buffer_size) +* [`additional_configuration`](#additional_configuration) +* [`package_ensure`](#package_ensure) + +##### `inherit_vhost_config` Data type: `String` @@ -4143,15 +4141,15 @@ Whether or not to inherit the vhost config Default value: `'on'` -##### `filter_xhtml` +##### `filter_xhtml` Data type: `Boolean` Whether to filter by xhtml -Default value: `false` +Default value: ``false`` -##### `cache_path` +##### `cache_path` Data type: `Stdlib::Absolutepath` @@ -4159,7 +4157,7 @@ Where to cache any files Default value: `'/var/cache/mod_pagespeed/'` -##### `log_dir` +##### `log_dir` Data type: `Stdlib::Absolutepath` @@ -4167,7 +4165,7 @@ The log directory Default value: `'/var/log/pagespeed'` -##### `memcache_servers` +##### `memcache_servers` Data type: `Array` @@ -4175,7 +4173,7 @@ Data type: `Array` Default value: `[]` -##### `rewrite_level` +##### `rewrite_level` Data type: `String` @@ -4184,7 +4182,7 @@ Can be `PassThrough`, `CoreFilters` or `OptimizeForBandwidth`. Default value: `'CoreFilters'` -##### `disable_filters` +##### `disable_filters` Data type: `Array` @@ -4192,7 +4190,7 @@ An array of filters that you wish to disable Default value: `[]` -##### `enable_filters` +##### `enable_filters` Data type: `Array` @@ -4200,7 +4198,7 @@ An array of filters that you wish to enable Default value: `[]` -##### `forbid_filters` +##### `forbid_filters` Data type: `Array` @@ -4208,7 +4206,7 @@ An array of filters that you wish to forbid Default value: `[]` -##### `rewrite_deadline_per_flush_ms` +##### `rewrite_deadline_per_flush_ms` Data type: `Integer` @@ -4216,15 +4214,15 @@ How long to wait after attempting to rewrite an uncache/expired resource. Default value: `10` -##### `additional_domains` +##### `additional_domains` Data type: `Optional[String]` Any additional domains that PageSpeed should optimize resources from. -Default value: `undef` +Default value: ``undef`` -##### `file_cache_size_kb` +##### `file_cache_size_kb` Data type: `Integer` @@ -4232,7 +4230,7 @@ The maximum size of the cache Default value: `102400` -##### `file_cache_clean_interval_ms` +##### `file_cache_clean_interval_ms` Data type: `Integer` @@ -4240,7 +4238,7 @@ The interval between which the cache is cleaned Default value: `3600000` -##### `lru_cache_per_process` +##### `lru_cache_per_process` Data type: `Integer` @@ -4248,7 +4246,7 @@ The amount of memory dedcated to each process Default value: `1024` -##### `lru_cache_byte_limit` +##### `lru_cache_byte_limit` Data type: `Integer` @@ -4256,7 +4254,7 @@ How large a cache entry the cache will accept Default value: `16384` -##### `css_flatten_max_bytes` +##### `css_flatten_max_bytes` Data type: `Integer` @@ -4264,7 +4262,7 @@ The maximum size in bytes of the flattened CSS Default value: `2048` -##### `css_inline_max_bytes` +##### `css_inline_max_bytes` Data type: `Integer` @@ -4272,7 +4270,7 @@ The maximum size in bytes of any image that will be inlined into CSS Default value: `2048` -##### `css_image_inline_max_bytes` +##### `css_image_inline_max_bytes` Data type: `Integer` @@ -4280,7 +4278,7 @@ The maximum size in bytes of any image that will be inlined into an HTML file Default value: `2048` -##### `image_inline_max_bytes` +##### `image_inline_max_bytes` Data type: `Integer` @@ -4288,7 +4286,7 @@ The maximum size in bytes of any inlined CSS file Default value: `2048` -##### `js_inline_max_bytes` +##### `js_inline_max_bytes` Data type: `Integer` @@ -4296,7 +4294,7 @@ The maximum size in bytes of any inlined JavaScript file Default value: `2048` -##### `css_outline_min_bytes` +##### `css_outline_min_bytes` Data type: `Integer` @@ -4304,7 +4302,7 @@ The minimum size in bytes for a CSS file to qualify as an outline Default value: `3000` -##### `js_outline_min_bytes` +##### `js_outline_min_bytes` Data type: `Integer` @@ -4312,7 +4310,7 @@ The minimum size in bytes for a JavaScript file to qualify as an outline Default value: `3000` -##### `inode_limit` +##### `inode_limit` Data type: `Integer` @@ -4320,7 +4318,7 @@ The file cache inode limit Default value: `500000` -##### `image_max_rewrites_at_once` +##### `image_max_rewrites_at_once` Data type: `Integer` @@ -4328,7 +4326,7 @@ The maximum number of images to optimize concurrently Default value: `8` -##### `num_rewrite_threads` +##### `num_rewrite_threads` Data type: `Integer` @@ -4337,7 +4335,7 @@ These threads are used for short, latency-sensitive work. Default value: `4` -##### `num_expensive_rewrite_threads` +##### `num_expensive_rewrite_threads` Data type: `Integer` @@ -4346,7 +4344,7 @@ These threads are used for full optimization. Default value: `4` -##### `collect_statistics` +##### `collect_statistics` Data type: `String` @@ -4354,7 +4352,7 @@ Whether to collect cross-process statistics Default value: `'on'` -##### `statistics_logging` +##### `statistics_logging` Data type: `String` @@ -4362,7 +4360,7 @@ Whether graphs should be drawn from collected statistics Default value: `'on'` -##### `allow_view_stats` +##### `allow_view_stats` Data type: `Array` @@ -4370,7 +4368,7 @@ What sources should be allowed to view the resultant graph Default value: `[]` -##### `allow_pagespeed_console` +##### `allow_pagespeed_console` Data type: `Array` @@ -4378,7 +4376,7 @@ What sources to draw the graphs from Default value: `[]` -##### `allow_pagespeed_message` +##### `allow_pagespeed_message` Data type: `Array` @@ -4386,7 +4384,7 @@ Data type: `Array` Default value: `[]` -##### `message_buffer_size` +##### `message_buffer_size` Data type: `Integer` @@ -4394,7 +4392,7 @@ The amount of bytes to allocate as a buffer to hold recent log messages Default value: `100000` -##### `additional_configuration` +##### `additional_configuration` Data type: `Variant[Array, Hash]` @@ -4402,15 +4400,15 @@ Any additional configuration no included as it's own option Default value: `{}` -##### `package_ensure` +##### `package_ensure` Data type: `Optional[String]` -Default value: `undef` +Default value: ``undef`` -### `apache::mod::passenger` +### `apache::mod::passenger` The current set of server configurations settings were taken directly from the Passenger Reference. To enable deprecation warnings and removal failure messages, set the passenger_installed_version to the version number installed on the server. @@ -4433,176 +4431,176 @@ There are also several undocumented settings. The following parameters are available in the `apache::mod::passenger` class: -* [`manage_repo`](#-apache--mod--passenger--manage_repo) -* [`mod_id`](#-apache--mod--passenger--mod_id) -* [`mod_lib`](#-apache--mod--passenger--mod_lib) -* [`mod_lib_path`](#-apache--mod--passenger--mod_lib_path) -* [`mod_package`](#-apache--mod--passenger--mod_package) -* [`mod_package_ensure`](#-apache--mod--passenger--mod_package_ensure) -* [`mod_path`](#-apache--mod--passenger--mod_path) -* [`passenger_allow_encoded_slashes`](#-apache--mod--passenger--passenger_allow_encoded_slashes) -* [`passenger_anonymous_telemetry_proxy`](#-apache--mod--passenger--passenger_anonymous_telemetry_proxy) -* [`passenger_app_env`](#-apache--mod--passenger--passenger_app_env) -* [`passenger_app_group_name`](#-apache--mod--passenger--passenger_app_group_name) -* [`passenger_app_root`](#-apache--mod--passenger--passenger_app_root) -* [`passenger_app_type`](#-apache--mod--passenger--passenger_app_type) -* [`passenger_base_uri`](#-apache--mod--passenger--passenger_base_uri) -* [`passenger_buffer_response`](#-apache--mod--passenger--passenger_buffer_response) -* [`passenger_buffer_upload`](#-apache--mod--passenger--passenger_buffer_upload) -* [`passenger_concurrency_model`](#-apache--mod--passenger--passenger_concurrency_model) -* [`passenger_conf_file`](#-apache--mod--passenger--passenger_conf_file) -* [`passenger_conf_package_file`](#-apache--mod--passenger--passenger_conf_package_file) -* [`passenger_data_buffer_dir`](#-apache--mod--passenger--passenger_data_buffer_dir) -* [`passenger_debug_log_file`](#-apache--mod--passenger--passenger_debug_log_file) -* [`passenger_debugger`](#-apache--mod--passenger--passenger_debugger) -* [`passenger_default_group`](#-apache--mod--passenger--passenger_default_group) -* [`passenger_default_ruby`](#-apache--mod--passenger--passenger_default_ruby) -* [`passenger_default_user`](#-apache--mod--passenger--passenger_default_user) -* [`passenger_disable_anonymous_telemetry`](#-apache--mod--passenger--passenger_disable_anonymous_telemetry) -* [`passenger_disable_log_prefix`](#-apache--mod--passenger--passenger_disable_log_prefix) -* [`passenger_disable_security_update_check`](#-apache--mod--passenger--passenger_disable_security_update_check) -* [`passenger_enabled`](#-apache--mod--passenger--passenger_enabled) -* [`passenger_error_override`](#-apache--mod--passenger--passenger_error_override) -* [`passenger_file_descriptor_log_file`](#-apache--mod--passenger--passenger_file_descriptor_log_file) -* [`passenger_fly_with`](#-apache--mod--passenger--passenger_fly_with) -* [`passenger_force_max_concurrent_requests_per_process`](#-apache--mod--passenger--passenger_force_max_concurrent_requests_per_process) -* [`passenger_friendly_error_pages`](#-apache--mod--passenger--passenger_friendly_error_pages) -* [`passenger_group`](#-apache--mod--passenger--passenger_group) -* [`passenger_high_performance`](#-apache--mod--passenger--passenger_high_performance) -* [`passenger_installed_version`](#-apache--mod--passenger--passenger_installed_version) -* [`passenger_instance_registry_dir`](#-apache--mod--passenger--passenger_instance_registry_dir) -* [`passenger_load_shell_envvars`](#-apache--mod--passenger--passenger_load_shell_envvars) -* [`passenger_preload_bundler`](#-apache--mod--passenger--passenger_preload_bundler) -* [`passenger_log_file`](#-apache--mod--passenger--passenger_log_file) -* [`passenger_log_level`](#-apache--mod--passenger--passenger_log_level) -* [`passenger_lve_min_uid`](#-apache--mod--passenger--passenger_lve_min_uid) -* [`passenger_max_instances`](#-apache--mod--passenger--passenger_max_instances) -* [`passenger_max_instances_per_app`](#-apache--mod--passenger--passenger_max_instances_per_app) -* [`passenger_max_pool_size`](#-apache--mod--passenger--passenger_max_pool_size) -* [`passenger_max_preloader_idle_time`](#-apache--mod--passenger--passenger_max_preloader_idle_time) -* [`passenger_max_request_queue_size`](#-apache--mod--passenger--passenger_max_request_queue_size) -* [`passenger_max_request_time`](#-apache--mod--passenger--passenger_max_request_time) -* [`passenger_max_requests`](#-apache--mod--passenger--passenger_max_requests) -* [`passenger_memory_limit`](#-apache--mod--passenger--passenger_memory_limit) -* [`passenger_meteor_app_settings`](#-apache--mod--passenger--passenger_meteor_app_settings) -* [`passenger_min_instances`](#-apache--mod--passenger--passenger_min_instances) -* [`passenger_nodejs`](#-apache--mod--passenger--passenger_nodejs) -* [`passenger_pool_idle_time`](#-apache--mod--passenger--passenger_pool_idle_time) -* [`passenger_pre_start`](#-apache--mod--passenger--passenger_pre_start) -* [`passenger_python`](#-apache--mod--passenger--passenger_python) -* [`passenger_resist_deployment_errors`](#-apache--mod--passenger--passenger_resist_deployment_errors) -* [`passenger_resolve_symlinks_in_document_root`](#-apache--mod--passenger--passenger_resolve_symlinks_in_document_root) -* [`passenger_response_buffer_high_watermark`](#-apache--mod--passenger--passenger_response_buffer_high_watermark) -* [`passenger_restart_dir`](#-apache--mod--passenger--passenger_restart_dir) -* [`passenger_rolling_restarts`](#-apache--mod--passenger--passenger_rolling_restarts) -* [`passenger_root`](#-apache--mod--passenger--passenger_root) -* [`passenger_ruby`](#-apache--mod--passenger--passenger_ruby) -* [`passenger_security_update_check_proxy`](#-apache--mod--passenger--passenger_security_update_check_proxy) -* [`passenger_show_version_in_header`](#-apache--mod--passenger--passenger_show_version_in_header) -* [`passenger_socket_backlog`](#-apache--mod--passenger--passenger_socket_backlog) -* [`passenger_spawn_dir`](#-apache--mod--passenger--passenger_spawn_dir) -* [`passenger_spawn_method`](#-apache--mod--passenger--passenger_spawn_method) -* [`passenger_start_timeout`](#-apache--mod--passenger--passenger_start_timeout) -* [`passenger_startup_file`](#-apache--mod--passenger--passenger_startup_file) -* [`passenger_stat_throttle_rate`](#-apache--mod--passenger--passenger_stat_throttle_rate) -* [`passenger_sticky_sessions`](#-apache--mod--passenger--passenger_sticky_sessions) -* [`passenger_sticky_sessions_cookie_name`](#-apache--mod--passenger--passenger_sticky_sessions_cookie_name) -* [`passenger_sticky_sessions_cookie_attributes`](#-apache--mod--passenger--passenger_sticky_sessions_cookie_attributes) -* [`passenger_thread_count`](#-apache--mod--passenger--passenger_thread_count) -* [`passenger_use_global_queue`](#-apache--mod--passenger--passenger_use_global_queue) -* [`passenger_user`](#-apache--mod--passenger--passenger_user) -* [`passenger_user_switching`](#-apache--mod--passenger--passenger_user_switching) -* [`rack_auto_detect`](#-apache--mod--passenger--rack_auto_detect) -* [`rack_autodetect`](#-apache--mod--passenger--rack_autodetect) -* [`rack_base_uri`](#-apache--mod--passenger--rack_base_uri) -* [`rack_env`](#-apache--mod--passenger--rack_env) -* [`rails_allow_mod_rewrite`](#-apache--mod--passenger--rails_allow_mod_rewrite) -* [`rails_app_spawner_idle_time`](#-apache--mod--passenger--rails_app_spawner_idle_time) -* [`rails_auto_detect`](#-apache--mod--passenger--rails_auto_detect) -* [`rails_autodetect`](#-apache--mod--passenger--rails_autodetect) -* [`rails_base_uri`](#-apache--mod--passenger--rails_base_uri) -* [`rails_default_user`](#-apache--mod--passenger--rails_default_user) -* [`rails_env`](#-apache--mod--passenger--rails_env) -* [`rails_framework_spawner_idle_time`](#-apache--mod--passenger--rails_framework_spawner_idle_time) -* [`rails_ruby`](#-apache--mod--passenger--rails_ruby) -* [`rails_spawn_method`](#-apache--mod--passenger--rails_spawn_method) -* [`rails_user_switching`](#-apache--mod--passenger--rails_user_switching) -* [`wsgi_auto_detect`](#-apache--mod--passenger--wsgi_auto_detect) - -##### `manage_repo` +* [`manage_repo`](#manage_repo) +* [`mod_id`](#mod_id) +* [`mod_lib`](#mod_lib) +* [`mod_lib_path`](#mod_lib_path) +* [`mod_package`](#mod_package) +* [`mod_package_ensure`](#mod_package_ensure) +* [`mod_path`](#mod_path) +* [`passenger_allow_encoded_slashes`](#passenger_allow_encoded_slashes) +* [`passenger_anonymous_telemetry_proxy`](#passenger_anonymous_telemetry_proxy) +* [`passenger_app_env`](#passenger_app_env) +* [`passenger_app_group_name`](#passenger_app_group_name) +* [`passenger_app_root`](#passenger_app_root) +* [`passenger_app_type`](#passenger_app_type) +* [`passenger_base_uri`](#passenger_base_uri) +* [`passenger_buffer_response`](#passenger_buffer_response) +* [`passenger_buffer_upload`](#passenger_buffer_upload) +* [`passenger_concurrency_model`](#passenger_concurrency_model) +* [`passenger_conf_file`](#passenger_conf_file) +* [`passenger_conf_package_file`](#passenger_conf_package_file) +* [`passenger_data_buffer_dir`](#passenger_data_buffer_dir) +* [`passenger_debug_log_file`](#passenger_debug_log_file) +* [`passenger_debugger`](#passenger_debugger) +* [`passenger_default_group`](#passenger_default_group) +* [`passenger_default_ruby`](#passenger_default_ruby) +* [`passenger_default_user`](#passenger_default_user) +* [`passenger_disable_anonymous_telemetry`](#passenger_disable_anonymous_telemetry) +* [`passenger_disable_log_prefix`](#passenger_disable_log_prefix) +* [`passenger_disable_security_update_check`](#passenger_disable_security_update_check) +* [`passenger_enabled`](#passenger_enabled) +* [`passenger_error_override`](#passenger_error_override) +* [`passenger_file_descriptor_log_file`](#passenger_file_descriptor_log_file) +* [`passenger_fly_with`](#passenger_fly_with) +* [`passenger_force_max_concurrent_requests_per_process`](#passenger_force_max_concurrent_requests_per_process) +* [`passenger_friendly_error_pages`](#passenger_friendly_error_pages) +* [`passenger_group`](#passenger_group) +* [`passenger_high_performance`](#passenger_high_performance) +* [`passenger_installed_version`](#passenger_installed_version) +* [`passenger_instance_registry_dir`](#passenger_instance_registry_dir) +* [`passenger_load_shell_envvars`](#passenger_load_shell_envvars) +* [`passenger_preload_bundler`](#passenger_preload_bundler) +* [`passenger_log_file`](#passenger_log_file) +* [`passenger_log_level`](#passenger_log_level) +* [`passenger_lve_min_uid`](#passenger_lve_min_uid) +* [`passenger_max_instances`](#passenger_max_instances) +* [`passenger_max_instances_per_app`](#passenger_max_instances_per_app) +* [`passenger_max_pool_size`](#passenger_max_pool_size) +* [`passenger_max_preloader_idle_time`](#passenger_max_preloader_idle_time) +* [`passenger_max_request_queue_size`](#passenger_max_request_queue_size) +* [`passenger_max_request_time`](#passenger_max_request_time) +* [`passenger_max_requests`](#passenger_max_requests) +* [`passenger_memory_limit`](#passenger_memory_limit) +* [`passenger_meteor_app_settings`](#passenger_meteor_app_settings) +* [`passenger_min_instances`](#passenger_min_instances) +* [`passenger_nodejs`](#passenger_nodejs) +* [`passenger_pool_idle_time`](#passenger_pool_idle_time) +* [`passenger_pre_start`](#passenger_pre_start) +* [`passenger_python`](#passenger_python) +* [`passenger_resist_deployment_errors`](#passenger_resist_deployment_errors) +* [`passenger_resolve_symlinks_in_document_root`](#passenger_resolve_symlinks_in_document_root) +* [`passenger_response_buffer_high_watermark`](#passenger_response_buffer_high_watermark) +* [`passenger_restart_dir`](#passenger_restart_dir) +* [`passenger_rolling_restarts`](#passenger_rolling_restarts) +* [`passenger_root`](#passenger_root) +* [`passenger_ruby`](#passenger_ruby) +* [`passenger_security_update_check_proxy`](#passenger_security_update_check_proxy) +* [`passenger_show_version_in_header`](#passenger_show_version_in_header) +* [`passenger_socket_backlog`](#passenger_socket_backlog) +* [`passenger_spawn_dir`](#passenger_spawn_dir) +* [`passenger_spawn_method`](#passenger_spawn_method) +* [`passenger_start_timeout`](#passenger_start_timeout) +* [`passenger_startup_file`](#passenger_startup_file) +* [`passenger_stat_throttle_rate`](#passenger_stat_throttle_rate) +* [`passenger_sticky_sessions`](#passenger_sticky_sessions) +* [`passenger_sticky_sessions_cookie_name`](#passenger_sticky_sessions_cookie_name) +* [`passenger_sticky_sessions_cookie_attributes`](#passenger_sticky_sessions_cookie_attributes) +* [`passenger_thread_count`](#passenger_thread_count) +* [`passenger_use_global_queue`](#passenger_use_global_queue) +* [`passenger_user`](#passenger_user) +* [`passenger_user_switching`](#passenger_user_switching) +* [`rack_auto_detect`](#rack_auto_detect) +* [`rack_autodetect`](#rack_autodetect) +* [`rack_base_uri`](#rack_base_uri) +* [`rack_env`](#rack_env) +* [`rails_allow_mod_rewrite`](#rails_allow_mod_rewrite) +* [`rails_app_spawner_idle_time`](#rails_app_spawner_idle_time) +* [`rails_auto_detect`](#rails_auto_detect) +* [`rails_autodetect`](#rails_autodetect) +* [`rails_base_uri`](#rails_base_uri) +* [`rails_default_user`](#rails_default_user) +* [`rails_env`](#rails_env) +* [`rails_framework_spawner_idle_time`](#rails_framework_spawner_idle_time) +* [`rails_ruby`](#rails_ruby) +* [`rails_spawn_method`](#rails_spawn_method) +* [`rails_user_switching`](#rails_user_switching) +* [`wsgi_auto_detect`](#wsgi_auto_detect) + +##### `manage_repo` Data type: `Boolean` Toggle whether to manage yum repo if on a RedHat node. -Default value: `true` +Default value: ``true`` -##### `mod_id` +##### `mod_id` Data type: `Optional[String]` Specifies the package id. -Default value: `undef` +Default value: ``undef`` -##### `mod_lib` +##### `mod_lib` Data type: `Optional[String]` Defines the module's shared object name. Do not configure manually without special reason. -Default value: `undef` +Default value: ``undef`` -##### `mod_lib_path` +##### `mod_lib_path` Data type: `Optional[String]` Specifies a path to the module's libraries. Do not manually set this parameter without special reason. The `path` parameter overrides this value. -Default value: `undef` +Default value: ``undef`` -##### `mod_package` +##### `mod_package` Data type: `Optional[String]` Name of the module package to install. -Default value: `undef` +Default value: ``undef`` -##### `mod_package_ensure` +##### `mod_package_ensure` Data type: `Optional[String]` Determines whether Puppet ensures the module should be installed. -Default value: `undef` +Default value: ``undef`` -##### `mod_path` +##### `mod_path` Data type: `Optional[String]` Specifies a path to the module. Do not manually set this parameter without a special reason. -Default value: `undef` +Default value: ``undef`` -##### `passenger_allow_encoded_slashes` +##### `passenger_allow_encoded_slashes` -Data type: `Optional[Enum['on', 'off', 'On', 'Off']]` +Data type: `Optional[Apache::OnOff]` Toggle whether URLs with encoded slashes (%2f) can be used (by default Apache does not support this). -Default value: `undef` +Default value: ``undef`` -##### `passenger_anonymous_telemetry_proxy` +##### `passenger_anonymous_telemetry_proxy` Data type: `Optional[String]` Set an intermediate proxy for the Passenger anonymous telemetry reporting. -Default value: `undef` +Default value: ``undef`` -##### `passenger_app_env` +##### `passenger_app_env` Data type: `Optional[String]` @@ -4613,66 +4611,66 @@ This option sets, for the current application, the value of the following enviro - NODE_ENV - PASSENGER_APP_ENV -Default value: `undef` +Default value: ``undef`` -##### `passenger_app_group_name` +##### `passenger_app_group_name` Data type: `Optional[String]` Sets the name of the application group that the current application should belong to. -Default value: `undef` +Default value: ``undef`` -##### `passenger_app_root` +##### `passenger_app_root` Data type: `Optional[String]` Path to the application root which allows access independent from the DocumentRoot. -Default value: `undef` +Default value: ``undef`` -##### `passenger_app_type` +##### `passenger_app_type` Data type: `Optional[String]` Specifies the type of the application. If you set this option, then you must also set PassengerAppRoot, otherwise Passenger will not properly recognize your application. -Default value: `undef` +Default value: ``undef`` -##### `passenger_base_uri` +##### `passenger_base_uri` Data type: `Optional[String]` Used to specify that the given URI is an distinct application that should be served by Passenger. -Default value: `undef` +Default value: ``undef`` -##### `passenger_buffer_response` +##### `passenger_buffer_response` -Data type: `Optional[Enum['on', 'off', 'On', 'Off']]` +Data type: `Optional[Apache::OnOff]` Toggle whether application-generated responses are buffered by Apache. Buffering will happen in memory. -Default value: `undef` +Default value: ``undef`` -##### `passenger_buffer_upload` +##### `passenger_buffer_upload` -Data type: `Optional[Enum['on', 'off', 'On', 'Off']]` +Data type: `Optional[Apache::OnOff]` Toggle whether HTTP client request bodies are buffered before they are sent to the application. -Default value: `undef` +Default value: ``undef`` -##### `passenger_concurrency_model` +##### `passenger_concurrency_model` Data type: `Optional[String]` Specifies the I/O concurrency model that should be used for Ruby application processes. -Default value: `undef` +Default value: ``undef`` -##### `passenger_conf_file` +##### `passenger_conf_file` Data type: `String` @@ -4680,7 +4678,7 @@ Data type: `String` Default value: `$apache::params::passenger_conf_file` -##### `passenger_conf_package_file` +##### `passenger_conf_package_file` Data type: `Optional[String]` @@ -4688,39 +4686,39 @@ Data type: `Optional[String]` Default value: `$apache::params::passenger_conf_package_file` -##### `passenger_data_buffer_dir` +##### `passenger_data_buffer_dir` Data type: `Optional[Stdlib::Absolutepath]` Specifies the directory in which to store data buffers. -Default value: `undef` +Default value: ``undef`` -##### `passenger_debug_log_file` +##### `passenger_debug_log_file` Data type: `Optional[String]` -Default value: `undef` +Default value: ``undef`` -##### `passenger_debugger` +##### `passenger_debugger` -Data type: `Optional[Enum['on', 'off', 'On', 'Off']]` +Data type: `Optional[Apache::OnOff]` Turns support for Ruby application debugging on or off. -Default value: `undef` +Default value: ``undef`` -##### `passenger_default_group` +##### `passenger_default_group` Data type: `Optional[String]` Allows you to specify the group that applications must run as, if user switching fails or is disabled. -Default value: `undef` +Default value: ``undef`` -##### `passenger_default_ruby` +##### `passenger_default_ruby` Data type: `Optional[String]` @@ -4728,318 +4726,318 @@ File path to desired ruby interpreter to use by default. Default value: `$apache::params::passenger_default_ruby` -##### `passenger_default_user` +##### `passenger_default_user` Data type: `Optional[String]` Allows you to specify the user that applications must run as, if user switching fails or is disabled. -Default value: `undef` +Default value: ``undef`` -##### `passenger_disable_anonymous_telemetry` +##### `passenger_disable_anonymous_telemetry` Data type: `Optional[Boolean]` Whether or not to disable the Passenger anonymous telemetry reporting. -Default value: `undef` +Default value: ``undef`` -##### `passenger_disable_log_prefix` +##### `passenger_disable_log_prefix` Data type: `Optional[Boolean]` Whether to stop Passenger from prefixing logs when they are written to a log file. -Default value: `undef` +Default value: ``undef`` -##### `passenger_disable_security_update_check` +##### `passenger_disable_security_update_check` -Data type: `Optional[Enum['on', 'off', 'On', 'Off']]` +Data type: `Optional[Apache::OnOff]` Allows disabling the Passenger security update check, a daily check with https://securitycheck.phusionpassenger.com for important security updates that might be available. -Default value: `undef` +Default value: ``undef`` -##### `passenger_enabled` +##### `passenger_enabled` -Data type: `Optional[Enum['on', 'off', 'On', 'Off']]` +Data type: `Optional[Apache::OnOff]` Toggles whether Passenger should be enabled for that particular context. -Default value: `undef` +Default value: ``undef`` -##### `passenger_error_override` +##### `passenger_error_override` -Data type: `Optional[Enum['on', 'off', 'On', 'Off']]` +Data type: `Optional[Apache::OnOff]` Toggles whether Apache will intercept and handle responses with HTTP status codes of 400 and higher. -Default value: `undef` +Default value: ``undef`` -##### `passenger_file_descriptor_log_file` +##### `passenger_file_descriptor_log_file` Data type: `Optional[String]` Log file descriptor debug tracing messages to the given file. -Default value: `undef` +Default value: ``undef`` -##### `passenger_fly_with` +##### `passenger_fly_with` Data type: `Optional[String]` Enables the Flying Passenger mode, and configures Apache to connect to the Flying Passenger daemon that's listening on the given socket filename. -Default value: `undef` +Default value: ``undef`` -##### `passenger_force_max_concurrent_requests_per_process` +##### `passenger_force_max_concurrent_requests_per_process` Data type: `Optional[Variant[Integer, String]]` Use this option to tell Passenger how many concurrent requests the application can handle per process. -Default value: `undef` +Default value: ``undef`` -##### `passenger_friendly_error_pages` +##### `passenger_friendly_error_pages` -Data type: `Optional[Enum['on', 'off', 'On', 'Off']]` +Data type: `Optional[Apache::OnOff]` Toggles whether Passenger should display friendly error pages whenever an application fails to start. -Default value: `undef` +Default value: ``undef`` -##### `passenger_group` +##### `passenger_group` Data type: `Optional[String]` Allows you to override that behavior and explicitly set a group to run the web application as, regardless of the ownership of the startup file. -Default value: `undef` +Default value: ``undef`` -##### `passenger_high_performance` +##### `passenger_high_performance` -Data type: `Optional[Enum['on', 'off', 'On', 'Off']]` +Data type: `Optional[Apache::OnOff]` Toggles whether to enable PassengerHighPerformance which will make Passenger will be a little faster, in return for reduced compatibility with other Apache modules. -Default value: `undef` +Default value: ``undef`` -##### `passenger_installed_version` +##### `passenger_installed_version` Data type: `Optional[String]` -Default value: `undef` +Default value: ``undef`` -##### `passenger_instance_registry_dir` +##### `passenger_instance_registry_dir` Data type: `Optional[String]` Specifies the directory that Passenger should use for registering its current instance. -Default value: `undef` +Default value: ``undef`` -##### `passenger_load_shell_envvars` +##### `passenger_load_shell_envvars` -Data type: `Optional[Enum['on', 'off', 'On', 'Off']]` +Data type: `Optional[Apache::OnOff]` Enables or disables the loading of shell environment variables before spawning the application. -Default value: `undef` +Default value: ``undef`` -##### `passenger_preload_bundler` +##### `passenger_preload_bundler` Data type: `Optional[Boolean]` Enables or disables loading bundler before loading your Ruby app. -Default value: `undef` +Default value: ``undef`` -##### `passenger_log_file` +##### `passenger_log_file` Data type: `Optional[Stdlib::Absolutepath]` File path to log file. By default Passenger log messages are written to the Apache global error log. -Default value: `undef` +Default value: ``undef`` -##### `passenger_log_level` +##### `passenger_log_level` Data type: `Optional[Integer]` Specifies how much information Passenger should log to its log file. A higher log level value means that more information will be logged. -Default value: `undef` +Default value: ``undef`` -##### `passenger_lve_min_uid` +##### `passenger_lve_min_uid` Data type: `Optional[Integer]` When using Passenger on a LVE-enabled kernel, a security check (enter) is run for spawning application processes. This options tells the check to only allow processes with UIDs equal to, or higher than, the specified value. -Default value: `undef` +Default value: ``undef`` -##### `passenger_max_instances` +##### `passenger_max_instances` Data type: `Optional[Integer]` The maximum number of application processes that may simultaneously exist for an application. -Default value: `undef` +Default value: ``undef`` -##### `passenger_max_instances_per_app` +##### `passenger_max_instances_per_app` Data type: `Optional[Integer]` The maximum number of application processes that may simultaneously exist for a single application. -Default value: `undef` +Default value: ``undef`` -##### `passenger_max_pool_size` +##### `passenger_max_pool_size` Data type: `Optional[Integer]` The maximum number of application processes that may simultaneously exist. -Default value: `undef` +Default value: ``undef`` -##### `passenger_max_preloader_idle_time` +##### `passenger_max_preloader_idle_time` Data type: `Optional[Integer]` Set the preloader's idle timeout, in seconds. A value of 0 means that it should never idle timeout. -Default value: `undef` +Default value: ``undef`` -##### `passenger_max_request_queue_size` +##### `passenger_max_request_queue_size` Data type: `Optional[Integer]` Specifies the maximum size for the queue of all incoming requests. -Default value: `undef` +Default value: ``undef`` -##### `passenger_max_request_time` +##### `passenger_max_request_time` Data type: `Optional[Integer]` The maximum amount of time, in seconds, that an application process may take to process a request. -Default value: `undef` +Default value: ``undef`` -##### `passenger_max_requests` +##### `passenger_max_requests` Data type: `Optional[Integer]` The maximum number of requests an application process will process. -Default value: `undef` +Default value: ``undef`` -##### `passenger_memory_limit` +##### `passenger_memory_limit` Data type: `Optional[Integer]` The maximum amount of memory that an application process may use, in megabytes. -Default value: `undef` +Default value: ``undef`` -##### `passenger_meteor_app_settings` +##### `passenger_meteor_app_settings` Data type: `Optional[String]` When using a Meteor application in non-bundled mode, use this option to specify a JSON file with settings for the application. -Default value: `undef` +Default value: ``undef`` -##### `passenger_min_instances` +##### `passenger_min_instances` Data type: `Optional[Integer]` Specifies the minimum number of application processes that should exist for a given application. -Default value: `undef` +Default value: ``undef`` -##### `passenger_nodejs` +##### `passenger_nodejs` Data type: `Optional[String]` Specifies the Node.js command to use for serving Node.js web applications. -Default value: `undef` +Default value: ``undef`` -##### `passenger_pool_idle_time` +##### `passenger_pool_idle_time` Data type: `Optional[Integer]` The maximum number of seconds that an application process may be idle. -Default value: `undef` +Default value: ``undef`` -##### `passenger_pre_start` +##### `passenger_pre_start` Data type: `Optional[Variant[String, Array[String]]]` URL of the web application you want to pre-start. -Default value: `undef` +Default value: ``undef`` -##### `passenger_python` +##### `passenger_python` Data type: `Optional[String]` Specifies the Python interpreter to use for serving Python web applications. -Default value: `undef` +Default value: ``undef`` -##### `passenger_resist_deployment_errors` +##### `passenger_resist_deployment_errors` -Data type: `Optional[Enum['on', 'off', 'On', 'Off']]` +Data type: `Optional[Apache::OnOff]` Enables or disables resistance against deployment errors. -Default value: `undef` +Default value: ``undef`` -##### `passenger_resolve_symlinks_in_document_root` +##### `passenger_resolve_symlinks_in_document_root` -Data type: `Optional[Enum['on', 'off', 'On', 'Off']]` +Data type: `Optional[Apache::OnOff]` This option is no longer available in version 5.2.0. Switch to PassengerAppRoot if you are setting the application root via a document root containing symlinks. -Default value: `undef` +Default value: ``undef`` -##### `passenger_response_buffer_high_watermark` +##### `passenger_response_buffer_high_watermark` Data type: `Optional[Variant[Integer, String]]` Configures the maximum size of the real-time disk-backed response buffering system. -Default value: `undef` +Default value: ``undef`` -##### `passenger_restart_dir` +##### `passenger_restart_dir` Data type: `Optional[String]` Path to directory containing restart.txt file. Can be either absolute or relative. -Default value: `undef` +Default value: ``undef`` -##### `passenger_rolling_restarts` +##### `passenger_rolling_restarts` -Data type: `Optional[Enum['on', 'off', 'On', 'Off']]` +Data type: `Optional[Apache::OnOff]` Enables or disables support for zero-downtime application restarts through restart.txt. -Default value: `undef` +Default value: ``undef`` -##### `passenger_root` +##### `passenger_root` Data type: `Optional[String]` @@ -5047,7 +5045,7 @@ Refers to the location to the Passenger root directory, or to a location configu Default value: `$apache::params::passenger_root` -##### `passenger_ruby` +##### `passenger_ruby` Data type: `Optional[String]` @@ -5055,257 +5053,257 @@ Specifies the Ruby interpreter to use for serving Ruby web applications. Default value: `$apache::params::passenger_ruby` -##### `passenger_security_update_check_proxy` +##### `passenger_security_update_check_proxy` Data type: `Optional[String]` Allows use of an intermediate proxy for the Passenger security update check. -Default value: `undef` +Default value: ``undef`` -##### `passenger_show_version_in_header` +##### `passenger_show_version_in_header` -Data type: `Optional[Enum['on', 'off', 'On', 'Off']]` +Data type: `Optional[Apache::OnOff]` Toggle whether Passenger will output its version number in the X-Powered-By header in all Passenger-served requests: -Default value: `undef` +Default value: ``undef`` -##### `passenger_socket_backlog` +##### `passenger_socket_backlog` Data type: `Optional[Variant[Integer, String]]` This option can be raised if Apache manages to overflow the backlog queue. -Default value: `undef` +Default value: ``undef`` -##### `passenger_spawn_dir` +##### `passenger_spawn_dir` Data type: `Optional[String]` The directory in which Passenger will record progress during startup -Default value: `undef` +Default value: ``undef`` -##### `passenger_spawn_method` +##### `passenger_spawn_method` Data type: `Optional[Enum['smart', 'direct', 'smart-lv2', 'conservative']]` Controls whether Passenger spawns applications directly, or using a prefork copy-on-write mechanism. -Default value: `undef` +Default value: ``undef`` -##### `passenger_start_timeout` +##### `passenger_start_timeout` Data type: `Optional[Integer]` Specifies a timeout for the startup of application processes. -Default value: `undef` +Default value: ``undef`` -##### `passenger_startup_file` +##### `passenger_startup_file` Data type: `Optional[String]` Specifies the startup file that Passenger should use when loading the application. -Default value: `undef` +Default value: ``undef`` -##### `passenger_stat_throttle_rate` +##### `passenger_stat_throttle_rate` Data type: `Optional[Integer]` Setting this option to a value of x means that certain filesystem checks will be performed at most once every x seconds. -Default value: `undef` +Default value: ``undef`` -##### `passenger_sticky_sessions` +##### `passenger_sticky_sessions` -Data type: `Optional[Enum['on', 'off', 'On', 'Off']]` +Data type: `Optional[Apache::OnOff]` Toggles whether all requests that a client sends will be routed to the same originating application process, whenever possible. -Default value: `undef` +Default value: ``undef`` -##### `passenger_sticky_sessions_cookie_name` +##### `passenger_sticky_sessions_cookie_name` Data type: `Optional[String]` Sets the name of the sticky sessions cookie. -Default value: `undef` +Default value: ``undef`` -##### `passenger_sticky_sessions_cookie_attributes` +##### `passenger_sticky_sessions_cookie_attributes` Data type: `Optional[String]` Sets the attributes of the sticky sessions cookie. -Default value: `undef` +Default value: ``undef`` -##### `passenger_thread_count` +##### `passenger_thread_count` Data type: `Optional[Integer]` Specifies the number of threads that Passenger should spawn per Ruby application process. -Default value: `undef` +Default value: ``undef`` -##### `passenger_use_global_queue` +##### `passenger_use_global_queue` Data type: `Optional[String]` N/A. -Default value: `undef` +Default value: ``undef`` -##### `passenger_user` +##### `passenger_user` Data type: `Optional[String]` Allows you to override that behavior and explicitly set a user to run the web application as, regardless of the ownership of the startup file. -Default value: `undef` +Default value: ``undef`` -##### `passenger_user_switching` +##### `passenger_user_switching` -Data type: `Optional[Enum['on', 'off', 'On', 'Off']]` +Data type: `Optional[Apache::OnOff]` Toggles whether to attempt to enable user account sandboxing, also known as user switching. -Default value: `undef` +Default value: ``undef`` -##### `rack_auto_detect` +##### `rack_auto_detect` Data type: `Optional[String]` This option has been removed in version 4.0.0 as part of an optimization. You should use PassengerEnabled instead. -Default value: `undef` +Default value: ``undef`` -##### `rack_autodetect` +##### `rack_autodetect` Data type: `Optional[String]` This option has been removed in version 4.0.0 as part of an optimization. You should use PassengerEnabled instead. -Default value: `undef` +Default value: ``undef`` -##### `rack_base_uri` +##### `rack_base_uri` Data type: `Optional[String]` Deprecated in 3.0.0 in favor of PassengerBaseURI. -Default value: `undef` +Default value: ``undef`` -##### `rack_env` +##### `rack_env` Data type: `Optional[String]` Alias for PassengerAppEnv. -Default value: `undef` +Default value: ``undef`` -##### `rails_allow_mod_rewrite` +##### `rails_allow_mod_rewrite` Data type: `Optional[String]` This option doesn't do anything anymore since version 4.0.0. -Default value: `undef` +Default value: ``undef`` -##### `rails_app_spawner_idle_time` +##### `rails_app_spawner_idle_time` Data type: `Optional[String]` This option has been removed in version 4.0.0, and replaced with PassengerMaxPreloaderIdleTime. -Default value: `undef` +Default value: ``undef`` -##### `rails_auto_detect` +##### `rails_auto_detect` Data type: `Optional[String]` This option has been removed in version 4.0.0 as part of an optimization. You should use PassengerEnabled instead. -Default value: `undef` +Default value: ``undef`` -##### `rails_autodetect` +##### `rails_autodetect` Data type: `Optional[String]` This option has been removed in version 4.0.0 as part of an optimization. You should use PassengerEnabled instead. -Default value: `undef` +Default value: ``undef`` -##### `rails_base_uri` +##### `rails_base_uri` Data type: `Optional[String]` Deprecated in 3.0.0 in favor of PassengerBaseURI. -Default value: `undef` +Default value: ``undef`` -##### `rails_default_user` +##### `rails_default_user` Data type: `Optional[String]` Deprecated in 3.0.0 in favor of PassengerDefaultUser -Default value: `undef` +Default value: ``undef`` -##### `rails_env` +##### `rails_env` Data type: `Optional[String]` Alias for PassengerAppEnv. -Default value: `undef` +Default value: ``undef`` -##### `rails_framework_spawner_idle_time` +##### `rails_framework_spawner_idle_time` Data type: `Optional[String]` This option is no longer available in version 4.0.0. There is no alternative because framework spawning has been removed altogether. You should use smart spawning instead. -Default value: `undef` +Default value: ``undef`` -##### `rails_ruby` +##### `rails_ruby` Data type: `Optional[String]` Deprecated in 3.0.0 in favor of PassengerRuby. -Default value: `undef` +Default value: ``undef`` -##### `rails_spawn_method` +##### `rails_spawn_method` Data type: `Optional[String]` Deprecated in 3.0.0 in favor of PassengerSpawnMethod. -Default value: `undef` +Default value: ``undef`` -##### `rails_user_switching` +##### `rails_user_switching` Data type: `Optional[String]` Deprecated in 3.0.0 in favor of PassengerUserSwitching. -Default value: `undef` +Default value: ``undef`` -##### `wsgi_auto_detect` +##### `wsgi_auto_detect` Data type: `Optional[String]` This option has been removed in version 4.0.0 as part of an optimization. You should use PassengerEnabled instead. -Default value: `undef` +Default value: ``undef`` -### `apache::mod::perl` +### `apache::mod::perl` Installs `mod_perl`. @@ -5313,7 +5311,7 @@ Installs `mod_perl`. * https://perl.apache.org * for additional documentation. -### `apache::mod::peruser` +### `apache::mod::peruser` Installs `mod_peruser`. @@ -5321,16 +5319,16 @@ Installs `mod_peruser`. The following parameters are available in the `apache::mod::peruser` class: -* [`minspareprocessors`](#-apache--mod--peruser--minspareprocessors) -* [`minprocessors`](#-apache--mod--peruser--minprocessors) -* [`maxprocessors`](#-apache--mod--peruser--maxprocessors) -* [`maxclients`](#-apache--mod--peruser--maxclients) -* [`maxrequestsperchild`](#-apache--mod--peruser--maxrequestsperchild) -* [`idletimeout`](#-apache--mod--peruser--idletimeout) -* [`expiretimeout`](#-apache--mod--peruser--expiretimeout) -* [`keepalive`](#-apache--mod--peruser--keepalive) +* [`minspareprocessors`](#minspareprocessors) +* [`minprocessors`](#minprocessors) +* [`maxprocessors`](#maxprocessors) +* [`maxclients`](#maxclients) +* [`maxrequestsperchild`](#maxrequestsperchild) +* [`idletimeout`](#idletimeout) +* [`expiretimeout`](#expiretimeout) +* [`keepalive`](#keepalive) -##### `minspareprocessors` +##### `minspareprocessors` Data type: `Integer` @@ -5338,7 +5336,7 @@ Data type: `Integer` Default value: `2` -##### `minprocessors` +##### `minprocessors` Data type: `Integer` @@ -5346,7 +5344,7 @@ The minimum amount of processors Default value: `2` -##### `maxprocessors` +##### `maxprocessors` Data type: `Integer` @@ -5354,7 +5352,7 @@ The maximum amount of processors Default value: `10` -##### `maxclients` +##### `maxclients` Data type: `Integer` @@ -5362,7 +5360,7 @@ The maximum amount of clients Default value: `150` -##### `maxrequestsperchild` +##### `maxrequestsperchild` Data type: `Integer` @@ -5370,7 +5368,7 @@ The maximum amount of requests per child Default value: `1000` -##### `idletimeout` +##### `idletimeout` Data type: `Integer` @@ -5378,7 +5376,7 @@ Data type: `Integer` Default value: `120` -##### `expiretimeout` +##### `expiretimeout` Data type: `Integer` @@ -5386,15 +5384,15 @@ Data type: `Integer` Default value: `120` -##### `keepalive` +##### `keepalive` -Data type: `Enum['On', 'Off']` +Data type: `Apache::OnOff` Default value: `'Off'` -### `apache::mod::php` +### `apache::mod::php` Installs `mod_php`. @@ -5404,26 +5402,26 @@ Installs `mod_php`. The following parameters are available in the `apache::mod::php` class: -* [`package_name`](#-apache--mod--php--package_name) -* [`package_ensure`](#-apache--mod--php--package_ensure) -* [`path`](#-apache--mod--php--path) -* [`extensions`](#-apache--mod--php--extensions) -* [`content`](#-apache--mod--php--content) -* [`template`](#-apache--mod--php--template) -* [`source`](#-apache--mod--php--source) -* [`root_group`](#-apache--mod--php--root_group) -* [`php_version`](#-apache--mod--php--php_version) -* [`libphp_prefix`](#-apache--mod--php--libphp_prefix) +* [`package_name`](#package_name) +* [`package_ensure`](#package_ensure) +* [`path`](#path) +* [`extensions`](#extensions) +* [`content`](#content) +* [`template`](#template) +* [`source`](#source) +* [`root_group`](#root_group) +* [`php_version`](#php_version) +* [`libphp_prefix`](#libphp_prefix) -##### `package_name` +##### `package_name` Data type: `Optional[String]` The package name -Default value: `undef` +Default value: ``undef`` -##### `package_ensure` +##### `package_ensure` Data type: `String` @@ -5431,15 +5429,15 @@ Whether the package is `present` or `absent` Default value: `'present'` -##### `path` +##### `path` Data type: `Optional[String]` -Default value: `undef` +Default value: ``undef`` -##### `extensions` +##### `extensions` Data type: `Array` @@ -5447,15 +5445,15 @@ Data type: `Array` Default value: `['.php']` -##### `content` +##### `content` Data type: `Optional[String]` -Default value: `undef` +Default value: ``undef`` -##### `template` +##### `template` Data type: `String` @@ -5463,15 +5461,15 @@ Data type: `String` Default value: `'apache/mod/php.conf.erb'` -##### `source` +##### `source` Data type: `Optional[String]` -Default value: `undef` +Default value: ``undef`` -##### `root_group` +##### `root_group` Data type: `Optional[String]` @@ -5479,7 +5477,7 @@ UNIX group of the root user Default value: `$apache::params::root_group` -##### `php_version` +##### `php_version` Data type: `Optional[String]` @@ -5487,7 +5485,7 @@ The php version. This is a required parameter, but optional allows showing a cle Default value: `$apache::params::php_version` -##### `libphp_prefix` +##### `libphp_prefix` Data type: `String` @@ -5495,7 +5493,7 @@ Data type: `String` Default value: `'libphp'` -### `apache::mod::prefork` +### `apache::mod::prefork` Installs and configures MPM `prefork`. @@ -5507,17 +5505,17 @@ Installs and configures MPM `prefork`. The following parameters are available in the `apache::mod::prefork` class: -* [`startservers`](#-apache--mod--prefork--startservers) -* [`minspareservers`](#-apache--mod--prefork--minspareservers) -* [`maxspareservers`](#-apache--mod--prefork--maxspareservers) -* [`serverlimit`](#-apache--mod--prefork--serverlimit) -* [`maxclients`](#-apache--mod--prefork--maxclients) -* [`maxrequestworkers`](#-apache--mod--prefork--maxrequestworkers) -* [`maxrequestsperchild`](#-apache--mod--prefork--maxrequestsperchild) -* [`maxconnectionsperchild`](#-apache--mod--prefork--maxconnectionsperchild) -* [`listenbacklog`](#-apache--mod--prefork--listenbacklog) +* [`startservers`](#startservers) +* [`minspareservers`](#minspareservers) +* [`maxspareservers`](#maxspareservers) +* [`serverlimit`](#serverlimit) +* [`maxclients`](#maxclients) +* [`maxrequestworkers`](#maxrequestworkers) +* [`maxrequestsperchild`](#maxrequestsperchild) +* [`maxconnectionsperchild`](#maxconnectionsperchild) +* [`listenbacklog`](#listenbacklog) -##### `startservers` +##### `startservers` Data type: `Integer` @@ -5525,7 +5523,7 @@ Number of child server processes created at startup. Default value: `8` -##### `minspareservers` +##### `minspareservers` Data type: `Integer` @@ -5533,7 +5531,7 @@ Minimum number of idle child server processes. Default value: `5` -##### `maxspareservers` +##### `maxspareservers` Data type: `Integer` @@ -5541,7 +5539,7 @@ Maximum number of idle child server processes. Default value: `20` -##### `serverlimit` +##### `serverlimit` Data type: `Integer` @@ -5549,7 +5547,7 @@ Upper limit on configurable number of processes. Default value: `256` -##### `maxclients` +##### `maxclients` Data type: `Integer` @@ -5557,15 +5555,15 @@ Old alias for MaxRequestWorkers. Default value: `256` -##### `maxrequestworkers` +##### `maxrequestworkers` Data type: `Optional[Integer]` Maximum number of connections that will be processed simultaneously. -Default value: `undef` +Default value: ``undef`` -##### `maxrequestsperchild` +##### `maxrequestsperchild` Data type: `Integer` @@ -5573,15 +5571,15 @@ Old alias for MaxConnectionsPerChild. Default value: `4000` -##### `maxconnectionsperchild` +##### `maxconnectionsperchild` Data type: `Optional[Integer]` Limit on the number of connections that an individual child server will handle during its life. -Default value: `undef` +Default value: ``undef`` -##### `listenbacklog` +##### `listenbacklog` Data type: `Integer` @@ -5589,7 +5587,7 @@ Maximum length of the queue of pending connections. Default value: `511` -### `apache::mod::proxy` +### `apache::mod::proxy` Installs and configures `mod_proxy`. @@ -5601,14 +5599,14 @@ Installs and configures `mod_proxy`. The following parameters are available in the `apache::mod::proxy` class: -* [`proxy_requests`](#-apache--mod--proxy--proxy_requests) -* [`allow_from`](#-apache--mod--proxy--allow_from) -* [`package_name`](#-apache--mod--proxy--package_name) -* [`proxy_via`](#-apache--mod--proxy--proxy_via) -* [`proxy_timeout`](#-apache--mod--proxy--proxy_timeout) -* [`proxy_iobuffersize`](#-apache--mod--proxy--proxy_iobuffersize) +* [`proxy_requests`](#proxy_requests) +* [`allow_from`](#allow_from) +* [`package_name`](#package_name) +* [`proxy_via`](#proxy_via) +* [`proxy_timeout`](#proxy_timeout) +* [`proxy_iobuffersize`](#proxy_iobuffersize) -##### `proxy_requests` +##### `proxy_requests` Data type: `String` @@ -5616,23 +5614,23 @@ Enables forward (standard) proxy requests. Default value: `'Off'` -##### `allow_from` +##### `allow_from` Data type: `Optional[Variant[Stdlib::IP::Address, Array[Stdlib::IP::Address]]]` IP address or list of IPs allowed to access proxy. -Default value: `undef` +Default value: ``undef`` -##### `package_name` +##### `package_name` Data type: `Optional[String]` Name of the proxy package to install. -Default value: `undef` +Default value: ``undef`` -##### `proxy_via` +##### `proxy_via` Data type: `String` @@ -5640,23 +5638,23 @@ Set local IP address for outgoing proxy connections. Default value: `'On'` -##### `proxy_timeout` +##### `proxy_timeout` Data type: `Optional[Integer[0]]` Network timeout for proxied requests. -Default value: `undef` +Default value: ``undef`` -##### `proxy_iobuffersize` +##### `proxy_iobuffersize` Data type: `Optional[String]` Set the size of internal data throughput buffer -Default value: `undef` +Default value: ``undef`` -### `apache::mod::proxy_ajp` +### `apache::mod::proxy_ajp` Installs `mod_proxy_ajp`. @@ -5664,7 +5662,7 @@ Installs `mod_proxy_ajp`. * https://httpd.apache.org/docs/current/mod/mod_proxy_ajp.html * for additional documentation. -### `apache::mod::proxy_balancer` +### `apache::mod::proxy_balancer` Installs and configures `mod_proxy_balancer`. @@ -5676,19 +5674,19 @@ Installs and configures `mod_proxy_balancer`. The following parameters are available in the `apache::mod::proxy_balancer` class: -* [`manager`](#-apache--mod--proxy_balancer--manager) -* [`manager_path`](#-apache--mod--proxy_balancer--manager_path) -* [`allow_from`](#-apache--mod--proxy_balancer--allow_from) +* [`manager`](#manager) +* [`manager_path`](#manager_path) +* [`allow_from`](#allow_from) -##### `manager` +##### `manager` Data type: `Boolean` Toggle whether to enable balancer manager support. -Default value: `false` +Default value: ``false`` -##### `manager_path` +##### `manager_path` Data type: `Stdlib::Unixpath` @@ -5696,7 +5694,7 @@ Server relative path to balancer manager. Default value: `'/balancer-manager'` -##### `allow_from` +##### `allow_from` Data type: `Array[Stdlib::IP::Address]` @@ -5704,7 +5702,7 @@ List of IPs from which the balancer manager can be accessed. Default value: `['127.0.0.1', '::1']` -### `apache::mod::proxy_connect` +### `apache::mod::proxy_connect` Installs `mod_proxy_connect`. @@ -5712,7 +5710,7 @@ Installs `mod_proxy_connect`. * https://httpd.apache.org/docs/current/mod/mod_proxy_connect.html * for additional documentation. -### `apache::mod::proxy_fcgi` +### `apache::mod::proxy_fcgi` Installs `mod_proxy_fcgi`. @@ -5720,7 +5718,7 @@ Installs `mod_proxy_fcgi`. * https://httpd.apache.org/docs/current/mod/mod_proxy_fcgi.html * for additional documentation. -### `apache::mod::proxy_html` +### `apache::mod::proxy_html` Installs `mod_proxy_html`. @@ -5728,7 +5726,7 @@ Installs `mod_proxy_html`. * https://httpd.apache.org/docs/current/mod/mod_proxy_html.html * for additional documentation. -### `apache::mod::proxy_http` +### `apache::mod::proxy_http` Installs `mod_proxy_http`. @@ -5736,7 +5734,15 @@ Installs `mod_proxy_http`. * https://httpd.apache.org/docs/current/mod/mod_proxy_http.html * for additional documentation. -### `apache::mod::proxy_wstunnel` +### `apache::mod::proxy_http2` + +Installs `mod_proxy_http2`. + +* **See also** + * https://httpd.apache.org/docs/current/mod/mod_proxy_http2.html + * for additional documentation. + +### `apache::mod::proxy_wstunnel` Installs `mod_proxy_wstunnel`. @@ -5744,7 +5750,7 @@ Installs `mod_proxy_wstunnel`. * https://httpd.apache.org/docs/current/mod/mod_proxy_wstunnel.html * for additional documentation. -### `apache::mod::python` +### `apache::mod::python` Installs and configures `mod_python`. @@ -5756,17 +5762,17 @@ Installs and configures `mod_python`. The following parameters are available in the `apache::mod::python` class: -* [`loadfile_name`](#-apache--mod--python--loadfile_name) +* [`loadfile_name`](#loadfile_name) -##### `loadfile_name` +##### `loadfile_name` Data type: `Optional[String]` Sets the name of the configuration file that is used to load the python module. -Default value: `undef` +Default value: ``undef`` -### `apache::mod::remoteip` +### `apache::mod::remoteip` Installs and configures `mod_remoteip`. @@ -5779,18 +5785,18 @@ Installs and configures `mod_remoteip`. The following parameters are available in the `apache::mod::remoteip` class: -* [`header`](#-apache--mod--remoteip--header) -* [`internal_proxy`](#-apache--mod--remoteip--internal_proxy) -* [`proxy_ips`](#-apache--mod--remoteip--proxy_ips) -* [`internal_proxy_list`](#-apache--mod--remoteip--internal_proxy_list) -* [`proxies_header`](#-apache--mod--remoteip--proxies_header) -* [`proxy_protocol`](#-apache--mod--remoteip--proxy_protocol) -* [`proxy_protocol_exceptions`](#-apache--mod--remoteip--proxy_protocol_exceptions) -* [`trusted_proxy`](#-apache--mod--remoteip--trusted_proxy) -* [`trusted_proxy_ips`](#-apache--mod--remoteip--trusted_proxy_ips) -* [`trusted_proxy_list`](#-apache--mod--remoteip--trusted_proxy_list) +* [`header`](#header) +* [`internal_proxy`](#internal_proxy) +* [`proxy_ips`](#proxy_ips) +* [`internal_proxy_list`](#internal_proxy_list) +* [`proxies_header`](#proxies_header) +* [`proxy_protocol`](#proxy_protocol) +* [`proxy_protocol_exceptions`](#proxy_protocol_exceptions) +* [`trusted_proxy`](#trusted_proxy) +* [`trusted_proxy_ips`](#trusted_proxy_ips) +* [`trusted_proxy_list`](#trusted_proxy_list) -##### `header` +##### `header` Data type: `String` @@ -5798,26 +5804,26 @@ The header field in which `mod_remoteip` will look for the useragent IP. Default value: `'X-Forwarded-For'` -##### `internal_proxy` +##### `internal_proxy` -Data type: `Optional[Array[Variant[Stdlib::Host,Stdlib::IP::Address]]]` +Data type: `Optional[Array[Stdlib::Host]]` A list of IP addresses, IP blocks or hostname that are trusted to set a valid value inside specified header. Unlike the `$trusted_proxy_ips` parameter, any IP address (including private addresses) presented by these proxies will trusted by `mod_remoteip`. -Default value: `undef` +Default value: ``undef`` -##### `proxy_ips` +##### `proxy_ips` -Data type: `Optional[Array[Variant[Stdlib::Host,Stdlib::IP::Address]]]` +Data type: `Optional[Array[Stdlib::Host]]` *Deprecated*: use `$internal_proxy` instead. -Default value: `undef` +Default value: ``undef`` -##### `internal_proxy_list` +##### `internal_proxy_list` Data type: `Optional[Stdlib::Absolutepath]` @@ -5825,9 +5831,9 @@ The path to a file containing a list of IP addresses, IP blocks or hostname that are trusted to set a valid value inside the specified header. See `$internal_proxy` for details. -Default value: `undef` +Default value: ``undef`` -##### `proxies_header` +##### `proxies_header` Data type: `Optional[String]` @@ -5835,27 +5841,27 @@ A header into which `mod_remoteip` will collect a list of all of the intermediate client IP addresses trusted to resolve the useragent IP of the request (e.g. `X-Forwarded-By`). -Default value: `undef` +Default value: ``undef`` -##### `proxy_protocol` +##### `proxy_protocol` Data type: `Boolean` Wether or not to enable the PROXY protocol header handling. If enabled upstream clients must set the header every time they open a connection. -Default value: `false` +Default value: ``false`` -##### `proxy_protocol_exceptions` +##### `proxy_protocol_exceptions` -Data type: `Optional[Array[Variant[Stdlib::Host,Stdlib::IP::Address]]]` +Data type: `Optional[Array[Stdlib::Host]]` A list of IP address or IP blocks that are not required to use the PROXY protocol. -Default value: `undef` +Default value: ``undef`` -##### `trusted_proxy` +##### `trusted_proxy` Data type: `Optional[Array[Stdlib::Host]]` @@ -5864,17 +5870,17 @@ valid value inside the specified header. Unlike the `$proxy_ips` parameter, any private IP presented by these proxies will be disgarded by `mod_remoteip`. -Default value: `undef` +Default value: ``undef`` -##### `trusted_proxy_ips` +##### `trusted_proxy_ips` Data type: `Optional[Array[Stdlib::Host]]` *Deprecated*: use `$trusted_proxy` instead. -Default value: `undef` +Default value: ``undef`` -##### `trusted_proxy_list` +##### `trusted_proxy_list` Data type: `Optional[Stdlib::Absolutepath]` @@ -5882,9 +5888,9 @@ The path to a file containing a list of IP addresses, IP blocks or hostname that are trusted to set a valid value inside the specified header. See `$trusted_proxy` for details. -Default value: `undef` +Default value: ``undef`` -### `apache::mod::reqtimeout` +### `apache::mod::reqtimeout` Installs and configures `mod_reqtimeout`. @@ -5896,9 +5902,9 @@ Installs and configures `mod_reqtimeout`. The following parameters are available in the `apache::mod::reqtimeout` class: -* [`timeouts`](#-apache--mod--reqtimeout--timeouts) +* [`timeouts`](#timeouts) -##### `timeouts` +##### `timeouts` Data type: `Variant[Array[String], String]` @@ -5906,7 +5912,7 @@ List of timeouts and data rates for receiving requests. Default value: `['header=20-40,minrate=500', 'body=10,minrate=500']` -### `apache::mod::rewrite` +### `apache::mod::rewrite` Installs `mod_rewrite`. @@ -5914,7 +5920,7 @@ Installs `mod_rewrite`. * https://httpd.apache.org/docs/current/mod/mod_rewrite.html * for additional documentation. -### `apache::mod::rpaf` +### `apache::mod::rpaf` Installs and configures `mod_rpaf`. @@ -5926,20 +5932,20 @@ Installs and configures `mod_rpaf`. The following parameters are available in the `apache::mod::rpaf` class: -* [`sethostname`](#-apache--mod--rpaf--sethostname) -* [`proxy_ips`](#-apache--mod--rpaf--proxy_ips) -* [`header`](#-apache--mod--rpaf--header) -* [`template`](#-apache--mod--rpaf--template) +* [`sethostname`](#sethostname) +* [`proxy_ips`](#proxy_ips) +* [`header`](#header) +* [`template`](#template) -##### `sethostname` +##### `sethostname` Data type: `Variant[Boolean, String]` Toggles whether to update vhost name so ServerName and ServerAlias work. -Default value: `true` +Default value: ``true`` -##### `proxy_ips` +##### `proxy_ips` Data type: `Array[Stdlib::IP::Address]` @@ -5947,7 +5953,7 @@ List of IPs & bitmasked subnets to adjust requests for Default value: `['127.0.0.1']` -##### `header` +##### `header` Data type: `String` @@ -5955,7 +5961,7 @@ Header to use for the real IP address. Default value: `'X-Forwarded-For'` -##### `template` +##### `template` Data type: `String` @@ -5963,7 +5969,7 @@ Path to template to use for configuring mod_rpaf. Default value: `'apache/mod/rpaf.conf.erb'` -### `apache::mod::security` +### `apache::mod::security` Installs and configures `mod_security`. @@ -5977,48 +5983,48 @@ Installs and configures `mod_security`. The following parameters are available in the `apache::mod::security` class: -* [`version`](#-apache--mod--security--version) -* [`logroot`](#-apache--mod--security--logroot) -* [`crs_package`](#-apache--mod--security--crs_package) -* [`activated_rules`](#-apache--mod--security--activated_rules) -* [`custom_rules`](#-apache--mod--security--custom_rules) -* [`custom_rules_set`](#-apache--mod--security--custom_rules_set) -* [`modsec_dir`](#-apache--mod--security--modsec_dir) -* [`modsec_secruleengine`](#-apache--mod--security--modsec_secruleengine) -* [`audit_log_relevant_status`](#-apache--mod--security--audit_log_relevant_status) -* [`audit_log_parts`](#-apache--mod--security--audit_log_parts) -* [`audit_log_type`](#-apache--mod--security--audit_log_type) -* [`audit_log_storage_dir`](#-apache--mod--security--audit_log_storage_dir) -* [`secpcrematchlimit`](#-apache--mod--security--secpcrematchlimit) -* [`secpcrematchlimitrecursion`](#-apache--mod--security--secpcrematchlimitrecursion) -* [`allowed_methods`](#-apache--mod--security--allowed_methods) -* [`content_types`](#-apache--mod--security--content_types) -* [`restricted_extensions`](#-apache--mod--security--restricted_extensions) -* [`restricted_headers`](#-apache--mod--security--restricted_headers) -* [`secdefaultaction`](#-apache--mod--security--secdefaultaction) -* [`inbound_anomaly_threshold`](#-apache--mod--security--inbound_anomaly_threshold) -* [`outbound_anomaly_threshold`](#-apache--mod--security--outbound_anomaly_threshold) -* [`critical_anomaly_score`](#-apache--mod--security--critical_anomaly_score) -* [`error_anomaly_score`](#-apache--mod--security--error_anomaly_score) -* [`warning_anomaly_score`](#-apache--mod--security--warning_anomaly_score) -* [`notice_anomaly_score`](#-apache--mod--security--notice_anomaly_score) -* [`paranoia_level`](#-apache--mod--security--paranoia_level) -* [`executing_paranoia_level`](#-apache--mod--security--executing_paranoia_level) -* [`secrequestmaxnumargs`](#-apache--mod--security--secrequestmaxnumargs) -* [`secrequestbodylimit`](#-apache--mod--security--secrequestbodylimit) -* [`secrequestbodynofileslimit`](#-apache--mod--security--secrequestbodynofileslimit) -* [`secrequestbodyinmemorylimit`](#-apache--mod--security--secrequestbodyinmemorylimit) -* [`secrequestbodyaccess`](#-apache--mod--security--secrequestbodyaccess) -* [`secrequestbodylimitaction`](#-apache--mod--security--secrequestbodylimitaction) -* [`secresponsebodyaccess`](#-apache--mod--security--secresponsebodyaccess) -* [`secresponsebodylimitaction`](#-apache--mod--security--secresponsebodylimitaction) -* [`manage_security_crs`](#-apache--mod--security--manage_security_crs) -* [`enable_dos_protection`](#-apache--mod--security--enable_dos_protection) -* [`dos_burst_time_slice`](#-apache--mod--security--dos_burst_time_slice) -* [`dos_counter_threshold`](#-apache--mod--security--dos_counter_threshold) -* [`dos_block_timeout`](#-apache--mod--security--dos_block_timeout) - -##### `version` +* [`version`](#version) +* [`logroot`](#logroot) +* [`crs_package`](#crs_package) +* [`activated_rules`](#activated_rules) +* [`custom_rules`](#custom_rules) +* [`custom_rules_set`](#custom_rules_set) +* [`modsec_dir`](#modsec_dir) +* [`modsec_secruleengine`](#modsec_secruleengine) +* [`audit_log_relevant_status`](#audit_log_relevant_status) +* [`audit_log_parts`](#audit_log_parts) +* [`audit_log_type`](#audit_log_type) +* [`audit_log_storage_dir`](#audit_log_storage_dir) +* [`secpcrematchlimit`](#secpcrematchlimit) +* [`secpcrematchlimitrecursion`](#secpcrematchlimitrecursion) +* [`allowed_methods`](#allowed_methods) +* [`content_types`](#content_types) +* [`restricted_extensions`](#restricted_extensions) +* [`restricted_headers`](#restricted_headers) +* [`secdefaultaction`](#secdefaultaction) +* [`inbound_anomaly_threshold`](#inbound_anomaly_threshold) +* [`outbound_anomaly_threshold`](#outbound_anomaly_threshold) +* [`critical_anomaly_score`](#critical_anomaly_score) +* [`error_anomaly_score`](#error_anomaly_score) +* [`warning_anomaly_score`](#warning_anomaly_score) +* [`notice_anomaly_score`](#notice_anomaly_score) +* [`paranoia_level`](#paranoia_level) +* [`executing_paranoia_level`](#executing_paranoia_level) +* [`secrequestmaxnumargs`](#secrequestmaxnumargs) +* [`secrequestbodylimit`](#secrequestbodylimit) +* [`secrequestbodynofileslimit`](#secrequestbodynofileslimit) +* [`secrequestbodyinmemorylimit`](#secrequestbodyinmemorylimit) +* [`secrequestbodyaccess`](#secrequestbodyaccess) +* [`secrequestbodylimitaction`](#secrequestbodylimitaction) +* [`secresponsebodyaccess`](#secresponsebodyaccess) +* [`secresponsebodylimitaction`](#secresponsebodylimitaction) +* [`manage_security_crs`](#manage_security_crs) +* [`enable_dos_protection`](#enable_dos_protection) +* [`dos_burst_time_slice`](#dos_burst_time_slice) +* [`dos_counter_threshold`](#dos_counter_threshold) +* [`dos_block_timeout`](#dos_block_timeout) + +##### `version` Data type: `Integer` @@ -6026,7 +6032,7 @@ Manage mod_security or mod_security2 Default value: `$apache::params::modsec_version` -##### `logroot` +##### `logroot` Data type: `Stdlib::Absolutepath` @@ -6034,7 +6040,7 @@ Configures the location of audit and debug logs. Default value: `$apache::params::logroot` -##### `crs_package` +##### `crs_package` Data type: `Optional[String]` @@ -6042,7 +6048,7 @@ Name of package that installs CRS rules. Default value: `$apache::params::modsec_crs_package` -##### `activated_rules` +##### `activated_rules` Data type: `Array[String]` @@ -6050,7 +6056,7 @@ An array of rules from the modsec_crs_path or absolute to activate via symlinks. Default value: `$apache::params::modsec_default_rules` -##### `custom_rules` +##### `custom_rules` Data type: `Boolean` @@ -6058,7 +6064,7 @@ Data type: `Boolean` Default value: `$apache::params::modsec_custom_rules` -##### `custom_rules_set` +##### `custom_rules_set` Data type: `Optional[Array[String]]` @@ -6066,7 +6072,7 @@ Data type: `Optional[Array[String]]` Default value: `$apache::params::modsec_custom_rules_set` -##### `modsec_dir` +##### `modsec_dir` Data type: `Stdlib::Absolutepath` @@ -6074,7 +6080,7 @@ Defines the path where Puppet installs the modsec configuration and activated ru Default value: `$apache::params::modsec_dir` -##### `modsec_secruleengine` +##### `modsec_secruleengine` Data type: `String` @@ -6082,7 +6088,7 @@ Configures the rules engine. Default value: `$apache::params::modsec_secruleengine` -##### `audit_log_relevant_status` +##### `audit_log_relevant_status` Data type: `String` @@ -6090,7 +6096,7 @@ Configures which response status code is to be considered relevant for the purpo Default value: `'^(?:5|4(?!04))'` -##### `audit_log_parts` +##### `audit_log_parts` Data type: `String` @@ -6099,7 +6105,7 @@ letter appears in the list then the equivalent part will be recorded. Default value: `$apache::params::modsec_audit_log_parts` -##### `audit_log_type` +##### `audit_log_type` Data type: `String` @@ -6107,15 +6113,15 @@ Defines the type of audit logging mechanism to be used. Default value: `$apache::params::modsec_audit_log_type` -##### `audit_log_storage_dir` +##### `audit_log_storage_dir` Data type: `Optional[Stdlib::Absolutepath]` Defines the directory where concurrent audit log entries are to be stored. This directive is only needed when concurrent audit logging is used. -Default value: `undef` +Default value: ``undef`` -##### `secpcrematchlimit` +##### `secpcrematchlimit` Data type: `Integer` @@ -6123,7 +6129,7 @@ Sets the match limit in the PCRE library. Default value: `$apache::params::secpcrematchlimit` -##### `secpcrematchlimitrecursion` +##### `secpcrematchlimitrecursion` Data type: `Integer` @@ -6131,7 +6137,7 @@ Sets the match limit recursion in the PCRE library. Default value: `$apache::params::secpcrematchlimitrecursion` -##### `allowed_methods` +##### `allowed_methods` Data type: `String` @@ -6139,7 +6145,7 @@ A space-separated list of allowed HTTP methods. Default value: `'GET HEAD POST OPTIONS'` -##### `content_types` +##### `content_types` Data type: `String` @@ -6147,7 +6153,7 @@ A list of one or more allowed MIME types. Default value: `'application/x-www-form-urlencoded|multipart/form-data|text/xml|application/xml|application/x-amf'` -##### `restricted_extensions` +##### `restricted_extensions` Data type: `String` @@ -6155,7 +6161,7 @@ A space-sparated list of prohibited file extensions. Default value: `'.asa/ .asax/ .ascx/ .axd/ .backup/ .bak/ .bat/ .cdx/ .cer/ .cfg/ .cmd/ .com/ .config/ .conf/ .cs/ .csproj/ .csr/ .dat/ .db/ .dbf/ .dll/ .dos/ .htr/ .htw/ .ida/ .idc/ .idq/ .inc/ .ini/ .key/ .licx/ .lnk/ .log/ .mdb/ .old/ .pass/ .pdb/ .pol/ .printer/ .pwd/ .resources/ .resx/ .sql/ .sys/ .vb/ .vbs/ .vbproj/ .vsdisco/ .webinfo/ .xsd/ .xsx/'` -##### `restricted_headers` +##### `restricted_headers` Data type: `String` @@ -6163,7 +6169,7 @@ A list of restricted headers separated by slashes and spaces. Default value: `'/Proxy-Connection/ /Lock-Token/ /Content-Range/ /Translate/ /via/ /if/'` -##### `secdefaultaction` +##### `secdefaultaction` Data type: `String` @@ -6171,7 +6177,7 @@ Defines the default list of actions, which will be inherited by the rules in the Default value: `'deny'` -##### `inbound_anomaly_threshold` +##### `inbound_anomaly_threshold` Data type: `Integer` @@ -6179,7 +6185,7 @@ Sets the scoring threshold level of the inbound blocking rules for the Collabora Default value: `5` -##### `outbound_anomaly_threshold` +##### `outbound_anomaly_threshold` Data type: `Integer` @@ -6187,7 +6193,7 @@ Sets the scoring threshold level of the outbound blocking rules for the Collabor Default value: `4` -##### `critical_anomaly_score` +##### `critical_anomaly_score` Data type: `Integer` @@ -6195,7 +6201,7 @@ Sets the Anomaly Score for rules assigned with a critical severity. Default value: `5` -##### `error_anomaly_score` +##### `error_anomaly_score` Data type: `Integer` @@ -6203,7 +6209,7 @@ Sets the Anomaly Score for rules assigned with a error severity. Default value: `4` -##### `warning_anomaly_score` +##### `warning_anomaly_score` Data type: `Integer` @@ -6211,7 +6217,7 @@ Sets the Anomaly Score for rules assigned with a warning severity. Default value: `3` -##### `notice_anomaly_score` +##### `notice_anomaly_score` Data type: `Integer` @@ -6219,7 +6225,7 @@ Sets the Anomaly Score for rules assigned with a notice severity. Default value: `2` -##### `paranoia_level` +##### `paranoia_level` Data type: `Integer[1,4]` @@ -6227,7 +6233,7 @@ Sets the paranoia level in the OWASP ModSecurity Core Rule Set. Default value: `1` -##### `executing_paranoia_level` +##### `executing_paranoia_level` Data type: `Integer[1,4]` @@ -6236,7 +6242,7 @@ The default is equal to, and cannot be lower than, $paranoia_level. Default value: `$paranoia_level` -##### `secrequestmaxnumargs` +##### `secrequestmaxnumargs` Data type: `Integer` @@ -6244,7 +6250,7 @@ Sets the maximum number of arguments in the request. Default value: `255` -##### `secrequestbodylimit` +##### `secrequestbodylimit` Data type: `Integer` @@ -6252,7 +6258,7 @@ Sets the maximum request body size ModSecurity will accept for buffering. Default value: `13107200` -##### `secrequestbodynofileslimit` +##### `secrequestbodynofileslimit` Data type: `Integer` @@ -6261,7 +6267,7 @@ in the request. Default value: `131072` -##### `secrequestbodyinmemorylimit` +##### `secrequestbodyinmemorylimit` Data type: `Integer` @@ -6269,15 +6275,15 @@ Configures the maximum request body size that ModSecurity will store in memory. Default value: `131072` -##### `secrequestbodyaccess` +##### `secrequestbodyaccess` -Data type: `Enum['On', 'Off']` +Data type: `Apache::OnOff` Toggle SecRequestBodyAccess On or Off Default value: `'On'` -##### `secrequestbodylimitaction` +##### `secrequestbodylimitaction` Data type: `Enum['Reject', 'ProcessPartial']` @@ -6286,15 +6292,15 @@ SecRequestBodyLimit, is encountered Default value: `'Reject'` -##### `secresponsebodyaccess` +##### `secresponsebodyaccess` -Data type: `Enum['On', 'Off']` +Data type: `Apache::OnOff` Toggle SecResponseBodyAccess On or Off Default value: `'Off'` -##### `secresponsebodylimitaction` +##### `secresponsebodylimitaction` Data type: `Enum['Reject', 'ProcessPartial']` @@ -6303,24 +6309,24 @@ SecResponseBodyLimitAction, is encountered. Default value: `'ProcessPartial'` -##### `manage_security_crs` +##### `manage_security_crs` Data type: `Boolean` Toggles whether to manage ModSecurity Core Rule Set -Default value: `true` +Default value: ``true`` -##### `enable_dos_protection` +##### `enable_dos_protection` Data type: `Boolean` Toggles the optional OWASP ModSecurity Core Rule Set DOS protection rule (rule id 900700) -Default value: `true` +Default value: ``true`` -##### `dos_burst_time_slice` +##### `dos_burst_time_slice` Data type: `Integer[1, default]` @@ -6329,7 +6335,7 @@ Configures time in which a burst is measured for the OWASP ModSecurity Core Rule Default value: `60` -##### `dos_counter_threshold` +##### `dos_counter_threshold` Data type: `Integer[1, default]` @@ -6338,7 +6344,7 @@ the OWASP ModSecurity Core Rule Set DOS protection rule (rule id 900700) Default value: `100` -##### `dos_block_timeout` +##### `dos_block_timeout` Data type: `Integer[1, default]` @@ -6347,7 +6353,7 @@ ModSecurity Core Rule Set DOS protection rule (rule id 900700) Default value: `600` -### `apache::mod::setenvif` +### `apache::mod::setenvif` Installs `mod_setenvif`. @@ -6355,7 +6361,7 @@ Installs `mod_setenvif`. * https://httpd.apache.org/docs/current/mod/mod_setenvif.html * for additional documentation. -### `apache::mod::shib` +### `apache::mod::shib` This class installs and configures only the Apache components of a web application that consumes Shibboleth SSO identities. You can manage the Shibboleth configuration manually, with Puppet, or using a [Shibboleth Puppet Module](https://github.com/aethylred/puppet-shibboleth). @@ -6371,45 +6377,45 @@ See the [Shibboleth Service Provider Installation Guide](http://wiki.aaf.edu.au/ The following parameters are available in the `apache::mod::shib` class: -* [`suppress_warning`](#-apache--mod--shib--suppress_warning) -* [`mod_full_path`](#-apache--mod--shib--mod_full_path) -* [`package_name`](#-apache--mod--shib--package_name) -* [`mod_lib`](#-apache--mod--shib--mod_lib) +* [`suppress_warning`](#suppress_warning) +* [`mod_full_path`](#mod_full_path) +* [`package_name`](#package_name) +* [`mod_lib`](#mod_lib) -##### `suppress_warning` +##### `suppress_warning` Data type: `Boolean` Toggles whether to trigger warning on RedHat nodes. -Default value: `false` +Default value: ``false`` -##### `mod_full_path` +##### `mod_full_path` Data type: `Optional[Stdlib::Absolutepath]` Specifies a path to the module. Do not manually set this parameter without a special reason. -Default value: `undef` +Default value: ``undef`` -##### `package_name` +##### `package_name` Data type: `Optional[String]` Name of the Shibboleth package to be installed. -Default value: `undef` +Default value: ``undef`` -##### `mod_lib` +##### `mod_lib` Data type: `Optional[String]` Specifies a path to the module's libraries. Do not manually set this parameter without special reason. The `path` parameter overrides this value. -Default value: `undef` +Default value: ``undef`` -### `apache::mod::socache_shmcb` +### `apache::mod::socache_shmcb` Installs `mod_socache_shmcb`. @@ -6417,7 +6423,7 @@ Installs `mod_socache_shmcb`. * https://httpd.apache.org/docs/current/mod/mod_socache_shmcb.html * for additional documentation. -### `apache::mod::speling` +### `apache::mod::speling` Installs `mod_spelling`. @@ -6425,7 +6431,7 @@ Installs `mod_spelling`. * https://httpd.apache.org/docs/current/mod/mod_speling.html * for additional documentation. -### `apache::mod::ssl` +### `apache::mod::ssl` On most operating systems, the ssl.conf is placed in the module configuration directory. On Red Hat based operating systems, this file is placed in /etc/httpd/conf.d, the same location in which the RPM stores the configuration. @@ -6441,47 +6447,47 @@ apache::vhost to true. The following parameters are available in the `apache::mod::ssl` class: -* [`ssl_compression`](#-apache--mod--ssl--ssl_compression) -* [`ssl_sessiontickets`](#-apache--mod--ssl--ssl_sessiontickets) -* [`ssl_cryptodevice`](#-apache--mod--ssl--ssl_cryptodevice) -* [`ssl_options`](#-apache--mod--ssl--ssl_options) -* [`ssl_openssl_conf_cmd`](#-apache--mod--ssl--ssl_openssl_conf_cmd) -* [`ssl_cert`](#-apache--mod--ssl--ssl_cert) -* [`ssl_key`](#-apache--mod--ssl--ssl_key) -* [`ssl_ca`](#-apache--mod--ssl--ssl_ca) -* [`ssl_cipher`](#-apache--mod--ssl--ssl_cipher) -* [`ssl_honorcipherorder`](#-apache--mod--ssl--ssl_honorcipherorder) -* [`ssl_protocol`](#-apache--mod--ssl--ssl_protocol) -* [`ssl_proxy_protocol`](#-apache--mod--ssl--ssl_proxy_protocol) -* [`ssl_proxy_cipher_suite`](#-apache--mod--ssl--ssl_proxy_cipher_suite) -* [`ssl_pass_phrase_dialog`](#-apache--mod--ssl--ssl_pass_phrase_dialog) -* [`ssl_random_seed_bytes`](#-apache--mod--ssl--ssl_random_seed_bytes) -* [`ssl_sessioncache`](#-apache--mod--ssl--ssl_sessioncache) -* [`ssl_sessioncachetimeout`](#-apache--mod--ssl--ssl_sessioncachetimeout) -* [`ssl_stapling`](#-apache--mod--ssl--ssl_stapling) -* [`stapling_cache`](#-apache--mod--ssl--stapling_cache) -* [`ssl_stapling_return_errors`](#-apache--mod--ssl--ssl_stapling_return_errors) -* [`ssl_mutex`](#-apache--mod--ssl--ssl_mutex) -* [`ssl_reload_on_change`](#-apache--mod--ssl--ssl_reload_on_change) -* [`package_name`](#-apache--mod--ssl--package_name) - -##### `ssl_compression` +* [`ssl_compression`](#ssl_compression) +* [`ssl_sessiontickets`](#ssl_sessiontickets) +* [`ssl_cryptodevice`](#ssl_cryptodevice) +* [`ssl_options`](#ssl_options) +* [`ssl_openssl_conf_cmd`](#ssl_openssl_conf_cmd) +* [`ssl_cert`](#ssl_cert) +* [`ssl_key`](#ssl_key) +* [`ssl_ca`](#ssl_ca) +* [`ssl_cipher`](#ssl_cipher) +* [`ssl_honorcipherorder`](#ssl_honorcipherorder) +* [`ssl_protocol`](#ssl_protocol) +* [`ssl_proxy_protocol`](#ssl_proxy_protocol) +* [`ssl_proxy_cipher_suite`](#ssl_proxy_cipher_suite) +* [`ssl_pass_phrase_dialog`](#ssl_pass_phrase_dialog) +* [`ssl_random_seed_bytes`](#ssl_random_seed_bytes) +* [`ssl_sessioncache`](#ssl_sessioncache) +* [`ssl_sessioncachetimeout`](#ssl_sessioncachetimeout) +* [`ssl_stapling`](#ssl_stapling) +* [`stapling_cache`](#stapling_cache) +* [`ssl_stapling_return_errors`](#ssl_stapling_return_errors) +* [`ssl_mutex`](#ssl_mutex) +* [`ssl_reload_on_change`](#ssl_reload_on_change) +* [`package_name`](#package_name) + +##### `ssl_compression` Data type: `Boolean` Enable compression on the SSL level. -Default value: `false` +Default value: ``false`` -##### `ssl_sessiontickets` +##### `ssl_sessiontickets` Data type: `Optional[Boolean]` Enable or disable use of TLS session tickets -Default value: `undef` +Default value: ``undef`` -##### `ssl_cryptodevice` +##### `ssl_cryptodevice` Data type: `String` @@ -6489,7 +6495,7 @@ Enable use of a cryptographic hardware accelerator. Default value: `'builtin'` -##### `ssl_options` +##### `ssl_options` Data type: `Array[String]` @@ -6497,55 +6503,55 @@ Configure various SSL engine run-time options. Default value: `['StdEnvVars']` -##### `ssl_openssl_conf_cmd` +##### `ssl_openssl_conf_cmd` Data type: `Optional[String]` Configure OpenSSL parameters through its SSL_CONF API. -Default value: `undef` +Default value: ``undef`` -##### `ssl_cert` +##### `ssl_cert` Data type: `Optional[Stdlib::Absolutepath]` Path to server PEM-encoded X.509 certificate data file. -Default value: `undef` +Default value: ``undef`` -##### `ssl_key` +##### `ssl_key` Data type: `Optional[Stdlib::Absolutepath]` Path to server PEM-encoded private key file -Default value: `undef` +Default value: ``undef`` -##### `ssl_ca` +##### `ssl_ca` Data type: `Optional[Stdlib::Absolutepath]` File of concatenated PEM-encoded CA Certificates for Client Auth. -Default value: `undef` +Default value: ``undef`` -##### `ssl_cipher` +##### `ssl_cipher` -Data type: `String` +Data type: `Variant[String[1], Hash[String[1], String[1]]]` Cipher Suite available for negotiation in SSL handshake. Default value: `$apache::params::ssl_cipher` -##### `ssl_honorcipherorder` +##### `ssl_honorcipherorder` -Data type: `Variant[Boolean, Enum['on', 'off']]` +Data type: `Variant[Boolean, Apache::OnOff]` Option to prefer the server's cipher preference order. -Default value: `true` +Default value: ``true`` -##### `ssl_protocol` +##### `ssl_protocol` Data type: `Array[String]` @@ -6556,7 +6562,7 @@ Default based on the OS: Default value: `$apache::params::ssl_protocol` -##### `ssl_proxy_protocol` +##### `ssl_proxy_protocol` Data type: `Array` @@ -6564,7 +6570,7 @@ Configure usable SSL protocol flavors for proxy usage. Default value: `[]` -##### `ssl_proxy_cipher_suite` +##### `ssl_proxy_cipher_suite` Data type: `Optional[String[1]]` @@ -6572,7 +6578,7 @@ Configure usable SSL ciphers for proxy usage. Equivalent to ssl_cipher but for p Default value: `$apache::params::ssl_proxy_cipher_suite` -##### `ssl_pass_phrase_dialog` +##### `ssl_pass_phrase_dialog` Data type: `String` @@ -6580,7 +6586,7 @@ Type of pass phrase dialog for encrypted private keys. Default value: `'builtin'` -##### `ssl_random_seed_bytes` +##### `ssl_random_seed_bytes` Data type: `Integer` @@ -6588,7 +6594,7 @@ Pseudo Random Number Generator (PRNG) seeding source. Default value: `512` -##### `ssl_sessioncache` +##### `ssl_sessioncache` Data type: `String` @@ -6596,7 +6602,7 @@ Configures the storage type of the global/inter-process SSL Session Cache Default value: `$apache::params::ssl_sessioncache` -##### `ssl_sessioncachetimeout` +##### `ssl_sessioncachetimeout` Data type: `Integer` @@ -6604,32 +6610,32 @@ Number of seconds before an SSL session expires in the Session Cache. Default value: `300` -##### `ssl_stapling` +##### `ssl_stapling` Data type: `Boolean` Enable stapling of OCSP responses in the TLS handshake. -Default value: `false` +Default value: ``false`` -##### `stapling_cache` +##### `stapling_cache` Data type: `Optional[String]` Configures the cache used to store OCSP responses which get included in the TLS handshake if SSLUseStapling is enabled. -Default value: `undef` +Default value: ``undef`` -##### `ssl_stapling_return_errors` +##### `ssl_stapling_return_errors` Data type: `Optional[Boolean]` Pass stapling related OCSP errors on to client. -Default value: `undef` +Default value: ``undef`` -##### `ssl_mutex` +##### `ssl_mutex` Data type: `String` @@ -6641,23 +6647,23 @@ Default based on the OS and/or Apache version: Default value: `'default'` -##### `ssl_reload_on_change` +##### `ssl_reload_on_change` Data type: `Boolean` Enable reloading of apache if the content of ssl files have changed. It only affects ssl files configured here and not vhost ones. -Default value: `false` +Default value: ``false`` -##### `package_name` +##### `package_name` Data type: `Optional[String]` Name of ssl package to install. -Default value: `undef` +Default value: ``undef`` -### `apache::mod::status` +### `apache::mod::status` Installs and configures `mod_status`. @@ -6680,11 +6686,11 @@ class { 'apache::mod::status': The following parameters are available in the `apache::mod::status` class: -* [`requires`](#-apache--mod--status--requires) -* [`extended_status`](#-apache--mod--status--extended_status) -* [`status_path`](#-apache--mod--status--status_path) +* [`requires`](#requires) +* [`extended_status`](#extended_status) +* [`status_path`](#status_path) -##### `requires` +##### `requires` Data type: `Optional[Variant[String, Array, Hash]]` @@ -6701,17 +6707,17 @@ A Variant type that can be: This encloses "Require" directives in "" block Optional - If unspecified, "Require" directives follow current flow -Default value: `undef` +Default value: ``undef`` -##### `extended_status` +##### `extended_status` -Data type: `Enum['On', 'Off', 'on', 'off']` +Data type: `Apache::OnOff` Determines whether to track extended status information for each request, via the ExtendedStatus directive. Default value: `'On'` -##### `status_path` +##### `status_path` Data type: `String` @@ -6719,7 +6725,7 @@ Path assigned to the Location directive which defines the URL to access the serv Default value: `'/server-status'` -### `apache::mod::suexec` +### `apache::mod::suexec` Installs `mod_suexec`. @@ -6727,7 +6733,7 @@ Installs `mod_suexec`. * https://httpd.apache.org/docs/current/mod/mod_suexec.html * for additional documentation. -### `apache::mod::userdir` +### `apache::mod::userdir` Installs and configures `mod_userdir`. @@ -6739,49 +6745,49 @@ Installs and configures `mod_userdir`. The following parameters are available in the `apache::mod::userdir` class: -* [`home`](#-apache--mod--userdir--home) -* [`dir`](#-apache--mod--userdir--dir) -* [`userdir`](#-apache--mod--userdir--userdir) -* [`disable_root`](#-apache--mod--userdir--disable_root) -* [`path`](#-apache--mod--userdir--path) -* [`overrides`](#-apache--mod--userdir--overrides) -* [`options`](#-apache--mod--userdir--options) -* [`unmanaged_path`](#-apache--mod--userdir--unmanaged_path) -* [`custom_fragment`](#-apache--mod--userdir--custom_fragment) +* [`home`](#home) +* [`dir`](#dir) +* [`userdir`](#userdir) +* [`disable_root`](#disable_root) +* [`path`](#path) +* [`overrides`](#overrides) +* [`options`](#options) +* [`unmanaged_path`](#unmanaged_path) +* [`custom_fragment`](#custom_fragment) -##### `home` +##### `home` Data type: `Optional[String]` *Deprecated* Path to system home directory. -Default value: `undef` +Default value: ``undef`` -##### `dir` +##### `dir` Data type: `Optional[String]` *Deprecated* Path from user's home directory to public directory. -Default value: `undef` +Default value: ``undef`` -##### `userdir` +##### `userdir` Data type: `Optional[String[1]]` Path or directory name to be used as the UserDir. -Default value: `undef` +Default value: ``undef`` -##### `disable_root` +##### `disable_root` Data type: `Boolean` Toggles whether to allow use of root directory. -Default value: `true` +Default value: ``true`` -##### `path` +##### `path` Data type: `String` @@ -6789,7 +6795,7 @@ Path to directory or pattern from which to find user-specific directories. Default value: `'/home/*/public_html'` -##### `overrides` +##### `overrides` Data type: `Array[String]` @@ -6797,7 +6803,7 @@ Array of directives that are allowed in .htaccess files. Default value: `['FileInfo', 'AuthConfig', 'Limit', 'Indexes']` -##### `options` +##### `options` Data type: `Array[String]` @@ -6805,23 +6811,23 @@ Configures what features are available in a particular directory. Default value: `['MultiViews', 'Indexes', 'SymLinksIfOwnerMatch', 'IncludesNoExec']` -##### `unmanaged_path` +##### `unmanaged_path` Data type: `Boolean` Toggles whether to manage path in userdir.conf -Default value: `false` +Default value: ``false`` -##### `custom_fragment` +##### `custom_fragment` Data type: `Optional[String]` Custom configuration to be added to userdir.conf -Default value: `undef` +Default value: ``undef`` -### `apache::mod::version` +### `apache::mod::version` Installs `mod_version`. @@ -6829,7 +6835,7 @@ Installs `mod_version`. * https://httpd.apache.org/docs/current/mod/mod_version.html * for additional documentation. -### `apache::mod::vhost_alias` +### `apache::mod::vhost_alias` Installs Apache `mod_vhost_alias`. @@ -6837,7 +6843,7 @@ Installs Apache `mod_vhost_alias`. * https://httpd.apache.org/docs/current/mod/mod_vhost_alias.html * for additional documentation. -### `apache::mod::watchdog` +### `apache::mod::watchdog` Installs and configures `mod_watchdog`. @@ -6849,17 +6855,17 @@ Installs and configures `mod_watchdog`. The following parameters are available in the `apache::mod::watchdog` class: -* [`watchdog_interval`](#-apache--mod--watchdog--watchdog_interval) +* [`watchdog_interval`](#watchdog_interval) -##### `watchdog_interval` +##### `watchdog_interval` Data type: `Optional[Integer]` Sets the interval at which the watchdog_step hook runs. -Default value: `undef` +Default value: ``undef`` -### `apache::mod::worker` +### `apache::mod::worker` Installs and manages the MPM `worker`. @@ -6871,17 +6877,17 @@ Installs and manages the MPM `worker`. The following parameters are available in the `apache::mod::worker` class: -* [`startservers`](#-apache--mod--worker--startservers) -* [`minsparethreads`](#-apache--mod--worker--minsparethreads) -* [`maxsparethreads`](#-apache--mod--worker--maxsparethreads) -* [`threadsperchild`](#-apache--mod--worker--threadsperchild) -* [`maxrequestsperchild`](#-apache--mod--worker--maxrequestsperchild) -* [`serverlimit`](#-apache--mod--worker--serverlimit) -* [`threadlimit`](#-apache--mod--worker--threadlimit) -* [`listenbacklog`](#-apache--mod--worker--listenbacklog) -* [`maxrequestworkers`](#-apache--mod--worker--maxrequestworkers) +* [`startservers`](#startservers) +* [`minsparethreads`](#minsparethreads) +* [`maxsparethreads`](#maxsparethreads) +* [`threadsperchild`](#threadsperchild) +* [`maxrequestsperchild`](#maxrequestsperchild) +* [`serverlimit`](#serverlimit) +* [`threadlimit`](#threadlimit) +* [`listenbacklog`](#listenbacklog) +* [`maxrequestworkers`](#maxrequestworkers) -##### `startservers` +##### `startservers` Data type: `Integer` @@ -6889,7 +6895,7 @@ The number of child server processes created on startup Default value: `2` -##### `minsparethreads` +##### `minsparethreads` Data type: `Integer` @@ -6897,7 +6903,7 @@ Minimum number of idle threads to handle request spikes. Default value: `25` -##### `maxsparethreads` +##### `maxsparethreads` Data type: `Integer` @@ -6905,7 +6911,7 @@ Maximum number of idle threads. Default value: `75` -##### `threadsperchild` +##### `threadsperchild` Data type: `Integer` @@ -6913,7 +6919,7 @@ The number of threads created by each child process. Default value: `25` -##### `maxrequestsperchild` +##### `maxrequestsperchild` Data type: `Integer` @@ -6923,7 +6929,7 @@ name is MaxConnectionsPerChild as of 2.3.9+. Default value: `0` -##### `serverlimit` +##### `serverlimit` Data type: `Integer` @@ -6935,7 +6941,7 @@ MaxRequestWorkers and ThreadsPerChild. Default value: `25` -##### `threadlimit` +##### `threadlimit` Data type: `Integer` @@ -6944,7 +6950,7 @@ ThreadsPerChild for the lifetime of the Apache httpd process. Default value: `64` -##### `listenbacklog` +##### `listenbacklog` Data type: `Integer` @@ -6952,7 +6958,7 @@ Maximum length of the queue of pending connections. Default value: `511` -##### `maxrequestworkers` +##### `maxrequestworkers` Data type: `Integer` @@ -6960,7 +6966,7 @@ Maximum number of connections that will be processed simultaneously Default value: `150` -### `apache::mod::wsgi` +### `apache::mod::wsgi` Installs and configures `mod_wsgi`. @@ -6974,24 +6980,24 @@ Installs and configures `mod_wsgi`. The following parameters are available in the `apache::mod::wsgi` class: -* [`wsgi_restrict_embedded`](#-apache--mod--wsgi--wsgi_restrict_embedded) -* [`wsgi_socket_prefix`](#-apache--mod--wsgi--wsgi_socket_prefix) -* [`wsgi_python_path`](#-apache--mod--wsgi--wsgi_python_path) -* [`wsgi_python_home`](#-apache--mod--wsgi--wsgi_python_home) -* [`wsgi_python_optimize`](#-apache--mod--wsgi--wsgi_python_optimize) -* [`wsgi_application_group`](#-apache--mod--wsgi--wsgi_application_group) -* [`package_name`](#-apache--mod--wsgi--package_name) -* [`mod_path`](#-apache--mod--wsgi--mod_path) +* [`wsgi_restrict_embedded`](#wsgi_restrict_embedded) +* [`wsgi_socket_prefix`](#wsgi_socket_prefix) +* [`wsgi_python_path`](#wsgi_python_path) +* [`wsgi_python_home`](#wsgi_python_home) +* [`wsgi_python_optimize`](#wsgi_python_optimize) +* [`wsgi_application_group`](#wsgi_application_group) +* [`package_name`](#package_name) +* [`mod_path`](#mod_path) -##### `wsgi_restrict_embedded` +##### `wsgi_restrict_embedded` Data type: `Optional[String]` Enable restrictions on use of embedded mode. -Default value: `undef` +Default value: ``undef`` -##### `wsgi_socket_prefix` +##### `wsgi_socket_prefix` Data type: `Optional[String]` @@ -6999,55 +7005,55 @@ Configure directory to use for daemon sockets. Default value: `$apache::params::wsgi_socket_prefix` -##### `wsgi_python_path` +##### `wsgi_python_path` Data type: `Optional[Stdlib::Absolutepath]` Additional directories to search for Python modules. -Default value: `undef` +Default value: ``undef`` -##### `wsgi_python_home` +##### `wsgi_python_home` Data type: `Optional[Stdlib::Absolutepath]` Absolute path to Python prefix/exec_prefix directories. -Default value: `undef` +Default value: ``undef`` -##### `wsgi_python_optimize` +##### `wsgi_python_optimize` Data type: `Optional[Integer]` Enables basic Python optimisation features. -Default value: `undef` +Default value: ``undef`` -##### `wsgi_application_group` +##### `wsgi_application_group` Data type: `Optional[String]` Sets which application group WSGI application belongs to. -Default value: `undef` +Default value: ``undef`` -##### `package_name` +##### `package_name` Data type: `Optional[String]` Names of package that installs mod_wsgi. -Default value: `undef` +Default value: ``undef`` -##### `mod_path` +##### `mod_path` Data type: `Optional[String]` Defines the path to the mod_wsgi shared object (.so) file. -Default value: `undef` +Default value: ``undef`` -### `apache::mod::xsendfile` +### `apache::mod::xsendfile` Installs `mod_xsendfile`. @@ -7055,19 +7061,19 @@ Installs `mod_xsendfile`. * https://tn123.org/mod_xsendfile/ * for additional documentation. -### `apache::mpm::disable_mpm_event` +### `apache::mpm::disable_mpm_event` disable Apache-Module event -### `apache::mpm::disable_mpm_prefork` +### `apache::mpm::disable_mpm_prefork` disable Apache-Module prefork -### `apache::mpm::disable_mpm_worker` +### `apache::mpm::disable_mpm_worker` disable Apache-Module worker -### `apache::vhosts` +### `apache::vhosts` host parameters or Configuring virtual hosts in the README section. @@ -7092,9 +7098,9 @@ class { 'apache::vhosts': The following parameters are available in the `apache::vhosts` class: -* [`vhosts`](#-apache--vhosts--vhosts) +* [`vhosts`](#vhosts) -##### `vhosts` +##### `vhosts` Data type: `Hash` @@ -7105,7 +7111,7 @@ Default value: `{}` ## Defined types -### `apache::balancer` +### `apache::balancer` Each balancer cluster needs one or more balancer members (that can be declared with the apache::balancermember defined resource type). Using @@ -7129,18 +7135,18 @@ apache::balancer { 'puppet00': } The following parameters are available in the `apache::balancer` defined type: -* [`name`](#-apache--balancer--name) -* [`proxy_set`](#-apache--balancer--proxy_set) -* [`target`](#-apache--balancer--target) -* [`collect_exported`](#-apache--balancer--collect_exported) -* [`options`](#-apache--balancer--options) +* [`name`](#name) +* [`proxy_set`](#proxy_set) +* [`target`](#target) +* [`collect_exported`](#collect_exported) +* [`options`](#options) -##### `name` +##### `name` The namevar of the defined resource type is the balancer clusters name.
This name is also used in the name of the conf.d file -##### `proxy_set` +##### `proxy_set` Data type: `Hash` @@ -7148,15 +7154,15 @@ Configures key-value pairs to be used as a ProxySet lines in the configuration. Default value: `{}` -##### `target` +##### `target` Data type: `Optional[String]` The path to the file the balancer definition will be written in. -Default value: `undef` +Default value: ``undef`` -##### `collect_exported` +##### `collect_exported` Data type: `Boolean` @@ -7171,9 +7177,9 @@ If you don't use exported resources, a single Puppet run configures all balancer you use exported resources, Puppet has to run on the balanced nodes first, then run on the balancer. -Default value: `true` +Default value: ``true`` -##### `options` +##### `options` Data type: `Array[Pattern[/=/]]` @@ -7182,7 +7188,7 @@ after the balancer URL, and accepts any key-value pairs available to `ProxyPass` Default value: `[]` -### `apache::balancermember` +### `apache::balancermember` Sets up a balancer member inside a listening service configuration block in the load balancer's `apache.cfg`. @@ -7214,24 +7220,24 @@ from all balancer members. The following parameters are available in the `apache::balancermember` defined type: -* [`name`](#-apache--balancermember--name) -* [`balancer_cluster`](#-apache--balancermember--balancer_cluster) -* [`url`](#-apache--balancermember--url) -* [`options`](#-apache--balancermember--options) +* [`name`](#name) +* [`balancer_cluster`](#balancer_cluster) +* [`url`](#url) +* [`options`](#options) -##### `name` +##### `name` The title of the resource is arbitrary and only utilized in the concat fragment name. -##### `balancer_cluster` +##### `balancer_cluster` Data type: `String` The apache service's instance name (or, the title of the apache::balancer resource). This must match up with a declared apache::balancer resource. -##### `url` +##### `url` Data type: `Apache::ModProxyProtocol` @@ -7239,7 +7245,7 @@ The url used to contact the balancer member server. Default value: `"http://${$facts['networking']['fqdn']}/"` -##### `options` +##### `options` Data type: `Array` @@ -7248,7 +7254,7 @@ after the URL, and accepts any key-value pairs available to `ProxyPass`. Default value: `[]` -### `apache::custom_config` +### `apache::custom_config` If the file is invalid and this defined type's `verify_config` parameter's value is `true`, Puppet throws an error during a Puppet run. @@ -7257,20 +7263,20 @@ If the file is invalid and this defined type's `verify_config` parameter's value The following parameters are available in the `apache::custom_config` defined type: -* [`ensure`](#-apache--custom_config--ensure) -* [`confdir`](#-apache--custom_config--confdir) -* [`content`](#-apache--custom_config--content) -* [`filename`](#-apache--custom_config--filename) -* [`priority`](#-apache--custom_config--priority) -* [`source`](#-apache--custom_config--source) -* [`verify_command`](#-apache--custom_config--verify_command) -* [`verify_config`](#-apache--custom_config--verify_config) -* [`owner`](#-apache--custom_config--owner) -* [`group`](#-apache--custom_config--group) -* [`file_mode`](#-apache--custom_config--file_mode) -* [`show_diff`](#-apache--custom_config--show_diff) - -##### `ensure` +* [`ensure`](#ensure) +* [`confdir`](#confdir) +* [`content`](#content) +* [`filename`](#filename) +* [`priority`](#priority) +* [`source`](#source) +* [`verify_command`](#verify_command) +* [`verify_config`](#verify_config) +* [`owner`](#owner) +* [`group`](#group) +* [`file_mode`](#file_mode) +* [`show_diff`](#show_diff) + +##### `ensure` Data type: `Enum['absent', 'present']` @@ -7278,7 +7284,7 @@ Specifies whether the configuration file should be present. Default value: `'present'` -##### `confdir` +##### `confdir` Data type: `Stdlib::Absolutepath` @@ -7286,24 +7292,24 @@ Sets the directory in which Puppet places configuration files. Default value: `$apache::confd_dir` -##### `content` +##### `content` Data type: `Optional[Variant[Sensitive, String]]` Sets the configuration file's content. The `content` and `source` parameters are exclusive of each other. -Default value: `undef` +Default value: ``undef`` -##### `filename` +##### `filename` Data type: `Optional[String]` Sets the name of the file under `confdir` in which Puppet stores the configuration. -Default value: `undef` +Default value: ``undef`` -##### `priority` +##### `priority` Data type: `Apache::Vhost::Priority` @@ -7313,16 +7319,16 @@ To omit the priority prefix in the configuration file's name, set this parameter Default value: `25` -##### `source` +##### `source` Data type: `Optional[String]` Points to the configuration file's source. The `content` and `source` parameters are exclusive of each other. -Default value: `undef` +Default value: ``undef`` -##### `verify_command` +##### `verify_command` Data type: `Variant[String, Array[String], Array[Array[String]]]` @@ -7337,47 +7343,47 @@ Or an array of arrays with each one having to pass succesfully, i.e. `[['/usr/sb Default value: `$apache::params::verify_command` -##### `verify_config` +##### `verify_config` Data type: `Boolean` Specifies whether to validate the configuration file before notifying the Apache service. -Default value: `true` +Default value: ``true`` -##### `owner` +##### `owner` Data type: `Optional[String]` File owner of configuration file -Default value: `undef` +Default value: ``undef`` -##### `group` +##### `group` Data type: `Optional[String]` File group of configuration file -Default value: `undef` +Default value: ``undef`` -##### `file_mode` +##### `file_mode` Data type: `Optional[Stdlib::Filemode]` File mode of configuration file -Default value: `undef` +Default value: ``undef`` -##### `show_diff` +##### `show_diff` Data type: `Boolean` show_diff property for configuration file resource -Default value: `true` +Default value: ``true`` -### `apache::fastcgi::server` +### `apache::fastcgi::server` Defines one or more external FastCGI servers to handle specific file types. Use this defined type with `mod_fastcgi`. @@ -7386,15 +7392,15 @@ defined type with `mod_fastcgi`. The following parameters are available in the `apache::fastcgi::server` defined type: -* [`host`](#-apache--fastcgi--server--host) -* [`timeout`](#-apache--fastcgi--server--timeout) -* [`flush`](#-apache--fastcgi--server--flush) -* [`faux_path`](#-apache--fastcgi--server--faux_path) -* [`fcgi_alias`](#-apache--fastcgi--server--fcgi_alias) -* [`file_type`](#-apache--fastcgi--server--file_type) -* [`pass_header`](#-apache--fastcgi--server--pass_header) +* [`host`](#host) +* [`timeout`](#timeout) +* [`flush`](#flush) +* [`faux_path`](#faux_path) +* [`fcgi_alias`](#fcgi_alias) +* [`file_type`](#file_type) +* [`pass_header`](#pass_header) -##### `host` +##### `host` Data type: `String` @@ -7402,7 +7408,7 @@ Determines the FastCGI's hostname or IP address and TCP port number (1-65535). Default value: `'127.0.0.1:9000'` -##### `timeout` +##### `timeout` Data type: `Integer` @@ -7415,7 +7421,7 @@ the client (the response is buffered), the timeout does not apply. Default value: `15` -##### `flush` +##### `flush` Data type: `Boolean` @@ -7423,9 +7429,9 @@ Forces `mod_fastcgi` to write to the client as data is received from the application. By default, `mod_fastcgi` buffers data in order to free the application as quickly as possible. -Default value: `false` +Default value: ``false`` -##### `faux_path` +##### `faux_path` Data type: `Stdlib::Absolutepath` @@ -7434,7 +7440,7 @@ parameter does not have to exist in the local filesystem. Default value: `"/var/www/${name}.fcgi"` -##### `fcgi_alias` +##### `fcgi_alias` Data type: `Stdlib::Unixpath` @@ -7442,7 +7448,7 @@ Internally links actions with the FastCGI server. This alias must be unique. Default value: `"/${name}.fcgi"` -##### `file_type` +##### `file_type` Data type: `String` @@ -7450,20 +7456,20 @@ Sets the MIME `content-type` of the file to be processed by the FastCGI server. Default value: `'application/x-httpd-php'` -##### `pass_header` +##### `pass_header` Data type: `Optional[String]` Sets a header for the server -Default value: `undef` +Default value: ``undef`` -### `apache::listen` +### `apache::listen` The `apache::vhost` class uses this defined type, and titles take the form ``, `:`, or `:`. -### `apache::mod` +### `apache::mod` Checks for or places the module's default configuration files in the Apache server's `module` and `enable` directories. The default locations depend on your operating system. @@ -7472,25 +7478,25 @@ Checks for or places the module's default configuration files in the Apache serv The following parameters are available in the `apache::mod` defined type: -* [`package`](#-apache--mod--package) -* [`package_ensure`](#-apache--mod--package_ensure) -* [`lib`](#-apache--mod--lib) -* [`lib_path`](#-apache--mod--lib_path) -* [`loadfile_name`](#-apache--mod--loadfile_name) -* [`id`](#-apache--mod--id) -* [`loadfiles`](#-apache--mod--loadfiles) -* [`path`](#-apache--mod--path) +* [`package`](#package) +* [`package_ensure`](#package_ensure) +* [`lib`](#lib) +* [`lib_path`](#lib_path) +* [`loadfile_name`](#loadfile_name) +* [`id`](#id) +* [`loadfiles`](#loadfiles) +* [`path`](#path) -##### `package` +##### `package` Data type: `Optional[String]` **Required**.
Names the package Puppet uses to install the Apache module. -Default value: `undef` +Default value: ``undef`` -##### `package_ensure` +##### `package_ensure` Data type: `String` @@ -7498,15 +7504,15 @@ Determines whether Puppet ensures the Apache module should be installed. Default value: `'present'` -##### `lib` +##### `lib` Data type: `Optional[String]` Defines the module's shared object name. Do not configure manually without special reason. -Default value: `undef` +Default value: ``undef`` -##### `lib_path` +##### `lib_path` Data type: `String` @@ -7515,46 +7521,46 @@ without special reason. The `path` parameter overrides this value. Default value: `$apache::lib_path` -##### `loadfile_name` +##### `loadfile_name` Data type: `Optional[String]` Sets the filename for the module's `LoadFile` directive, which can also set the module load order as Apache processes them in alphanumeric order. -Default value: `undef` +Default value: ``undef`` -##### `id` +##### `id` Data type: `Optional[String]` Specifies the package id -Default value: `undef` +Default value: ``undef`` -##### `loadfiles` +##### `loadfiles` Data type: `Optional[Array]` Specifies an array of `LoadFile` directives. -Default value: `undef` +Default value: ``undef`` -##### `path` +##### `path` Data type: `Optional[String]` Specifies a path to the module. Do not manually set this parameter without a special reason. -Default value: `undef` +Default value: ``undef`` -### `apache::namevirtualhost` +### `apache::namevirtualhost` Adds all related directives to the `ports.conf` file in the Apache HTTPD configuration directory. Titles can take the forms `\*`, `\*:\`, `\_default\_:\`, `\`, or `\:\`. -### `apache::vhost` +### `apache::vhost` The apache module allows a lot of flexibility in the setup and configuration of virtual hosts. This flexibility is due, in part, to `vhost` being a defined resource type, which allows Apache @@ -7624,6 +7630,32 @@ lint:endignore } ``` +lint:ignore:parameter_documentation +lint:endignore + Specifies mod_authz_core parameters for particular directories in a virtual host directory + ```puppet + apache::vhost { 'sample.example.net': + docroot => '/path/to/directory', + directories => [ + { path => '/path/to/different/dir', + authz_core => { + require_all => { + 'require_any' => { + 'require' => ['user superadmin'], + 'require_all' => { + 'require' => ['group admins', 'ldap-group "cn=Administrators,o=Airius"'], + }, + }, + 'require_none' => { + 'require' => ['group temps', 'ldap-group "cn=Temporary Employees,o=Airius"'] + } + } + } + }, + ], + } + ``` + #### Examples ##### @@ -7639,266 +7671,267 @@ class { 'apache': The following parameters are available in the `apache::vhost` defined type: -* [`access_log`](#-apache--vhost--access_log) -* [`access_log_env_var`](#-apache--vhost--access_log_env_var) -* [`access_log_file`](#-apache--vhost--access_log_file) -* [`access_log_format`](#-apache--vhost--access_log_format) -* [`access_log_pipe`](#-apache--vhost--access_log_pipe) -* [`access_log_syslog`](#-apache--vhost--access_log_syslog) -* [`access_logs`](#-apache--vhost--access_logs) -* [`add_default_charset`](#-apache--vhost--add_default_charset) -* [`add_listen`](#-apache--vhost--add_listen) -* [`use_optional_includes`](#-apache--vhost--use_optional_includes) -* [`aliases`](#-apache--vhost--aliases) -* [`allow_encoded_slashes`](#-apache--vhost--allow_encoded_slashes) -* [`block`](#-apache--vhost--block) -* [`cas_attribute_prefix`](#-apache--vhost--cas_attribute_prefix) -* [`cas_attribute_delimiter`](#-apache--vhost--cas_attribute_delimiter) -* [`cas_login_url`](#-apache--vhost--cas_login_url) -* [`cas_root_proxied_as`](#-apache--vhost--cas_root_proxied_as) -* [`cas_scrub_request_headers`](#-apache--vhost--cas_scrub_request_headers) -* [`cas_sso_enabled`](#-apache--vhost--cas_sso_enabled) -* [`cas_validate_saml`](#-apache--vhost--cas_validate_saml) -* [`cas_validate_url`](#-apache--vhost--cas_validate_url) -* [`cas_cookie_path`](#-apache--vhost--cas_cookie_path) -* [`comment`](#-apache--vhost--comment) -* [`default_vhost`](#-apache--vhost--default_vhost) -* [`directoryindex`](#-apache--vhost--directoryindex) -* [`docroot`](#-apache--vhost--docroot) -* [`docroot_group`](#-apache--vhost--docroot_group) -* [`docroot_owner`](#-apache--vhost--docroot_owner) -* [`docroot_mode`](#-apache--vhost--docroot_mode) -* [`manage_docroot`](#-apache--vhost--manage_docroot) -* [`error_log`](#-apache--vhost--error_log) -* [`error_log_file`](#-apache--vhost--error_log_file) -* [`error_log_pipe`](#-apache--vhost--error_log_pipe) -* [`error_log_syslog`](#-apache--vhost--error_log_syslog) -* [`error_log_format`](#-apache--vhost--error_log_format) -* [`error_documents`](#-apache--vhost--error_documents) -* [`ensure`](#-apache--vhost--ensure) -* [`fallbackresource`](#-apache--vhost--fallbackresource) -* [`filters`](#-apache--vhost--filters) -* [`h2_copy_files`](#-apache--vhost--h2_copy_files) -* [`h2_direct`](#-apache--vhost--h2_direct) -* [`h2_early_hints`](#-apache--vhost--h2_early_hints) -* [`h2_max_session_streams`](#-apache--vhost--h2_max_session_streams) -* [`h2_modern_tls_only`](#-apache--vhost--h2_modern_tls_only) -* [`h2_push`](#-apache--vhost--h2_push) -* [`h2_push_diary_size`](#-apache--vhost--h2_push_diary_size) -* [`h2_push_priority`](#-apache--vhost--h2_push_priority) -* [`h2_push_resource`](#-apache--vhost--h2_push_resource) -* [`h2_serialize_headers`](#-apache--vhost--h2_serialize_headers) -* [`h2_stream_max_mem_size`](#-apache--vhost--h2_stream_max_mem_size) -* [`h2_tls_cool_down_secs`](#-apache--vhost--h2_tls_cool_down_secs) -* [`h2_tls_warm_up_size`](#-apache--vhost--h2_tls_warm_up_size) -* [`h2_upgrade`](#-apache--vhost--h2_upgrade) -* [`h2_window_size`](#-apache--vhost--h2_window_size) -* [`ip`](#-apache--vhost--ip) -* [`ip_based`](#-apache--vhost--ip_based) -* [`itk`](#-apache--vhost--itk) -* [`action`](#-apache--vhost--action) -* [`jk_mounts`](#-apache--vhost--jk_mounts) -* [`http_protocol_options`](#-apache--vhost--http_protocol_options) -* [`keepalive`](#-apache--vhost--keepalive) -* [`keepalive_timeout`](#-apache--vhost--keepalive_timeout) -* [`max_keepalive_requests`](#-apache--vhost--max_keepalive_requests) -* [`auth_kerb`](#-apache--vhost--auth_kerb) -* [`krb_method_negotiate`](#-apache--vhost--krb_method_negotiate) -* [`krb_method_k5passwd`](#-apache--vhost--krb_method_k5passwd) -* [`krb_authoritative`](#-apache--vhost--krb_authoritative) -* [`krb_auth_realms`](#-apache--vhost--krb_auth_realms) -* [`krb_5keytab`](#-apache--vhost--krb_5keytab) -* [`krb_local_user_mapping`](#-apache--vhost--krb_local_user_mapping) -* [`krb_verify_kdc`](#-apache--vhost--krb_verify_kdc) -* [`krb_servicename`](#-apache--vhost--krb_servicename) -* [`krb_save_credentials`](#-apache--vhost--krb_save_credentials) -* [`logroot`](#-apache--vhost--logroot) -* [`logroot_ensure`](#-apache--vhost--logroot_ensure) -* [`logroot_mode`](#-apache--vhost--logroot_mode) -* [`logroot_owner`](#-apache--vhost--logroot_owner) -* [`logroot_group`](#-apache--vhost--logroot_group) -* [`log_level`](#-apache--vhost--log_level) -* [`modsec_body_limit`](#-apache--vhost--modsec_body_limit) -* [`modsec_disable_vhost`](#-apache--vhost--modsec_disable_vhost) -* [`modsec_disable_ids`](#-apache--vhost--modsec_disable_ids) -* [`modsec_disable_ips`](#-apache--vhost--modsec_disable_ips) -* [`modsec_disable_msgs`](#-apache--vhost--modsec_disable_msgs) -* [`modsec_disable_tags`](#-apache--vhost--modsec_disable_tags) -* [`modsec_audit_log_file`](#-apache--vhost--modsec_audit_log_file) -* [`modsec_audit_log_pipe`](#-apache--vhost--modsec_audit_log_pipe) -* [`modsec_audit_log`](#-apache--vhost--modsec_audit_log) -* [`modsec_inbound_anomaly_threshold`](#-apache--vhost--modsec_inbound_anomaly_threshold) -* [`modsec_outbound_anomaly_threshold`](#-apache--vhost--modsec_outbound_anomaly_threshold) -* [`modsec_allowed_methods`](#-apache--vhost--modsec_allowed_methods) -* [`no_proxy_uris`](#-apache--vhost--no_proxy_uris) -* [`no_proxy_uris_match`](#-apache--vhost--no_proxy_uris_match) -* [`proxy_preserve_host`](#-apache--vhost--proxy_preserve_host) -* [`proxy_add_headers`](#-apache--vhost--proxy_add_headers) -* [`proxy_error_override`](#-apache--vhost--proxy_error_override) -* [`options`](#-apache--vhost--options) -* [`override`](#-apache--vhost--override) -* [`passenger_enabled`](#-apache--vhost--passenger_enabled) -* [`passenger_base_uri`](#-apache--vhost--passenger_base_uri) -* [`passenger_ruby`](#-apache--vhost--passenger_ruby) -* [`passenger_python`](#-apache--vhost--passenger_python) -* [`passenger_nodejs`](#-apache--vhost--passenger_nodejs) -* [`passenger_meteor_app_settings`](#-apache--vhost--passenger_meteor_app_settings) -* [`passenger_app_env`](#-apache--vhost--passenger_app_env) -* [`passenger_app_root`](#-apache--vhost--passenger_app_root) -* [`passenger_app_group_name`](#-apache--vhost--passenger_app_group_name) -* [`passenger_app_start_command`](#-apache--vhost--passenger_app_start_command) -* [`passenger_app_type`](#-apache--vhost--passenger_app_type) -* [`passenger_startup_file`](#-apache--vhost--passenger_startup_file) -* [`passenger_restart_dir`](#-apache--vhost--passenger_restart_dir) -* [`passenger_spawn_method`](#-apache--vhost--passenger_spawn_method) -* [`passenger_load_shell_envvars`](#-apache--vhost--passenger_load_shell_envvars) -* [`passenger_preload_bundler`](#-apache--vhost--passenger_preload_bundler) -* [`passenger_rolling_restarts`](#-apache--vhost--passenger_rolling_restarts) -* [`passenger_resist_deployment_errors`](#-apache--vhost--passenger_resist_deployment_errors) -* [`passenger_user`](#-apache--vhost--passenger_user) -* [`passenger_group`](#-apache--vhost--passenger_group) -* [`passenger_friendly_error_pages`](#-apache--vhost--passenger_friendly_error_pages) -* [`passenger_min_instances`](#-apache--vhost--passenger_min_instances) -* [`passenger_max_instances`](#-apache--vhost--passenger_max_instances) -* [`passenger_max_preloader_idle_time`](#-apache--vhost--passenger_max_preloader_idle_time) -* [`passenger_force_max_concurrent_requests_per_process`](#-apache--vhost--passenger_force_max_concurrent_requests_per_process) -* [`passenger_start_timeout`](#-apache--vhost--passenger_start_timeout) -* [`passenger_concurrency_model`](#-apache--vhost--passenger_concurrency_model) -* [`passenger_thread_count`](#-apache--vhost--passenger_thread_count) -* [`passenger_max_requests`](#-apache--vhost--passenger_max_requests) -* [`passenger_max_request_time`](#-apache--vhost--passenger_max_request_time) -* [`passenger_memory_limit`](#-apache--vhost--passenger_memory_limit) -* [`passenger_stat_throttle_rate`](#-apache--vhost--passenger_stat_throttle_rate) -* [`passenger_pre_start`](#-apache--vhost--passenger_pre_start) -* [`passenger_high_performance`](#-apache--vhost--passenger_high_performance) -* [`passenger_buffer_upload`](#-apache--vhost--passenger_buffer_upload) -* [`passenger_buffer_response`](#-apache--vhost--passenger_buffer_response) -* [`passenger_error_override`](#-apache--vhost--passenger_error_override) -* [`passenger_max_request_queue_size`](#-apache--vhost--passenger_max_request_queue_size) -* [`passenger_max_request_queue_time`](#-apache--vhost--passenger_max_request_queue_time) -* [`passenger_sticky_sessions`](#-apache--vhost--passenger_sticky_sessions) -* [`passenger_sticky_sessions_cookie_name`](#-apache--vhost--passenger_sticky_sessions_cookie_name) -* [`passenger_sticky_sessions_cookie_attributes`](#-apache--vhost--passenger_sticky_sessions_cookie_attributes) -* [`passenger_allow_encoded_slashes`](#-apache--vhost--passenger_allow_encoded_slashes) -* [`passenger_app_log_file`](#-apache--vhost--passenger_app_log_file) -* [`passenger_debugger`](#-apache--vhost--passenger_debugger) -* [`passenger_lve_min_uid`](#-apache--vhost--passenger_lve_min_uid) -* [`php_values`](#-apache--vhost--php_values) -* [`php_flags`](#-apache--vhost--php_flags) -* [`php_admin_values`](#-apache--vhost--php_admin_values) -* [`php_admin_flags`](#-apache--vhost--php_admin_flags) -* [`port`](#-apache--vhost--port) -* [`priority`](#-apache--vhost--priority) -* [`protocols`](#-apache--vhost--protocols) -* [`protocols_honor_order`](#-apache--vhost--protocols_honor_order) -* [`proxy_dest`](#-apache--vhost--proxy_dest) -* [`proxy_pass`](#-apache--vhost--proxy_pass) -* [`proxy_dest_match`](#-apache--vhost--proxy_dest_match) -* [`proxy_dest_reverse_match`](#-apache--vhost--proxy_dest_reverse_match) -* [`proxy_pass_match`](#-apache--vhost--proxy_pass_match) -* [`redirect_dest`](#-apache--vhost--redirect_dest) -* [`redirect_source`](#-apache--vhost--redirect_source) -* [`redirect_status`](#-apache--vhost--redirect_status) -* [`redirectmatch_regexp`](#-apache--vhost--redirectmatch_regexp) -* [`redirectmatch_status`](#-apache--vhost--redirectmatch_status) -* [`redirectmatch_dest`](#-apache--vhost--redirectmatch_dest) -* [`request_headers`](#-apache--vhost--request_headers) -* [`rewrites`](#-apache--vhost--rewrites) -* [`rewrite_base`](#-apache--vhost--rewrite_base) -* [`rewrite_rule`](#-apache--vhost--rewrite_rule) -* [`rewrite_cond`](#-apache--vhost--rewrite_cond) -* [`rewrite_inherit`](#-apache--vhost--rewrite_inherit) -* [`scriptalias`](#-apache--vhost--scriptalias) -* [`scriptaliases`](#-apache--vhost--scriptaliases) -* [`serveradmin`](#-apache--vhost--serveradmin) -* [`serveraliases`](#-apache--vhost--serveraliases) -* [`servername`](#-apache--vhost--servername) -* [`setenv`](#-apache--vhost--setenv) -* [`setenvif`](#-apache--vhost--setenvif) -* [`setenvifnocase`](#-apache--vhost--setenvifnocase) -* [`suexec_user_group`](#-apache--vhost--suexec_user_group) -* [`vhost_name`](#-apache--vhost--vhost_name) -* [`virtual_docroot`](#-apache--vhost--virtual_docroot) -* [`virtual_use_default_docroot`](#-apache--vhost--virtual_use_default_docroot) -* [`wsgi_daemon_process`](#-apache--vhost--wsgi_daemon_process) -* [`wsgi_daemon_process_options`](#-apache--vhost--wsgi_daemon_process_options) -* [`wsgi_application_group`](#-apache--vhost--wsgi_application_group) -* [`wsgi_import_script`](#-apache--vhost--wsgi_import_script) -* [`wsgi_import_script_options`](#-apache--vhost--wsgi_import_script_options) -* [`wsgi_chunked_request`](#-apache--vhost--wsgi_chunked_request) -* [`wsgi_process_group`](#-apache--vhost--wsgi_process_group) -* [`wsgi_script_aliases`](#-apache--vhost--wsgi_script_aliases) -* [`wsgi_script_aliases_match`](#-apache--vhost--wsgi_script_aliases_match) -* [`wsgi_pass_authorization`](#-apache--vhost--wsgi_pass_authorization) -* [`directories`](#-apache--vhost--directories) -* [`custom_fragment`](#-apache--vhost--custom_fragment) -* [`headers`](#-apache--vhost--headers) -* [`shib_compat_valid_user`](#-apache--vhost--shib_compat_valid_user) -* [`ssl_options`](#-apache--vhost--ssl_options) -* [`additional_includes`](#-apache--vhost--additional_includes) -* [`gssapi`](#-apache--vhost--gssapi) -* [`ssl`](#-apache--vhost--ssl) -* [`ssl_ca`](#-apache--vhost--ssl_ca) -* [`ssl_cert`](#-apache--vhost--ssl_cert) -* [`ssl_protocol`](#-apache--vhost--ssl_protocol) -* [`ssl_cipher`](#-apache--vhost--ssl_cipher) -* [`ssl_honorcipherorder`](#-apache--vhost--ssl_honorcipherorder) -* [`ssl_certs_dir`](#-apache--vhost--ssl_certs_dir) -* [`ssl_chain`](#-apache--vhost--ssl_chain) -* [`ssl_crl`](#-apache--vhost--ssl_crl) -* [`ssl_crl_path`](#-apache--vhost--ssl_crl_path) -* [`ssl_crl_check`](#-apache--vhost--ssl_crl_check) -* [`ssl_key`](#-apache--vhost--ssl_key) -* [`ssl_verify_client`](#-apache--vhost--ssl_verify_client) -* [`ssl_verify_depth`](#-apache--vhost--ssl_verify_depth) -* [`ssl_proxy_protocol`](#-apache--vhost--ssl_proxy_protocol) -* [`ssl_proxy_verify`](#-apache--vhost--ssl_proxy_verify) -* [`ssl_proxy_verify_depth`](#-apache--vhost--ssl_proxy_verify_depth) -* [`ssl_proxy_cipher_suite`](#-apache--vhost--ssl_proxy_cipher_suite) -* [`ssl_proxy_ca_cert`](#-apache--vhost--ssl_proxy_ca_cert) -* [`ssl_proxy_machine_cert`](#-apache--vhost--ssl_proxy_machine_cert) -* [`ssl_proxy_machine_cert_chain`](#-apache--vhost--ssl_proxy_machine_cert_chain) -* [`ssl_proxy_check_peer_cn`](#-apache--vhost--ssl_proxy_check_peer_cn) -* [`ssl_proxy_check_peer_name`](#-apache--vhost--ssl_proxy_check_peer_name) -* [`ssl_proxy_check_peer_expire`](#-apache--vhost--ssl_proxy_check_peer_expire) -* [`ssl_openssl_conf_cmd`](#-apache--vhost--ssl_openssl_conf_cmd) -* [`ssl_proxyengine`](#-apache--vhost--ssl_proxyengine) -* [`ssl_stapling`](#-apache--vhost--ssl_stapling) -* [`ssl_stapling_timeout`](#-apache--vhost--ssl_stapling_timeout) -* [`ssl_stapling_return_errors`](#-apache--vhost--ssl_stapling_return_errors) -* [`ssl_user_name`](#-apache--vhost--ssl_user_name) -* [`ssl_reload_on_change`](#-apache--vhost--ssl_reload_on_change) -* [`use_canonical_name`](#-apache--vhost--use_canonical_name) -* [`define`](#-apache--vhost--define) -* [`auth_oidc`](#-apache--vhost--auth_oidc) -* [`oidc_settings`](#-apache--vhost--oidc_settings) -* [`limitreqfields`](#-apache--vhost--limitreqfields) -* [`limitreqfieldsize`](#-apache--vhost--limitreqfieldsize) -* [`limitreqline`](#-apache--vhost--limitreqline) -* [`limitreqbody`](#-apache--vhost--limitreqbody) -* [`use_servername_for_filenames`](#-apache--vhost--use_servername_for_filenames) -* [`use_port_for_filenames`](#-apache--vhost--use_port_for_filenames) -* [`mdomain`](#-apache--vhost--mdomain) -* [`proxy_requests`](#-apache--vhost--proxy_requests) -* [`userdir`](#-apache--vhost--userdir) - -##### `access_log` +* [`access_log`](#access_log) +* [`access_log_env_var`](#access_log_env_var) +* [`access_log_file`](#access_log_file) +* [`access_log_format`](#access_log_format) +* [`access_log_pipe`](#access_log_pipe) +* [`access_log_syslog`](#access_log_syslog) +* [`access_logs`](#access_logs) +* [`add_default_charset`](#add_default_charset) +* [`add_listen`](#add_listen) +* [`use_optional_includes`](#use_optional_includes) +* [`aliases`](#aliases) +* [`allow_encoded_slashes`](#allow_encoded_slashes) +* [`block`](#block) +* [`cas_attribute_prefix`](#cas_attribute_prefix) +* [`cas_attribute_delimiter`](#cas_attribute_delimiter) +* [`cas_login_url`](#cas_login_url) +* [`cas_root_proxied_as`](#cas_root_proxied_as) +* [`cas_scrub_request_headers`](#cas_scrub_request_headers) +* [`cas_sso_enabled`](#cas_sso_enabled) +* [`cas_validate_saml`](#cas_validate_saml) +* [`cas_validate_url`](#cas_validate_url) +* [`cas_cookie_path`](#cas_cookie_path) +* [`comment`](#comment) +* [`default_vhost`](#default_vhost) +* [`directoryindex`](#directoryindex) +* [`docroot`](#docroot) +* [`docroot_group`](#docroot_group) +* [`docroot_owner`](#docroot_owner) +* [`docroot_mode`](#docroot_mode) +* [`manage_docroot`](#manage_docroot) +* [`error_log`](#error_log) +* [`error_log_file`](#error_log_file) +* [`error_log_pipe`](#error_log_pipe) +* [`error_log_syslog`](#error_log_syslog) +* [`error_log_format`](#error_log_format) +* [`error_documents`](#error_documents) +* [`ensure`](#ensure) +* [`fallbackresource`](#fallbackresource) +* [`filters`](#filters) +* [`h2_copy_files`](#h2_copy_files) +* [`h2_direct`](#h2_direct) +* [`h2_early_hints`](#h2_early_hints) +* [`h2_max_session_streams`](#h2_max_session_streams) +* [`h2_modern_tls_only`](#h2_modern_tls_only) +* [`h2_push`](#h2_push) +* [`h2_push_diary_size`](#h2_push_diary_size) +* [`h2_push_priority`](#h2_push_priority) +* [`h2_push_resource`](#h2_push_resource) +* [`h2_serialize_headers`](#h2_serialize_headers) +* [`h2_stream_max_mem_size`](#h2_stream_max_mem_size) +* [`h2_tls_cool_down_secs`](#h2_tls_cool_down_secs) +* [`h2_tls_warm_up_size`](#h2_tls_warm_up_size) +* [`h2_upgrade`](#h2_upgrade) +* [`h2_window_size`](#h2_window_size) +* [`ip`](#ip) +* [`ip_based`](#ip_based) +* [`itk`](#itk) +* [`action`](#action) +* [`jk_mounts`](#jk_mounts) +* [`http_protocol_options`](#http_protocol_options) +* [`keepalive`](#keepalive) +* [`keepalive_timeout`](#keepalive_timeout) +* [`max_keepalive_requests`](#max_keepalive_requests) +* [`auth_kerb`](#auth_kerb) +* [`krb_method_negotiate`](#krb_method_negotiate) +* [`krb_method_k5passwd`](#krb_method_k5passwd) +* [`krb_authoritative`](#krb_authoritative) +* [`krb_auth_realms`](#krb_auth_realms) +* [`krb_5keytab`](#krb_5keytab) +* [`krb_local_user_mapping`](#krb_local_user_mapping) +* [`krb_verify_kdc`](#krb_verify_kdc) +* [`krb_servicename`](#krb_servicename) +* [`krb_save_credentials`](#krb_save_credentials) +* [`logroot`](#logroot) +* [`logroot_ensure`](#logroot_ensure) +* [`logroot_mode`](#logroot_mode) +* [`logroot_owner`](#logroot_owner) +* [`logroot_group`](#logroot_group) +* [`log_level`](#log_level) +* [`modsec_body_limit`](#modsec_body_limit) +* [`modsec_disable_vhost`](#modsec_disable_vhost) +* [`modsec_disable_ids`](#modsec_disable_ids) +* [`modsec_disable_ips`](#modsec_disable_ips) +* [`modsec_disable_msgs`](#modsec_disable_msgs) +* [`modsec_disable_tags`](#modsec_disable_tags) +* [`modsec_audit_log_file`](#modsec_audit_log_file) +* [`modsec_audit_log_pipe`](#modsec_audit_log_pipe) +* [`modsec_audit_log`](#modsec_audit_log) +* [`modsec_inbound_anomaly_threshold`](#modsec_inbound_anomaly_threshold) +* [`modsec_outbound_anomaly_threshold`](#modsec_outbound_anomaly_threshold) +* [`modsec_allowed_methods`](#modsec_allowed_methods) +* [`no_proxy_uris`](#no_proxy_uris) +* [`no_proxy_uris_match`](#no_proxy_uris_match) +* [`proxy_preserve_host`](#proxy_preserve_host) +* [`proxy_add_headers`](#proxy_add_headers) +* [`proxy_error_override`](#proxy_error_override) +* [`options`](#options) +* [`override`](#override) +* [`passenger_enabled`](#passenger_enabled) +* [`passenger_base_uri`](#passenger_base_uri) +* [`passenger_ruby`](#passenger_ruby) +* [`passenger_python`](#passenger_python) +* [`passenger_nodejs`](#passenger_nodejs) +* [`passenger_meteor_app_settings`](#passenger_meteor_app_settings) +* [`passenger_app_env`](#passenger_app_env) +* [`passenger_app_root`](#passenger_app_root) +* [`passenger_app_group_name`](#passenger_app_group_name) +* [`passenger_app_start_command`](#passenger_app_start_command) +* [`passenger_app_type`](#passenger_app_type) +* [`passenger_startup_file`](#passenger_startup_file) +* [`passenger_restart_dir`](#passenger_restart_dir) +* [`passenger_spawn_method`](#passenger_spawn_method) +* [`passenger_load_shell_envvars`](#passenger_load_shell_envvars) +* [`passenger_preload_bundler`](#passenger_preload_bundler) +* [`passenger_rolling_restarts`](#passenger_rolling_restarts) +* [`passenger_resist_deployment_errors`](#passenger_resist_deployment_errors) +* [`passenger_user`](#passenger_user) +* [`passenger_group`](#passenger_group) +* [`passenger_friendly_error_pages`](#passenger_friendly_error_pages) +* [`passenger_min_instances`](#passenger_min_instances) +* [`passenger_max_instances`](#passenger_max_instances) +* [`passenger_max_preloader_idle_time`](#passenger_max_preloader_idle_time) +* [`passenger_force_max_concurrent_requests_per_process`](#passenger_force_max_concurrent_requests_per_process) +* [`passenger_start_timeout`](#passenger_start_timeout) +* [`passenger_concurrency_model`](#passenger_concurrency_model) +* [`passenger_thread_count`](#passenger_thread_count) +* [`passenger_max_requests`](#passenger_max_requests) +* [`passenger_max_request_time`](#passenger_max_request_time) +* [`passenger_memory_limit`](#passenger_memory_limit) +* [`passenger_stat_throttle_rate`](#passenger_stat_throttle_rate) +* [`passenger_pre_start`](#passenger_pre_start) +* [`passenger_high_performance`](#passenger_high_performance) +* [`passenger_buffer_upload`](#passenger_buffer_upload) +* [`passenger_buffer_response`](#passenger_buffer_response) +* [`passenger_error_override`](#passenger_error_override) +* [`passenger_max_request_queue_size`](#passenger_max_request_queue_size) +* [`passenger_max_request_queue_time`](#passenger_max_request_queue_time) +* [`passenger_sticky_sessions`](#passenger_sticky_sessions) +* [`passenger_sticky_sessions_cookie_name`](#passenger_sticky_sessions_cookie_name) +* [`passenger_sticky_sessions_cookie_attributes`](#passenger_sticky_sessions_cookie_attributes) +* [`passenger_allow_encoded_slashes`](#passenger_allow_encoded_slashes) +* [`passenger_app_log_file`](#passenger_app_log_file) +* [`passenger_debugger`](#passenger_debugger) +* [`passenger_lve_min_uid`](#passenger_lve_min_uid) +* [`php_values`](#php_values) +* [`php_flags`](#php_flags) +* [`php_admin_values`](#php_admin_values) +* [`php_admin_flags`](#php_admin_flags) +* [`port`](#port) +* [`priority`](#priority) +* [`protocols`](#protocols) +* [`protocols_honor_order`](#protocols_honor_order) +* [`proxy_dest`](#proxy_dest) +* [`proxy_pass`](#proxy_pass) +* [`proxy_dest_match`](#proxy_dest_match) +* [`proxy_dest_reverse_match`](#proxy_dest_reverse_match) +* [`proxy_pass_match`](#proxy_pass_match) +* [`redirect_dest`](#redirect_dest) +* [`redirect_source`](#redirect_source) +* [`redirect_status`](#redirect_status) +* [`redirectmatch_regexp`](#redirectmatch_regexp) +* [`redirectmatch_status`](#redirectmatch_status) +* [`redirectmatch_dest`](#redirectmatch_dest) +* [`request_headers`](#request_headers) +* [`rewrites`](#rewrites) +* [`rewrite_base`](#rewrite_base) +* [`rewrite_rule`](#rewrite_rule) +* [`rewrite_cond`](#rewrite_cond) +* [`rewrite_inherit`](#rewrite_inherit) +* [`scriptalias`](#scriptalias) +* [`scriptaliases`](#scriptaliases) +* [`serveradmin`](#serveradmin) +* [`serveraliases`](#serveraliases) +* [`servername`](#servername) +* [`setenv`](#setenv) +* [`setenvif`](#setenvif) +* [`setenvifnocase`](#setenvifnocase) +* [`suexec_user_group`](#suexec_user_group) +* [`vhost_name`](#vhost_name) +* [`virtual_docroot`](#virtual_docroot) +* [`virtual_use_default_docroot`](#virtual_use_default_docroot) +* [`wsgi_daemon_process`](#wsgi_daemon_process) +* [`wsgi_daemon_process_options`](#wsgi_daemon_process_options) +* [`wsgi_application_group`](#wsgi_application_group) +* [`wsgi_import_script`](#wsgi_import_script) +* [`wsgi_import_script_options`](#wsgi_import_script_options) +* [`wsgi_chunked_request`](#wsgi_chunked_request) +* [`wsgi_process_group`](#wsgi_process_group) +* [`wsgi_script_aliases`](#wsgi_script_aliases) +* [`wsgi_script_aliases_match`](#wsgi_script_aliases_match) +* [`wsgi_pass_authorization`](#wsgi_pass_authorization) +* [`directories`](#directories) +* [`custom_fragment`](#custom_fragment) +* [`headers`](#headers) +* [`shib_compat_valid_user`](#shib_compat_valid_user) +* [`ssl_options`](#ssl_options) +* [`additional_includes`](#additional_includes) +* [`gssapi`](#gssapi) +* [`authz_core`](#authz_core) +* [`ssl`](#ssl) +* [`ssl_ca`](#ssl_ca) +* [`ssl_cert`](#ssl_cert) +* [`ssl_protocol`](#ssl_protocol) +* [`ssl_cipher`](#ssl_cipher) +* [`ssl_honorcipherorder`](#ssl_honorcipherorder) +* [`ssl_certs_dir`](#ssl_certs_dir) +* [`ssl_chain`](#ssl_chain) +* [`ssl_crl`](#ssl_crl) +* [`ssl_crl_path`](#ssl_crl_path) +* [`ssl_crl_check`](#ssl_crl_check) +* [`ssl_key`](#ssl_key) +* [`ssl_verify_client`](#ssl_verify_client) +* [`ssl_verify_depth`](#ssl_verify_depth) +* [`ssl_proxy_protocol`](#ssl_proxy_protocol) +* [`ssl_proxy_verify`](#ssl_proxy_verify) +* [`ssl_proxy_verify_depth`](#ssl_proxy_verify_depth) +* [`ssl_proxy_cipher_suite`](#ssl_proxy_cipher_suite) +* [`ssl_proxy_ca_cert`](#ssl_proxy_ca_cert) +* [`ssl_proxy_machine_cert`](#ssl_proxy_machine_cert) +* [`ssl_proxy_machine_cert_chain`](#ssl_proxy_machine_cert_chain) +* [`ssl_proxy_check_peer_cn`](#ssl_proxy_check_peer_cn) +* [`ssl_proxy_check_peer_name`](#ssl_proxy_check_peer_name) +* [`ssl_proxy_check_peer_expire`](#ssl_proxy_check_peer_expire) +* [`ssl_openssl_conf_cmd`](#ssl_openssl_conf_cmd) +* [`ssl_proxyengine`](#ssl_proxyengine) +* [`ssl_stapling`](#ssl_stapling) +* [`ssl_stapling_timeout`](#ssl_stapling_timeout) +* [`ssl_stapling_return_errors`](#ssl_stapling_return_errors) +* [`ssl_user_name`](#ssl_user_name) +* [`ssl_reload_on_change`](#ssl_reload_on_change) +* [`use_canonical_name`](#use_canonical_name) +* [`define`](#define) +* [`auth_oidc`](#auth_oidc) +* [`oidc_settings`](#oidc_settings) +* [`limitreqfields`](#limitreqfields) +* [`limitreqfieldsize`](#limitreqfieldsize) +* [`limitreqline`](#limitreqline) +* [`limitreqbody`](#limitreqbody) +* [`use_servername_for_filenames`](#use_servername_for_filenames) +* [`use_port_for_filenames`](#use_port_for_filenames) +* [`mdomain`](#mdomain) +* [`proxy_requests`](#proxy_requests) +* [`userdir`](#userdir) + +##### `access_log` Data type: `Boolean` Determines whether to configure `*_access.log` directives (`*_file`, `*_pipe`, or `*_syslog`). -Default value: `true` +Default value: ``true`` -##### `access_log_env_var` +##### `access_log_env_var` Data type: `Optional[Variant[Boolean, String]]` Specifies that only requests with particular environment variables be logged. -Default value: `undef` +Default value: ``undef`` -##### `access_log_file` +##### `access_log_file` Data type: `Optional[String[1]]` @@ -7907,52 +7940,52 @@ instance, example.com--- it defaults to 'example.com_ssl.log' for [SSL-encrypted](https://httpd.apache.org/docs/current/ssl/index.html) virtual hosts and `example.com_access.log` for unencrypted virtual hosts. -Default value: `undef` +Default value: ``undef`` -##### `access_log_format` +##### `access_log_format` Data type: `Optional[String[1]]` Specifies the use of either a `LogFormat` nickname or a custom-formatted string for the access log. -Default value: `undef` +Default value: ``undef`` -##### `access_log_pipe` +##### `access_log_pipe` Data type: `Optional[String[1]]` Specifies a pipe where Apache sends access log messages. -Default value: `undef` +Default value: ``undef`` -##### `access_log_syslog` +##### `access_log_syslog` Data type: `Optional[Variant[String, Boolean]]` Sends all access log messages to syslog. -Default value: `undef` +Default value: ``undef`` -##### `access_logs` +##### `access_logs` Data type: `Optional[Array[Hash]]` Allows you to give a hash that specifies the state of each of the `access_log_*` directives shown above, i.e. `access_log_pipe` and `access_log_syslog`. -Default value: `undef` +Default value: ``undef`` -##### `add_default_charset` +##### `add_default_charset` Data type: `Optional[String]` Sets a default media charset value for the `AddDefaultCharset` directive, which is added to `text/plain` and `text/html` responses. -Default value: `undef` +Default value: ``undef`` -##### `add_listen` +##### `add_listen` Data type: `Boolean` @@ -7961,9 +7994,9 @@ Setting `add_listen` to `false` prevents the virtual host from creating a `Liste statement. This is important when combining virtual hosts that aren't passed an `ip` parameter with those that are. -Default value: `true` +Default value: ``true`` -##### `use_optional_includes` +##### `use_optional_includes` Data type: `Boolean` @@ -7972,7 +8005,7 @@ Specifies whether Apache uses the `IncludeOptional` directive instead of `Includ Default value: `$apache::use_optional_includes` -##### `aliases` +##### `aliases` Data type: `Array[Hash[String[1], String[1]]]` @@ -8015,18 +8048,18 @@ directive might not be able to honor the `PassengerEnabled => off` statement. Se Default value: `[]` -##### `allow_encoded_slashes` +##### `allow_encoded_slashes` -Data type: `Optional[Enum['on', 'off', 'nodecode']]` +Data type: `Optional[Variant[Apache::OnOff, Enum['nodecode']]]` Sets the `AllowEncodedSlashes` declaration for the virtual host, overriding the server default. This modifies the virtual host responses to URLs with `\` and `/` characters. The default setting omits the declaration from the server configuration and selects the Apache default setting of `Off`. -Default value: `undef` +Default value: ``undef`` -##### `block` +##### `block` Data type: `Variant[Array[String], String]` @@ -8035,83 +8068,83 @@ blocks web access to `.svn`), `.git`, and `.bzr` directories. Default value: `[]` -##### `cas_attribute_prefix` +##### `cas_attribute_prefix` Data type: `Optional[String]` Adds a header with the value of this header being the attribute values when SAML validation is enabled. -Default value: `undef` +Default value: ``undef`` -##### `cas_attribute_delimiter` +##### `cas_attribute_delimiter` Data type: `Optional[String]` Sets the delimiter between attribute values in the header created by `cas_attribute_prefix`. -Default value: `undef` +Default value: ``undef`` -##### `cas_login_url` +##### `cas_login_url` Data type: `Optional[String]` Sets the URL to which the module redirects users when they attempt to access a CAS-protected resource and don't have an active session. -Default value: `undef` +Default value: ``undef`` -##### `cas_root_proxied_as` +##### `cas_root_proxied_as` Data type: `Optional[String]` Sets the URL end users see when access to this Apache server is proxied per vhost. This URL should not include a trailing slash. -Default value: `undef` +Default value: ``undef`` -##### `cas_scrub_request_headers` +##### `cas_scrub_request_headers` Data type: `Boolean` Remove inbound request headers that may have special meaning within mod_auth_cas. -Default value: `false` +Default value: ``false`` -##### `cas_sso_enabled` +##### `cas_sso_enabled` Data type: `Boolean` Enables experimental support for single sign out (may mangle POST data). -Default value: `false` +Default value: ``false`` -##### `cas_validate_saml` +##### `cas_validate_saml` Data type: `Boolean` Parse response from CAS server for SAML. -Default value: `false` +Default value: ``false`` -##### `cas_validate_url` +##### `cas_validate_url` Data type: `Optional[String]` Sets the URL to use when validating a client-presented ticket in an HTTP query string. -Default value: `undef` +Default value: ``undef`` -##### `cas_cookie_path` +##### `cas_cookie_path` Data type: `Optional[String]` Sets the location where information on the current session should be stored. This should be writable by the web server only. -Default value: `undef` +Default value: ``undef`` -##### `comment` +##### `comment` Data type: `Optional[Variant[String, Array[String]]]` @@ -8128,18 +8161,18 @@ comment => [ ] ``` -Default value: `undef` +Default value: ``undef`` -##### `default_vhost` +##### `default_vhost` Data type: `Boolean` Sets a given `apache::vhost` defined type as the default to serve requests that do not match any other `apache::vhost` defined types. -Default value: `false` +Default value: ``false`` -##### `directoryindex` +##### `directoryindex` Data type: `Optional[String]` @@ -8147,9 +8180,9 @@ Sets the list of resources to look for when a client requests an index of the di by specifying a '/' at the end of the directory name. See the `DirectoryIndex` directive documentation for details. -Default value: `undef` +Default value: ``undef`` -##### `docroot` +##### `docroot` Data type: `Variant[Stdlib::Absolutepath, Boolean]` @@ -8158,7 +8191,7 @@ Sets the `DocumentRoot` location, from which Apache serves files.
If `docroot` and `manage_docroot` are both set to `false`, no `DocumentRoot` will be set and the accompanying `` block will not be created. -##### `docroot_group` +##### `docroot_group` Data type: `String` @@ -8166,7 +8199,7 @@ Sets group access to the `docroot` directory. Default value: `$apache::params::root_group` -##### `docroot_owner` +##### `docroot_owner` Data type: `String` @@ -8174,31 +8207,31 @@ Sets individual user access to the `docroot` directory. Default value: `'root'` -##### `docroot_mode` +##### `docroot_mode` Data type: `Optional[Stdlib::Filemode]` Sets access permissions for the `docroot` directory, in numeric notation. -Default value: `undef` +Default value: ``undef`` -##### `manage_docroot` +##### `manage_docroot` Data type: `Boolean` Determines whether Puppet manages the `docroot` directory. -Default value: `true` +Default value: ``true`` -##### `error_log` +##### `error_log` Data type: `Boolean` Specifies whether `*_error.log` directives should be configured. -Default value: `true` +Default value: ``true`` -##### `error_log_file` +##### `error_log_file` Data type: `Optional[String]` @@ -8208,9 +8241,9 @@ If none of these parameters is set, given a virtual host `example.com`, Puppet d to `$logroot/example.com_error_ssl.log` for SSL virtual hosts and `$logroot/example.com_error.log` for non-SSL virtual hosts. -Default value: `undef` +Default value: ``undef`` -##### `error_log_pipe` +##### `error_log_pipe` Data type: `Optional[String]` @@ -8218,9 +8251,9 @@ Specifies a pipe to send error log messages to.
This parameter has no effect if the `error_log_file` parameter has a value. If neither this parameter nor `error_log_file` has a value, Puppet then checks `error_log_syslog`. -Default value: `undef` +Default value: ``undef`` -##### `error_log_syslog` +##### `error_log_syslog` Data type: `Optional[Variant[String, Boolean]]` @@ -8230,22 +8263,18 @@ parameters has a value. If none of these parameters has a value, given a virtual `example.com`, Puppet defaults to `$logroot/example.com_error_ssl.log` for SSL virtual hosts and `$logroot/example.com_error.log` for non-SSL virtual hosts. -Default value: `undef` +Default value: ``undef`` -##### `error_log_format` +##### `error_log_format` -Data type: - -```puppet -Optional[ +Data type: `Optional[ Array[ Variant[ String, Hash[String, Enum['connection', 'request']] ] ] - ] -``` + ]` Sets the [ErrorLogFormat](https://httpd.apache.org/docs/current/mod/core.html#errorlogformat) format specification for error log entries inside virtual host @@ -8263,9 +8292,9 @@ apache::vhost { 'site.name.fdqn': } ``` -Default value: `undef` +Default value: ``undef`` -##### `error_documents` +##### `error_documents` Data type: `Variant[Array[Hash], String]` @@ -8284,7 +8313,7 @@ apache::vhost { 'sample.example.net': Default value: `[]` -##### `ensure` +##### `ensure` Data type: `Enum['absent', 'present']` @@ -8292,7 +8321,7 @@ Specifies if the virtual host is present or absent.
Default value: `'present'` -##### `fallbackresource` +##### `fallbackresource` Data type: `Optional[Variant[Stdlib::Absolutepath, Enum['disabled']]]` @@ -8301,9 +8330,9 @@ directive, which specifies an action to take for any URL that doesn't map to any your filesystem and would otherwise return 'HTTP 404 (Not Found)'. Values must either begin with a `/` or be `disabled`. -Default value: `undef` +Default value: ``undef`` -##### `filters` +##### `filters` Data type: `Array[String[1]]` @@ -8322,25 +8351,25 @@ apache::vhost { "$::fqdn": Default value: `[]` -##### `h2_copy_files` +##### `h2_copy_files` Data type: `Optional[Boolean]` Sets the [H2CopyFiles](https://httpd.apache.org/docs/current/mod/mod_http2.html#h2copyfiles) directive which influences how the requestion process pass files to the main connection. -Default value: `undef` +Default value: ``undef`` -##### `h2_direct` +##### `h2_direct` Data type: `Optional[Boolean]` Sets the [H2Direct](https://httpd.apache.org/docs/current/mod/mod_http2.html#h2direct) directive which toggles the usage of the HTTP/2 Direct Mode. -Default value: `undef` +Default value: ``undef`` -##### `h2_early_hints` +##### `h2_early_hints` Data type: `Optional[Boolean]` @@ -8348,9 +8377,9 @@ Sets the [H2EarlyHints](https://httpd.apache.org/docs/current/mod/mod_http2.html directive which controls if HTTP status 103 interim responses are forwarded to the client or not. -Default value: `undef` +Default value: ``undef`` -##### `h2_max_session_streams` +##### `h2_max_session_streams` Data type: `Optional[Integer]` @@ -8358,27 +8387,27 @@ Sets the [H2MaxSessionStreams](https://httpd.apache.org/docs/current/mod/mod_htt directive which sets the maximum number of active streams per HTTP/2 session that the server allows. -Default value: `undef` +Default value: ``undef`` -##### `h2_modern_tls_only` +##### `h2_modern_tls_only` Data type: `Optional[Boolean]` Sets the [H2ModernTLSOnly](https://httpd.apache.org/docs/current/mod/mod_http2.html#h2moderntlsonly) directive which toggles the security checks on HTTP/2 connections in TLS mode. -Default value: `undef` +Default value: ``undef`` -##### `h2_push` +##### `h2_push` Data type: `Optional[Boolean]` Sets the [H2Push](https://httpd.apache.org/docs/current/mod/mod_http2.html#h2push) directive which toggles the usage of the HTTP/2 server push protocol feature. -Default value: `undef` +Default value: ``undef`` -##### `h2_push_diary_size` +##### `h2_push_diary_size` Data type: `Optional[Integer]` @@ -8386,9 +8415,9 @@ Sets the [H2PushDiarySize](https://httpd.apache.org/docs/current/mod/mod_http2.h directive which toggles the maximum number of HTTP/2 server pushes that are remembered per HTTP/2 connection. -Default value: `undef` +Default value: ``undef`` -##### `h2_push_priority` +##### `h2_push_priority` Data type: `Array[String]` @@ -8398,7 +8427,7 @@ content-type of the response. Default value: `[]` -##### `h2_push_resource` +##### `h2_push_resource` Data type: `Array[String]` @@ -8407,7 +8436,7 @@ directive which declares resources for early pushing to the client. Default value: `[]` -##### `h2_serialize_headers` +##### `h2_serialize_headers` Data type: `Optional[Boolean]` @@ -8415,9 +8444,9 @@ Sets the [H2SerializeHeaders](https://httpd.apache.org/docs/current/mod/mod_http directive which toggles if HTTP/2 requests are serialized in HTTP/1.1 format for processing by httpd core. -Default value: `undef` +Default value: ``undef`` -##### `h2_stream_max_mem_size` +##### `h2_stream_max_mem_size` Data type: `Optional[Integer]` @@ -8425,9 +8454,9 @@ Sets the [H2StreamMaxMemSize](https://httpd.apache.org/docs/current/mod/mod_http directive which sets the maximum number of outgoing data bytes buffered in memory for an active stream. -Default value: `undef` +Default value: ``undef`` -##### `h2_tls_cool_down_secs` +##### `h2_tls_cool_down_secs` Data type: `Optional[Integer]` @@ -8435,9 +8464,9 @@ Sets the [H2TLSCoolDownSecs](https://httpd.apache.org/docs/current/mod/mod_http2 directive which sets the number of seconds of idle time on a TLS connection before the TLS write size falls back to a small (~1300 bytes) length. -Default value: `undef` +Default value: ``undef`` -##### `h2_tls_warm_up_size` +##### `h2_tls_warm_up_size` Data type: `Optional[Integer]` @@ -8445,9 +8474,9 @@ Sets the [H2TLSWarmUpSize](https://httpd.apache.org/docs/current/mod/mod_http2.h directive which sets the number of bytes to be sent in small TLS records (~1300 bytes) until doing maximum sized writes (16k) on https: HTTP/2 connections. -Default value: `undef` +Default value: ``undef`` -##### `h2_upgrade` +##### `h2_upgrade` Data type: `Optional[Boolean]` @@ -8455,9 +8484,9 @@ Sets the [H2Upgrade](https://httpd.apache.org/docs/current/mod/mod_http2.html#h2 directive which toggles the usage of the HTTP/1.1 Upgrade method for switching to HTTP/2. -Default value: `undef` +Default value: ``undef`` -##### `h2_window_size` +##### `h2_window_size` Data type: `Optional[Integer]` @@ -8465,27 +8494,23 @@ Sets the [H2WindowSize](https://httpd.apache.org/docs/current/mod/mod_http2.html directive which sets the size of the window that is used for flow control from client to server and limits the amount of data the server has to buffer. -Default value: `undef` +Default value: ``undef`` -##### `ip` +##### `ip` -Data type: - -```puppet -Optional[ +Data type: `Optional[ Variant[ Array[Variant[Stdlib::IP::Address, Enum['*']]], Variant[Stdlib::IP::Address, Enum['*']] ] - ] -``` + ]` Sets the IP address the virtual host listens on. By default, uses Apache's default behavior of listening on all IPs. -Default value: `undef` +Default value: ``undef`` -##### `ip_based` +##### `ip_based` Data type: `Boolean` @@ -8493,9 +8518,9 @@ Enables an [IP-based](https://httpd.apache.org/docs/current/vhosts/ip-based.html host. This parameter inhibits the creation of a NameVirtualHost directive, since those are used to funnel requests to name-based virtual hosts. -Default value: `false` +Default value: ``false`` -##### `itk` +##### `itk` Data type: `Optional[Hash]` @@ -8519,18 +8544,18 @@ Valid values are: a hash, which can include the keys: * `limituidrange` (Linux 3.5.0 or newer) * `limitgidrange` (Linux 3.5.0 or newer) -Default value: `undef` +Default value: ``undef`` -##### `action` +##### `action` Data type: `Optional[String]` Specifies whether you wish to configure mod_actions action directive which will activate cgi-script when triggered by a request. -Default value: `undef` +Default value: ``undef`` -##### `jk_mounts` +##### `jk_mounts` Data type: `Array[Hash]` @@ -8550,26 +8575,26 @@ apache::vhost { 'sample.example.net': Default value: `[]` -##### `http_protocol_options` +##### `http_protocol_options` Data type: `Optional[Pattern[/^((Strict|Unsafe)?\s*(\b(Registered|Lenient)Methods)?\s*(\b(Allow0\.9|Require1\.0))?)$/]]` Specifies the strictness of HTTP protocol checks. -Default value: `undef` +Default value: ``undef`` -##### `keepalive` +##### `keepalive` -Data type: `Optional[Enum['on', 'off']]` +Data type: `Optional[Apache::OnOff]` Determines whether to enable persistent HTTP connections with the `KeepAlive` directive for the virtual host. By default, the global, server-wide `KeepAlive` setting is in effect.
Use the `keepalive_timeout` and `max_keepalive_requests` parameters to set relevant options for the virtual host. -Default value: `undef` +Default value: ``undef`` -##### `keepalive_timeout` +##### `keepalive_timeout` Data type: `Optional[Variant[Integer, String]]` @@ -8579,9 +8604,9 @@ global, server-wide `KeepAlive` setting is in effect.
This parameter is only relevant if either the global, server-wide `keepalive` parameter or the per-vhost `keepalive` parameter is enabled. -Default value: `undef` +Default value: ``undef`` -##### `max_keepalive_requests` +##### `max_keepalive_requests` Data type: `Optional[Variant[Integer, String]]` @@ -8590,9 +8615,9 @@ the global, server-wide `KeepAlive` setting is in effect.
This parameter is only relevant if either the global, server-wide `keepalive` parameter or the per-vhost `keepalive` parameter is enabled. -Default value: `undef` +Default value: ``undef`` -##### `auth_kerb` +##### `auth_kerb` Data type: `Boolean` @@ -8615,33 +8640,33 @@ apache::vhost { 'sample.example.net': } ``` -Default value: `false` +Default value: ``false`` -##### `krb_method_negotiate` +##### `krb_method_negotiate` -Data type: `Enum['on', 'off']` +Data type: `Apache::OnOff` Determines whether to use the Negotiate method. Default value: `'on'` -##### `krb_method_k5passwd` +##### `krb_method_k5passwd` -Data type: `Enum['on', 'off']` +Data type: `Apache::OnOff` Determines whether to use password-based authentication for Kerberos v5. Default value: `'on'` -##### `krb_authoritative` +##### `krb_authoritative` -Data type: `Enum['on', 'off']` +Data type: `Apache::OnOff` If set to `off`, authentication controls can be passed on to another module. Default value: `'on'` -##### `krb_auth_realms` +##### `krb_auth_realms` Data type: `Array[String]` @@ -8649,32 +8674,32 @@ Specifies an array of Kerberos realms to use for authentication. Default value: `[]` -##### `krb_5keytab` +##### `krb_5keytab` Data type: `Optional[String]` Specifies the Kerberos v5 keytab file's location. -Default value: `undef` +Default value: ``undef`` -##### `krb_local_user_mapping` +##### `krb_local_user_mapping` -Data type: `Optional[Enum['on', 'off']]` +Data type: `Optional[Apache::OnOff]` Strips @REALM from usernames for further use. -Default value: `undef` +Default value: ``undef`` -##### `krb_verify_kdc` +##### `krb_verify_kdc` -Data type: `Enum['on', 'off']` +Data type: `Apache::OnOff` This option can be used to disable the verification tickets against local keytab to prevent KDC spoofing attacks. Default value: `'on'` -##### `krb_servicename` +##### `krb_servicename` Data type: `String` @@ -8683,15 +8708,15 @@ key of this name must be stored in the keytab. Default value: `'HTTP'` -##### `krb_save_credentials` +##### `krb_save_credentials` -Data type: `Enum['on', 'off']` +Data type: `Apache::OnOff` This option enables credential saving functionality. Default value: `'off'` -##### `logroot` +##### `logroot` Data type: `Stdlib::Absolutepath` @@ -8699,7 +8724,7 @@ Specifies the location of the virtual host's logfiles. Default value: `$apache::logroot` -##### `logroot_ensure` +##### `logroot_ensure` Data type: `Enum['directory', 'absent']` @@ -8707,7 +8732,7 @@ Determines whether or not to remove the logroot directory for a virtual host. Default value: `'directory'` -##### `logroot_mode` +##### `logroot_mode` Data type: `Optional[Stdlib::Filemode]` @@ -8715,49 +8740,49 @@ Overrides the mode the logroot directory is set to. Do *not* grant write access directory the logs are stored in without being aware of the consequences; for more information, see [Apache's log security documentation](https://httpd.apache.org/docs/2.4/logs.html#security). -Default value: `undef` +Default value: ``undef`` -##### `logroot_owner` +##### `logroot_owner` Data type: `Optional[String]` Sets individual user access to the logroot directory. -Default value: `undef` +Default value: ``undef`` -##### `logroot_group` +##### `logroot_group` Data type: `Optional[String]` Sets group access to the `logroot` directory. -Default value: `undef` +Default value: ``undef`` -##### `log_level` +##### `log_level` Data type: `Optional[Apache::LogLevel]` Specifies the verbosity of the error log. -Default value: `undef` +Default value: ``undef`` -##### `modsec_body_limit` +##### `modsec_body_limit` Data type: `Optional[String]` Configures the maximum request body size (in bytes) ModSecurity accepts for buffering. -Default value: `undef` +Default value: ``undef`` -##### `modsec_disable_vhost` +##### `modsec_disable_vhost` Data type: `Boolean` Disables `mod_security` on a virtual host. Only valid if `apache::mod::security` is included. -Default value: `false` +Default value: ``false`` -##### `modsec_disable_ids` +##### `modsec_disable_ids` Data type: `Optional[Variant[Hash, Array]]` @@ -8775,9 +8800,9 @@ apache::vhost { 'sample.example.net': } ``` -Default value: `undef` +Default value: ``undef`` -##### `modsec_disable_ips` +##### `modsec_disable_ips` Data type: `Array[String[1]]` @@ -8785,7 +8810,7 @@ Specifies an array of IP addresses to exclude from `mod_security` rule matching. Default value: `[]` -##### `modsec_disable_msgs` +##### `modsec_disable_msgs` Data type: `Optional[Variant[Hash, Array]]` @@ -8802,9 +8827,9 @@ apache::vhost { 'sample.example.net': } ``` -Default value: `undef` +Default value: ``undef`` -##### `modsec_disable_tags` +##### `modsec_disable_tags` Data type: `Optional[Variant[Hash, Array]]` @@ -8821,9 +8846,9 @@ apache::vhost { 'sample.example.net': } ``` -Default value: `undef` +Default value: ``undef`` -##### `modsec_audit_log_file` +##### `modsec_audit_log_file` Data type: `Optional[String]` @@ -8833,9 +8858,9 @@ log ([SecAuditLog](https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manu If none of those parameters are set, the global audit log is used (`/var/log/httpd/modsec\_audit.log`; Debian and derivatives: `/var/log/apache2/modsec\_audit.log`; others: ). -Default value: `undef` +Default value: ``undef`` -##### `modsec_audit_log_pipe` +##### `modsec_audit_log_pipe` Data type: `Optional[String]` @@ -8846,9 +8871,9 @@ log ([SecAuditLog](https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manu If none of those parameters are set, the global audit log is used (`/var/log/httpd/modsec\_audit.log`; Debian and derivatives: `/var/log/apache2/modsec\_audit.log`; others: ). -Default value: `undef` +Default value: ``undef`` -##### `modsec_audit_log` +##### `modsec_audit_log` Data type: `Optional[Variant[String, Boolean]]` @@ -8860,9 +8885,9 @@ log ([SecAuditLog](https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manu If none of those parameters are set, the global audit log is used (`/var/log/httpd/modsec\_audit.log`; Debian and derivatives: `/var/log/apache2/modsec\_audit.log`; others: ). -Default value: `undef` +Default value: ``undef`` -##### `modsec_inbound_anomaly_threshold` +##### `modsec_inbound_anomaly_threshold` Data type: `Optional[Integer[1, default]]` @@ -8870,9 +8895,9 @@ Override the global scoring threshold level of the inbound blocking rules for the Collaborative Detection Mode in the OWASP ModSecurity Core Rule Set. -Default value: `undef` +Default value: ``undef`` -##### `modsec_outbound_anomaly_threshold` +##### `modsec_outbound_anomaly_threshold` Data type: `Optional[Integer[1, default]]` @@ -8880,17 +8905,17 @@ Override the global scoring threshold level of the outbound blocking rules for the Collaborative Detection Mode in the OWASP ModSecurity Core Rule Set. -Default value: `undef` +Default value: ``undef`` -##### `modsec_allowed_methods` +##### `modsec_allowed_methods` Data type: `Optional[String]` Override global allowed methods. A space-separated list of allowed HTTP methods. -Default value: `undef` +Default value: ``undef`` -##### `no_proxy_uris` +##### `no_proxy_uris` Data type: `Variant[Array[String], String]` @@ -8899,7 +8924,7 @@ with [`proxy_dest`](#proxy_dest). Default value: `[]` -##### `no_proxy_uris_match` +##### `no_proxy_uris_match` Data type: `Variant[Array[String], String]` @@ -8907,7 +8932,7 @@ This directive is equivalent to `no_proxy_uris`, but takes regular expressions. Default value: `[]` -##### `proxy_preserve_host` +##### `proxy_preserve_host` Data type: `Boolean` @@ -8915,9 +8940,9 @@ Sets the [ProxyPreserveHost Directive](https://httpd.apache.org/docs/current/mod Setting this parameter to `true` enables the `Host:` line from an incoming request to be proxied to the host instead of hostname. Setting it to `false` sets this directive to 'Off'. -Default value: `false` +Default value: ``false`` -##### `proxy_add_headers` +##### `proxy_add_headers` Data type: `Optional[Variant[String, Boolean]]` @@ -8925,18 +8950,18 @@ Sets the [ProxyAddHeaders Directive](https://httpd.apache.org/docs/current/mod/m This parameter controlls whether proxy-related HTTP headers (X-Forwarded-For, X-Forwarded-Host and X-Forwarded-Server) get sent to the backend server. -Default value: `undef` +Default value: ``undef`` -##### `proxy_error_override` +##### `proxy_error_override` Data type: `Boolean` Sets the [ProxyErrorOverride Directive](https://httpd.apache.org/docs/current/mod/mod_proxy.html#proxyerroroverride). This directive controls whether Apache should override error pages for proxied content. -Default value: `false` +Default value: ``false`` -##### `options` +##### `options` Data type: `Array[String]` @@ -8952,7 +8977,7 @@ apache::vhost { 'site.name.fdqn': Default value: `['Indexes', 'FollowSymLinks', 'MultiViews']` -##### `override` +##### `override` Data type: `Array[String]` @@ -8961,7 +8986,7 @@ Sets the overrides for the specified virtual host. Accepts an array of Default value: `['None']` -##### `passenger_enabled` +##### `passenger_enabled` Data type: `Optional[Boolean]` @@ -8980,45 +9005,45 @@ apache::vhost { 'sample.example.net': > **Note:** There is an [issue](http://www.conandalton.net/2010/06/passengerenabled-off-not-working.html) using the PassengerEnabled directive with the PassengerHighPerformance directive. -Default value: `undef` +Default value: ``undef`` -##### `passenger_base_uri` +##### `passenger_base_uri` Data type: `Optional[String]` Sets [PassengerBaseURI](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerbase_rui), to specify that the given URI is a distinct application served by Passenger. -Default value: `undef` +Default value: ``undef`` -##### `passenger_ruby` +##### `passenger_ruby` Data type: `Optional[Stdlib::Absolutepath]` Sets [PassengerRuby](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerruby), specifying the Ruby interpreter to use when serving the relevant web applications. -Default value: `undef` +Default value: ``undef`` -##### `passenger_python` +##### `passenger_python` Data type: `Optional[Stdlib::Absolutepath]` Sets [PassengerPython](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerpython), specifying the Python interpreter to use when serving the relevant web applications. -Default value: `undef` +Default value: ``undef`` -##### `passenger_nodejs` +##### `passenger_nodejs` Data type: `Optional[Stdlib::Absolutepath]` Sets the [`PassengerNodejs`](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengernodejs), specifying Node.js command to use when serving the relevant web applications. -Default value: `undef` +Default value: ``undef`` -##### `passenger_meteor_app_settings` +##### `passenger_meteor_app_settings` Data type: `Optional[String]` @@ -9026,9 +9051,9 @@ Sets [PassengerMeteorAppSettings](https://www.phusionpassenger.com/docs/referenc specifying a JSON file with settings for the application when using a Meteor application in non-bundled mode. -Default value: `undef` +Default value: ``undef`` -##### `passenger_app_env` +##### `passenger_app_env` Data type: `Optional[String]` @@ -9036,126 +9061,126 @@ Sets [PassengerAppEnv](https://www.phusionpassenger.com/docs/references/config_r the environment for the Passenger application. If not specified, defaults to the global setting or 'production'. -Default value: `undef` +Default value: ``undef`` -##### `passenger_app_root` +##### `passenger_app_root` Data type: `Optional[Stdlib::Absolutepath]` Sets [PassengerRoot](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerapproot), the location of the Passenger application root if different from the DocumentRoot. -Default value: `undef` +Default value: ``undef`` -##### `passenger_app_group_name` +##### `passenger_app_group_name` Data type: `Optional[String]` Sets [PassengerAppGroupName](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerappgroupname), the name of the application group that the current application should belong to. -Default value: `undef` +Default value: ``undef`` -##### `passenger_app_start_command` +##### `passenger_app_start_command` Data type: `Optional[String]` Sets [PassengerAppStartCommand](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerappstartcommand), how Passenger should start your app on a specific port. -Default value: `undef` +Default value: ``undef`` -##### `passenger_app_type` +##### `passenger_app_type` Data type: `Optional[Enum['meteor', 'node', 'rack', 'wsgi']]` Sets [PassengerAppType](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerapptype), to force Passenger to recognize the application as a specific type. -Default value: `undef` +Default value: ``undef`` -##### `passenger_startup_file` +##### `passenger_startup_file` Data type: `Optional[String]` Sets the [PassengerStartupFile](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerstartupfile), path. This path is relative to the application root. -Default value: `undef` +Default value: ``undef`` -##### `passenger_restart_dir` +##### `passenger_restart_dir` Data type: `Optional[String]` Sets the [PassengerRestartDir](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerrestartdir), to customize the directory in which `restart.txt` is searched for. -Default value: `undef` +Default value: ``undef`` -##### `passenger_spawn_method` +##### `passenger_spawn_method` Data type: `Optional[Enum['direct', 'smart']]` Sets [PassengerSpawnMethod](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerspawnmethod), whether Passenger spawns applications directly, or using a prefork copy-on-write mechanism. -Default value: `undef` +Default value: ``undef`` -##### `passenger_load_shell_envvars` +##### `passenger_load_shell_envvars` Data type: `Optional[Boolean]` Sets [PassengerLoadShellEnvvars](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerloadshellenvvars), to enable or disable the loading of shell environment variables before spawning the application. -Default value: `undef` +Default value: ``undef`` -##### `passenger_preload_bundler` +##### `passenger_preload_bundler` Data type: `Optional[Boolean]` Sets [PassengerPreloadBundler](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerpreloadbundler), to enable or disable the loading of bundler before loading the application. -Default value: `undef` +Default value: ``undef`` -##### `passenger_rolling_restarts` +##### `passenger_rolling_restarts` Data type: `Optional[Boolean]` Sets [PassengerRollingRestarts](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerrollingrestarts), to enable or disable support for zero-downtime application restarts through `restart.txt`. -Default value: `undef` +Default value: ``undef`` -##### `passenger_resist_deployment_errors` +##### `passenger_resist_deployment_errors` Data type: `Optional[Boolean]` Sets [PassengerResistDeploymentErrors](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerresistdeploymenterrors), to enable or disable resistance against deployment errors. -Default value: `undef` +Default value: ``undef`` -##### `passenger_user` +##### `passenger_user` Data type: `Optional[String]` Sets [PassengerUser](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengeruser), the running user for sandboxing applications. -Default value: `undef` +Default value: ``undef`` -##### `passenger_group` +##### `passenger_group` Data type: `Optional[String]` Sets [PassengerGroup](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengergroup), the running group for sandboxing applications. -Default value: `undef` +Default value: ``undef`` -##### `passenger_friendly_error_pages` +##### `passenger_friendly_error_pages` Data type: `Optional[Boolean]` @@ -9164,54 +9189,54 @@ which can display friendly error pages whenever an application fails to start. T friendly error page presents the startup error message, some suggestions for solving the problem, a backtrace and a dump of the environment variables. -Default value: `undef` +Default value: ``undef`` -##### `passenger_min_instances` +##### `passenger_min_instances` Data type: `Optional[Integer]` Sets [PassengerMinInstances](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengermininstances), the minimum number of application processes to run. -Default value: `undef` +Default value: ``undef`` -##### `passenger_max_instances` +##### `passenger_max_instances` Data type: `Optional[Integer]` Sets [PassengerMaxInstances](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengermaxinstances), the maximum number of application processes to run. -Default value: `undef` +Default value: ``undef`` -##### `passenger_max_preloader_idle_time` +##### `passenger_max_preloader_idle_time` Data type: `Optional[Integer]` Sets [PassengerMaxPreloaderIdleTime](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengermaxpreloaderidletime), the maximum amount of time the preloader waits before shutting down an idle process. -Default value: `undef` +Default value: ``undef`` -##### `passenger_force_max_concurrent_requests_per_process` +##### `passenger_force_max_concurrent_requests_per_process` Data type: `Optional[Integer]` Sets [PassengerForceMaxConcurrentRequestsPerProcess](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerforcemaxconcurrentrequestsperprocess), the maximum amount of concurrent requests the application can handle per process. -Default value: `undef` +Default value: ``undef`` -##### `passenger_start_timeout` +##### `passenger_start_timeout` Data type: `Optional[Integer]` Sets [PassengerStartTimeout](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerstarttimeout), the timeout for the application startup. -Default value: `undef` +Default value: ``undef`` -##### `passenger_concurrency_model` +##### `passenger_concurrency_model` Data type: `Optional[Enum['process', 'thread']]` @@ -9221,9 +9246,9 @@ Passenger supports two concurrency models:
* `process` - single-threaded, multi-processed I/O concurrency. * `thread` - multi-threaded, multi-processed I/O concurrency. -Default value: `undef` +Default value: ``undef`` -##### `passenger_thread_count` +##### `passenger_thread_count` Data type: `Optional[Integer]` @@ -9231,18 +9256,18 @@ Sets [PassengerThreadCount](https://www.phusionpassenger.com/docs/references/con the number of threads that Passenger should spawn per Ruby application process.
This option only has effect if PassengerConcurrencyModel is `thread`. -Default value: `undef` +Default value: ``undef`` -##### `passenger_max_requests` +##### `passenger_max_requests` Data type: `Optional[Integer]` Sets [PassengerMaxRequests](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengermaxrequests), the maximum number of requests an application process will process. -Default value: `undef` +Default value: ``undef`` -##### `passenger_max_request_time` +##### `passenger_max_request_time` Data type: `Optional[Integer]` @@ -9250,63 +9275,63 @@ Sets [PassengerMaxRequestTime](https://www.phusionpassenger.com/docs/references/ the maximum amount of time, in seconds, that an application process may take to process a request. -Default value: `undef` +Default value: ``undef`` -##### `passenger_memory_limit` +##### `passenger_memory_limit` Data type: `Optional[Integer]` Sets [PassengerMemoryLimit](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengermemorylimit), the maximum amount of memory that an application process may use, in megabytes. -Default value: `undef` +Default value: ``undef`` -##### `passenger_stat_throttle_rate` +##### `passenger_stat_throttle_rate` Data type: `Optional[Integer]` Sets [PassengerStatThrottleRate](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerstatthrottlerate), to set a limit, in seconds, on how often Passenger will perform it's filesystem checks. -Default value: `undef` +Default value: ``undef`` -##### `passenger_pre_start` +##### `passenger_pre_start` Data type: `Optional[Variant[String, Array[String]]]` Sets [PassengerPreStart](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerprestart), the URL of the application if pre-starting is required. -Default value: `undef` +Default value: ``undef`` -##### `passenger_high_performance` +##### `passenger_high_performance` Data type: `Optional[Boolean]` Sets [PassengerHighPerformance](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerhighperformance), to enhance performance in return for reduced compatibility. -Default value: `undef` +Default value: ``undef`` -##### `passenger_buffer_upload` +##### `passenger_buffer_upload` Data type: `Optional[Boolean]` Sets [PassengerBufferUpload](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerbufferupload), to buffer HTTP client request bodies before they are sent to the application. -Default value: `undef` +Default value: ``undef`` -##### `passenger_buffer_response` +##### `passenger_buffer_response` Data type: `Optional[Boolean]` Sets [PassengerBufferResponse](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerbufferresponse), to buffer Happlication-generated responses. -Default value: `undef` +Default value: ``undef`` -##### `passenger_error_override` +##### `passenger_error_override` Data type: `Optional[Boolean]` @@ -9314,9 +9339,9 @@ Sets [PassengerErrorOverride](https://www.phusionpassenger.com/docs/references/c to specify whether Apache will intercept and handle response with HTTP status codes of 400 and higher. -Default value: `undef` +Default value: ``undef`` -##### `passenger_max_request_queue_size` +##### `passenger_max_request_queue_size` Data type: `Optional[Integer]` @@ -9326,9 +9351,9 @@ concurrent request limit is reached. If the queue is already at this specified l Passenger immediately sends a "503 Service Unavailable" error to any incoming requests.
A value of 0 means that the queue size is unbounded. -Default value: `undef` +Default value: ``undef`` -##### `passenger_max_request_queue_time` +##### `passenger_max_request_queue_time` Data type: `Optional[Integer]` @@ -9338,9 +9363,9 @@ whenever the maximum concurrent request limit is reached. If a request reaches t limit, then Passenger immeaditly sends a "504 Gateway Timeout" error for that request.
A value of 0 means that the queue time is unbounded. -Default value: `undef` +Default value: ``undef`` -##### `passenger_sticky_sessions` +##### `passenger_sticky_sessions` Data type: `Optional[Boolean]` @@ -9348,27 +9373,27 @@ Sets [PassengerStickySessions](https://www.phusionpassenger.com/docs/references/ to specify that, whenever possible, all requests sent by a client will be routed to the same originating application process. -Default value: `undef` +Default value: ``undef`` -##### `passenger_sticky_sessions_cookie_name` +##### `passenger_sticky_sessions_cookie_name` Data type: `Optional[String]` Sets [PassengerStickySessionsCookieName](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerstickysessionscookiename), to specify the name of the sticky sessions cookie. -Default value: `undef` +Default value: ``undef`` -##### `passenger_sticky_sessions_cookie_attributes` +##### `passenger_sticky_sessions_cookie_attributes` Data type: `Optional[String]` Sets [PassengerStickySessionsCookieAttributes](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerstickysessionscookieattributes), the attributes of the sticky sessions cookie. -Default value: `undef` +Default value: ``undef`` -##### `passenger_allow_encoded_slashes` +##### `passenger_allow_encoded_slashes` Data type: `Optional[Boolean]` @@ -9376,27 +9401,27 @@ Sets [PassengerAllowEncodedSlashes](https://www.phusionpassenger.com/docs/refere to allow URLs with encoded slashes. Please note that this feature will not work properly unless Apache's `AllowEncodedSlashes` is also enabled. -Default value: `undef` +Default value: ``undef`` -##### `passenger_app_log_file` +##### `passenger_app_log_file` Data type: `Optional[String]` Sets [PassengerAppLogFile](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerapplogfile), app specific messages logged to a different file in addition to Passenger log file. -Default value: `undef` +Default value: ``undef`` -##### `passenger_debugger` +##### `passenger_debugger` Data type: `Optional[Boolean]` Sets [PassengerDebugger](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerdebugger), to turn support for Ruby application debugging on or off. -Default value: `undef` +Default value: ``undef`` -##### `passenger_lve_min_uid` +##### `passenger_lve_min_uid` Data type: `Optional[Integer]` @@ -9404,9 +9429,9 @@ Sets [PassengerLveMinUid](https://www.phusionpassenger.com/docs/references/confi to only allow the spawning of application processes with UIDs equal to, or higher than, this specified value on LVE-enabled kernels. -Default value: `undef` +Default value: ``undef`` -##### `php_values` +##### `php_values` Data type: `Hash` @@ -9419,7 +9444,7 @@ Within a vhost declaration: Default value: `{}` -##### `php_flags` +##### `php_flags` Data type: `Hash` @@ -9428,7 +9453,7 @@ These flags or values can be overwritten by a user or an application. Default value: `{}` -##### `php_admin_values` +##### `php_admin_values` Data type: `Variant[Array[String], Hash]` @@ -9437,7 +9462,7 @@ These flags or values cannot be overwritten by a user or an application. Default value: `{}` -##### `php_admin_flags` +##### `php_admin_flags` Data type: `Variant[Array[String], Hash]` @@ -9446,7 +9471,7 @@ These flags or values cannot be overwritten by a user or an application. Default value: `{}` -##### `port` +##### `port` Data type: `Optional[Variant[Array[Stdlib::Port], Stdlib::Port]]` @@ -9454,9 +9479,9 @@ Sets the port the host is configured on. The module's defaults ensure the host l on port 80 for non-SSL virtual hosts and port 443 for SSL virtual hosts. The host only listens on the port set in this parameter. -Default value: `undef` +Default value: ``undef`` -##### `priority` +##### `priority` Data type: `Optional[Apache::Vhost::Priority]` @@ -9468,9 +9493,9 @@ used if no other names match.
aware that the `default_vhost` parameter for `apache::vhost` passes a priority of 15.
To omit the priority prefix in file names, pass a priority of `false`. -Default value: `undef` +Default value: ``undef`` -##### `protocols` +##### `protocols` Data type: `Array[Enum['h2', 'h2c', 'http/1.1']]` @@ -9479,24 +9504,24 @@ directive, which lists available protocols for the virutal host. Default value: `[]` -##### `protocols_honor_order` +##### `protocols_honor_order` Data type: `Optional[Boolean]` Sets the [ProtocolsHonorOrder](https://httpd.apache.org/docs/current/en/mod/core.html#protocolshonororder) directive which determines wether the order of Protocols sets precedence during negotiation. -Default value: `undef` +Default value: ``undef`` -##### `proxy_dest` +##### `proxy_dest` Data type: `Optional[String]` Specifies the destination address of a [ProxyPass](https://httpd.apache.org/docs/current/mod/mod_proxy.html#proxypass) configuration. -Default value: `undef` +Default value: ``undef`` -##### `proxy_pass` +##### `proxy_pass` Data type: `Optional[Variant[Array[Hash], Hash]]` @@ -9529,9 +9554,9 @@ apache::vhost { 'site.name.fdqn': * `params`. *Optional.* Allows for ProxyPass key-value parameters, such as connection settings. * `setenv`. *Optional.* Sets [environment variables](https://httpd.apache.org/docs/current/mod/mod_proxy.html#envsettings) for the proxy directive. Values: array. -Default value: `undef` +Default value: ``undef`` -##### `proxy_dest_match` +##### `proxy_dest_match` Data type: `Optional[String]` @@ -9539,9 +9564,9 @@ This directive is equivalent to `proxy_dest`, but takes regular expressions, see [ProxyPassMatch](https://httpd.apache.org/docs/current/mod/mod_proxy.html#proxypassmatch) for details. -Default value: `undef` +Default value: ``undef`` -##### `proxy_dest_reverse_match` +##### `proxy_dest_reverse_match` Data type: `Optional[String]` @@ -9549,9 +9574,9 @@ Allows you to pass a ProxyPassReverse if `proxy_dest_match` is specified. See [ProxyPassReverse](https://httpd.apache.org/docs/current/mod/mod_proxy.html#proxypassreverse) for details. -Default value: `undef` +Default value: ``undef`` -##### `proxy_pass_match` +##### `proxy_pass_match` Data type: `Optional[Variant[Array[Hash], Hash]]` @@ -9559,17 +9584,17 @@ This directive is equivalent to `proxy_pass`, but takes regular expressions, see [ProxyPassMatch](https://httpd.apache.org/docs/current/mod/mod_proxy.html#proxypassmatch) for details. -Default value: `undef` +Default value: ``undef`` -##### `redirect_dest` +##### `redirect_dest` Data type: `Optional[Variant[Array[String], String]]` Specifies the address to redirect to. -Default value: `undef` +Default value: ``undef`` -##### `redirect_source` +##### `redirect_source` Data type: `Variant[String, Array[String]]` @@ -9586,7 +9611,7 @@ apache::vhost { 'site.name.fdqn': Default value: `'/'` -##### `redirect_status` +##### `redirect_status` Data type: `Optional[Variant[Array[String], String]]` @@ -9598,9 +9623,9 @@ Specifies the status to append to the redirect. } ``` -Default value: `undef` +Default value: ``undef`` -##### `redirectmatch_regexp` +##### `redirectmatch_regexp` Data type: `Optional[Variant[Array[String], String]]` @@ -9616,9 +9641,9 @@ apache::vhost { 'site.name.fdqn': } ``` -Default value: `undef` +Default value: ``undef`` -##### `redirectmatch_status` +##### `redirectmatch_status` Data type: `Optional[Variant[Array[String], String]]` @@ -9634,9 +9659,9 @@ apache::vhost { 'site.name.fdqn': } ``` -Default value: `undef` +Default value: ``undef`` -##### `redirectmatch_dest` +##### `redirectmatch_dest` Data type: `Optional[Variant[Array[String], String]]` @@ -9652,9 +9677,9 @@ apache::vhost { 'site.name.fdqn': } ``` -Default value: `undef` +Default value: ``undef`` -##### `request_headers` +##### `request_headers` Data type: `Array[String[1]]` @@ -9673,7 +9698,7 @@ apache::vhost { 'site.name.fdqn': Default value: `[]` -##### `rewrites` +##### `rewrites` Data type: `Array[Hash]` @@ -9750,7 +9775,7 @@ than setting the rewrites in the virtual host's directories. Default value: `[]` -##### `rewrite_base` +##### `rewrite_base` Data type: `Optional[String[1]]` @@ -9758,18 +9783,18 @@ The parameter [`rewrite_base`](https://httpd.apache.org/docs/current/mod/mod_rew specifies the URL prefix to be used for per-directory (htaccess) RewriteRule directives that substitue a relative path. -Default value: `undef` +Default value: ``undef`` -##### `rewrite_rule` +##### `rewrite_rule` Data type: `Optional[Variant[Array[String[1]], String[1]]]` The parameter [`rewrite_rile`](https://httpd.apache.org/docs/current/mod/mod_rewrite.html#rewriterule) allows the user to define the rules that will be used by the rewrite engine. -Default value: `undef` +Default value: ``undef`` -##### `rewrite_cond` +##### `rewrite_cond` Data type: `Array[String[1]]` @@ -9779,7 +9804,7 @@ rewrite engine. Default value: `[]` -##### `rewrite_inherit` +##### `rewrite_inherit` Data type: `Boolean` @@ -9807,18 +9832,18 @@ RewriteOptions Inherit Refer to the official [`mod_rewrite`](https://httpd.apache.org/docs/2.2/mod/mod_rewrite.html) documentation, section "Rewriting in Virtual Hosts". -Default value: `false` +Default value: ``false`` -##### `scriptalias` +##### `scriptalias` Data type: `Optional[String]` Defines a directory of CGI scripts to be aliased to the path '/cgi-bin', such as '/usr/scripts'. -Default value: `undef` +Default value: ``undef`` -##### `scriptaliases` +##### `scriptaliases` Data type: `Array[Hash]` @@ -9851,15 +9876,15 @@ before more general ones to avoid shadowing. Default value: `[]` -##### `serveradmin` +##### `serveradmin` Data type: `Optional[String]` Specifies the email address Apache displays when it renders one of its error pages. -Default value: `undef` +Default value: ``undef`` -##### `serveraliases` +##### `serveraliases` Data type: `Variant[Array[String], String]` @@ -9868,7 +9893,7 @@ of the site. Default value: `[]` -##### `servername` +##### `servername` Data type: `Optional[String]` @@ -9876,7 +9901,7 @@ Sets the servername corresponding to the hostname you connect to the virtual hos Default value: `$name` -##### `setenv` +##### `setenv` Data type: `Variant[Array[String], String]` @@ -9890,7 +9915,7 @@ apache::vhost { 'setenv.example.com': Default value: `[]` -##### `setenvif` +##### `setenvif` Data type: `Variant[Array[String], String]` @@ -9898,7 +9923,7 @@ Used by HTTPD to conditionally set environment variables for virtual hosts. Default value: `[]` -##### `setenvifnocase` +##### `setenvifnocase` Data type: `Variant[Array[String], String]` @@ -9906,16 +9931,16 @@ Used by HTTPD to conditionally set environment variables for virtual hosts (case Default value: `[]` -##### `suexec_user_group` +##### `suexec_user_group` Data type: `Optional[Pattern[/^[\w-]+ [\w-]+$/]]` Allows the spcification of user and group execution privileges for CGI programs through inclusion of the `mod_suexec` module. -Default value: `undef` +Default value: ``undef`` -##### `vhost_name` +##### `vhost_name` Data type: `String` @@ -9926,7 +9951,7 @@ title of the resource. Default value: `'*'` -##### `virtual_docroot` +##### `virtual_docroot` Data type: `Variant[Stdlib::Absolutepath, Boolean]` @@ -9944,9 +9969,9 @@ apache::vhost { 'subdomain.loc': } ``` -Default value: `false` +Default value: ``false`` -##### `virtual_use_default_docroot` +##### `virtual_use_default_docroot` Data type: `Boolean` @@ -9963,9 +9988,9 @@ apache::vhost { 'subdomain.loc': } ``` -Default value: `false` +Default value: ``false`` -##### `wsgi_daemon_process` +##### `wsgi_daemon_process` Data type: `Optional[Variant[String, Hash]]` @@ -9991,9 +10016,9 @@ apache::vhost { 'wsgi.example.com': } ``` -Default value: `undef` +Default value: ``undef`` -##### `wsgi_daemon_process_options` +##### `wsgi_daemon_process_options` Data type: `Optional[Hash]` @@ -10002,9 +10027,9 @@ wsgi_daemon_process, wsgi_process_group, wsgi_script_aliases and wsgi_pass_authorization.
Sets the group ID that the virtual host runs under. -Default value: `undef` +Default value: ``undef`` -##### `wsgi_application_group` +##### `wsgi_application_group` Data type: `Optional[String]` @@ -10016,9 +10041,9 @@ thus allowing you to specify which application group the WSGI application belong with all WSGI applications within the same group executing within the context of the same Python sub interpreter. -Default value: `undef` +Default value: ``undef`` -##### `wsgi_import_script` +##### `wsgi_import_script` Data type: `Optional[String]` @@ -10028,9 +10053,9 @@ and wsgi_pass_authorization.
This parameter defines the [`WSGIImportScript directive`](https://modwsgi.readthedocs.io/en/develop/configuration-directives/WSGIImportScript.html), which can be used in order to specify a script file to be loaded upon a process starting. -Default value: `undef` +Default value: ``undef`` -##### `wsgi_import_script_options` +##### `wsgi_import_script_options` Data type: `Optional[Hash]` @@ -10041,11 +10066,11 @@ This parameter defines the [`WSGIImportScript directive`](https://modwsgi.readth which can be used in order to specify a script file to be loaded upon a process starting.
Specifies the process and aplication groups of the script. -Default value: `undef` +Default value: ``undef`` -##### `wsgi_chunked_request` +##### `wsgi_chunked_request` -Data type: `Optional[Enum['On', 'Off']]` +Data type: `Optional[Apache::OnOff]` Sets up a virtual host with [WSGI](https://github.com/GrahamDumpleton/mod_wsgi) alongside wsgi_daemon_process, wsgi_daemon_process_options, wsgi_process_group, @@ -10055,9 +10080,9 @@ allowing you to enable support for chunked request content.
WSGI is technically incapable of supporting chunked request content without all chunked request content having first been read in and buffered. -Default value: `undef` +Default value: ``undef`` -##### `wsgi_process_group` +##### `wsgi_process_group` Data type: `Optional[String]` @@ -10066,9 +10091,9 @@ wsgi_daemon_process, wsgi_daemon_process_options, wsgi_script_aliases and wsgi_pass_authorization.
Requires a hash of web paths to filesystem `.wsgi paths/`. -Default value: `undef` +Default value: ``undef`` -##### `wsgi_script_aliases` +##### `wsgi_script_aliases` Data type: `Optional[Hash]` @@ -10078,9 +10103,9 @@ and wsgi_pass_authorization.
Uses the WSGI application to handle authorization instead of Apache when set to `On`.
For more information, see mod_wsgi's [WSGIPassAuthorization documentation](https://modwsgi.readthedocs.org/en/latest/configuration-directives/WSGIPassAuthorization.html). -Default value: `undef` +Default value: ``undef`` -##### `wsgi_script_aliases_match` +##### `wsgi_script_aliases_match` Data type: `Optional[Hash]` @@ -10092,20 +10117,20 @@ This directive is similar to `wsgi_script_aliases`, but makes use of regular exp in place of simple prefix matching.
For more information, see mod_wsgi's [WSGIPassAuthorization documentation](https://modwsgi.readthedocs.org/en/latest/configuration-directives/WSGIPassAuthorization.html). -Default value: `undef` +Default value: ``undef`` -##### `wsgi_pass_authorization` +##### `wsgi_pass_authorization` -Data type: `Optional[Enum['on', 'off', 'On', 'Off']]` +Data type: `Optional[Apache::OnOff]` Sets up a virtual host with [WSGI](https://github.com/GrahamDumpleton/mod_wsgi) alongside wsgi_daemon_process, wsgi_daemon_process_options, wsgi_process_group and wsgi_script_aliases.
Enables support for chunked requests. -Default value: `undef` +Default value: ``undef`` -##### `directories` +##### `directories` Data type: `Optional[Array[Hash]]` @@ -10156,9 +10181,9 @@ apache::vhost { 'sample.example.net': Any handlers you do not set in these hashes are considered `undefined` within Puppet and are not added to the virtual host, resulting in the module using their default values. -Default value: `undef` +Default value: ``undef`` -##### `custom_fragment` +##### `custom_fragment` Data type: `Optional[String]` @@ -10187,9 +10212,9 @@ ProxyStatus On', } ``` -Default value: `undef` +Default value: ``undef`` -##### `headers` +##### `headers` Data type: `Array[String[1]]` @@ -10208,7 +10233,7 @@ apache::vhost { 'sample.example.net': Default value: `[]` -##### `shib_compat_valid_user` +##### `shib_compat_valid_user` Data type: `Optional[String]` @@ -10219,9 +10244,9 @@ Apache behavior when processing the `valid-user` and `user` Require rules. See t and [NativeSPhtaccess](https://wiki.shibboleth.net/confluence/display/SHIB2/NativeSPhtaccess) topic for more details. This key is disabled if `apache::mod::shib` is not defined. -Default value: `undef` +Default value: ``undef`` -##### `ssl_options` +##### `ssl_options` Data type: `Optional[Variant[Array[String], String]]` @@ -10242,9 +10267,9 @@ apache::vhost { 'secure.example.net': } ``` -Default value: `undef` +Default value: ``undef`` -##### `additional_includes` +##### `additional_includes` Data type: `Variant[Array[String], String]` @@ -10263,19 +10288,23 @@ apache::vhost { 'sample.example.net': Default value: `[]` -##### `gssapi` +##### `gssapi` + + + +##### `authz_core` -##### `ssl` +##### `ssl` Data type: `Boolean` Enables SSL for the virtual host. SSL virtual hosts only respond to HTTPS queries. -Default value: `false` +Default value: ``false`` -##### `ssl_ca` +##### `ssl_ca` Data type: `Optional[Stdlib::Absolutepath]` @@ -10284,7 +10313,7 @@ for authentication. Default value: `$apache::default_ssl_ca` -##### `ssl_cert` +##### `ssl_cert` Data type: `Optional[Stdlib::Absolutepath]` @@ -10292,34 +10321,34 @@ Specifies the SSL certification. Default value: `$apache::default_ssl_cert` -##### `ssl_protocol` +##### `ssl_protocol` Data type: `Optional[Variant[Array[String], String]]` Specifies [SSLProtocol](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslprotocol). Expects an array or space separated string of accepted protocols. -Default value: `undef` +Default value: ``undef`` -##### `ssl_cipher` +##### `ssl_cipher` -Data type: `Optional[Variant[Array[String], String]]` +Data type: `Optional[Variant[Array[String[1]], String[1], Hash[String[1], String[1]]]]` Specifies [SSLCipherSuite](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslciphersuite). -Default value: `undef` +Default value: ``undef`` -##### `ssl_honorcipherorder` +##### `ssl_honorcipherorder` -Data type: `Variant[Boolean, Enum['on', 'On', 'off', 'Off'], Undef]` +Data type: `Variant[Boolean, Apache::OnOff, Undef]` Sets [SSLHonorCipherOrder](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslhonorcipherorder), to cause Apache to use the server's preferred order of ciphers rather than the client's preferred order. -Default value: `undef` +Default value: ``undef`` -##### `ssl_certs_dir` +##### `ssl_certs_dir` Data type: `Optional[Stdlib::Absolutepath]` @@ -10327,7 +10356,7 @@ Specifies the location of the SSL certification directory to verify client certs Default value: `$apache::params::ssl_certs_dir` -##### `ssl_chain` +##### `ssl_chain` Data type: `Optional[Stdlib::Absolutepath]` @@ -10337,7 +10366,7 @@ production. Default value: `$apache::default_ssl_chain` -##### `ssl_crl` +##### `ssl_crl` Data type: `Optional[Stdlib::Absolutepath]` @@ -10347,7 +10376,7 @@ before being used in production.) Default value: `$apache::default_ssl_crl` -##### `ssl_crl_path` +##### `ssl_crl_path` Data type: `Optional[Stdlib::Absolutepath]` @@ -10358,7 +10387,7 @@ production.) Default value: `$apache::default_ssl_crl_path` -##### `ssl_crl_check` +##### `ssl_crl_check` Data type: `Optional[String]` @@ -10369,7 +10398,7 @@ older versions. Default value: `$apache::default_ssl_crl_check` -##### `ssl_key` +##### `ssl_key` Data type: `Optional[Stdlib::Absolutepath]` @@ -10380,7 +10409,7 @@ being used in production. Default value: `$apache::default_ssl_key` -##### `ssl_verify_client` +##### `ssl_verify_client` Data type: `Optional[Enum['none', 'optional', 'require', 'optional_no_ca']]` @@ -10393,9 +10422,9 @@ apache::vhost { 'sample.example.net': } ``` -Default value: `undef` +Default value: ``undef`` -##### `ssl_verify_depth` +##### `ssl_verify_depth` Data type: `Optional[Integer]` @@ -10410,9 +10439,9 @@ apache::vhost { 'sample.example.net': } ``` -Default value: `undef` +Default value: ``undef`` -##### `ssl_proxy_protocol` +##### `ssl_proxy_protocol` Data type: `Optional[String]` @@ -10421,9 +10450,9 @@ directive, which controls which SSL protocol flavors `mod_ssl` should use when e its server environment for proxy. It connects to servers using only one of the provided protocols. -Default value: `undef` +Default value: ``undef`` -##### `ssl_proxy_verify` +##### `ssl_proxy_verify` Data type: `Optional[Enum['none', 'optional', 'require', 'optional_no_ca']]` @@ -10431,9 +10460,9 @@ Sets the [SSLProxyVerify](https://httpd.apache.org/docs/current/mod/mod_ssl.html directive, which configures certificate verification of the remote server when a proxy is configured to forward requests to a remote SSL server. -Default value: `undef` +Default value: ``undef`` -##### `ssl_proxy_verify_depth` +##### `ssl_proxy_verify_depth` Data type: `Optional[Integer[0]]` @@ -10444,18 +10473,18 @@ A depth of 0 means that only self-signed remote server certificates are accepted the default depth of 1 means the remote server certificate can be self-signed or signed by a CA that is directly known to the server. -Default value: `undef` +Default value: ``undef`` -##### `ssl_proxy_cipher_suite` +##### `ssl_proxy_cipher_suite` Data type: `Optional[String]` Sets the [SSLProxyCipherSuite](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslproxyciphersuite) directive, which controls cipher suites supported for ssl proxy traffic. -Default value: `undef` +Default value: ``undef`` -##### `ssl_proxy_ca_cert` +##### `ssl_proxy_ca_cert` Data type: `Optional[Stdlib::Absolutepath]` @@ -10465,9 +10494,9 @@ of Certification Authorities (CA) whose remote servers you deal with. These are for Remote Server Authentication. This file should be a concatenation of the PEM-encoded certificate files in order of preference. -Default value: `undef` +Default value: ``undef`` -##### `ssl_proxy_machine_cert` +##### `ssl_proxy_machine_cert` Data type: `Optional[Stdlib::Absolutepath]` @@ -10482,9 +10511,9 @@ apache::vhost { 'sample.example.net': } ``` -Default value: `undef` +Default value: ``undef`` -##### `ssl_proxy_machine_cert_chain` +##### `ssl_proxy_machine_cert_chain` Data type: `Optional[Stdlib::Absolutepath]` @@ -10496,56 +10525,56 @@ client certificates. This referenced file is simply the concatenation of the var PEM-encoded certificate files. Upon startup, each client certificate configured will be examined and a chain of trust will be constructed. -Default value: `undef` +Default value: ``undef`` -##### `ssl_proxy_check_peer_cn` +##### `ssl_proxy_check_peer_cn` -Data type: `Optional[Enum['on', 'off']]` +Data type: `Optional[Apache::OnOff]` Sets the [SSLProxyCheckPeerCN](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslproxycheckpeercn) directive, which specifies whether the remote server certificate's CN field is compared against the hostname of the request URL. -Default value: `undef` +Default value: ``undef`` -##### `ssl_proxy_check_peer_name` +##### `ssl_proxy_check_peer_name` -Data type: `Optional[Enum['on', 'off']]` +Data type: `Optional[Apache::OnOff]` Sets the [SSLProxyCheckPeerName](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslproxycheckpeername) directive, which specifies whether the remote server certificate's CN field is compared against the hostname of the request URL. -Default value: `undef` +Default value: ``undef`` -##### `ssl_proxy_check_peer_expire` +##### `ssl_proxy_check_peer_expire` -Data type: `Optional[Enum['on', 'off']]` +Data type: `Optional[Apache::OnOff]` Sets the [SSLProxyCheckPeerExpire](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslproxycheckpeerexpire) directive, which specifies whether the remote server certificate is checked for expiration or not. -Default value: `undef` +Default value: ``undef`` -##### `ssl_openssl_conf_cmd` +##### `ssl_openssl_conf_cmd` Data type: `Optional[String]` Sets the [SSLOpenSSLConfCmd](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslopensslconfcmd) directive, which provides direct configuration of OpenSSL parameters. -Default value: `undef` +Default value: ``undef`` -##### `ssl_proxyengine` +##### `ssl_proxyengine` Data type: `Boolean` Specifies whether or not to use [SSLProxyEngine](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslproxyengine). -Default value: `false` +Default value: ``false`` -##### `ssl_stapling` +##### `ssl_stapling` Data type: `Optional[Boolean]` @@ -10553,35 +10582,35 @@ Specifies whether or not to use [SSLUseStapling](http://httpd.apache.org/docs/cu By default, uses what is set globally.
This parameter only applies to Apache 2.4 or higher and is ignored on older versions. -Default value: `undef` +Default value: ``undef`` -##### `ssl_stapling_timeout` +##### `ssl_stapling_timeout` Data type: `Optional[Integer]` Can be used to set the [SSLStaplingResponderTimeout](http://httpd.apache.org/docs/current/mod/mod_ssl.html#sslstaplingrespondertimeout) directive.
This parameter only applies to Apache 2.4 or higher and is ignored on older versions. -Default value: `undef` +Default value: ``undef`` -##### `ssl_stapling_return_errors` +##### `ssl_stapling_return_errors` -Data type: `Optional[Enum['on', 'off']]` +Data type: `Optional[Apache::OnOff]` Can be used to set the [SSLStaplingReturnResponderErrors](http://httpd.apache.org/docs/current/mod/mod_ssl.html#sslstaplingreturnrespondererrors) directive.
This parameter only applies to Apache 2.4 or higher and is ignored on older versions. -Default value: `undef` +Default value: ``undef`` -##### `ssl_user_name` +##### `ssl_user_name` Data type: `Optional[String]` Sets the [SSLUserName](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslusername) directive. -Default value: `undef` +Default value: ``undef`` -##### `ssl_reload_on_change` +##### `ssl_reload_on_change` Data type: `Boolean` @@ -10589,16 +10618,16 @@ Enable reloading of apache if the content of ssl files have changed. Default value: `$apache::default_ssl_reload_on_change` -##### `use_canonical_name` +##### `use_canonical_name` -Data type: `Optional[Enum['On', 'on', 'Off', 'off', 'DNS', 'dns']]` +Data type: `Optional[Variant[Apache::OnOff, Enum['DNS', 'dns']]]` Specifies whether to use the [`UseCanonicalName directive`](https://httpd.apache.org/docs/2.4/mod/core.html#usecanonicalname), which allows you to configure how the server determines it's own name and port. -Default value: `undef` +Default value: ``undef`` -##### `define` +##### `define` Data type: `Hash` @@ -10607,15 +10636,15 @@ these can then be used to replace configuration values. All Defines are Undefine Default value: `{}` -##### `auth_oidc` +##### `auth_oidc` Data type: `Boolean` Enable `mod_auth_openidc` parameters for OpenID Connect authentication. -Default value: `false` +Default value: ``false`` -##### `oidc_settings` +##### `oidc_settings` Data type: `Apache::OIDCSettings` @@ -10623,7 +10652,7 @@ An Apache::OIDCSettings Struct containing (mod_auth_openidc settings)[https://gi Default value: `{}` -##### `limitreqfields` +##### `limitreqfields` Data type: `Optional[Integer]` @@ -10633,18 +10662,18 @@ abnormal client request behavior, which may be useful for avoiding some forms of denial-of-service attacks. The value should be increased if normal clients see an error response from the server that indicates too many fields were sent in the request. -Default value: `undef` +Default value: ``undef`` -##### `limitreqfieldsize` +##### `limitreqfieldsize` Data type: `Optional[Integer]` The `limitreqfieldsize` parameter sets the maximum ammount of _bytes_ that will be allowed within a request header. -Default value: `undef` +Default value: ``undef`` -##### `limitreqline` +##### `limitreqline` Data type: `Optional[Integer]` @@ -10658,9 +10687,9 @@ allowed for a request on the server. A server needs this value to be large enough to hold any of its resource names, including any information that might be passed in the query part of a GET request. -Default value: `undef` +Default value: ``undef`` -##### `limitreqbody` +##### `limitreqbody` Data type: `Optional[Integer]` @@ -10671,9 +10700,9 @@ directive is given (server, per-directory, per-file or per-location). If the client request exceeds that limit, the server will return an error response instead of servicing the request. -Default value: `undef` +Default value: ``undef`` -##### `use_servername_for_filenames` +##### `use_servername_for_filenames` Data type: `Boolean` @@ -10682,9 +10711,9 @@ value of the $servername parameter. When set to false (default), the existing behaviour of using the $name parameter will remain. -Default value: `false` +Default value: ``false`` -##### `use_port_for_filenames` +##### `use_port_for_filenames` Data type: `Boolean` @@ -10694,34 +10723,34 @@ $port parameters. When set to false (default), the port is not included in the file names and may lead to duplicate declarations if two virtual hosts use the same domain. -Default value: `false` +Default value: ``false`` -##### `mdomain` +##### `mdomain` Data type: `Optional[Variant[Boolean, String]]` All the names in the list are managed as one Managed Domain (MD). mod_md will request one single certificate that is valid for all these names. -Default value: `undef` +Default value: ``undef`` -##### `proxy_requests` +##### `proxy_requests` Data type: `Boolean` Whether to accept proxy requests -Default value: `false` +Default value: ``false`` -##### `userdir` +##### `userdir` Data type: `Optional[Variant[String[1], Array[String[1]]]]` Instances of apache::mod::userdir -Default value: `undef` +Default value: ``undef`` -### `apache::vhost::custom` +### `apache::vhost::custom` The `apache::vhost::custom` defined type is a thin wrapper around the `apache::custom_config` defined type, and simply overrides some of its default settings specific to the virtual host directory in Apache. @@ -10729,18 +10758,18 @@ The `apache::vhost::custom` defined type is a thin wrapper around the `apache::c The following parameters are available in the `apache::vhost::custom` defined type: -* [`content`](#-apache--vhost--custom--content) -* [`ensure`](#-apache--vhost--custom--ensure) -* [`priority`](#-apache--vhost--custom--priority) -* [`verify_config`](#-apache--vhost--custom--verify_config) +* [`content`](#content) +* [`ensure`](#ensure) +* [`priority`](#priority) +* [`verify_config`](#verify_config) -##### `content` +##### `content` Data type: `String` Sets the configuration file's content. -##### `ensure` +##### `ensure` Data type: `String` @@ -10748,7 +10777,7 @@ Specifies if the virtual host file is present or absent. Default value: `'present'` -##### `priority` +##### `priority` Data type: `Apache::Vhost::Priority` @@ -10756,15 +10785,15 @@ Sets the relative load order for Apache HTTPD VirtualHost configuration files. Default value: `25` -##### `verify_config` +##### `verify_config` Data type: `Boolean` Specifies whether to validate the configuration file before notifying the Apache service. -Default value: `true` +Default value: ``true`` -### `apache::vhost::fragment` +### `apache::vhost::fragment` Define a fragment within a vhost @@ -10825,37 +10854,37 @@ apache::vhost::fragment { 'myfragment': The following parameters are available in the `apache::vhost::fragment` defined type: -* [`vhost`](#-apache--vhost--fragment--vhost) -* [`priority`](#-apache--vhost--fragment--priority) -* [`content`](#-apache--vhost--fragment--content) -* [`order`](#-apache--vhost--fragment--order) -* [`port`](#-apache--vhost--fragment--port) +* [`vhost`](#vhost) +* [`priority`](#priority) +* [`content`](#content) +* [`order`](#order) +* [`port`](#port) -##### `vhost` +##### `vhost` Data type: `String[1]` The title of the vhost resource to append to -##### `priority` +##### `priority` Data type: `Optional[Apache::Vhost::Priority]` Set the priority to match the one `apache::vhost` sets. This must match the one `apache::vhost` sets or else the concat fragment won't be found. -Default value: `undef` +Default value: ``undef`` -##### `content` +##### `content` Data type: `Optional[String]` The content to put in the fragment. Only when it's non-empty the actual fragment will be created. -Default value: `undef` +Default value: ``undef`` -##### `order` +##### `order` Data type: `Integer[0]` @@ -10863,15 +10892,15 @@ The order to insert the fragment at Default value: `900` -##### `port` +##### `port` Data type: `Optional[Stdlib::Port]` The port to use -Default value: `undef` +Default value: ``undef`` -### `apache::vhost::proxy` +### `apache::vhost::proxy` Configure a reverse proxy for a vhost @@ -10922,39 +10951,39 @@ apache::vhost::proxy { 'myvhost-proxy': The following parameters are available in the `apache::vhost::proxy` defined type: -* [`vhost`](#-apache--vhost--proxy--vhost) -* [`priority`](#-apache--vhost--proxy--priority) -* [`order`](#-apache--vhost--proxy--order) -* [`port`](#-apache--vhost--proxy--port) -* [`proxy_dest`](#-apache--vhost--proxy--proxy_dest) -* [`proxy_dest_match`](#-apache--vhost--proxy--proxy_dest_match) -* [`proxy_dest_reverse_match`](#-apache--vhost--proxy--proxy_dest_reverse_match) -* [`no_proxy_uris`](#-apache--vhost--proxy--no_proxy_uris) -* [`no_proxy_uris_match`](#-apache--vhost--proxy--no_proxy_uris_match) -* [`proxy_pass`](#-apache--vhost--proxy--proxy_pass) -* [`proxy_pass_match`](#-apache--vhost--proxy--proxy_pass_match) -* [`proxy_requests`](#-apache--vhost--proxy--proxy_requests) -* [`proxy_preserve_host`](#-apache--vhost--proxy--proxy_preserve_host) -* [`proxy_add_headers`](#-apache--vhost--proxy--proxy_add_headers) -* [`proxy_error_override`](#-apache--vhost--proxy--proxy_error_override) - -##### `vhost` +* [`vhost`](#vhost) +* [`priority`](#priority) +* [`order`](#order) +* [`port`](#port) +* [`proxy_dest`](#proxy_dest) +* [`proxy_dest_match`](#proxy_dest_match) +* [`proxy_dest_reverse_match`](#proxy_dest_reverse_match) +* [`no_proxy_uris`](#no_proxy_uris) +* [`no_proxy_uris_match`](#no_proxy_uris_match) +* [`proxy_pass`](#proxy_pass) +* [`proxy_pass_match`](#proxy_pass_match) +* [`proxy_requests`](#proxy_requests) +* [`proxy_preserve_host`](#proxy_preserve_host) +* [`proxy_add_headers`](#proxy_add_headers) +* [`proxy_error_override`](#proxy_error_override) + +##### `vhost` Data type: `String[1]` The title of the vhost resource to which reverse proxy configuration will be appended. -##### `priority` +##### `priority` Data type: `Optional[Apache::Vhost::Priority]` Set the priority to match the one `apache::vhost` sets. This must match the one `apache::vhost` sets or else the vhost's `concat` resource won't be found. -Default value: `undef` +Default value: ``undef`` -##### `order` +##### `order` Data type: `Integer[0]` @@ -10964,24 +10993,24 @@ vhost's configuration. Default value: `170` -##### `port` +##### `port` Data type: `Optional[Stdlib::Port]` Set the port to match the one `apache::vhost` sets. This must match the one `apache::vhost` sets or else the vhost's `concat` resource won't be found. -Default value: `undef` +Default value: ``undef`` -##### `proxy_dest` +##### `proxy_dest` Data type: `Optional[String[1]]` Specifies the destination address of a [ProxyPass](https://httpd.apache.org/docs/current/mod/mod_proxy.html#proxypass) configuration for the `/` path. -Default value: `undef` +Default value: ``undef`` -##### `proxy_dest_match` +##### `proxy_dest_match` Data type: `Optional[String[1]]` @@ -10989,9 +11018,9 @@ This directive is equivalent to `proxy_dest`, but takes regular expressions, see [ProxyPassMatch](https://httpd.apache.org/docs/current/mod/mod_proxy.html#proxypassmatch) for details. -Default value: `undef` +Default value: ``undef`` -##### `proxy_dest_reverse_match` +##### `proxy_dest_reverse_match` Data type: `Optional[String[1]]` @@ -10999,9 +11028,9 @@ Allows you to pass a ProxyPassReverse if `proxy_dest_match` is specified. See [ProxyPassReverse](https://httpd.apache.org/docs/current/mod/mod_proxy.html#proxypassreverse) for details. -Default value: `undef` +Default value: ``undef`` -##### `no_proxy_uris` +##### `no_proxy_uris` Data type: `Variant[Array[String[1]], String[1]]` @@ -11014,7 +11043,7 @@ data type. This configuration uses the [ProxyPass](https://httpd.apache.org/docs Default value: `[]` -##### `no_proxy_uris_match` +##### `no_proxy_uris_match` Data type: `Variant[Array[String[1]], String[1]]` @@ -11023,7 +11052,7 @@ as it instead uses [ProxyPassMatch](https://httpd.apache.org/docs/current/mod/mo Default value: `[]` -##### `proxy_pass` +##### `proxy_pass` Data type: `Optional[Array[Apache::Vhost::ProxyPass]]` @@ -11032,9 +11061,9 @@ configuration. See the documentation for the Apache::Vhost::ProxyPass data type for a detailed description of the structure including optional parameters. -Default value: `undef` +Default value: ``undef`` -##### `proxy_pass_match` +##### `proxy_pass_match` Data type: `Optional[Array[Apache::Vhost::ProxyPass]]` @@ -11042,35 +11071,35 @@ This directive is equivalent to `proxy_pass`, but takes regular expressions, see [ProxyPassMatch](https://httpd.apache.org/docs/current/mod/mod_proxy.html#proxypassmatch) for details. -Default value: `undef` +Default value: ``undef`` -##### `proxy_requests` +##### `proxy_requests` Data type: `Boolean` Enables forward (standard) proxy requests. See [ProxyRequests](https://httpd.apache.org/docs/current/mod/mod_proxy.html#proxyrequests) for details. -Default value: `false` +Default value: ``false`` -##### `proxy_preserve_host` +##### `proxy_preserve_host` Data type: `Boolean` When enabled, pass the `Host:` line from the incoming request to the proxied host. See [ProxyPreserveHost](https://httpd.apache.org/docs/current/mod/mod_proxy.html#proxypreservehost) for details. -Default value: `false` +Default value: ``false`` -##### `proxy_add_headers` +##### `proxy_add_headers` Data type: `Optional[Boolean]` Add X-Forwarded-For, X-Forwarded-Host, and X-Forwarded-Server HTTP headers. See [ProxyAddHeaders](https://httpd.apache.org/docs/current/mod/mod_proxy.html#proxyaddheaders) for details. -Default value: `undef` +Default value: ``undef`` -##### `proxy_error_override` +##### `proxy_error_override` Data type: `Boolean` @@ -11078,11 +11107,11 @@ Override error pages from the proxied host. The current Puppet implementation supports enabling or disabling the directive, but not specifying a custom list of status codes. See [ProxyErrorOverride](https://httpd.apache.org/docs/current/mod/mod_proxy.html#proxyerroroverride) for details. -Default value: `false` +Default value: ``false`` ## Functions -### `apache::apache_pw_hash` +### `apache::apache_pw_hash` Type: Ruby 4.x API @@ -11100,7 +11129,103 @@ Data type: `Any` -### `apache::bool2httpd` +### `apache::authz_core_config` + +Type: Ruby 4.x API + +Function to generate the authz_core configuration directives. + +#### Examples + +##### + +```puppet + +arg = { + require_all => { + 'require_any' => { + 'require' => ['user superadmin'], + 'require_all' => { + 'require' => ['group admins'], + }, + }, + 'require_none' => { + 'require' => ['group temps'] + } + } +} + +apache::bool2httpd(arg) +returns : +[ + " ", + " ", + " Require user superadmin", + " ", + " Require group admins", + " Require ldap-group \"cn=Administrators,o=Airius\"", + " ", + " ", + " ", + " Require group temps", + " Require ldap-group \"cn=Temporary Employees,o=Airius\"", + " ", + " " +] +``` + +#### `apache::authz_core_config(Hash $config)` + +The apache::authz_core_config function. + +Returns: `Array` Returns the authz_core config directives in array. + +##### Examples + +###### + +```puppet + +arg = { + require_all => { + 'require_any' => { + 'require' => ['user superadmin'], + 'require_all' => { + 'require' => ['group admins'], + }, + }, + 'require_none' => { + 'require' => ['group temps'] + } + } +} + +apache::bool2httpd(arg) +returns : +[ + " ", + " ", + " Require user superadmin", + " ", + " Require group admins", + " Require ldap-group \"cn=Administrators,o=Airius\"", + " ", + " ", + " ", + " Require group temps", + " Require ldap-group \"cn=Temporary Employees,o=Airius\"", + " ", + " " +] +``` + +##### `config` + +Data type: `Hash` + +The input as JSON format. + +### `apache::bool2httpd` Type: Ruby 4.x API @@ -11145,7 +11270,7 @@ Data type: `Any` The value to be converted into a string. -### `apache::pw_hash` +### `apache::pw_hash` Type: Ruby 4.x API @@ -11203,7 +11328,7 @@ Data type: `Any` ## Data types -### `Apache::LogLevel` +### `Apache::LogLevel` A string that conforms to the Apache `LogLevel` syntax. Different levels can be specified for individual apache modules. @@ -11231,18 +11356,26 @@ The levels are (in order of decreasing significance): * **See also** * https://httpd.apache.org/docs/current/mod/core.html#loglevel -Alias of `Pattern[/(emerg|alert|crit|error|warn|notice|info|debug|trace[1-8])/]` +Alias of + +```puppet +Pattern[/(emerg|alert|crit|error|warn|notice|info|debug|trace[1-8])/] +``` -### `Apache::ModProxyProtocol` +### `Apache::ModProxyProtocol` Supported protocols / schemes by mod_proxy * **See also** * https://httpd.apache.org/docs/2.4/mod/mod_proxy.html -Alias of `Pattern[/(\A(ajp|fcgi|ftp|h2c?|https?|scgi|uwsgi|wss?):\/\/.+\z)/, /(\Aunix:\/([^\n\/\0]+\/*)*\z)/]` +Alias of + +```puppet +Pattern[/(\A(ajp|fcgi|ftp|h2c?|https?|scgi|uwsgi|wss?):\/\/.+\z)/, /(\Aunix:\/([^\n\/\0]+\/*)*\z)/] +``` -### `Apache::OIDCSettings` +### `Apache::OIDCSettings` https://github.com/zmartzone/mod_auth_openidc/blob/master/auth_openidc.conf @@ -11360,22 +11493,40 @@ Struct[{ }] ``` -### `Apache::ServerTokens` +### `Apache::OnOff` + +A string that is accepted in Apache config to turn something on or off + +Alias of + +```puppet +Enum['On', 'on', 'Off', 'off'] +``` + +### `Apache::ServerTokens` A string that conforms to the Apache `ServerTokens` syntax. * **See also** * https://httpd.apache.org/docs/2.4/mod/core.html#servertokens -Alias of `Enum['Major', 'Minor', 'Min', 'Minimal', 'Prod', 'ProductOnly', 'OS', 'Full']` +Alias of -### `Apache::Vhost::Priority` +```puppet +Enum['Major', 'Minor', 'Min', 'Minimal', 'Prod', 'ProductOnly', 'OS', 'Full'] +``` + +### `Apache::Vhost::Priority` The priority on vhost -Alias of `Variant[Pattern[/^\d+$/], Integer, Boolean]` +Alias of + +```puppet +Variant[Pattern[/^\d+$/], Integer, Boolean] +``` -### `Apache::Vhost::ProxyPass` +### `Apache::Vhost::ProxyPass` host context. Because the implementation uses SetEnv, you must `include apache::mod::env`; for the same reason, this cannot set the newer `no-proxy` environment variable, which @@ -11463,35 +11614,35 @@ Struct[{ The following parameters are available in the `Apache::Vhost::ProxyPass` data type: -* [`path`](#-Apache--Vhost--ProxyPass--path) -* [`url`](#-Apache--Vhost--ProxyPass--url) -* [`params`](#-Apache--Vhost--ProxyPass--params) -* [`reverse_urls`](#-Apache--Vhost--ProxyPass--reverse_urls) -* [`reverse_cookies`](#-Apache--Vhost--ProxyPass--reverse_cookies) -* [`keywords`](#-Apache--Vhost--ProxyPass--keywords) -* [`setenv`](#-Apache--Vhost--ProxyPass--setenv) -* [`no_proxy_uris`](#-Apache--Vhost--ProxyPass--no_proxy_uris) -* [`no_proxy_uris_match`](#-Apache--Vhost--ProxyPass--no_proxy_uris_match) +* [`path`](#path) +* [`url`](#url) +* [`params`](#params) +* [`reverse_urls`](#reverse_urls) +* [`reverse_cookies`](#reverse_cookies) +* [`keywords`](#keywords) +* [`setenv`](#setenv) +* [`no_proxy_uris`](#no_proxy_uris) +* [`no_proxy_uris_match`](#no_proxy_uris_match) -##### `path` +##### `path` Data type: `String[1]` The virtual path on the local server to map. -##### `url` +##### `url` Data type: `String[1]` The URL to which the path and its children will be mapped. -##### `params` +##### `params` Data type: `Optional[Hash]` Optional [ProxyPass](https://httpd.apache.org/docs/current/mod/mod_proxy.html#proxypass) key-value parameters, such as connection settings. -##### `reverse_urls` +##### `reverse_urls` Data type: `Array[String[1]]` @@ -11499,7 +11650,7 @@ Optional (but usually recommended) URLs for [ProxyPassReverse](https://httpd.apa Allows Apache to adjust certain headers on HTTP redirect responses, to prevent redirects on the back-end from bypassing the reverse proxy. -##### `reverse_cookies` +##### `reverse_cookies` Data type: `Optional[Array[Hash]]` @@ -11515,7 +11666,7 @@ Options: * **:path** `Optional[String[1]]`: Internal path for [ProxyPassReverseCookiePath](https://httpd.apache.org/docs/current/mod/mod_proxy.html#proxypassreversecookiepath) configuration. * **:domain** `Optional[String[1]]`: Internal domain for [ProxyPassReverseCookieDomain](https://httpd.apache.org/docs/current/mod/mod_proxy.html#proxypassreversecookiedomain) configuration. -##### `keywords` +##### `keywords` Data type: `Optional[Array[String[1]]]` @@ -11523,20 +11674,20 @@ Array of optional keywords such as `nocanon`, `interpolate`, or `noquery` suppor by [ProxyPass](https://httpd.apache.org/docs/current/mod/mod_proxy.html#proxypass) (refer to subsection under heading "Additional ProxyPass Keywords"). -##### `setenv` +##### `setenv` Data type: `Optional[Array[String[1]]]` Optional Array of Strings of the form "${env_var_name} ${value}". Uses [SetEnv](https://httpd.apache.org/docs/current/mod/mod_env.html#setenv) to make [Protocol Adjustments](https://httpd.apache.org/docs/current/mod/mod_proxy.html#envsettings) to mod_proxy in the virtual -##### `no_proxy_uris` +##### `no_proxy_uris` Data type: `Optional[Array[String[1]]]` Optional Array of paths to exclude from proxying, using the `!` directive to [ProxyPass](https://httpd.apache.org/docs/current/mod/mod_proxy.html#proxypass). -##### `no_proxy_uris_match` +##### `no_proxy_uris_match` Data type: `Optional[Array[String[1]]]` diff --git a/lib/puppet/functions/apache/authz_core_config.rb b/lib/puppet/functions/apache/authz_core_config.rb new file mode 100644 index 0000000000..304ab9d739 --- /dev/null +++ b/lib/puppet/functions/apache/authz_core_config.rb @@ -0,0 +1,78 @@ +# frozen_string_literal: true + +# @summary +# Function to generate the authz_core configuration directives. +# +Puppet::Functions.create_function(:'apache::authz_core_config') do + # @param config + # The input as JSON format. + # + # @return + # Returns the authz_core config directives in array. + # + # @example + # + # arg = { + # require_all => { + # 'require_any' => { + # 'require' => ['user superadmin'], + # 'require_all' => { + # 'require' => ['group admins'], + # }, + # }, + # 'require_none' => { + # 'require' => ['group temps'] + # } + # } + # } + # + # apache::bool2httpd(arg) + # returns : + # [ + # " ", + # " ", + # " Require user superadmin", + # " ", + # " Require group admins", + # " Require ldap-group \"cn=Administrators,o=Airius\"", + # " ", + # " ", + # " ", + # " Require group temps", + # " Require ldap-group \"cn=Temporary Employees,o=Airius\"", + # " ", + # " " + # ] + # + dispatch :authz_core_config do + param 'Hash', :config + return_type 'Array' + end + + private + + def build_directive(value) + value.split('_').map(&:capitalize).join + end + + def authz_core_config(config, count = 1) + result_string = [] + config.map do |key, value| + directive = build_directive(key) + if value.is_a?(Hash) + result_string << spacing("<#{directive}>", count) + result_string << authz_core_config(value, count + 1) + result_string << spacing("", count) + else + value.map do |v| + result_string << spacing("#{directive} #{v}", count) + end + end + end + result_string.flatten + end + + def spacing(string, count) + (' ' * count) + string + end +end diff --git a/manifests/default_mods.pp b/manifests/default_mods.pp index 40a69bc89a..b03b2660b5 100644 --- a/manifests/default_mods.pp +++ b/manifests/default_mods.pp @@ -131,9 +131,7 @@ include apache::mod::filter # authz_core is needed for 'Require' directive - ::apache::mod { 'authz_core': - id => 'authz_core_module', - } + include apache::mod::authz_core # lots of stuff seems to break without access_compat ::apache::mod { 'access_compat': } @@ -145,17 +143,13 @@ ::apache::default_mods::load { $mods: } # authz_core is needed for 'Require' directive - ::apache::mod { 'authz_core': - id => 'authz_core_module', - } + include apache::mod::authz_core # filter is needed by mod_deflate include apache::mod::filter } else { # authz_core is needed for 'Require' directive - ::apache::mod { 'authz_core': - id => 'authz_core_module', - } + include apache::mod::authz_core # filter is needed by mod_deflate include apache::mod::filter diff --git a/manifests/mod/authz_core.pp b/manifests/mod/authz_core.pp new file mode 100644 index 0000000000..26fcb55c9a --- /dev/null +++ b/manifests/mod/authz_core.pp @@ -0,0 +1,8 @@ +# @summary +# Installs `mod_authz_core`. +# +# @see https://httpd.apache.org/docs/current/mod/mod_authz_core.html for additional documentation. +# +class apache::mod::authz_core { + apache::mod { 'authz_core': } +} diff --git a/manifests/vhost.pp b/manifests/vhost.pp index 3b9bca577d..75e77c2ed1 100644 --- a/manifests/vhost.pp +++ b/manifests/vhost.pp @@ -1455,6 +1455,33 @@ # } # ``` # +# lint:ignore:parameter_documentation +# @param authz_core +# lint:endignore +# Specifies mod_authz_core parameters for particular directories in a virtual host directory +# ```puppet +# apache::vhost { 'sample.example.net': +# docroot => '/path/to/directory', +# directories => [ +# { path => '/path/to/different/dir', +# authz_core => { +# require_all => { +# 'require_any' => { +# 'require' => ['user superadmin'], +# 'require_all' => { +# 'require' => ['group admins', 'ldap-group "cn=Administrators,o=Airius"'], +# }, +# }, +# 'require_none' => { +# 'require' => ['group temps', 'ldap-group "cn=Temporary Employees,o=Airius"'] +# } +# } +# } +# }, +# ], +# } +# ``` +# # @param ssl # Enables SSL for the virtual host. SSL virtual hosts only respond to HTTPS queries. # diff --git a/spec/functions/authz_core_config_spec.rb b/spec/functions/authz_core_config_spec.rb new file mode 100644 index 0000000000..068b82a31e --- /dev/null +++ b/spec/functions/authz_core_config_spec.rb @@ -0,0 +1,53 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'apache::authz_core_config' do + let(:input1) do + { + 'Require' => [ + 'user foo', + 'user bar', + ] + } + end + + let(:input2) do + { + 'require_all' => { + 'require_any' => { + 'require' => ['user superadmin'], + 'require_all' => { + 'require' => ['group admins', 'ldap-group "cn=Administrators,o=Airius"'] + } + }, + 'require_none' => { + 'require' => ['group temps', 'ldap-group "cn=Temporary Employees,o=Airius"'] + } + } + } + end + let(:output2) do + [ + ' ', + ' ', + ' Require user superadmin', + ' ', + ' Require group admins', + ' Require ldap-group "cn=Administrators,o=Airius"', + ' ', + ' ', + ' ', + ' Require group temps', + ' Require ldap-group "cn=Temporary Employees,o=Airius"', + ' ', + ' ', + ] + end + + it { is_expected.to run.with_params(nil).and_raise_error(StandardError) } + it { is_expected.to run.with_params([]).and_raise_error(StandardError) } + it { is_expected.to run.with_params({}).and_return([]) } + it { is_expected.to run.with_params(input1).and_return([' Require user foo', ' Require user bar']) } + it { is_expected.to run.with_params(input2).and_return(output2) } +end diff --git a/templates/vhost/_authz_core.epp b/templates/vhost/_authz_core.epp new file mode 100644 index 0000000000..fc26470c0b --- /dev/null +++ b/templates/vhost/_authz_core.epp @@ -0,0 +1,3 @@ +<% $authz_core_config.each |$line| { -%> + <%= $line %> +<%- } -%> diff --git a/templates/vhost/_directories.erb b/templates/vhost/_directories.erb index 35189f2369..79f28b2961 100644 --- a/templates/vhost/_directories.erb +++ b/templates/vhost/_directories.erb @@ -544,6 +544,9 @@ <%- if directory['custom_fragment'] -%> <%= directory['custom_fragment'] %> <%- end -%> + <%- if directory['authz_core'] -%> + <%= scope.call_function('epp',["apache/vhost/_authz_core.epp", 'authz_core_config' => scope.call_function('apache::authz_core_config', directory['authz_core'])]) -%> + <%- end -%> <%- if directory['gssapi'] -%> <%= scope.call_function('epp',["apache/vhost/_gssapi.epp", directory['gssapi']]) -%> <%- end -%> From c9cc80d8ee5fb638f06d044ef7aeade3e41e78f1 Mon Sep 17 00:00:00 2001 From: Ramesh Sencha Date: Wed, 20 Sep 2023 09:34:32 +0530 Subject: [PATCH 2/2] Update manifests/vhost.pp MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Romain Tartière --- REFERENCE.md | 5376 ++++++++++++++++++++++---------------------- manifests/vhost.pp | 154 +- 2 files changed, 2763 insertions(+), 2767 deletions(-) diff --git a/REFERENCE.md b/REFERENCE.md index de492908db..1b03b5a9b0 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -9,110 +9,110 @@ #### Public Classes * [`apache`](#apache): Guides the basic setup and installation of Apache on your system. -* [`apache::dev`](#apachedev): Installs Apache development libraries. -* [`apache::mod::actions`](#apachemodactions): Installs Apache mod_actions -* [`apache::mod::alias`](#apachemodalias): Installs and configures `mod_alias`. -* [`apache::mod::apreq2`](#apachemodapreq2): Installs `mod_apreq2`. -* [`apache::mod::auth_basic`](#apachemodauth_basic): Installs `mod_auth_basic` -* [`apache::mod::auth_cas`](#apachemodauth_cas): Installs and configures `mod_auth_cas`. -* [`apache::mod::auth_gssapi`](#apachemodauth_gssapi): Installs `mod_auth_gsappi`. -* [`apache::mod::auth_kerb`](#apachemodauth_kerb): Installs `mod_auth_kerb` -* [`apache::mod::auth_mellon`](#apachemodauth_mellon): Installs and configures `mod_auth_mellon`. -* [`apache::mod::auth_openidc`](#apachemodauth_openidc): Installs and configures `mod_auth_openidc`. -* [`apache::mod::authn_core`](#apachemodauthn_core): Installs `mod_authn_core`. -* [`apache::mod::authn_dbd`](#apachemodauthn_dbd): Installs `mod_authn_dbd`. -* [`apache::mod::authn_file`](#apachemodauthn_file): Installs `mod_authn_file`. -* [`apache::mod::authnz_ldap`](#apachemodauthnz_ldap): Installs `mod_authnz_ldap`. -* [`apache::mod::authnz_pam`](#apachemodauthnz_pam): Installs `mod_authnz_pam`. -* [`apache::mod::authz_core`](#apachemodauthz_core): Installs `mod_authz_core`. -* [`apache::mod::authz_groupfile`](#apachemodauthz_groupfile): Installs `mod_authz_groupfile` -* [`apache::mod::authz_user`](#apachemodauthz_user): Installs `mod_authz_user` -* [`apache::mod::autoindex`](#apachemodautoindex): Installs `mod_autoindex` -* [`apache::mod::cache`](#apachemodcache): Installs `mod_cache` -* [`apache::mod::cgi`](#apachemodcgi): Installs `mod_cgi`. -* [`apache::mod::cgid`](#apachemodcgid): Installs `mod_cgid`. -* [`apache::mod::cluster`](#apachemodcluster): Installs `mod_cluster`. -* [`apache::mod::data`](#apachemoddata): Installs and configures `mod_data`. -* [`apache::mod::dav`](#apachemoddav): Installs `mod_dav`. -* [`apache::mod::dav_fs`](#apachemoddav_fs): Installs `mod_dav_fs`. -* [`apache::mod::dav_svn`](#apachemoddav_svn): Installs and configures `mod_dav_svn`. -* [`apache::mod::dbd`](#apachemoddbd): Installs `mod_dbd`. -* [`apache::mod::deflate`](#apachemoddeflate): Installs and configures `mod_deflate`. -* [`apache::mod::dev`](#apachemoddev): Installs `mod_dev`. -* [`apache::mod::dir`](#apachemoddir): Installs and configures `mod_dir`. -* [`apache::mod::disk_cache`](#apachemoddisk_cache): Installs and configures `mod_disk_cache`. -* [`apache::mod::dumpio`](#apachemoddumpio): Installs and configures `mod_dumpio`. -* [`apache::mod::env`](#apachemodenv): Installs `mod_env`. -* [`apache::mod::event`](#apachemodevent): Installs and configures `mod_event`. -* [`apache::mod::expires`](#apachemodexpires): Installs and configures `mod_expires`. -* [`apache::mod::ext_filter`](#apachemodext_filter): Installs and configures `mod_ext_filter`. -* [`apache::mod::fcgid`](#apachemodfcgid): Installs and configures `mod_fcgid`. -* [`apache::mod::filter`](#apachemodfilter): Installs `mod_filter`. -* [`apache::mod::geoip`](#apachemodgeoip): Installs and configures `mod_geoip`. -* [`apache::mod::headers`](#apachemodheaders): Installs and configures `mod_headers`. -* [`apache::mod::http2`](#apachemodhttp2): Installs and configures `mod_http2`. -* [`apache::mod::include`](#apachemodinclude): Installs `mod_include`. -* [`apache::mod::info`](#apachemodinfo): Installs and configures `mod_info`. -* [`apache::mod::intercept_form_submit`](#apachemodintercept_form_submit): Installs `mod_intercept_form_submit`. -* [`apache::mod::itk`](#apachemoditk): Installs MPM `mod_itk`. -* [`apache::mod::jk`](#apachemodjk): Installs `mod_jk`. -* [`apache::mod::lbmethod_bybusyness`](#apachemodlbmethod_bybusyness): Installs `lbmethod_bybusyness`. -* [`apache::mod::lbmethod_byrequests`](#apachemodlbmethod_byrequests): Installs `lbmethod_byrequests`. -* [`apache::mod::lbmethod_bytraffic`](#apachemodlbmethod_bytraffic): Installs `lbmethod_bytraffic`. -* [`apache::mod::lbmethod_heartbeat`](#apachemodlbmethod_heartbeat): Installs `lbmethod_heartbeat`. -* [`apache::mod::ldap`](#apachemodldap): Installs and configures `mod_ldap`. -* [`apache::mod::log_forensic`](#apachemodlog_forensic): Installs `mod_log_forensic` -* [`apache::mod::lookup_identity`](#apachemodlookup_identity): Installs `mod_lookup_identity` -* [`apache::mod::macro`](#apachemodmacro): Installs `mod_macro`. -* [`apache::mod::md`](#apachemodmd): Installs and configures `mod_md`. -* [`apache::mod::mime`](#apachemodmime): Installs and configures `mod_mime`. -* [`apache::mod::mime_magic`](#apachemodmime_magic): Installs and configures `mod_mime_magic`. -* [`apache::mod::negotiation`](#apachemodnegotiation): Installs and configures `mod_negotiation`. -* [`apache::mod::nss`](#apachemodnss): Installs and configures `mod_nss`. -* [`apache::mod::pagespeed`](#apachemodpagespeed): Installs and manages mod_pagespeed, which is a Google module that rewrites web pages to reduce latency and bandwidth. +* [`apache::dev`](#apache--dev): Installs Apache development libraries. +* [`apache::mod::actions`](#apache--mod--actions): Installs Apache mod_actions +* [`apache::mod::alias`](#apache--mod--alias): Installs and configures `mod_alias`. +* [`apache::mod::apreq2`](#apache--mod--apreq2): Installs `mod_apreq2`. +* [`apache::mod::auth_basic`](#apache--mod--auth_basic): Installs `mod_auth_basic` +* [`apache::mod::auth_cas`](#apache--mod--auth_cas): Installs and configures `mod_auth_cas`. +* [`apache::mod::auth_gssapi`](#apache--mod--auth_gssapi): Installs `mod_auth_gsappi`. +* [`apache::mod::auth_kerb`](#apache--mod--auth_kerb): Installs `mod_auth_kerb` +* [`apache::mod::auth_mellon`](#apache--mod--auth_mellon): Installs and configures `mod_auth_mellon`. +* [`apache::mod::auth_openidc`](#apache--mod--auth_openidc): Installs and configures `mod_auth_openidc`. +* [`apache::mod::authn_core`](#apache--mod--authn_core): Installs `mod_authn_core`. +* [`apache::mod::authn_dbd`](#apache--mod--authn_dbd): Installs `mod_authn_dbd`. +* [`apache::mod::authn_file`](#apache--mod--authn_file): Installs `mod_authn_file`. +* [`apache::mod::authnz_ldap`](#apache--mod--authnz_ldap): Installs `mod_authnz_ldap`. +* [`apache::mod::authnz_pam`](#apache--mod--authnz_pam): Installs `mod_authnz_pam`. +* [`apache::mod::authz_core`](#apache--mod--authz_core): Installs `mod_authz_core`. +* [`apache::mod::authz_groupfile`](#apache--mod--authz_groupfile): Installs `mod_authz_groupfile` +* [`apache::mod::authz_user`](#apache--mod--authz_user): Installs `mod_authz_user` +* [`apache::mod::autoindex`](#apache--mod--autoindex): Installs `mod_autoindex` +* [`apache::mod::cache`](#apache--mod--cache): Installs `mod_cache` +* [`apache::mod::cgi`](#apache--mod--cgi): Installs `mod_cgi`. +* [`apache::mod::cgid`](#apache--mod--cgid): Installs `mod_cgid`. +* [`apache::mod::cluster`](#apache--mod--cluster): Installs `mod_cluster`. +* [`apache::mod::data`](#apache--mod--data): Installs and configures `mod_data`. +* [`apache::mod::dav`](#apache--mod--dav): Installs `mod_dav`. +* [`apache::mod::dav_fs`](#apache--mod--dav_fs): Installs `mod_dav_fs`. +* [`apache::mod::dav_svn`](#apache--mod--dav_svn): Installs and configures `mod_dav_svn`. +* [`apache::mod::dbd`](#apache--mod--dbd): Installs `mod_dbd`. +* [`apache::mod::deflate`](#apache--mod--deflate): Installs and configures `mod_deflate`. +* [`apache::mod::dev`](#apache--mod--dev): Installs `mod_dev`. +* [`apache::mod::dir`](#apache--mod--dir): Installs and configures `mod_dir`. +* [`apache::mod::disk_cache`](#apache--mod--disk_cache): Installs and configures `mod_disk_cache`. +* [`apache::mod::dumpio`](#apache--mod--dumpio): Installs and configures `mod_dumpio`. +* [`apache::mod::env`](#apache--mod--env): Installs `mod_env`. +* [`apache::mod::event`](#apache--mod--event): Installs and configures `mod_event`. +* [`apache::mod::expires`](#apache--mod--expires): Installs and configures `mod_expires`. +* [`apache::mod::ext_filter`](#apache--mod--ext_filter): Installs and configures `mod_ext_filter`. +* [`apache::mod::fcgid`](#apache--mod--fcgid): Installs and configures `mod_fcgid`. +* [`apache::mod::filter`](#apache--mod--filter): Installs `mod_filter`. +* [`apache::mod::geoip`](#apache--mod--geoip): Installs and configures `mod_geoip`. +* [`apache::mod::headers`](#apache--mod--headers): Installs and configures `mod_headers`. +* [`apache::mod::http2`](#apache--mod--http2): Installs and configures `mod_http2`. +* [`apache::mod::include`](#apache--mod--include): Installs `mod_include`. +* [`apache::mod::info`](#apache--mod--info): Installs and configures `mod_info`. +* [`apache::mod::intercept_form_submit`](#apache--mod--intercept_form_submit): Installs `mod_intercept_form_submit`. +* [`apache::mod::itk`](#apache--mod--itk): Installs MPM `mod_itk`. +* [`apache::mod::jk`](#apache--mod--jk): Installs `mod_jk`. +* [`apache::mod::lbmethod_bybusyness`](#apache--mod--lbmethod_bybusyness): Installs `lbmethod_bybusyness`. +* [`apache::mod::lbmethod_byrequests`](#apache--mod--lbmethod_byrequests): Installs `lbmethod_byrequests`. +* [`apache::mod::lbmethod_bytraffic`](#apache--mod--lbmethod_bytraffic): Installs `lbmethod_bytraffic`. +* [`apache::mod::lbmethod_heartbeat`](#apache--mod--lbmethod_heartbeat): Installs `lbmethod_heartbeat`. +* [`apache::mod::ldap`](#apache--mod--ldap): Installs and configures `mod_ldap`. +* [`apache::mod::log_forensic`](#apache--mod--log_forensic): Installs `mod_log_forensic` +* [`apache::mod::lookup_identity`](#apache--mod--lookup_identity): Installs `mod_lookup_identity` +* [`apache::mod::macro`](#apache--mod--macro): Installs `mod_macro`. +* [`apache::mod::md`](#apache--mod--md): Installs and configures `mod_md`. +* [`apache::mod::mime`](#apache--mod--mime): Installs and configures `mod_mime`. +* [`apache::mod::mime_magic`](#apache--mod--mime_magic): Installs and configures `mod_mime_magic`. +* [`apache::mod::negotiation`](#apache--mod--negotiation): Installs and configures `mod_negotiation`. +* [`apache::mod::nss`](#apache--mod--nss): Installs and configures `mod_nss`. +* [`apache::mod::pagespeed`](#apache--mod--pagespeed): Installs and manages mod_pagespeed, which is a Google module that rewrites web pages to reduce latency and bandwidth. This module does *not* manage the software repositories needed to automatically install the mod-pagespeed-stable package. The module does however require that the package be installed, or be installable using the system's default package provider. You should ensure that this pre-requisite is met or declaring `apache::mod::pagespeed` will cause the puppet run to fail. -* [`apache::mod::passenger`](#apachemodpassenger): Installs `mod_pasenger`. -* [`apache::mod::perl`](#apachemodperl): Installs `mod_perl`. -* [`apache::mod::peruser`](#apachemodperuser): Installs `mod_peruser`. -* [`apache::mod::php`](#apachemodphp): Installs `mod_php`. -* [`apache::mod::prefork`](#apachemodprefork): Installs and configures MPM `prefork`. -* [`apache::mod::proxy`](#apachemodproxy): Installs and configures `mod_proxy`. -* [`apache::mod::proxy_ajp`](#apachemodproxy_ajp): Installs `mod_proxy_ajp`. -* [`apache::mod::proxy_balancer`](#apachemodproxy_balancer): Installs and configures `mod_proxy_balancer`. -* [`apache::mod::proxy_connect`](#apachemodproxy_connect): Installs `mod_proxy_connect`. -* [`apache::mod::proxy_fcgi`](#apachemodproxy_fcgi): Installs `mod_proxy_fcgi`. -* [`apache::mod::proxy_html`](#apachemodproxy_html): Installs `mod_proxy_html`. -* [`apache::mod::proxy_http`](#apachemodproxy_http): Installs `mod_proxy_http`. -* [`apache::mod::proxy_http2`](#apachemodproxy_http2): Installs `mod_proxy_http2`. -* [`apache::mod::proxy_wstunnel`](#apachemodproxy_wstunnel): Installs `mod_proxy_wstunnel`. -* [`apache::mod::python`](#apachemodpython): Installs and configures `mod_python`. -* [`apache::mod::remoteip`](#apachemodremoteip): Installs and configures `mod_remoteip`. -* [`apache::mod::reqtimeout`](#apachemodreqtimeout): Installs and configures `mod_reqtimeout`. -* [`apache::mod::rewrite`](#apachemodrewrite): Installs `mod_rewrite`. -* [`apache::mod::rpaf`](#apachemodrpaf): Installs and configures `mod_rpaf`. -* [`apache::mod::security`](#apachemodsecurity): Installs and configures `mod_security`. -* [`apache::mod::setenvif`](#apachemodsetenvif): Installs `mod_setenvif`. -* [`apache::mod::shib`](#apachemodshib): Installs and configures `mod_shib`. -* [`apache::mod::socache_shmcb`](#apachemodsocache_shmcb): Installs `mod_socache_shmcb`. -* [`apache::mod::speling`](#apachemodspeling): Installs `mod_spelling`. -* [`apache::mod::ssl`](#apachemodssl): Installs `mod_ssl`. -* [`apache::mod::status`](#apachemodstatus): Installs and configures `mod_status`. -* [`apache::mod::suexec`](#apachemodsuexec): Installs `mod_suexec`. -* [`apache::mod::userdir`](#apachemoduserdir): Installs and configures `mod_userdir`. -* [`apache::mod::version`](#apachemodversion): Installs `mod_version`. -* [`apache::mod::vhost_alias`](#apachemodvhost_alias): Installs Apache `mod_vhost_alias`. -* [`apache::mod::watchdog`](#apachemodwatchdog): Installs and configures `mod_watchdog`. -* [`apache::mod::worker`](#apachemodworker): Installs and manages the MPM `worker`. -* [`apache::mod::wsgi`](#apachemodwsgi): Installs and configures `mod_wsgi`. -* [`apache::mod::xsendfile`](#apachemodxsendfile): Installs `mod_xsendfile`. -* [`apache::mpm::disable_mpm_event`](#apachempmdisable_mpm_event): disable Apache-Module event -* [`apache::mpm::disable_mpm_prefork`](#apachempmdisable_mpm_prefork): disable Apache-Module prefork -* [`apache::mpm::disable_mpm_worker`](#apachempmdisable_mpm_worker): disable Apache-Module worker -* [`apache::vhosts`](#apachevhosts): Creates `apache::vhost` defined types. +* [`apache::mod::passenger`](#apache--mod--passenger): Installs `mod_pasenger`. +* [`apache::mod::perl`](#apache--mod--perl): Installs `mod_perl`. +* [`apache::mod::peruser`](#apache--mod--peruser): Installs `mod_peruser`. +* [`apache::mod::php`](#apache--mod--php): Installs `mod_php`. +* [`apache::mod::prefork`](#apache--mod--prefork): Installs and configures MPM `prefork`. +* [`apache::mod::proxy`](#apache--mod--proxy): Installs and configures `mod_proxy`. +* [`apache::mod::proxy_ajp`](#apache--mod--proxy_ajp): Installs `mod_proxy_ajp`. +* [`apache::mod::proxy_balancer`](#apache--mod--proxy_balancer): Installs and configures `mod_proxy_balancer`. +* [`apache::mod::proxy_connect`](#apache--mod--proxy_connect): Installs `mod_proxy_connect`. +* [`apache::mod::proxy_fcgi`](#apache--mod--proxy_fcgi): Installs `mod_proxy_fcgi`. +* [`apache::mod::proxy_html`](#apache--mod--proxy_html): Installs `mod_proxy_html`. +* [`apache::mod::proxy_http`](#apache--mod--proxy_http): Installs `mod_proxy_http`. +* [`apache::mod::proxy_http2`](#apache--mod--proxy_http2): Installs `mod_proxy_http2`. +* [`apache::mod::proxy_wstunnel`](#apache--mod--proxy_wstunnel): Installs `mod_proxy_wstunnel`. +* [`apache::mod::python`](#apache--mod--python): Installs and configures `mod_python`. +* [`apache::mod::remoteip`](#apache--mod--remoteip): Installs and configures `mod_remoteip`. +* [`apache::mod::reqtimeout`](#apache--mod--reqtimeout): Installs and configures `mod_reqtimeout`. +* [`apache::mod::rewrite`](#apache--mod--rewrite): Installs `mod_rewrite`. +* [`apache::mod::rpaf`](#apache--mod--rpaf): Installs and configures `mod_rpaf`. +* [`apache::mod::security`](#apache--mod--security): Installs and configures `mod_security`. +* [`apache::mod::setenvif`](#apache--mod--setenvif): Installs `mod_setenvif`. +* [`apache::mod::shib`](#apache--mod--shib): Installs and configures `mod_shib`. +* [`apache::mod::socache_shmcb`](#apache--mod--socache_shmcb): Installs `mod_socache_shmcb`. +* [`apache::mod::speling`](#apache--mod--speling): Installs `mod_spelling`. +* [`apache::mod::ssl`](#apache--mod--ssl): Installs `mod_ssl`. +* [`apache::mod::status`](#apache--mod--status): Installs and configures `mod_status`. +* [`apache::mod::suexec`](#apache--mod--suexec): Installs `mod_suexec`. +* [`apache::mod::userdir`](#apache--mod--userdir): Installs and configures `mod_userdir`. +* [`apache::mod::version`](#apache--mod--version): Installs `mod_version`. +* [`apache::mod::vhost_alias`](#apache--mod--vhost_alias): Installs Apache `mod_vhost_alias`. +* [`apache::mod::watchdog`](#apache--mod--watchdog): Installs and configures `mod_watchdog`. +* [`apache::mod::worker`](#apache--mod--worker): Installs and manages the MPM `worker`. +* [`apache::mod::wsgi`](#apache--mod--wsgi): Installs and configures `mod_wsgi`. +* [`apache::mod::xsendfile`](#apache--mod--xsendfile): Installs `mod_xsendfile`. +* [`apache::mpm::disable_mpm_event`](#apache--mpm--disable_mpm_event): disable Apache-Module event +* [`apache::mpm::disable_mpm_prefork`](#apache--mpm--disable_mpm_prefork): disable Apache-Module prefork +* [`apache::mpm::disable_mpm_worker`](#apache--mpm--disable_mpm_worker): disable Apache-Module worker +* [`apache::vhosts`](#apache--vhosts): Creates `apache::vhost` defined types. #### Private Classes @@ -133,22 +133,22 @@ pre-requisite is met or declaring `apache::mod::pagespeed` will cause the puppet #### Public Defined types -* [`apache::balancer`](#apachebalancer): This type will create an apache balancer cluster file inside the conf.d +* [`apache::balancer`](#apache--balancer): This type will create an apache balancer cluster file inside the conf.d directory. -* [`apache::balancermember`](#apachebalancermember): Defines members of `mod_proxy_balancer` -* [`apache::custom_config`](#apachecustom_config): Adds a custom configuration file to the Apache server's `conf.d` directory. -* [`apache::fastcgi::server`](#apachefastcgiserver): Defines one or more external FastCGI servers to handle specific file types. Use this +* [`apache::balancermember`](#apache--balancermember): Defines members of `mod_proxy_balancer` +* [`apache::custom_config`](#apache--custom_config): Adds a custom configuration file to the Apache server's `conf.d` directory. +* [`apache::fastcgi::server`](#apache--fastcgi--server): Defines one or more external FastCGI servers to handle specific file types. Use this defined type with `mod_fastcgi`. -* [`apache::listen`](#apachelisten): Adds `Listen` directives to `ports.conf` that define the +* [`apache::listen`](#apache--listen): Adds `Listen` directives to `ports.conf` that define the Apache server's or a virtual host's listening address and port. -* [`apache::mod`](#apachemod): Installs packages for an Apache module that doesn't have a corresponding +* [`apache::mod`](#apache--mod): Installs packages for an Apache module that doesn't have a corresponding `apache::mod::` class. -* [`apache::namevirtualhost`](#apachenamevirtualhost): Enables name-based virtual hosts -* [`apache::vhost`](#apachevhost): Allows specialised configurations for virtual hosts that possess requirements +* [`apache::namevirtualhost`](#apache--namevirtualhost): Enables name-based virtual hosts +* [`apache::vhost`](#apache--vhost): Allows specialised configurations for virtual hosts that possess requirements outside of the defaults. -* [`apache::vhost::custom`](#apachevhostcustom): A wrapper around the `apache::custom_config` defined type. -* [`apache::vhost::fragment`](#apachevhostfragment): Define a fragment within a vhost -* [`apache::vhost::proxy`](#apachevhostproxy): Configure a reverse proxy for a vhost +* [`apache::vhost::custom`](#apache--vhost--custom): A wrapper around the `apache::custom_config` defined type. +* [`apache::vhost::fragment`](#apache--vhost--fragment): Define a fragment within a vhost +* [`apache::vhost::proxy`](#apache--vhost--proxy): Configure a reverse proxy for a vhost #### Private Defined types @@ -160,22 +160,22 @@ outside of the defaults. ### Functions -* [`apache::apache_pw_hash`](#apacheapache_pw_hash): DEPRECATED. Use the function [`apache::pw_hash`](#apachepw_hash) instead. -* [`apache::authz_core_config`](#apacheauthz_core_config): Function to generate the authz_core configuration directives. -* [`apache::bool2httpd`](#apachebool2httpd): Transform a supposed boolean to On or Off. Passes all other values through. -* [`apache::pw_hash`](#apachepw_hash): Hashes a password in a format suitable for htpasswd files read by apache. +* [`apache::apache_pw_hash`](#apache--apache_pw_hash): DEPRECATED. Use the function [`apache::pw_hash`](#apachepw_hash) instead. +* [`apache::authz_core_config`](#apache--authz_core_config): Function to generate the authz_core configuration directives. +* [`apache::bool2httpd`](#apache--bool2httpd): Transform a supposed boolean to On or Off. Passes all other values through. +* [`apache::pw_hash`](#apache--pw_hash): Hashes a password in a format suitable for htpasswd files read by apache. * [`apache_pw_hash`](#apache_pw_hash): DEPRECATED. Use the namespaced function [`apache::pw_hash`](#apachepw_hash) instead. * [`bool2httpd`](#bool2httpd): DEPRECATED. Use the namespaced function [`apache::bool2httpd`](#apachebool2httpd) instead. ### Data types -* [`Apache::LogLevel`](#apacheloglevel): A string that conforms to the Apache `LogLevel` syntax. -* [`Apache::ModProxyProtocol`](#apachemodproxyprotocol): Supported protocols / schemes by mod_proxy -* [`Apache::OIDCSettings`](#apacheoidcsettings): https://github.com/zmartzone/mod_auth_openidc/blob/master/auth_openidc.conf -* [`Apache::OnOff`](#apacheonoff): A string that is accepted in Apache config to turn something on or off -* [`Apache::ServerTokens`](#apacheservertokens): A string that conforms to the Apache `ServerTokens` syntax. -* [`Apache::Vhost::Priority`](#apachevhostpriority): The priority on vhost -* [`Apache::Vhost::ProxyPass`](#apachevhostproxypass): Struct representing reverse proxy configuration for an Apache vhost, used by the Apache::Vhost::Proxy defined resource type. +* [`Apache::LogLevel`](#Apache--LogLevel): A string that conforms to the Apache `LogLevel` syntax. +* [`Apache::ModProxyProtocol`](#Apache--ModProxyProtocol): Supported protocols / schemes by mod_proxy +* [`Apache::OIDCSettings`](#Apache--OIDCSettings): https://github.com/zmartzone/mod_auth_openidc/blob/master/auth_openidc.conf +* [`Apache::OnOff`](#Apache--OnOff): A string that is accepted in Apache config to turn something on or off +* [`Apache::ServerTokens`](#Apache--ServerTokens): A string that conforms to the Apache `ServerTokens` syntax. +* [`Apache::Vhost::Priority`](#Apache--Vhost--Priority): The priority on vhost +* [`Apache::Vhost::ProxyPass`](#Apache--Vhost--ProxyPass): Struct representing reverse proxy configuration for an Apache vhost, used by the Apache::Vhost::Proxy defined resource type. ### Tasks @@ -206,95 +206,95 @@ class { 'apache': } The following parameters are available in the `apache` class: -* [`allow_encoded_slashes`](#allow_encoded_slashes) -* [`conf_dir`](#conf_dir) -* [`conf_template`](#conf_template) -* [`confd_dir`](#confd_dir) -* [`default_charset`](#default_charset) -* [`default_confd_files`](#default_confd_files) -* [`default_mods`](#default_mods) -* [`default_ssl_ca`](#default_ssl_ca) -* [`default_ssl_cert`](#default_ssl_cert) -* [`default_ssl_chain`](#default_ssl_chain) -* [`default_ssl_crl`](#default_ssl_crl) -* [`default_ssl_crl_path`](#default_ssl_crl_path) -* [`default_ssl_crl_check`](#default_ssl_crl_check) -* [`default_ssl_key`](#default_ssl_key) -* [`default_ssl_reload_on_change`](#default_ssl_reload_on_change) -* [`default_ssl_vhost`](#default_ssl_vhost) -* [`default_type`](#default_type) -* [`default_vhost`](#default_vhost) -* [`dev_packages`](#dev_packages) -* [`docroot`](#docroot) -* [`error_documents`](#error_documents) -* [`group`](#group) -* [`httpd_dir`](#httpd_dir) -* [`http_protocol_options`](#http_protocol_options) -* [`keepalive`](#keepalive) -* [`keepalive_timeout`](#keepalive_timeout) -* [`max_keepalive_requests`](#max_keepalive_requests) -* [`hostname_lookups`](#hostname_lookups) -* [`ldap_trusted_mode`](#ldap_trusted_mode) -* [`ldap_verify_server_cert`](#ldap_verify_server_cert) -* [`lib_path`](#lib_path) -* [`log_level`](#log_level) -* [`log_formats`](#log_formats) -* [`logroot`](#logroot) -* [`logroot_mode`](#logroot_mode) -* [`manage_group`](#manage_group) -* [`supplementary_groups`](#supplementary_groups) -* [`manage_user`](#manage_user) -* [`mod_dir`](#mod_dir) -* [`mod_libs`](#mod_libs) -* [`mod_packages`](#mod_packages) -* [`mpm_module`](#mpm_module) -* [`package_ensure`](#package_ensure) -* [`pidfile`](#pidfile) -* [`ports_file`](#ports_file) -* [`protocols`](#protocols) -* [`protocols_honor_order`](#protocols_honor_order) -* [`purge_configs`](#purge_configs) -* [`purge_vhost_dir`](#purge_vhost_dir) -* [`sendfile`](#sendfile) -* [`serveradmin`](#serveradmin) -* [`servername`](#servername) -* [`server_root`](#server_root) -* [`server_signature`](#server_signature) -* [`server_tokens`](#server_tokens) -* [`service_enable`](#service_enable) -* [`service_ensure`](#service_ensure) -* [`service_name`](#service_name) -* [`service_manage`](#service_manage) -* [`service_restart`](#service_restart) -* [`timeout`](#timeout) -* [`trace_enable`](#trace_enable) -* [`use_canonical_name`](#use_canonical_name) -* [`use_systemd`](#use_systemd) -* [`file_mode`](#file_mode) -* [`root_directory_options`](#root_directory_options) -* [`root_directory_secured`](#root_directory_secured) -* [`vhost_dir`](#vhost_dir) -* [`vhost_include_pattern`](#vhost_include_pattern) -* [`user`](#user) -* [`apache_name`](#apache_name) -* [`error_log`](#error_log) -* [`scriptalias`](#scriptalias) -* [`access_log_file`](#access_log_file) -* [`limitreqfields`](#limitreqfields) -* [`limitreqfieldsize`](#limitreqfieldsize) -* [`limitreqline`](#limitreqline) -* [`ip`](#ip) -* [`purge_vdir`](#purge_vdir) -* [`conf_enabled`](#conf_enabled) -* [`vhost_enable_dir`](#vhost_enable_dir) -* [`manage_vhost_enable_dir`](#manage_vhost_enable_dir) -* [`mod_enable_dir`](#mod_enable_dir) -* [`ssl_file`](#ssl_file) -* [`file_e_tag`](#file_e_tag) -* [`use_optional_includes`](#use_optional_includes) -* [`mime_types_additional`](#mime_types_additional) - -##### `allow_encoded_slashes` +* [`allow_encoded_slashes`](#-apache--allow_encoded_slashes) +* [`conf_dir`](#-apache--conf_dir) +* [`conf_template`](#-apache--conf_template) +* [`confd_dir`](#-apache--confd_dir) +* [`default_charset`](#-apache--default_charset) +* [`default_confd_files`](#-apache--default_confd_files) +* [`default_mods`](#-apache--default_mods) +* [`default_ssl_ca`](#-apache--default_ssl_ca) +* [`default_ssl_cert`](#-apache--default_ssl_cert) +* [`default_ssl_chain`](#-apache--default_ssl_chain) +* [`default_ssl_crl`](#-apache--default_ssl_crl) +* [`default_ssl_crl_path`](#-apache--default_ssl_crl_path) +* [`default_ssl_crl_check`](#-apache--default_ssl_crl_check) +* [`default_ssl_key`](#-apache--default_ssl_key) +* [`default_ssl_reload_on_change`](#-apache--default_ssl_reload_on_change) +* [`default_ssl_vhost`](#-apache--default_ssl_vhost) +* [`default_type`](#-apache--default_type) +* [`default_vhost`](#-apache--default_vhost) +* [`dev_packages`](#-apache--dev_packages) +* [`docroot`](#-apache--docroot) +* [`error_documents`](#-apache--error_documents) +* [`group`](#-apache--group) +* [`httpd_dir`](#-apache--httpd_dir) +* [`http_protocol_options`](#-apache--http_protocol_options) +* [`keepalive`](#-apache--keepalive) +* [`keepalive_timeout`](#-apache--keepalive_timeout) +* [`max_keepalive_requests`](#-apache--max_keepalive_requests) +* [`hostname_lookups`](#-apache--hostname_lookups) +* [`ldap_trusted_mode`](#-apache--ldap_trusted_mode) +* [`ldap_verify_server_cert`](#-apache--ldap_verify_server_cert) +* [`lib_path`](#-apache--lib_path) +* [`log_level`](#-apache--log_level) +* [`log_formats`](#-apache--log_formats) +* [`logroot`](#-apache--logroot) +* [`logroot_mode`](#-apache--logroot_mode) +* [`manage_group`](#-apache--manage_group) +* [`supplementary_groups`](#-apache--supplementary_groups) +* [`manage_user`](#-apache--manage_user) +* [`mod_dir`](#-apache--mod_dir) +* [`mod_libs`](#-apache--mod_libs) +* [`mod_packages`](#-apache--mod_packages) +* [`mpm_module`](#-apache--mpm_module) +* [`package_ensure`](#-apache--package_ensure) +* [`pidfile`](#-apache--pidfile) +* [`ports_file`](#-apache--ports_file) +* [`protocols`](#-apache--protocols) +* [`protocols_honor_order`](#-apache--protocols_honor_order) +* [`purge_configs`](#-apache--purge_configs) +* [`purge_vhost_dir`](#-apache--purge_vhost_dir) +* [`sendfile`](#-apache--sendfile) +* [`serveradmin`](#-apache--serveradmin) +* [`servername`](#-apache--servername) +* [`server_root`](#-apache--server_root) +* [`server_signature`](#-apache--server_signature) +* [`server_tokens`](#-apache--server_tokens) +* [`service_enable`](#-apache--service_enable) +* [`service_ensure`](#-apache--service_ensure) +* [`service_name`](#-apache--service_name) +* [`service_manage`](#-apache--service_manage) +* [`service_restart`](#-apache--service_restart) +* [`timeout`](#-apache--timeout) +* [`trace_enable`](#-apache--trace_enable) +* [`use_canonical_name`](#-apache--use_canonical_name) +* [`use_systemd`](#-apache--use_systemd) +* [`file_mode`](#-apache--file_mode) +* [`root_directory_options`](#-apache--root_directory_options) +* [`root_directory_secured`](#-apache--root_directory_secured) +* [`vhost_dir`](#-apache--vhost_dir) +* [`vhost_include_pattern`](#-apache--vhost_include_pattern) +* [`user`](#-apache--user) +* [`apache_name`](#-apache--apache_name) +* [`error_log`](#-apache--error_log) +* [`scriptalias`](#-apache--scriptalias) +* [`access_log_file`](#-apache--access_log_file) +* [`limitreqfields`](#-apache--limitreqfields) +* [`limitreqfieldsize`](#-apache--limitreqfieldsize) +* [`limitreqline`](#-apache--limitreqline) +* [`ip`](#-apache--ip) +* [`purge_vdir`](#-apache--purge_vdir) +* [`conf_enabled`](#-apache--conf_enabled) +* [`vhost_enable_dir`](#-apache--vhost_enable_dir) +* [`manage_vhost_enable_dir`](#-apache--manage_vhost_enable_dir) +* [`mod_enable_dir`](#-apache--mod_enable_dir) +* [`ssl_file`](#-apache--ssl_file) +* [`file_e_tag`](#-apache--file_e_tag) +* [`use_optional_includes`](#-apache--use_optional_includes) +* [`mime_types_additional`](#-apache--mime_types_additional) + +##### `allow_encoded_slashes` Data type: `Optional[Variant[Apache::OnOff, Enum['nodecode']]]` @@ -302,9 +302,9 @@ Sets the server default for the `AllowEncodedSlashes` declaration, which modifie responses to URLs containing '\' and '/' characters. If not specified, this parameter omits the declaration from the server's configuration and uses Apache's default setting of 'off'. -Default value: ``undef`` +Default value: `undef` -##### `conf_dir` +##### `conf_dir` Data type: `Stdlib::Absolutepath` @@ -312,7 +312,7 @@ Sets the directory where the Apache server's main configuration file is located. Default value: `$apache::params::conf_dir` -##### `conf_template` +##### `conf_template` Data type: `String` @@ -322,7 +322,7 @@ configuration file customized by `conf.d` entries. Default value: `$apache::params::conf_template` -##### `confd_dir` +##### `confd_dir` Data type: `Stdlib::Absolutepath` @@ -330,15 +330,15 @@ Sets the location of the Apache server's custom configuration directory. Default value: `$apache::params::confd_dir` -##### `default_charset` +##### `default_charset` Data type: `Optional[String]` Used as the `AddDefaultCharset` directive in the main configuration file. -Default value: ``undef`` +Default value: `undef` -##### `default_confd_files` +##### `default_confd_files` Data type: `Boolean` @@ -347,9 +347,9 @@ in the directory defined by the `confd_dir` parameter. These configuration files correspond to what is typically installed with the Apache package on the server's operating system. -Default value: ``true`` +Default value: `true` -##### `default_mods` +##### `default_mods` Data type: `Variant[Array[String[1]], Boolean]` @@ -363,9 +363,9 @@ the value of the `mpm_module` parameter. Because these lists of modules can change frequently, consult the Puppet module's code for up-to-date lists.
If this parameter contains an array, Puppet instead enables all passed Apache modules. -Default value: ``true`` +Default value: `true` -##### `default_ssl_ca` +##### `default_ssl_ca` Data type: `Optional[Stdlib::Absolutepath]` @@ -374,9 +374,9 @@ Although the default value results in a functioning Apache server, you **must** this parameter with your certificate authority information before deploying this server in a production environment. -Default value: ``undef`` +Default value: `undef` -##### `default_ssl_cert` +##### `default_ssl_cert` Data type: `Stdlib::Absolutepath` @@ -386,7 +386,7 @@ parameter with your certificate location before deploying this server in a produ Default value: `$apache::params::default_ssl_cert` -##### `default_ssl_chain` +##### `default_ssl_chain` Data type: `Optional[Stdlib::Absolutepath]` @@ -394,9 +394,9 @@ Sets the default SSL chain location.
Although this default value results in a functioning Apache server, you **must** update this parameter with your SSL chain before deploying this server in a production environment. -Default value: ``undef`` +Default value: `undef` -##### `default_ssl_crl` +##### `default_ssl_crl` Data type: `Optional[Stdlib::Absolutepath]` @@ -405,9 +405,9 @@ Although this default value results in a functioning Apache server, you **must** this parameter with the CRL file path before deploying this server in a production environment. You can use this parameter with or in place of the `default_ssl_crl_path`. -Default value: ``undef`` +Default value: `undef` -##### `default_ssl_crl_path` +##### `default_ssl_crl_path` Data type: `Optional[Stdlib::Absolutepath]` @@ -415,9 +415,9 @@ Sets the server's certificate revocation list path, which contains your CRLs.
`default_ssl_crl_check` +##### `default_ssl_crl_check` Data type: `Optional[String]` @@ -426,9 +426,9 @@ This parameter applies only to Apache 2.4 or higher and is ignored on older vers Although this default value results in a functioning Apache server, you **must** specify this parameter when using certificate revocation lists in a production environment. -Default value: ``undef`` +Default value: `undef` -##### `default_ssl_key` +##### `default_ssl_key` Data type: `Stdlib::Absolutepath` @@ -439,15 +439,15 @@ environment. Default value: `$apache::params::default_ssl_key` -##### `default_ssl_reload_on_change` +##### `default_ssl_reload_on_change` Data type: `Boolean` Enable reloading of apache if the content of ssl files have changed. -Default value: ``false`` +Default value: `false` -##### `default_ssl_vhost` +##### `default_ssl_vhost` Data type: `Boolean` @@ -466,9 +466,9 @@ apache::vhost { 'default-ssl': ``` **Note**: SSL virtual hosts only respond to HTTPS queries. -Default value: ``false`` +Default value: `false` -##### `default_type` +##### `default_type` Data type: `String` @@ -478,7 +478,7 @@ newer, and is only for backwards compatibility in configuration files. Default value: `'none'` -##### `default_vhost` +##### `default_vhost` Data type: `Boolean` @@ -488,9 +488,9 @@ value to `false`.
> **Note**: Apache will not start without at least one virtual host. If you set this to `false` you must configure a virtual host elsewhere. -Default value: ``true`` +Default value: `true` -##### `dev_packages` +##### `dev_packages` Data type: `Optional[Variant[Array, String]]` @@ -506,7 +506,7 @@ class { 'apache': Default value: `$apache::params::dev_packages` -##### `docroot` +##### `docroot` Data type: `Stdlib::Absolutepath` @@ -514,15 +514,15 @@ Sets the default `DocumentRoot` location. Default value: `$apache::params::docroot` -##### `error_documents` +##### `error_documents` Data type: `Boolean` Determines whether to enable [custom error documents](https://httpd.apache.org/docs/current/custom-error.html) on the Apache server. -Default value: ``false`` +Default value: `false` -##### `group` +##### `group` Data type: `String` @@ -537,7 +537,7 @@ process. Default value: `$apache::params::group` -##### `httpd_dir` +##### `httpd_dir` Data type: `Stdlib::Absolutepath` @@ -547,7 +547,7 @@ with the default distribution packages. Default value: `$apache::params::httpd_dir` -##### `http_protocol_options` +##### `http_protocol_options` Data type: `Optional[String]` @@ -557,7 +557,7 @@ Valid options: any sequence of the following alternative values: `Strict` or `Un Default value: `$apache::params::http_protocol_options` -##### `keepalive` +##### `keepalive` Data type: `Apache::OnOff` @@ -567,7 +567,7 @@ to set relevant options.
Default value: `$apache::params::keepalive` -##### `keepalive_timeout` +##### `keepalive_timeout` Data type: `Integer` @@ -577,7 +577,7 @@ only relevant if the `keepalive` parameter is enabled. Default value: `$apache::params::keepalive_timeout` -##### `max_keepalive_requests` +##### `max_keepalive_requests` Data type: `Integer` @@ -585,7 +585,7 @@ Limits the number of requests allowed per connection when the `keepalive` parame Default value: `$apache::params::max_keepalive_requests` -##### `hostname_lookups` +##### `hostname_lookups` Data type: `Variant[Apache::OnOff, Enum['Double', 'double']]` @@ -595,7 +595,7 @@ CGIs/SSIs in REMOTE_HOST.
Default value: `$apache::params::hostname_lookups` -##### `ldap_trusted_mode` +##### `ldap_trusted_mode` Data type: `Optional[String]` @@ -607,9 +607,9 @@ The following modes are supported: Not all LDAP toolkits support all the above modes. An error message will be logged at runtime if a mode is not supported, and the connection to the LDAP server will fail. -Default value: ``undef`` +Default value: `undef` -##### `ldap_verify_server_cert` +##### `ldap_verify_server_cert` Data type: `Optional[Apache::OnOff]` @@ -617,9 +617,9 @@ Specifies whether to force the verification of a server certificate when establi connection to the LDAP server. On|Off -Default value: ``undef`` +Default value: `undef` -##### `lib_path` +##### `lib_path` Data type: `String` @@ -628,7 +628,7 @@ Specifies the location whereApache module files are stored.
Default value: `$apache::params::lib_path` -##### `log_level` +##### `log_level` Data type: `Apache::LogLevel` @@ -637,7 +637,7 @@ which adjusts the verbosity of the messages recorded in the error logs. Default value: `$apache::params::log_level` -##### `log_formats` +##### `log_formats` Data type: `Hash` @@ -657,7 +657,7 @@ If your `log_formats` parameter contains one of those, it will be overwritten wi Default value: `{}` -##### `logroot` +##### `logroot` Data type: `Stdlib::Absolutepath` @@ -665,7 +665,7 @@ Changes the directory of Apache log files for the virtual host. Default value: `$apache::params::logroot` -##### `logroot_mode` +##### `logroot_mode` Data type: `Optional[Stdlib::Filemode]` @@ -676,7 +676,7 @@ for details. Default value: `$apache::params::logroot_mode` -##### `manage_group` +##### `manage_group` Data type: `Boolean` @@ -685,9 +685,9 @@ If you have a group created from another Puppet module that you want to use to r set this to `false`. Without this parameter, attempting to use a previously established group results in a duplicate resource error. -Default value: ``true`` +Default value: `true` -##### `supplementary_groups` +##### `supplementary_groups` Data type: `Array` @@ -696,7 +696,7 @@ Notice: This option only has an effect when `manage_user` is set to true. Default value: `[]` -##### `manage_user` +##### `manage_user` Data type: `Boolean` @@ -705,9 +705,9 @@ This is for instances when you have a user, created from another Puppet module, to use to run Apache. Without this parameter, attempting to use a previously established user would result in a duplicate resource error. -Default value: ``true`` +Default value: `true` -##### `mod_dir` +##### `mod_dir` Data type: `Stdlib::Absolutepath` @@ -715,7 +715,7 @@ Sets where Puppet places configuration files for your Apache modules. Default value: `$apache::params::mod_dir` -##### `mod_libs` +##### `mod_libs` Data type: `Hash` @@ -731,7 +731,7 @@ class { 'apache': Default value: `$apache::params::mod_libs` -##### `mod_packages` +##### `mod_packages` Data type: `Hash` @@ -747,7 +747,7 @@ class { 'apache': Default value: `$apache::params::mod_packages` -##### `mpm_module` +##### `mpm_module` Data type: `Variant[Boolean, Enum['event', 'itk', 'peruser', 'prefork', 'worker']]` @@ -762,7 +762,7 @@ You must set this to `false` to explicitly declare the following classes with cu Default value: `$apache::params::mpm_module` -##### `package_ensure` +##### `package_ensure` Data type: `String` @@ -771,7 +771,7 @@ Controls the `package` resource's `ensure` attribute. Valid values are: `absent` Default value: `'installed'` -##### `pidfile` +##### `pidfile` Data type: `String` @@ -779,7 +779,7 @@ Allows settting a custom location for the pid file. Useful if using a custom-bui Default value: `$apache::params::pidfile` -##### `ports_file` +##### `ports_file` Data type: `Stdlib::Absolutepath` @@ -787,7 +787,7 @@ Sets the path to the file containing Apache ports configuration. Default value: `$apache::params::ports_file` -##### `protocols` +##### `protocols` Data type: `Array[Enum['h2', 'h2c', 'http/1.1']]` @@ -796,16 +796,16 @@ directive, which lists available protocols for the server. Default value: `[]` -##### `protocols_honor_order` +##### `protocols_honor_order` Data type: `Optional[Boolean]` Sets the [ProtocolsHonorOrder](https://httpd.apache.org/docs/current/en/mod/core.html#protocolshonororder) directive which determines whether the order of Protocols sets precedence during negotiation. -Default value: ``undef`` +Default value: `undef` -##### `purge_configs` +##### `purge_configs` Data type: `Boolean` @@ -814,9 +814,9 @@ Setting this to `false` is a stopgap measure to allow the apache module to coexi existing or unmanaged configurations. We recommend moving your configuration to resources within this module. For virtual host configurations, see `purge_vhost_dir`. -Default value: ``true`` +Default value: `true` -##### `purge_vhost_dir` +##### `purge_vhost_dir` Data type: `Optional[Boolean]` @@ -826,9 +826,9 @@ by Puppet.
Setting `purge_vhost_dir` to `false` is a stopgap measure to allow the apache module to coexist with existing or otherwise unmanaged configurations within `vhost_dir`. -Default value: ``undef`` +Default value: `undef` -##### `sendfile` +##### `sendfile` Data type: `Apache::OnOff` @@ -837,15 +837,15 @@ Forces Apache to use the Linux kernel's `sendfile` support to serve static files Default value: `'On'` -##### `serveradmin` +##### `serveradmin` Data type: `Optional[String[1]]` Sets the Apache server administrator's contact information via Apache's `ServerAdmin` directive. -Default value: ``undef`` +Default value: `undef` -##### `servername` +##### `servername` Data type: `Optional[String]` @@ -854,7 +854,7 @@ Setting to `false` will not set ServerName at all. Default value: `$apache::params::servername` -##### `server_root` +##### `server_root` Data type: `Stdlib::Absolutepath` @@ -862,7 +862,7 @@ Sets the Apache server's root directory via Apache's `ServerRoot` directive. Default value: `$apache::params::server_root` -##### `server_signature` +##### `server_signature` Data type: `Variant[Apache::OnOff, String]` @@ -872,7 +872,7 @@ directive. Valid values are: `On` or `Off`. Default value: `'On'` -##### `server_tokens` +##### `server_tokens` Data type: `Apache::ServerTokens` @@ -881,15 +881,15 @@ system, via Apache's `ServerTokens` directive. Default value: `'Prod'` -##### `service_enable` +##### `service_enable` Data type: `Boolean` Determines whether Puppet enables the Apache HTTPD service when the system is booted. -Default value: ``true`` +Default value: `true` -##### `service_ensure` +##### `service_ensure` Data type: `Variant[Stdlib::Ensure::Service, Boolean]` @@ -901,7 +901,7 @@ application, such as Pacemaker.
Default value: `'running'` -##### `service_name` +##### `service_name` Data type: `String` @@ -909,24 +909,24 @@ Sets the name of the Apache service. Default value: `$apache::params::service_name` -##### `service_manage` +##### `service_manage` Data type: `Boolean` Determines whether Puppet manages the HTTPD service's state. -Default value: ``true`` +Default value: `true` -##### `service_restart` +##### `service_restart` Data type: `Optional[String]` Determines whether Puppet should use a specific command to restart the HTTPD service. Values: a command to restart the Apache service. -Default value: ``undef`` +Default value: `undef` -##### `timeout` +##### `timeout` Data type: `Integer[0]` @@ -935,7 +935,7 @@ certain events before failing a request. Default value: `60` -##### `trace_enable` +##### `trace_enable` Data type: `Variant[Apache::OnOff, Enum['extended']]` @@ -943,7 +943,7 @@ Controls how Apache handles `TRACE` requests (per RFC 2616) via the `TraceEnable Default value: `'On'` -##### `use_canonical_name` +##### `use_canonical_name` Data type: `Optional[Variant[Apache::OnOff, Enum['DNS', 'dns']]]` @@ -951,9 +951,9 @@ Controls Apache's `UseCanonicalName` directive which controls how Apache handles self-referential URLs. If not specified, this parameter omits the declaration from the server's configuration and uses Apache's default setting of 'off'. -Default value: ``undef`` +Default value: `undef` -##### `use_systemd` +##### `use_systemd` Data type: `Boolean` @@ -962,7 +962,7 @@ especially useful if using custom-built RPMs. Default value: `$apache::params::use_systemd` -##### `file_mode` +##### `file_mode` Data type: `Stdlib::Filemode` @@ -971,7 +971,7 @@ Valid values are: a string, with permissions mode in symbolic or numeric notatio Default value: `$apache::params::file_mode` -##### `root_directory_options` +##### `root_directory_options` Data type: `Array` @@ -979,7 +979,7 @@ Array of the desired options for the `/` directory in httpd.conf. Default value: `$apache::params::root_directory_options` -##### `root_directory_secured` +##### `root_directory_secured` Data type: `Boolean` @@ -989,9 +989,9 @@ allows access to all resources that are missing a more specific access policy. A used to allow access to these resources (for example, in a directory block using the `directories` parameter). -Default value: ``false`` +Default value: `false` -##### `vhost_dir` +##### `vhost_dir` Data type: `Stdlib::Absolutepath` @@ -999,7 +999,7 @@ Changes your virtual host configuration files' location. Default value: `$apache::params::vhost_dir` -##### `vhost_include_pattern` +##### `vhost_include_pattern` Data type: `String` @@ -1012,7 +1012,7 @@ files ending in `.conf`. Default value: `$apache::params::vhost_include_pattern` -##### `user` +##### `user` Data type: `String` @@ -1022,7 +1022,7 @@ To prevent Puppet from managing the user, set the `manage_user` parameter to `fa Default value: `$apache::params::user` -##### `apache_name` +##### `apache_name` Data type: `String` @@ -1032,7 +1032,7 @@ For CentOS/RHEL Software Collections (SCL), you can also use `apache::version::s Default value: `$apache::params::apache_name` -##### `error_log` +##### `error_log` Data type: `String` @@ -1042,7 +1042,7 @@ The name of the error log file for the main server instance. If the string start Default value: `$apache::params::error_log` -##### `scriptalias` +##### `scriptalias` Data type: `String` @@ -1050,7 +1050,7 @@ Directory to use for global script alias Default value: `$apache::params::scriptalias` -##### `access_log_file` +##### `access_log_file` Data type: `String` @@ -1058,7 +1058,7 @@ The name of the access log file for the main server instance. Default value: `$apache::params::access_log_file` -##### `limitreqfields` +##### `limitreqfields` Data type: `Integer` @@ -1070,7 +1070,7 @@ response from the server that indicates too many fields were sent in the request Default value: `100` -##### `limitreqfieldsize` +##### `limitreqfieldsize` Data type: `Integer` @@ -1079,32 +1079,32 @@ be allowed within a request header. Default value: `8190` -##### `limitreqline` +##### `limitreqline` Data type: `Optional[Integer]` The 'limitreqline' parameter sets the limit on the allowed size of a client's HTTP request-line -Default value: ``undef`` +Default value: `undef` -##### `ip` +##### `ip` Data type: `Optional[String]` Specifies the ip address -Default value: ``undef`` +Default value: `undef` -##### `purge_vdir` +##### `purge_vdir` Data type: `Boolean` Removes all other Apache configs and virtual hosts.
> **Note**: This parameter is deprecated in favor of the `purge_configs` parameter.
-Default value: ``false`` +Default value: `false` -##### `conf_enabled` +##### `conf_enabled` Data type: `Optional[Stdlib::Absolutepath]` @@ -1112,7 +1112,7 @@ Whether the additional config files in `/etc/apache2/conf-enabled` should be man Default value: `$apache::params::conf_enabled` -##### `vhost_enable_dir` +##### `vhost_enable_dir` Data type: `Optional[Stdlib::Absolutepath]` @@ -1121,15 +1121,15 @@ they will be symlinked to and from sites-enabled. Default value: `$apache::params::vhost_enable_dir` -##### `manage_vhost_enable_dir` +##### `manage_vhost_enable_dir` Data type: `Boolean` Overides the vhost_enable_dir inherited parameters and allows it to be disabled -Default value: ``true`` +Default value: `true` -##### `mod_enable_dir` +##### `mod_enable_dir` Data type: `Optional[Stdlib::Absolutepath]` @@ -1137,25 +1137,25 @@ Set's whether the mods-enabled directory should be managed. Default value: `$apache::params::mod_enable_dir` -##### `ssl_file` +##### `ssl_file` Data type: `Optional[String]` This parameter allows you to set an ssl.conf file to be managed in order to implement an SSL Certificate. -Default value: ``undef`` +Default value: `undef` -##### `file_e_tag` +##### `file_e_tag` Data type: `Optional[String]` Sets the server default for the `FileETag` declaration, which modifies the response header field for static files. -Default value: ``undef`` +Default value: `undef` -##### `use_optional_includes` +##### `use_optional_includes` Data type: `Boolean` @@ -1164,7 +1164,7 @@ Specifies whether Apache uses the `IncludeOptional` directive instead of `Includ Default value: `$apache::params::use_optional_includes` -##### `mime_types_additional` +##### `mime_types_additional` Data type: `Hash` @@ -1172,7 +1172,7 @@ Specifies any idditional Internet media (mime) types that you wish to be configu Default value: `$apache::params::mime_types_additional` -### `apache::dev` +### `apache::dev` The libraries installed depends on the `dev_packages` parameter of the `apache::params` class, based on your operating system: @@ -1181,7 +1181,7 @@ class, based on your operating system: - **Gentoo**: `undef`. - **Red Hat**: `httpd-devel`. -### `apache::mod::actions` +### `apache::mod::actions` Installs Apache mod_actions @@ -1189,7 +1189,7 @@ Installs Apache mod_actions * https://httpd.apache.org/docs/current/mod/mod_actions.html * for additional documentation. -### `apache::mod::alias` +### `apache::mod::alias` Installs and configures `mod_alias`. @@ -1201,11 +1201,11 @@ Installs and configures `mod_alias`. The following parameters are available in the `apache::mod::alias` class: -* [`icons_options`](#icons_options) -* [`icons_path`](#icons_path) -* [`icons_prefix`](#icons_prefix) +* [`icons_options`](#-apache--mod--alias--icons_options) +* [`icons_path`](#-apache--mod--alias--icons_path) +* [`icons_prefix`](#-apache--mod--alias--icons_prefix) -##### `icons_options` +##### `icons_options` Data type: `String` @@ -1214,7 +1214,7 @@ directive. Default value: `'Indexes MultiViews'` -##### `icons_path` +##### `icons_path` Data type: `Variant[Boolean, Stdlib::Absolutepath]` @@ -1227,7 +1227,7 @@ Set to 'false' to disable the alias Default value: `$apache::params::alias_icons_path` -##### `icons_prefix` +##### `icons_prefix` Data type: `String` @@ -1235,7 +1235,7 @@ Change the alias for /icons/. Default value: `$apache::params::icons_prefix` -### `apache::mod::apreq2` +### `apache::mod::apreq2` Installs `mod_apreq2`. @@ -1245,7 +1245,7 @@ Installs `mod_apreq2`. * http://httpd.apache.org/apreq/docs/libapreq2/group__mod__apreq2.html * for additional documentation. -### `apache::mod::auth_basic` +### `apache::mod::auth_basic` Installs `mod_auth_basic` @@ -1253,7 +1253,7 @@ Installs `mod_auth_basic` * https://httpd.apache.org/docs/current/mod/mod_auth_basic.html * for additional documentation. -### `apache::mod::auth_cas` +### `apache::mod::auth_cas` Installs and configures `mod_auth_cas`. @@ -1267,45 +1267,45 @@ Installs and configures `mod_auth_cas`. The following parameters are available in the `apache::mod::auth_cas` class: -* [`cas_login_url`](#cas_login_url) -* [`cas_validate_url`](#cas_validate_url) -* [`cas_cookie_path`](#cas_cookie_path) -* [`cas_cookie_path_mode`](#cas_cookie_path_mode) -* [`cas_version`](#cas_version) -* [`cas_debug`](#cas_debug) -* [`cas_validate_server`](#cas_validate_server) -* [`cas_validate_depth`](#cas_validate_depth) -* [`cas_certificate_path`](#cas_certificate_path) -* [`cas_proxy_validate_url`](#cas_proxy_validate_url) -* [`cas_root_proxied_as`](#cas_root_proxied_as) -* [`cas_cookie_entropy`](#cas_cookie_entropy) -* [`cas_timeout`](#cas_timeout) -* [`cas_idle_timeout`](#cas_idle_timeout) -* [`cas_cache_clean_interval`](#cas_cache_clean_interval) -* [`cas_cookie_domain`](#cas_cookie_domain) -* [`cas_cookie_http_only`](#cas_cookie_http_only) -* [`cas_authoritative`](#cas_authoritative) -* [`cas_validate_saml`](#cas_validate_saml) -* [`cas_sso_enabled`](#cas_sso_enabled) -* [`cas_attribute_prefix`](#cas_attribute_prefix) -* [`cas_attribute_delimiter`](#cas_attribute_delimiter) -* [`cas_scrub_request_headers`](#cas_scrub_request_headers) -* [`suppress_warning`](#suppress_warning) - -##### `cas_login_url` +* [`cas_login_url`](#-apache--mod--auth_cas--cas_login_url) +* [`cas_validate_url`](#-apache--mod--auth_cas--cas_validate_url) +* [`cas_cookie_path`](#-apache--mod--auth_cas--cas_cookie_path) +* [`cas_cookie_path_mode`](#-apache--mod--auth_cas--cas_cookie_path_mode) +* [`cas_version`](#-apache--mod--auth_cas--cas_version) +* [`cas_debug`](#-apache--mod--auth_cas--cas_debug) +* [`cas_validate_server`](#-apache--mod--auth_cas--cas_validate_server) +* [`cas_validate_depth`](#-apache--mod--auth_cas--cas_validate_depth) +* [`cas_certificate_path`](#-apache--mod--auth_cas--cas_certificate_path) +* [`cas_proxy_validate_url`](#-apache--mod--auth_cas--cas_proxy_validate_url) +* [`cas_root_proxied_as`](#-apache--mod--auth_cas--cas_root_proxied_as) +* [`cas_cookie_entropy`](#-apache--mod--auth_cas--cas_cookie_entropy) +* [`cas_timeout`](#-apache--mod--auth_cas--cas_timeout) +* [`cas_idle_timeout`](#-apache--mod--auth_cas--cas_idle_timeout) +* [`cas_cache_clean_interval`](#-apache--mod--auth_cas--cas_cache_clean_interval) +* [`cas_cookie_domain`](#-apache--mod--auth_cas--cas_cookie_domain) +* [`cas_cookie_http_only`](#-apache--mod--auth_cas--cas_cookie_http_only) +* [`cas_authoritative`](#-apache--mod--auth_cas--cas_authoritative) +* [`cas_validate_saml`](#-apache--mod--auth_cas--cas_validate_saml) +* [`cas_sso_enabled`](#-apache--mod--auth_cas--cas_sso_enabled) +* [`cas_attribute_prefix`](#-apache--mod--auth_cas--cas_attribute_prefix) +* [`cas_attribute_delimiter`](#-apache--mod--auth_cas--cas_attribute_delimiter) +* [`cas_scrub_request_headers`](#-apache--mod--auth_cas--cas_scrub_request_headers) +* [`suppress_warning`](#-apache--mod--auth_cas--suppress_warning) + +##### `cas_login_url` Data type: `String` Sets the URL to which the module redirects users when they attempt to access a CAS-protected resource and don't have an active session. -##### `cas_validate_url` +##### `cas_validate_url` Data type: `String` Sets the URL to use when validating a client-presented ticket in an HTTP query string. -##### `cas_cookie_path` +##### `cas_cookie_path` Data type: `String` @@ -1314,7 +1314,7 @@ be writable by the web server only. Default value: `$apache::params::cas_cookie_path` -##### `cas_cookie_path_mode` +##### `cas_cookie_path_mode` Data type: `Stdlib::Filemode` @@ -1322,7 +1322,7 @@ The mode of cas_cookie_path. Default value: `'0750'` -##### `cas_version` +##### `cas_version` Data type: `Integer` @@ -1330,7 +1330,7 @@ The version of the CAS protocol to adhere to. Default value: `2` -##### `cas_debug` +##### `cas_debug` Data type: `String` @@ -1338,156 +1338,156 @@ Whether to enable or disable debug mode. Default value: `'Off'` -##### `cas_validate_server` +##### `cas_validate_server` Data type: `Optional[String]` Whether to validate the presented certificate. This has been deprecated and removed from Version 1.1-RC1 onward. -Default value: ``undef`` +Default value: `undef` -##### `cas_validate_depth` +##### `cas_validate_depth` Data type: `Optional[String]` The maximum depth for chained certificate validation. -Default value: ``undef`` +Default value: `undef` -##### `cas_certificate_path` +##### `cas_certificate_path` Data type: `Optional[String]` The path leading to the certificate -Default value: ``undef`` +Default value: `undef` -##### `cas_proxy_validate_url` +##### `cas_proxy_validate_url` Data type: `Optional[String]` The URL to use when performing a proxy validation. -Default value: ``undef`` +Default value: `undef` -##### `cas_root_proxied_as` +##### `cas_root_proxied_as` Data type: `Optional[String]` Sets the URL end users see when access to this Apache server is proxied per vhost. This URL should not include a trailing slash. -Default value: ``undef`` +Default value: `undef` -##### `cas_cookie_entropy` +##### `cas_cookie_entropy` Data type: `Optional[String]` When creating a local session, this many random bytes are used to create a unique session identifier. -Default value: ``undef`` +Default value: `undef` -##### `cas_timeout` +##### `cas_timeout` Data type: `Optional[Integer[0]]` The hard limit, in seconds, for a mod_auth_cas session. -Default value: ``undef`` +Default value: `undef` -##### `cas_idle_timeout` +##### `cas_idle_timeout` Data type: `Optional[Integer[0]]` The limit, in seconds, of how long a mod_auth_cas session can be idle. -Default value: ``undef`` +Default value: `undef` -##### `cas_cache_clean_interval` +##### `cas_cache_clean_interval` Data type: `Optional[String]` The minimum amount of time that must pass inbetween cache cleanings. -Default value: ``undef`` +Default value: `undef` -##### `cas_cookie_domain` +##### `cas_cookie_domain` Data type: `Optional[String]` The value for the 'Domain=' parameter in the Set-Cookie header. -Default value: ``undef`` +Default value: `undef` -##### `cas_cookie_http_only` +##### `cas_cookie_http_only` Data type: `Optional[String]` Setting this flag prevents the mod_auth_cas cookies from being accessed by client side Javascript. -Default value: ``undef`` +Default value: `undef` -##### `cas_authoritative` +##### `cas_authoritative` Data type: `Optional[String]` Determines whether an optional authorization directive is authoritative and thus binding. -Default value: ``undef`` +Default value: `undef` -##### `cas_validate_saml` +##### `cas_validate_saml` Data type: `Optional[String]` Parse response from CAS server for SAML. -Default value: ``undef`` +Default value: `undef` -##### `cas_sso_enabled` +##### `cas_sso_enabled` Data type: `Optional[String]` Enables experimental support for single sign out (may mangle POST data). -Default value: ``undef`` +Default value: `undef` -##### `cas_attribute_prefix` +##### `cas_attribute_prefix` Data type: `Optional[String]` Adds a header with the value of this header being the attribute values when SAML validation is enabled. -Default value: ``undef`` +Default value: `undef` -##### `cas_attribute_delimiter` +##### `cas_attribute_delimiter` Data type: `Optional[String]` Sets the delimiter between attribute values in the header created by `cas_attribute_prefix`. -Default value: ``undef`` +Default value: `undef` -##### `cas_scrub_request_headers` +##### `cas_scrub_request_headers` Data type: `Optional[String]` Remove inbound request headers that may have special meaning within mod_auth_cas. -Default value: ``undef`` +Default value: `undef` -##### `suppress_warning` +##### `suppress_warning` Data type: `Boolean` Suppress warning about being on RedHat (mod_auth_cas package is now available in epel-testing repo). -Default value: ``false`` +Default value: `false` -### `apache::mod::auth_gssapi` +### `apache::mod::auth_gssapi` Installs `mod_auth_gsappi`. @@ -1495,7 +1495,7 @@ Installs `mod_auth_gsappi`. * https://github.com/modauthgssapi/mod_auth_gssapi * for additional documentation. -### `apache::mod::auth_kerb` +### `apache::mod::auth_kerb` Installs `mod_auth_kerb` @@ -1503,7 +1503,7 @@ Installs `mod_auth_kerb` * http://modauthkerb.sourceforge.net * for additional documentation. -### `apache::mod::auth_mellon` +### `apache::mod::auth_mellon` Installs and configures `mod_auth_mellon`. @@ -1515,15 +1515,15 @@ Installs and configures `mod_auth_mellon`. The following parameters are available in the `apache::mod::auth_mellon` class: -* [`mellon_cache_size`](#mellon_cache_size) -* [`mellon_lock_file`](#mellon_lock_file) -* [`mellon_post_directory`](#mellon_post_directory) -* [`mellon_cache_entry_size`](#mellon_cache_entry_size) -* [`mellon_post_ttl`](#mellon_post_ttl) -* [`mellon_post_size`](#mellon_post_size) -* [`mellon_post_count`](#mellon_post_count) +* [`mellon_cache_size`](#-apache--mod--auth_mellon--mellon_cache_size) +* [`mellon_lock_file`](#-apache--mod--auth_mellon--mellon_lock_file) +* [`mellon_post_directory`](#-apache--mod--auth_mellon--mellon_post_directory) +* [`mellon_cache_entry_size`](#-apache--mod--auth_mellon--mellon_cache_entry_size) +* [`mellon_post_ttl`](#-apache--mod--auth_mellon--mellon_post_ttl) +* [`mellon_post_size`](#-apache--mod--auth_mellon--mellon_post_size) +* [`mellon_post_count`](#-apache--mod--auth_mellon--mellon_post_count) -##### `mellon_cache_size` +##### `mellon_cache_size` Data type: `Optional[Integer]` @@ -1531,7 +1531,7 @@ Maximum number of sessions which can be active at once. Default value: `$apache::params::mellon_cache_size` -##### `mellon_lock_file` +##### `mellon_lock_file` Data type: `Optional[Stdlib::Absolutepath]` @@ -1539,7 +1539,7 @@ Full path to a file used for synchronizing access to the session data. Default value: `$apache::params::mellon_lock_file` -##### `mellon_post_directory` +##### `mellon_post_directory` Data type: `Optional[Stdlib::Absolutepath]` @@ -1547,39 +1547,39 @@ Full path of a directory where POST requests are saved during authentication. Default value: `$apache::params::mellon_post_directory` -##### `mellon_cache_entry_size` +##### `mellon_cache_entry_size` Data type: `Optional[Integer]` Maximum size for a single session entry in bytes. -Default value: ``undef`` +Default value: `undef` -##### `mellon_post_ttl` +##### `mellon_post_ttl` Data type: `Optional[Integer]` Delay in seconds before a saved POST request can be flushed. -Default value: ``undef`` +Default value: `undef` -##### `mellon_post_size` +##### `mellon_post_size` Data type: `Optional[Integer]` Maximum size for saved POST requests. -Default value: ``undef`` +Default value: `undef` -##### `mellon_post_count` +##### `mellon_post_count` Data type: `Optional[Integer]` Maximum amount of saved POST requests. -Default value: ``undef`` +Default value: `undef` -### `apache::mod::auth_openidc` +### `apache::mod::auth_openidc` Installs and configures `mod_auth_openidc`. @@ -1593,19 +1593,19 @@ Installs and configures `mod_auth_openidc`. The following parameters are available in the `apache::mod::auth_openidc` class: -* [`manage_dnf_module`](#manage_dnf_module) -* [`dnf_module_ensure`](#dnf_module_ensure) -* [`dnf_module_name`](#dnf_module_name) +* [`manage_dnf_module`](#-apache--mod--auth_openidc--manage_dnf_module) +* [`dnf_module_ensure`](#-apache--mod--auth_openidc--dnf_module_ensure) +* [`dnf_module_name`](#-apache--mod--auth_openidc--dnf_module_name) -##### `manage_dnf_module` +##### `manage_dnf_module` Data type: `Boolean` Whether to manage the DNF module -Default value: `and` +Default value: `$facts['os']['family'] == 'RedHat' and $facts['os']['release']['major'] == '8'` -##### `dnf_module_ensure` +##### `dnf_module_ensure` Data type: `String[1]` @@ -1613,7 +1613,7 @@ The DNF module name to ensure. Only relevant if manage_dnf_module is set to true Default value: `'present'` -##### `dnf_module_name` +##### `dnf_module_name` Data type: `String[1]` @@ -1621,7 +1621,7 @@ The DNF module name to manage. Only relevant if manage_dnf_module is set to true Default value: `'mod_auth_openidc'` -### `apache::mod::authn_core` +### `apache::mod::authn_core` Installs `mod_authn_core`. @@ -1629,7 +1629,7 @@ Installs `mod_authn_core`. * https://httpd.apache.org/docs/current/mod/mod_authn_core.html * for additional documentation. -### `apache::mod::authn_dbd` +### `apache::mod::authn_dbd` Installs `mod_authn_dbd`. @@ -1641,22 +1641,22 @@ Installs `mod_authn_dbd`. The following parameters are available in the `apache::mod::authn_dbd` class: -* [`authn_dbd_params`](#authn_dbd_params) -* [`authn_dbd_dbdriver`](#authn_dbd_dbdriver) -* [`authn_dbd_query`](#authn_dbd_query) -* [`authn_dbd_min`](#authn_dbd_min) -* [`authn_dbd_max`](#authn_dbd_max) -* [`authn_dbd_keep`](#authn_dbd_keep) -* [`authn_dbd_exptime`](#authn_dbd_exptime) -* [`authn_dbd_alias`](#authn_dbd_alias) +* [`authn_dbd_params`](#-apache--mod--authn_dbd--authn_dbd_params) +* [`authn_dbd_dbdriver`](#-apache--mod--authn_dbd--authn_dbd_dbdriver) +* [`authn_dbd_query`](#-apache--mod--authn_dbd--authn_dbd_query) +* [`authn_dbd_min`](#-apache--mod--authn_dbd--authn_dbd_min) +* [`authn_dbd_max`](#-apache--mod--authn_dbd--authn_dbd_max) +* [`authn_dbd_keep`](#-apache--mod--authn_dbd--authn_dbd_keep) +* [`authn_dbd_exptime`](#-apache--mod--authn_dbd--authn_dbd_exptime) +* [`authn_dbd_alias`](#-apache--mod--authn_dbd--authn_dbd_alias) -##### `authn_dbd_params` +##### `authn_dbd_params` Data type: `Optional[String]` The params needed for the mod to function. -##### `authn_dbd_dbdriver` +##### `authn_dbd_dbdriver` Data type: `String` @@ -1664,15 +1664,15 @@ Selects an apr_dbd driver by name. Default value: `'mysql'` -##### `authn_dbd_query` +##### `authn_dbd_query` Data type: `Optional[String]` -Default value: ``undef`` +Default value: `undef` -##### `authn_dbd_min` +##### `authn_dbd_min` Data type: `Integer` @@ -1680,7 +1680,7 @@ Set the minimum number of connections per process. Default value: `4` -##### `authn_dbd_max` +##### `authn_dbd_max` Data type: `Integer` @@ -1688,7 +1688,7 @@ Set the maximum number of connections per process. Default value: `20` -##### `authn_dbd_keep` +##### `authn_dbd_keep` Data type: `Integer` @@ -1696,7 +1696,7 @@ Set the maximum number of connections per process to be sustained. Default value: `8` -##### `authn_dbd_exptime` +##### `authn_dbd_exptime` Data type: `Integer` @@ -1705,15 +1705,15 @@ connections specified in DBDKeep has been exceeded. Default value: `300` -##### `authn_dbd_alias` +##### `authn_dbd_alias` Data type: `Optional[String]` Sets an alias for `AuthnProvider. -Default value: ``undef`` +Default value: `undef` -### `apache::mod::authn_file` +### `apache::mod::authn_file` Installs `mod_authn_file`. @@ -1721,7 +1721,7 @@ Installs `mod_authn_file`. * https://httpd.apache.org/docs/2.4/mod/mod_authn_file.html * for additional documentation. -### `apache::mod::authnz_ldap` +### `apache::mod::authnz_ldap` Installs `mod_authnz_ldap`. @@ -1735,26 +1735,26 @@ Installs `mod_authnz_ldap`. The following parameters are available in the `apache::mod::authnz_ldap` class: -* [`verify_server_cert`](#verify_server_cert) -* [`package_name`](#package_name) +* [`verify_server_cert`](#-apache--mod--authnz_ldap--verify_server_cert) +* [`package_name`](#-apache--mod--authnz_ldap--package_name) -##### `verify_server_cert` +##### `verify_server_cert` Data type: `Boolean` Whether to force te verification of a server cert or not. -Default value: ``true`` +Default value: `true` -##### `package_name` +##### `package_name` Data type: `Optional[String]` The name of the ldap package. -Default value: ``undef`` +Default value: `undef` -### `apache::mod::authnz_pam` +### `apache::mod::authnz_pam` Installs `mod_authnz_pam`. @@ -1762,7 +1762,7 @@ Installs `mod_authnz_pam`. * https://www.adelton.com/apache/mod_authnz_pam * for additional documentation. -### `apache::mod::authz_core` +### `apache::mod::authz_core` Installs `mod_authz_core`. @@ -1770,7 +1770,7 @@ Installs `mod_authz_core`. * https://httpd.apache.org/docs/current/mod/mod_authz_core.html * for additional documentation. -### `apache::mod::authz_groupfile` +### `apache::mod::authz_groupfile` Installs `mod_authz_groupfile` @@ -1778,7 +1778,7 @@ Installs `mod_authz_groupfile` * https://httpd.apache.org/docs/current/mod/mod_authz_groupfile.html * for additional documentation. -### `apache::mod::authz_user` +### `apache::mod::authz_user` Installs `mod_authz_user` @@ -1786,7 +1786,7 @@ Installs `mod_authz_user` * https://httpd.apache.org/docs/current/mod/mod_authz_user.html * for additional documentation. -### `apache::mod::autoindex` +### `apache::mod::autoindex` Installs `mod_autoindex` @@ -1798,9 +1798,9 @@ Installs `mod_autoindex` The following parameters are available in the `apache::mod::autoindex` class: -* [`icons_prefix`](#icons_prefix) +* [`icons_prefix`](#-apache--mod--autoindex--icons_prefix) -##### `icons_prefix` +##### `icons_prefix` Data type: `String` @@ -1808,7 +1808,7 @@ Change the alias for /icons/. Default value: `$apache::params::icons_prefix` -### `apache::mod::cache` +### `apache::mod::cache` Installs `mod_cache` @@ -1816,7 +1816,7 @@ Installs `mod_cache` * https://httpd.apache.org/docs/current/mod/mod_cache.html * for additional documentation. -### `apache::mod::cgi` +### `apache::mod::cgi` Installs `mod_cgi`. @@ -1824,14 +1824,14 @@ Installs `mod_cgi`. * https://httpd.apache.org/docs/current/mod/mod_cgi.html * for additional documentation. -### `apache::mod::cgid` +### `apache::mod::cgid` Installs `mod_cgid`. * **See also** * https://httpd.apache.org/docs/current/mod/mod_cgid.html -### `apache::mod::cluster` +### `apache::mod::cluster` Installs `mod_cluster`. @@ -1859,51 +1859,51 @@ class { '::apache::mod::cluster': The following parameters are available in the `apache::mod::cluster` class: -* [`allowed_network`](#allowed_network) -* [`balancer_name`](#balancer_name) -* [`ip`](#ip) -* [`version`](#version) -* [`enable_mcpm_receive`](#enable_mcpm_receive) -* [`port`](#port) -* [`keep_alive_timeout`](#keep_alive_timeout) -* [`manager_allowed_network`](#manager_allowed_network) -* [`max_keep_alive_requests`](#max_keep_alive_requests) -* [`server_advertise`](#server_advertise) -* [`advertise_frequency`](#advertise_frequency) +* [`allowed_network`](#-apache--mod--cluster--allowed_network) +* [`balancer_name`](#-apache--mod--cluster--balancer_name) +* [`ip`](#-apache--mod--cluster--ip) +* [`version`](#-apache--mod--cluster--version) +* [`enable_mcpm_receive`](#-apache--mod--cluster--enable_mcpm_receive) +* [`port`](#-apache--mod--cluster--port) +* [`keep_alive_timeout`](#-apache--mod--cluster--keep_alive_timeout) +* [`manager_allowed_network`](#-apache--mod--cluster--manager_allowed_network) +* [`max_keep_alive_requests`](#-apache--mod--cluster--max_keep_alive_requests) +* [`server_advertise`](#-apache--mod--cluster--server_advertise) +* [`advertise_frequency`](#-apache--mod--cluster--advertise_frequency) -##### `allowed_network` +##### `allowed_network` Data type: `String` Balanced members network. -##### `balancer_name` +##### `balancer_name` Data type: `String` Name of balancer. -##### `ip` +##### `ip` Data type: `Stdlib::IP::Address` Specifies the IP address to listen to. -##### `version` +##### `version` Data type: `String` Specifies the mod_cluster version. Version 1.3.0 or greater is required for httpd 2.4. -##### `enable_mcpm_receive` +##### `enable_mcpm_receive` Data type: `Boolean` Whether MCPM should be enabled. -Default value: ``true`` +Default value: `true` -##### `port` +##### `port` Data type: `Stdlib::Port` @@ -1911,7 +1911,7 @@ mod_cluster listen port. Default value: `6666` -##### `keep_alive_timeout` +##### `keep_alive_timeout` Data type: `Integer` @@ -1919,7 +1919,7 @@ Specifies how long Apache should wait for a request, in seconds. Default value: `60` -##### `manager_allowed_network` +##### `manager_allowed_network` Data type: `Stdlib::IP::Address` @@ -1927,7 +1927,7 @@ Whether to allow the network to access the mod_cluster_manager. Default value: `'127.0.0.1'` -##### `max_keep_alive_requests` +##### `max_keep_alive_requests` Data type: `Integer` @@ -1935,23 +1935,23 @@ Maximum number of requests kept alive. Default value: `0` -##### `server_advertise` +##### `server_advertise` Data type: `Boolean` Whether the server should advertise. -Default value: ``true`` +Default value: `true` -##### `advertise_frequency` +##### `advertise_frequency` Data type: `Optional[String]` Sets the interval between advertise messages in seconds. -Default value: ``undef`` +Default value: `undef` -### `apache::mod::data` +### `apache::mod::data` Installs and configures `mod_data`. @@ -1959,7 +1959,7 @@ Installs and configures `mod_data`. * https://httpd.apache.org/docs/current/mod/mod_data.html * for additional documentation. -### `apache::mod::dav` +### `apache::mod::dav` Installs `mod_dav`. @@ -1967,7 +1967,7 @@ Installs `mod_dav`. * https://httpd.apache.org/docs/current/mod/mod_dav.html * for additional documentation. -### `apache::mod::dav_fs` +### `apache::mod::dav_fs` Installs `mod_dav_fs`. @@ -1975,7 +1975,7 @@ Installs `mod_dav_fs`. * https://httpd.apache.org/docs/current/mod/mod_dav_fs.html * for additional documentation. -### `apache::mod::dav_svn` +### `apache::mod::dav_svn` Installs and configures `mod_dav_svn`. @@ -1987,17 +1987,17 @@ Installs and configures `mod_dav_svn`. The following parameters are available in the `apache::mod::dav_svn` class: -* [`authz_svn_enabled`](#authz_svn_enabled) +* [`authz_svn_enabled`](#-apache--mod--dav_svn--authz_svn_enabled) -##### `authz_svn_enabled` +##### `authz_svn_enabled` Data type: `Boolean` Specifies whether to install Apache mod_authz_svn -Default value: ``false`` +Default value: `false` -### `apache::mod::dbd` +### `apache::mod::dbd` Installs `mod_dbd`. @@ -2005,7 +2005,7 @@ Installs `mod_dbd`. * https://httpd.apache.org/docs/current/mod/mod_dbd.html * for additional documentation. -### `apache::mod::deflate` +### `apache::mod::deflate` Installs and configures `mod_deflate`. @@ -2017,42 +2017,50 @@ Installs and configures `mod_deflate`. The following parameters are available in the `apache::mod::deflate` class: -* [`types`](#types) -* [`notes`](#notes) +* [`types`](#-apache--mod--deflate--types) +* [`notes`](#-apache--mod--deflate--notes) -##### `types` +##### `types` Data type: `Array[String]` An array of MIME types to be deflated. See https://www.iana.org/assignments/media-types/media-types.xhtml. -Default value: `[ +Default value: + +```puppet +[ 'text/html text/plain text/xml', 'text/css', 'application/x-javascript application/javascript application/ecmascript', 'application/rss+xml', 'application/json', - ]` + ] +``` -##### `notes` +##### `notes` Data type: `Hash` A Hash where the key represents the type and the value represents the note name. -Default value: `{ +Default value: + +```puppet +{ 'Input' => 'instream', 'Output' => 'outstream', 'Ratio' => 'ratio', - }` + } +``` -### `apache::mod::dev` +### `apache::mod::dev` Installs `mod_dev`. * **Note** This module is deprecated. Please use `apache::dev`. -### `apache::mod::dir` +### `apache::mod::dir` Installs and configures `mod_dir`. @@ -2067,10 +2075,10 @@ DirectoryIndex statements in a vhost configuration The following parameters are available in the `apache::mod::dir` class: -* [`dir`](#dir) -* [`indexes`](#indexes) +* [`dir`](#-apache--mod--dir--dir) +* [`indexes`](#-apache--mod--dir--indexes) -##### `dir` +##### `dir` Data type: `String` @@ -2078,22 +2086,26 @@ Data type: `String` Default value: `'public_html'` -##### `indexes` +##### `indexes` Data type: `Array[String]` Provides a string for the DirectoryIndex directive -Default value: `[ +Default value: + +```puppet +[ 'index.html', 'index.html.var', 'index.cgi', 'index.pl', 'index.php', 'index.xhtml', - ]` + ] +``` -### `apache::mod::disk_cache` +### `apache::mod::disk_cache` Installs and configures `mod_disk_cache`. @@ -2107,11 +2119,11 @@ Installs and configures `mod_disk_cache`. The following parameters are available in the `apache::mod::disk_cache` class: -* [`cache_root`](#cache_root) -* [`cache_ignore_headers`](#cache_ignore_headers) -* [`default_cache_enable`](#default_cache_enable) +* [`cache_root`](#-apache--mod--disk_cache--cache_root) +* [`cache_ignore_headers`](#-apache--mod--disk_cache--cache_ignore_headers) +* [`default_cache_enable`](#-apache--mod--disk_cache--default_cache_enable) -##### `cache_root` +##### `cache_root` Data type: `Optional[Stdlib::Absolutepath]` @@ -2121,17 +2133,17 @@ Default depends on the Apache version and operating system: - FreeBSD: /var/cache/mod_cache_disk - Red Hat: /var/cache/httpd/proxy -Default value: ``undef`` +Default value: `undef` -##### `cache_ignore_headers` +##### `cache_ignore_headers` Data type: `Optional[String]` Specifies HTTP header(s) that should not be stored in the cache. -Default value: ``undef`` +Default value: `undef` -##### `default_cache_enable` +##### `default_cache_enable` Data type: `Boolean` @@ -2139,9 +2151,9 @@ Default value is true, which enables "CacheEnable disk /" in disk_cache.conf for every request to apache by default for every vhost. If set to false the default cache all behaviour is supressed. You can then control this behaviour in individual vhosts by explicitly defining CacheEnable. -Default value: ``true`` +Default value: `true` -### `apache::mod::dumpio` +### `apache::mod::dumpio` Installs and configures `mod_dumpio`. @@ -2168,10 +2180,10 @@ class{'apache::mod::dumpio': The following parameters are available in the `apache::mod::dumpio` class: -* [`dump_io_input`](#dump_io_input) -* [`dump_io_output`](#dump_io_output) +* [`dump_io_input`](#-apache--mod--dumpio--dump_io_input) +* [`dump_io_output`](#-apache--mod--dumpio--dump_io_output) -##### `dump_io_input` +##### `dump_io_input` Data type: `Apache::OnOff` @@ -2179,7 +2191,7 @@ Dump all input data to the error log Default value: `'Off'` -##### `dump_io_output` +##### `dump_io_output` Data type: `Apache::OnOff` @@ -2187,7 +2199,7 @@ Dump all output data to the error log Default value: `'Off'` -### `apache::mod::env` +### `apache::mod::env` Installs `mod_env`. @@ -2195,7 +2207,7 @@ Installs `mod_env`. * https://httpd.apache.org/docs/current/mod/mod_env.html * for additional documentation. -### `apache::mod::event` +### `apache::mod::event` Installs and configures `mod_event`. @@ -2210,17 +2222,17 @@ apache::mod::worker on the same server. The following parameters are available in the `apache::mod::event` class: -* [`startservers`](#startservers) -* [`maxrequestworkers`](#maxrequestworkers) -* [`minsparethreads`](#minsparethreads) -* [`maxsparethreads`](#maxsparethreads) -* [`threadsperchild`](#threadsperchild) -* [`maxconnectionsperchild`](#maxconnectionsperchild) -* [`serverlimit`](#serverlimit) -* [`threadlimit`](#threadlimit) -* [`listenbacklog`](#listenbacklog) +* [`startservers`](#-apache--mod--event--startservers) +* [`maxrequestworkers`](#-apache--mod--event--maxrequestworkers) +* [`minsparethreads`](#-apache--mod--event--minsparethreads) +* [`maxsparethreads`](#-apache--mod--event--maxsparethreads) +* [`threadsperchild`](#-apache--mod--event--threadsperchild) +* [`maxconnectionsperchild`](#-apache--mod--event--maxconnectionsperchild) +* [`serverlimit`](#-apache--mod--event--serverlimit) +* [`threadlimit`](#-apache--mod--event--threadlimit) +* [`listenbacklog`](#-apache--mod--event--listenbacklog) -##### `startservers` +##### `startservers` Data type: `Variant[Integer, Boolean]` @@ -2229,16 +2241,16 @@ removes the parameter. Default value: `2` -##### `maxrequestworkers` +##### `maxrequestworkers` Data type: `Optional[Variant[Integer, Boolean]]` Sets the maximum number of connections Apache can simultaneously process, via the module's `MaxRequestWorkers` directive. Setting these to `false` removes the parameters. -Default value: ``undef`` +Default value: `undef` -##### `minsparethreads` +##### `minsparethreads` Data type: `Variant[Integer, Boolean]` @@ -2246,7 +2258,7 @@ Sets the minimum number of idle threads, via the `MinSpareThreads` directive. Se Default value: `25` -##### `maxsparethreads` +##### `maxsparethreads` Data type: `Variant[Integer, Boolean]` @@ -2254,7 +2266,7 @@ Sets the maximum number of idle threads, via the `MaxSpareThreads` directive. Se Default value: `75` -##### `threadsperchild` +##### `threadsperchild` Data type: `Variant[Integer, Boolean]` @@ -2262,15 +2274,15 @@ Number of threads created by each child process. Default value: `25` -##### `maxconnectionsperchild` +##### `maxconnectionsperchild` Data type: `Optional[Variant[Integer, Boolean]]` Limit on the number of connections that an individual child server will handle during its life. -Default value: ``undef`` +Default value: `undef` -##### `serverlimit` +##### `serverlimit` Data type: `Variant[Integer, Boolean]` @@ -2278,7 +2290,7 @@ Limits the configurable number of processes via the `ServerLimit` directive. Set Default value: `25` -##### `threadlimit` +##### `threadlimit` Data type: `Variant[Integer, Boolean]` @@ -2286,7 +2298,7 @@ Limits the number of event threads via the module's `ThreadLimit` directive. Set Default value: `64` -##### `listenbacklog` +##### `listenbacklog` Data type: `Variant[Integer, Boolean]` @@ -2295,7 +2307,7 @@ the parameter. Default value: `511` -### `apache::mod::expires` +### `apache::mod::expires` Installs and configures `mod_expires`. @@ -2307,27 +2319,27 @@ Installs and configures `mod_expires`. The following parameters are available in the `apache::mod::expires` class: -* [`expires_active`](#expires_active) -* [`expires_default`](#expires_default) -* [`expires_by_type`](#expires_by_type) +* [`expires_active`](#-apache--mod--expires--expires_active) +* [`expires_default`](#-apache--mod--expires--expires_default) +* [`expires_by_type`](#-apache--mod--expires--expires_by_type) -##### `expires_active` +##### `expires_active` Data type: `Boolean` Enables generation of Expires headers. -Default value: ``true`` +Default value: `true` -##### `expires_default` +##### `expires_default` Data type: `Optional[String]` Specifies the default algorithm for calculating expiration time using ExpiresByType syntax or interval syntax. -Default value: ``undef`` +Default value: `undef` -##### `expires_by_type` +##### `expires_by_type` Data type: `Optional[Array[Hash]]` @@ -2335,9 +2347,9 @@ Describes a set of [MIME content-types](https://www.iana.org/assignments/media-t times. This should be used as an array of Hashes, with each Hash's key a valid MIME content-type (i.e. 'text/json') and its value following valid interval syntax. -Default value: ``undef`` +Default value: `undef` -### `apache::mod::ext_filter` +### `apache::mod::ext_filter` Installs and configures `mod_ext_filter`. @@ -2362,17 +2374,17 @@ class { 'apache::mod::ext_filter': The following parameters are available in the `apache::mod::ext_filter` class: -* [`ext_filter_define`](#ext_filter_define) +* [`ext_filter_define`](#-apache--mod--ext_filter--ext_filter_define) -##### `ext_filter_define` +##### `ext_filter_define` Data type: `Optional[Hash]` Hash of filter names and their parameters. -Default value: ``undef`` +Default value: `undef` -### `apache::mod::fcgid` +### `apache::mod::fcgid` loaded first; Puppet will not automatically enable it if you set the fcgiwrapper parameter in apache::vhost. include apache::mod::fcgid @@ -2415,9 +2427,9 @@ class { 'apache::mod::fcgid': The following parameters are available in the `apache::mod::fcgid` class: -* [`options`](#options) +* [`options`](#-apache--mod--fcgid--options) -##### `options` +##### `options` Data type: `Hash` @@ -2431,7 +2443,7 @@ expires_by_type Default value: `{}` -### `apache::mod::filter` +### `apache::mod::filter` Installs `mod_filter`. @@ -2439,7 +2451,7 @@ Installs `mod_filter`. * https://httpd.apache.org/docs/current/mod/mod_filter.html * for additional documentation. -### `apache::mod::geoip` +### `apache::mod::geoip` Installs and configures `mod_geoip`. @@ -2451,24 +2463,24 @@ Installs and configures `mod_geoip`. The following parameters are available in the `apache::mod::geoip` class: -* [`enable`](#enable) -* [`db_file`](#db_file) -* [`flag`](#flag) -* [`output`](#output) -* [`enable_utf8`](#enable_utf8) -* [`scan_proxy_headers`](#scan_proxy_headers) -* [`scan_proxy_header_field`](#scan_proxy_header_field) -* [`use_last_xforwarededfor_ip`](#use_last_xforwarededfor_ip) +* [`enable`](#-apache--mod--geoip--enable) +* [`db_file`](#-apache--mod--geoip--db_file) +* [`flag`](#-apache--mod--geoip--flag) +* [`output`](#-apache--mod--geoip--output) +* [`enable_utf8`](#-apache--mod--geoip--enable_utf8) +* [`scan_proxy_headers`](#-apache--mod--geoip--scan_proxy_headers) +* [`scan_proxy_header_field`](#-apache--mod--geoip--scan_proxy_header_field) +* [`use_last_xforwarededfor_ip`](#-apache--mod--geoip--use_last_xforwarededfor_ip) -##### `enable` +##### `enable` Data type: `Boolean` Toggles whether to enable geoip. -Default value: ``false`` +Default value: `false` -##### `db_file` +##### `db_file` Data type: `Stdlib::Absolutepath` @@ -2476,7 +2488,7 @@ Path to database for GeoIP to use. Default value: `'/usr/share/GeoIP/GeoIP.dat'` -##### `flag` +##### `flag` Data type: `String` @@ -2484,7 +2496,7 @@ Caching directive to use. Values: 'CheckCache', 'IndexCache', 'MemoryCache', 'St Default value: `'Standard'` -##### `output` +##### `output` Data type: `String` @@ -2492,39 +2504,39 @@ Output variable locations. Values: 'All', 'Env', 'Request', 'Notes'. Default value: `'All'` -##### `enable_utf8` +##### `enable_utf8` Data type: `Optional[String]` Changes the output from ISO88591 (Latin1) to UTF8. -Default value: ``undef`` +Default value: `undef` -##### `scan_proxy_headers` +##### `scan_proxy_headers` Data type: `Optional[String]` Enables the GeoIPScanProxyHeaders option. -Default value: ``undef`` +Default value: `undef` -##### `scan_proxy_header_field` +##### `scan_proxy_header_field` Data type: `Optional[String]` Specifies the header mod_geoip uses to determine the client's IP address. -Default value: ``undef`` +Default value: `undef` -##### `use_last_xforwarededfor_ip` +##### `use_last_xforwarededfor_ip` Data type: `Optional[String]` Determines whether to use the first or last IP address for the client's IP in a comma-separated list of IP addresses is found. -Default value: ``undef`` +Default value: `undef` -### `apache::mod::headers` +### `apache::mod::headers` Installs and configures `mod_headers`. @@ -2532,7 +2544,7 @@ Installs and configures `mod_headers`. * https://httpd.apache.org/docs/current/mod/mod_headers.html * for additional documentation. -### `apache::mod::http2` +### `apache::mod::http2` Installs and configures `mod_http2`. @@ -2544,106 +2556,106 @@ Installs and configures `mod_http2`. The following parameters are available in the `apache::mod::http2` class: -* [`h2_copy_files`](#h2_copy_files) -* [`h2_direct`](#h2_direct) -* [`h2_early_hints`](#h2_early_hints) -* [`h2_max_session_streams`](#h2_max_session_streams) -* [`h2_max_worker_idle_seconds`](#h2_max_worker_idle_seconds) -* [`h2_max_workers`](#h2_max_workers) -* [`h2_min_workers`](#h2_min_workers) -* [`h2_modern_tls_only`](#h2_modern_tls_only) -* [`h2_push`](#h2_push) -* [`h2_push_diary_size`](#h2_push_diary_size) -* [`h2_push_priority`](#h2_push_priority) -* [`h2_push_resource`](#h2_push_resource) -* [`h2_serialize_headers`](#h2_serialize_headers) -* [`h2_stream_max_mem_size`](#h2_stream_max_mem_size) -* [`h2_tls_cool_down_secs`](#h2_tls_cool_down_secs) -* [`h2_tls_warm_up_size`](#h2_tls_warm_up_size) -* [`h2_upgrade`](#h2_upgrade) -* [`h2_window_size`](#h2_window_size) - -##### `h2_copy_files` +* [`h2_copy_files`](#-apache--mod--http2--h2_copy_files) +* [`h2_direct`](#-apache--mod--http2--h2_direct) +* [`h2_early_hints`](#-apache--mod--http2--h2_early_hints) +* [`h2_max_session_streams`](#-apache--mod--http2--h2_max_session_streams) +* [`h2_max_worker_idle_seconds`](#-apache--mod--http2--h2_max_worker_idle_seconds) +* [`h2_max_workers`](#-apache--mod--http2--h2_max_workers) +* [`h2_min_workers`](#-apache--mod--http2--h2_min_workers) +* [`h2_modern_tls_only`](#-apache--mod--http2--h2_modern_tls_only) +* [`h2_push`](#-apache--mod--http2--h2_push) +* [`h2_push_diary_size`](#-apache--mod--http2--h2_push_diary_size) +* [`h2_push_priority`](#-apache--mod--http2--h2_push_priority) +* [`h2_push_resource`](#-apache--mod--http2--h2_push_resource) +* [`h2_serialize_headers`](#-apache--mod--http2--h2_serialize_headers) +* [`h2_stream_max_mem_size`](#-apache--mod--http2--h2_stream_max_mem_size) +* [`h2_tls_cool_down_secs`](#-apache--mod--http2--h2_tls_cool_down_secs) +* [`h2_tls_warm_up_size`](#-apache--mod--http2--h2_tls_warm_up_size) +* [`h2_upgrade`](#-apache--mod--http2--h2_upgrade) +* [`h2_window_size`](#-apache--mod--http2--h2_window_size) + +##### `h2_copy_files` Data type: `Optional[Boolean]` Determine file handling in responses. -Default value: ``undef`` +Default value: `undef` -##### `h2_direct` +##### `h2_direct` Data type: `Optional[Boolean]` H2 Direct Protocol Switch. -Default value: ``undef`` +Default value: `undef` -##### `h2_early_hints` +##### `h2_early_hints` Data type: `Optional[Boolean]` Determine sending of 103 status codes. -Default value: ``undef`` +Default value: `undef` -##### `h2_max_session_streams` +##### `h2_max_session_streams` Data type: `Optional[Integer]` Sets maximum number of active streams per HTTP/2 session. -Default value: ``undef`` +Default value: `undef` -##### `h2_max_worker_idle_seconds` +##### `h2_max_worker_idle_seconds` Data type: `Optional[Integer]` Sets maximum number of seconds h2 workers remain idle until shut down. -Default value: ``undef`` +Default value: `undef` -##### `h2_max_workers` +##### `h2_max_workers` Data type: `Optional[Integer]` Sets maximum number of worker threads to use per child process. -Default value: ``undef`` +Default value: `undef` -##### `h2_min_workers` +##### `h2_min_workers` Data type: `Optional[Integer]` Sets minimal number of worker threads to use per child process. -Default value: ``undef`` +Default value: `undef` -##### `h2_modern_tls_only` +##### `h2_modern_tls_only` Data type: `Optional[Boolean]` Toggles the security checks on HTTP/2 connections in TLS mode -Default value: ``undef`` +Default value: `undef` -##### `h2_push` +##### `h2_push` Data type: `Optional[Boolean]` Toggles the usage of the HTTP/2 server push protocol feature. -Default value: ``undef`` +Default value: `undef` -##### `h2_push_diary_size` +##### `h2_push_diary_size` Data type: `Optional[Integer]` Sets maximum number of HTTP/2 server pushes that are remembered per HTTP/2 connection. -Default value: ``undef`` +Default value: `undef` -##### `h2_push_priority` +##### `h2_push_priority` Data type: `Array[String]` @@ -2651,7 +2663,7 @@ Require HTTP/2 connections to be "modern TLS" only Default value: `[]` -##### `h2_push_resource` +##### `h2_push_resource` Data type: `Array[String]` @@ -2660,59 +2672,59 @@ via this directive Default value: `[]` -##### `h2_serialize_headers` +##### `h2_serialize_headers` Data type: `Optional[Boolean]` Toggles if HTTP/2 requests shall be serialized in HTTP/1.1 format for processing by httpd core or if received binary data shall be passed into the request_recs directly. -Default value: ``undef`` +Default value: `undef` -##### `h2_stream_max_mem_size` +##### `h2_stream_max_mem_size` Data type: `Optional[Integer]` Sets the maximum number of outgoing data bytes buffered in memory for an active streams. -Default value: ``undef`` +Default value: `undef` -##### `h2_tls_cool_down_secs` +##### `h2_tls_cool_down_secs` Data type: `Optional[Integer]` Sets the number of seconds of idle time on a TLS connection before the TLS write size falls back to small (~1300 bytes) length. -Default value: ``undef`` +Default value: `undef` -##### `h2_tls_warm_up_size` +##### `h2_tls_warm_up_size` Data type: `Optional[Integer]` Sets the number of bytes to be sent in small TLS records (~1300 bytes) until doing maximum sized writes (16k) on https: HTTP/2 connections. -Default value: ``undef`` +Default value: `undef` -##### `h2_upgrade` +##### `h2_upgrade` Data type: `Optional[Boolean]` Toggles the usage of the HTTP/1.1 Upgrade method for switching to HTTP/2. -Default value: ``undef`` +Default value: `undef` -##### `h2_window_size` +##### `h2_window_size` Data type: `Optional[Integer]` Sets the size of the window that is used for flow control from client to server and limits the amount of data the server has to buffer. -Default value: ``undef`` +Default value: `undef` -### `apache::mod::include` +### `apache::mod::include` Installs `mod_include`. @@ -2720,7 +2732,7 @@ Installs `mod_include`. * https://httpd.apache.org/docs/current/mod/mod_include.html * for additional documentation. -### `apache::mod::info` +### `apache::mod::info` Installs and configures `mod_info`. @@ -2732,11 +2744,11 @@ Installs and configures `mod_info`. The following parameters are available in the `apache::mod::info` class: -* [`allow_from`](#allow_from) -* [`restrict_access`](#restrict_access) -* [`info_path`](#info_path) +* [`allow_from`](#-apache--mod--info--allow_from) +* [`restrict_access`](#-apache--mod--info--restrict_access) +* [`info_path`](#-apache--mod--info--info_path) -##### `allow_from` +##### `allow_from` Data type: `Array[Stdlib::IP::Address]` @@ -2744,16 +2756,16 @@ Allowlist of IPv4 or IPv6 addresses or ranges that can access the info path. Default value: `['127.0.0.1', '::1']` -##### `restrict_access` +##### `restrict_access` Data type: `Boolean` Toggles whether to restrict access to info path. If `false`, the `allow_from` allowlist is ignored and any IP address can access the info path. -Default value: ``true`` +Default value: `true` -##### `info_path` +##### `info_path` Data type: `Stdlib::Unixpath` @@ -2761,7 +2773,7 @@ Path on server to file containing server configuration information. Default value: `'/server-info'` -### `apache::mod::intercept_form_submit` +### `apache::mod::intercept_form_submit` Installs `mod_intercept_form_submit`. @@ -2769,7 +2781,7 @@ Installs `mod_intercept_form_submit`. * https://www.adelton.com/apache/mod_intercept_form_submit * for additional documentation. -### `apache::mod::itk` +### `apache::mod::itk` Installs MPM `mod_itk`. @@ -2783,15 +2795,15 @@ Installs MPM `mod_itk`. The following parameters are available in the `apache::mod::itk` class: -* [`startservers`](#startservers) -* [`minspareservers`](#minspareservers) -* [`maxspareservers`](#maxspareservers) -* [`serverlimit`](#serverlimit) -* [`maxclients`](#maxclients) -* [`maxrequestsperchild`](#maxrequestsperchild) -* [`enablecapabilities`](#enablecapabilities) +* [`startservers`](#-apache--mod--itk--startservers) +* [`minspareservers`](#-apache--mod--itk--minspareservers) +* [`maxspareservers`](#-apache--mod--itk--maxspareservers) +* [`serverlimit`](#-apache--mod--itk--serverlimit) +* [`maxclients`](#-apache--mod--itk--maxclients) +* [`maxrequestsperchild`](#-apache--mod--itk--maxrequestsperchild) +* [`enablecapabilities`](#-apache--mod--itk--enablecapabilities) -##### `startservers` +##### `startservers` Data type: `Integer` @@ -2799,7 +2811,7 @@ Number of child server processes created on startup. Default value: `8` -##### `minspareservers` +##### `minspareservers` Data type: `Integer` @@ -2807,7 +2819,7 @@ Minimum number of idle child server processes. Default value: `5` -##### `maxspareservers` +##### `maxspareservers` Data type: `Integer` @@ -2815,7 +2827,7 @@ Maximum number of idle child server processes. Default value: `20` -##### `serverlimit` +##### `serverlimit` Data type: `Integer` @@ -2823,7 +2835,7 @@ Maximum configured value for `MaxRequestWorkers` for the lifetime of the Apache Default value: `256` -##### `maxclients` +##### `maxclients` Data type: `Integer` @@ -2831,7 +2843,7 @@ Limit on the number of simultaneous requests that will be served. Default value: `256` -##### `maxrequestsperchild` +##### `maxrequestsperchild` Data type: `Integer` @@ -2839,7 +2851,7 @@ Limit on the number of connections that an individual child server process will Default value: `4000` -##### `enablecapabilities` +##### `enablecapabilities` Data type: `Optional[Variant[Boolean, String]]` @@ -2847,9 +2859,9 @@ Drop most root capabilities in the parent process, and instead run as the user g capabilities (in particular setuid). Somewhat more secure, but can cause problems when serving from filesystems that do not honor capabilities, such as NFS. -Default value: ``undef`` +Default value: `undef` -### `apache::mod::jk` +### `apache::mod::jk` Installs `mod_jk`. @@ -2898,59 +2910,59 @@ class { '::apache::mod::jk': The following parameters are available in the `apache::mod::jk` class: -* [`ip`](#ip) -* [`port`](#port) -* [`add_listen`](#add_listen) -* [`workers_file`](#workers_file) -* [`worker_property`](#worker_property) -* [`logroot`](#logroot) -* [`shm_file`](#shm_file) -* [`shm_size`](#shm_size) -* [`mount_file`](#mount_file) -* [`mount_file_reload`](#mount_file_reload) -* [`mount`](#mount) -* [`un_mount`](#un_mount) -* [`auto_alias`](#auto_alias) -* [`mount_copy`](#mount_copy) -* [`worker_indicator`](#worker_indicator) -* [`watchdog_interval`](#watchdog_interval) -* [`log_file`](#log_file) -* [`log_level`](#log_level) -* [`log_stamp_format`](#log_stamp_format) -* [`request_log_format`](#request_log_format) -* [`extract_ssl`](#extract_ssl) -* [`https_indicator`](#https_indicator) -* [`sslprotocol_indicator`](#sslprotocol_indicator) -* [`certs_indicator`](#certs_indicator) -* [`cipher_indicator`](#cipher_indicator) -* [`certchain_prefix`](#certchain_prefix) -* [`session_indicator`](#session_indicator) -* [`keysize_indicator`](#keysize_indicator) -* [`local_name_indicator`](#local_name_indicator) -* [`ignore_cl_indicator`](#ignore_cl_indicator) -* [`local_addr_indicator`](#local_addr_indicator) -* [`local_port_indicator`](#local_port_indicator) -* [`remote_host_indicator`](#remote_host_indicator) -* [`remote_addr_indicator`](#remote_addr_indicator) -* [`remote_port_indicator`](#remote_port_indicator) -* [`remote_user_indicator`](#remote_user_indicator) -* [`auth_type_indicator`](#auth_type_indicator) -* [`options`](#options) -* [`env_var`](#env_var) -* [`strip_session`](#strip_session) -* [`location_list`](#location_list) -* [`workers_file_content`](#workers_file_content) -* [`mount_file_content`](#mount_file_content) - -##### `ip` +* [`ip`](#-apache--mod--jk--ip) +* [`port`](#-apache--mod--jk--port) +* [`add_listen`](#-apache--mod--jk--add_listen) +* [`workers_file`](#-apache--mod--jk--workers_file) +* [`worker_property`](#-apache--mod--jk--worker_property) +* [`logroot`](#-apache--mod--jk--logroot) +* [`shm_file`](#-apache--mod--jk--shm_file) +* [`shm_size`](#-apache--mod--jk--shm_size) +* [`mount_file`](#-apache--mod--jk--mount_file) +* [`mount_file_reload`](#-apache--mod--jk--mount_file_reload) +* [`mount`](#-apache--mod--jk--mount) +* [`un_mount`](#-apache--mod--jk--un_mount) +* [`auto_alias`](#-apache--mod--jk--auto_alias) +* [`mount_copy`](#-apache--mod--jk--mount_copy) +* [`worker_indicator`](#-apache--mod--jk--worker_indicator) +* [`watchdog_interval`](#-apache--mod--jk--watchdog_interval) +* [`log_file`](#-apache--mod--jk--log_file) +* [`log_level`](#-apache--mod--jk--log_level) +* [`log_stamp_format`](#-apache--mod--jk--log_stamp_format) +* [`request_log_format`](#-apache--mod--jk--request_log_format) +* [`extract_ssl`](#-apache--mod--jk--extract_ssl) +* [`https_indicator`](#-apache--mod--jk--https_indicator) +* [`sslprotocol_indicator`](#-apache--mod--jk--sslprotocol_indicator) +* [`certs_indicator`](#-apache--mod--jk--certs_indicator) +* [`cipher_indicator`](#-apache--mod--jk--cipher_indicator) +* [`certchain_prefix`](#-apache--mod--jk--certchain_prefix) +* [`session_indicator`](#-apache--mod--jk--session_indicator) +* [`keysize_indicator`](#-apache--mod--jk--keysize_indicator) +* [`local_name_indicator`](#-apache--mod--jk--local_name_indicator) +* [`ignore_cl_indicator`](#-apache--mod--jk--ignore_cl_indicator) +* [`local_addr_indicator`](#-apache--mod--jk--local_addr_indicator) +* [`local_port_indicator`](#-apache--mod--jk--local_port_indicator) +* [`remote_host_indicator`](#-apache--mod--jk--remote_host_indicator) +* [`remote_addr_indicator`](#-apache--mod--jk--remote_addr_indicator) +* [`remote_port_indicator`](#-apache--mod--jk--remote_port_indicator) +* [`remote_user_indicator`](#-apache--mod--jk--remote_user_indicator) +* [`auth_type_indicator`](#-apache--mod--jk--auth_type_indicator) +* [`options`](#-apache--mod--jk--options) +* [`env_var`](#-apache--mod--jk--env_var) +* [`strip_session`](#-apache--mod--jk--strip_session) +* [`location_list`](#-apache--mod--jk--location_list) +* [`workers_file_content`](#-apache--mod--jk--workers_file_content) +* [`mount_file_content`](#-apache--mod--jk--mount_file_content) + +##### `ip` Data type: `Optional[Stdlib::IP::Address]` IP for binding to mod_jk. Useful when the binding address is not the primary network interface IP. -Default value: ``undef`` +Default value: `undef` -##### `port` +##### `port` Data type: `Stdlib::Port` @@ -2959,7 +2971,7 @@ needs to forward them to Apache at a different port. Default value: `80` -##### `add_listen` +##### `add_listen` Data type: `Boolean` @@ -2967,17 +2979,17 @@ Defines if a Listen directive according to parameters ip and port (see below), s and redirect to mod_jk. Useful when another Listen directive, like Listen *: or Listen , can conflict with the one necessary for mod_jk binding. -Default value: ``true`` +Default value: `true` -##### `workers_file` +##### `workers_file` Data type: `Optional[String]` The name of a worker file for the Tomcat servlet containers. -Default value: ``undef`` +Default value: `undef` -##### `worker_property` +##### `worker_property` Data type: `Hash` @@ -2985,16 +2997,16 @@ Enables setting worker properties inside Apache configuration file. Default value: `{}` -##### `logroot` +##### `logroot` Data type: `Optional[Stdlib::Absolutepath]` The base directory for shm_file and log_file is determined by the logroot parameter. If unspecified, defaults to apache::params::logroot. The default logroot is sane enough therefore it is not recommended to override it. -Default value: ``undef`` +Default value: `undef` -##### `shm_file` +##### `shm_file` Data type: `String` @@ -3002,31 +3014,31 @@ Shared memory file name. Default value: `'jk-runtime-status'` -##### `shm_size` +##### `shm_size` Data type: `Optional[String]` Size of the shared memory file name. -Default value: ``undef`` +Default value: `undef` -##### `mount_file` +##### `mount_file` Data type: `Optional[String]` File containing multiple mappings from a context to a Tomcat worker. -Default value: ``undef`` +Default value: `undef` -##### `mount_file_reload` +##### `mount_file_reload` Data type: `Optional[String]` This directive configures the reload check interval in seconds. -Default value: ``undef`` +Default value: `undef` -##### `mount` +##### `mount` Data type: `Hash` @@ -3034,7 +3046,7 @@ A mount point from a context to a Tomcat worker. Default value: `{}` -##### `un_mount` +##### `un_mount` Data type: `Hash` @@ -3042,41 +3054,41 @@ An exclusion mount point from a context to a Tomcat worker. Default value: `{}` -##### `auto_alias` +##### `auto_alias` Data type: `Optional[String]` Automatically Alias webapp context directories into the Apache document space -Default value: ``undef`` +Default value: `undef` -##### `mount_copy` +##### `mount_copy` Data type: `Optional[String]` If this directive is set to "On" in some virtual server, the mounts from the global server will be copied to this virtual server, more precisely all mounts defined by JkMount or JkUnMount. -Default value: ``undef`` +Default value: `undef` -##### `worker_indicator` +##### `worker_indicator` Data type: `Optional[String]` Name of the Apache environment variable that can be used to set worker names in combination with SetHandler jakarta-servlet. -Default value: ``undef`` +Default value: `undef` -##### `watchdog_interval` +##### `watchdog_interval` Data type: `Optional[Integer]` This directive configures the watchdog thread interval in seconds. -Default value: ``undef`` +Default value: `undef` -##### `log_file` +##### `log_file` Data type: `String` @@ -3084,167 +3096,167 @@ Full or server relative path to the mod_jk log file. Default value: `'mod_jk.log'` -##### `log_level` +##### `log_level` Data type: `Optional[String]` The mod_jk log level, can be debug, info, warn error or trace. -Default value: ``undef`` +Default value: `undef` -##### `log_stamp_format` +##### `log_stamp_format` Data type: `Optional[String]` The mod_jk date log format, using an extended strftime syntax. -Default value: ``undef`` +Default value: `undef` -##### `request_log_format` +##### `request_log_format` Data type: `Optional[String]` Request log format string. -Default value: ``undef`` +Default value: `undef` -##### `extract_ssl` +##### `extract_ssl` Data type: `Optional[String]` Turns on SSL processing and information gathering by mod_jk. -Default value: ``undef`` +Default value: `undef` -##### `https_indicator` +##### `https_indicator` Data type: `Optional[String]` Name of the Apache environment variable that contains SSL indication. -Default value: ``undef`` +Default value: `undef` -##### `sslprotocol_indicator` +##### `sslprotocol_indicator` Data type: `Optional[String]` Name of the Apache environment variable that contains the SSL protocol name. -Default value: ``undef`` +Default value: `undef` -##### `certs_indicator` +##### `certs_indicator` Data type: `Optional[String]` Name of the Apache environment variable that contains SSL client certificates. -Default value: ``undef`` +Default value: `undef` -##### `cipher_indicator` +##### `cipher_indicator` Data type: `Optional[String]` Name of the Apache environment variable that contains SSL client cipher. -Default value: ``undef`` +Default value: `undef` -##### `certchain_prefix` +##### `certchain_prefix` Data type: `Optional[String]` Name of the Apache environment (prefix) that contains SSL client chain certificates. -Default value: ``undef`` +Default value: `undef` -##### `session_indicator` +##### `session_indicator` Data type: `Optional[String]` Name of the Apache environment variable that contains SSL session. -Default value: ``undef`` +Default value: `undef` -##### `keysize_indicator` +##### `keysize_indicator` Data type: `Optional[String]` Name of the Apache environment variable that contains SSL key size in use. -Default value: ``undef`` +Default value: `undef` -##### `local_name_indicator` +##### `local_name_indicator` Data type: `Optional[String]` Name of the Apache environment variable which can be used to overwrite the forwarded local name. -Default value: ``undef`` +Default value: `undef` -##### `ignore_cl_indicator` +##### `ignore_cl_indicator` Data type: `Optional[String]` Name of the Apache environment variable which forces to ignore an existing Content-Length request header. -Default value: ``undef`` +Default value: `undef` -##### `local_addr_indicator` +##### `local_addr_indicator` Data type: `Optional[String]` Name of the Apache environment variable which can be used to overwrite the forwarded local IP address. -Default value: ``undef`` +Default value: `undef` -##### `local_port_indicator` +##### `local_port_indicator` Data type: `Optional[String]` Name of the Apache environment variable which can be used to overwrite the forwarded local port. -Default value: ``undef`` +Default value: `undef` -##### `remote_host_indicator` +##### `remote_host_indicator` Data type: `Optional[String]` Name of the Apache environment variable which can be used to overwrite the forwarded remote (client) host name. -Default value: ``undef`` +Default value: `undef` -##### `remote_addr_indicator` +##### `remote_addr_indicator` Data type: `Optional[String]` Name of the Apache environment variable which can be used to overwrite the forwarded remote (client) IP address. -Default value: ``undef`` +Default value: `undef` -##### `remote_port_indicator` +##### `remote_port_indicator` Data type: `Optional[String]` Name of the Apache environment variable which can be used to overwrite the forwarded remote (client) IP address. -Default value: ``undef`` +Default value: `undef` -##### `remote_user_indicator` +##### `remote_user_indicator` Data type: `Optional[String]` Name of the Apache environment variable which can be used to overwrite the forwarded user name. -Default value: ``undef`` +Default value: `undef` -##### `auth_type_indicator` +##### `auth_type_indicator` Data type: `Optional[String]` Name of the Apache environment variable which can be used to overwrite the forwarded authentication type. -Default value: ``undef`` +Default value: `undef` -##### `options` +##### `options` Data type: `Array` @@ -3252,7 +3264,7 @@ Set one of more options to configure the mod_jk module. Default value: `[]` -##### `env_var` +##### `env_var` Data type: `Hash` @@ -3260,16 +3272,16 @@ Adds a name and an optional default value of environment variable that should be Default value: `{}` -##### `strip_session` +##### `strip_session` Data type: `Optional[String]` If this directive is set to On in some virtual server, the session IDs ;jsessionid=... will be removed for URLs which are not forwarded but instead are handled by the local server. -Default value: ``undef`` +Default value: `undef` -##### `location_list` +##### `location_list` Data type: `Array` @@ -3302,7 +3314,7 @@ location_list = [ Default value: `[]` -##### `workers_file_content` +##### `workers_file_content` Data type: `Hash` @@ -3346,7 +3358,7 @@ $workers_file_content = { Default value: `{}` -##### `mount_file_content` +##### `mount_file_content` Data type: `Hash` @@ -3383,7 +3395,7 @@ $mount_file_content = { Default value: `{}` -### `apache::mod::lbmethod_bybusyness` +### `apache::mod::lbmethod_bybusyness` Installs `lbmethod_bybusyness`. @@ -3395,9 +3407,9 @@ Installs `lbmethod_bybusyness`. The following parameters are available in the `apache::mod::lbmethod_bybusyness` class: -* [`apache_version`](#apache_version) +* [`apache_version`](#-apache--mod--lbmethod_bybusyness--apache_version) -##### `apache_version` +##### `apache_version` Data type: `Optional[String]` @@ -3405,7 +3417,7 @@ Version of Apache to install module on. Default value: `$apache::apache_version` -### `apache::mod::lbmethod_byrequests` +### `apache::mod::lbmethod_byrequests` Installs `lbmethod_byrequests`. @@ -3417,9 +3429,9 @@ Installs `lbmethod_byrequests`. The following parameters are available in the `apache::mod::lbmethod_byrequests` class: -* [`apache_version`](#apache_version) +* [`apache_version`](#-apache--mod--lbmethod_byrequests--apache_version) -##### `apache_version` +##### `apache_version` Data type: `Optional[String]` @@ -3427,7 +3439,7 @@ Version of Apache to install module on. Default value: `$apache::apache_version` -### `apache::mod::lbmethod_bytraffic` +### `apache::mod::lbmethod_bytraffic` Installs `lbmethod_bytraffic`. @@ -3439,9 +3451,9 @@ Installs `lbmethod_bytraffic`. The following parameters are available in the `apache::mod::lbmethod_bytraffic` class: -* [`apache_version`](#apache_version) +* [`apache_version`](#-apache--mod--lbmethod_bytraffic--apache_version) -##### `apache_version` +##### `apache_version` Data type: `Optional[String]` @@ -3449,7 +3461,7 @@ Version of Apache to install module on. Default value: `$apache::apache_version` -### `apache::mod::lbmethod_heartbeat` +### `apache::mod::lbmethod_heartbeat` Installs `lbmethod_heartbeat`. @@ -3461,9 +3473,9 @@ Installs `lbmethod_heartbeat`. The following parameters are available in the `apache::mod::lbmethod_heartbeat` class: -* [`apache_version`](#apache_version) +* [`apache_version`](#-apache--mod--lbmethod_heartbeat--apache_version) -##### `apache_version` +##### `apache_version` Data type: `Optional[String]` @@ -3471,7 +3483,7 @@ Version of Apache to install module on. Default value: `$apache::apache_version` -### `apache::mod::ldap` +### `apache::mod::ldap` Installs and configures `mod_ldap`. @@ -3502,34 +3514,34 @@ class { 'apache::mod::ldap': The following parameters are available in the `apache::mod::ldap` class: -* [`package_name`](#package_name) -* [`ldap_trusted_global_cert_file`](#ldap_trusted_global_cert_file) -* [`ldap_trusted_global_cert_type`](#ldap_trusted_global_cert_type) -* [`ldap_shared_cache_size`](#ldap_shared_cache_size) -* [`ldap_cache_entries`](#ldap_cache_entries) -* [`ldap_cache_ttl`](#ldap_cache_ttl) -* [`ldap_opcache_entries`](#ldap_opcache_entries) -* [`ldap_opcache_ttl`](#ldap_opcache_ttl) -* [`ldap_trusted_mode`](#ldap_trusted_mode) -* [`ldap_path`](#ldap_path) +* [`package_name`](#-apache--mod--ldap--package_name) +* [`ldap_trusted_global_cert_file`](#-apache--mod--ldap--ldap_trusted_global_cert_file) +* [`ldap_trusted_global_cert_type`](#-apache--mod--ldap--ldap_trusted_global_cert_type) +* [`ldap_shared_cache_size`](#-apache--mod--ldap--ldap_shared_cache_size) +* [`ldap_cache_entries`](#-apache--mod--ldap--ldap_cache_entries) +* [`ldap_cache_ttl`](#-apache--mod--ldap--ldap_cache_ttl) +* [`ldap_opcache_entries`](#-apache--mod--ldap--ldap_opcache_entries) +* [`ldap_opcache_ttl`](#-apache--mod--ldap--ldap_opcache_ttl) +* [`ldap_trusted_mode`](#-apache--mod--ldap--ldap_trusted_mode) +* [`ldap_path`](#-apache--mod--ldap--ldap_path) -##### `package_name` +##### `package_name` Data type: `Optional[String]` Specifies the custom package name. -Default value: ``undef`` +Default value: `undef` -##### `ldap_trusted_global_cert_file` +##### `ldap_trusted_global_cert_file` Data type: `Optional[String]` Sets the file or database containing global trusted Certificate Authority or global client certificates. -Default value: ``undef`` +Default value: `undef` -##### `ldap_trusted_global_cert_type` +##### `ldap_trusted_global_cert_type` Data type: `String` @@ -3537,55 +3549,55 @@ Sets the certificate parameter of the global trusted Certificate Authority or gl Default value: `'CA_BASE64'` -##### `ldap_shared_cache_size` +##### `ldap_shared_cache_size` Data type: `Optional[Integer]` Size in bytes of the shared-memory cache -Default value: ``undef`` +Default value: `undef` -##### `ldap_cache_entries` +##### `ldap_cache_entries` Data type: `Optional[Integer]` Maximum number of entries in the primary LDAP cache -Default value: ``undef`` +Default value: `undef` -##### `ldap_cache_ttl` +##### `ldap_cache_ttl` Data type: `Optional[Integer]` Time that cached items remain valid (in seconds). -Default value: ``undef`` +Default value: `undef` -##### `ldap_opcache_entries` +##### `ldap_opcache_entries` Data type: `Optional[Integer]` Number of entries used to cache LDAP compare operations -Default value: ``undef`` +Default value: `undef` -##### `ldap_opcache_ttl` +##### `ldap_opcache_ttl` Data type: `Optional[Integer]` Time that entries in the operation cache remain valid (in seconds). -Default value: ``undef`` +Default value: `undef` -##### `ldap_trusted_mode` +##### `ldap_trusted_mode` Data type: `Optional[String]` Specifies the SSL/TLS mode to be used when connecting to an LDAP server. -Default value: ``undef`` +Default value: `undef` -##### `ldap_path` +##### `ldap_path` Data type: `String` @@ -3593,7 +3605,7 @@ The server location of the ldap status page. Default value: `'/ldap-status'` -### `apache::mod::log_forensic` +### `apache::mod::log_forensic` Installs `mod_log_forensic` @@ -3601,7 +3613,7 @@ Installs `mod_log_forensic` * https://httpd.apache.org/docs/current/mod/mod_log_forensic.html * for additional documentation. -### `apache::mod::lookup_identity` +### `apache::mod::lookup_identity` Installs `mod_lookup_identity` @@ -3609,7 +3621,7 @@ Installs `mod_lookup_identity` * https://www.adelton.com/apache/mod_lookup_identity * for additional documentation. -### `apache::mod::macro` +### `apache::mod::macro` Installs `mod_macro`. @@ -3617,7 +3629,7 @@ Installs `mod_macro`. * https://httpd.apache.org/docs/current/mod/mod_macro.html * for additional documentation. -### `apache::mod::md` +### `apache::mod::md` Installs and configures `mod_md`. @@ -3631,264 +3643,264 @@ Installs and configures `mod_md`. The following parameters are available in the `apache::mod::md` class: -* [`md_activation_delay`](#md_activation_delay) -* [`md_base_server`](#md_base_server) -* [`md_ca_challenges`](#md_ca_challenges) -* [`md_certificate_agreement`](#md_certificate_agreement) -* [`md_certificate_authority`](#md_certificate_authority) -* [`md_certificate_check`](#md_certificate_check) -* [`md_certificate_monitor`](#md_certificate_monitor) -* [`md_certificate_protocol`](#md_certificate_protocol) -* [`md_certificate_status`](#md_certificate_status) -* [`md_challenge_dns01`](#md_challenge_dns01) -* [`md_contact_email`](#md_contact_email) -* [`md_http_proxy`](#md_http_proxy) -* [`md_members`](#md_members) -* [`md_message_cmd`](#md_message_cmd) -* [`md_must_staple`](#md_must_staple) -* [`md_notify_cmd`](#md_notify_cmd) -* [`md_port_map`](#md_port_map) -* [`md_private_keys`](#md_private_keys) -* [`md_renew_mode`](#md_renew_mode) -* [`md_renew_window`](#md_renew_window) -* [`md_require_https`](#md_require_https) -* [`md_server_status`](#md_server_status) -* [`md_staple_others`](#md_staple_others) -* [`md_stapling`](#md_stapling) -* [`md_stapling_keep_response`](#md_stapling_keep_response) -* [`md_stapling_renew_window`](#md_stapling_renew_window) -* [`md_store_dir`](#md_store_dir) -* [`md_warn_window`](#md_warn_window) - -##### `md_activation_delay` +* [`md_activation_delay`](#-apache--mod--md--md_activation_delay) +* [`md_base_server`](#-apache--mod--md--md_base_server) +* [`md_ca_challenges`](#-apache--mod--md--md_ca_challenges) +* [`md_certificate_agreement`](#-apache--mod--md--md_certificate_agreement) +* [`md_certificate_authority`](#-apache--mod--md--md_certificate_authority) +* [`md_certificate_check`](#-apache--mod--md--md_certificate_check) +* [`md_certificate_monitor`](#-apache--mod--md--md_certificate_monitor) +* [`md_certificate_protocol`](#-apache--mod--md--md_certificate_protocol) +* [`md_certificate_status`](#-apache--mod--md--md_certificate_status) +* [`md_challenge_dns01`](#-apache--mod--md--md_challenge_dns01) +* [`md_contact_email`](#-apache--mod--md--md_contact_email) +* [`md_http_proxy`](#-apache--mod--md--md_http_proxy) +* [`md_members`](#-apache--mod--md--md_members) +* [`md_message_cmd`](#-apache--mod--md--md_message_cmd) +* [`md_must_staple`](#-apache--mod--md--md_must_staple) +* [`md_notify_cmd`](#-apache--mod--md--md_notify_cmd) +* [`md_port_map`](#-apache--mod--md--md_port_map) +* [`md_private_keys`](#-apache--mod--md--md_private_keys) +* [`md_renew_mode`](#-apache--mod--md--md_renew_mode) +* [`md_renew_window`](#-apache--mod--md--md_renew_window) +* [`md_require_https`](#-apache--mod--md--md_require_https) +* [`md_server_status`](#-apache--mod--md--md_server_status) +* [`md_staple_others`](#-apache--mod--md--md_staple_others) +* [`md_stapling`](#-apache--mod--md--md_stapling) +* [`md_stapling_keep_response`](#-apache--mod--md--md_stapling_keep_response) +* [`md_stapling_renew_window`](#-apache--mod--md--md_stapling_renew_window) +* [`md_store_dir`](#-apache--mod--md--md_store_dir) +* [`md_warn_window`](#-apache--mod--md--md_warn_window) + +##### `md_activation_delay` Data type: `Optional[String]` - -Default value: ``undef`` +Default value: `undef` -##### `md_base_server` +##### `md_base_server` Data type: `Optional[Apache::OnOff]` Control if base server may be managed or only virtual hosts. -Default value: ``undef`` +Default value: `undef` -##### `md_ca_challenges` +##### `md_ca_challenges` Data type: `Optional[Array[Enum['dns-01', 'http-01', 'tls-alpn-01']]]` Type of ACME challenge used to prove domain ownership. -Default value: ``undef`` +Default value: `undef` -##### `md_certificate_agreement` +##### `md_certificate_agreement` Data type: `Optional[Enum['accepted']]` You confirm that you accepted the Terms of Service of the Certificate Authority. -Default value: ``undef`` +Default value: `undef` -##### `md_certificate_authority` +##### `md_certificate_authority` Data type: `Optional[Stdlib::HTTPUrl]` The URL of the ACME Certificate Authority service. -Default value: ``undef`` +Default value: `undef` -##### `md_certificate_check` +##### `md_certificate_check` Data type: `Optional[String]` - -Default value: ``undef`` +Default value: `undef` -##### `md_certificate_monitor` +##### `md_certificate_monitor` Data type: `Optional[String]` The URL of a certificate log monitor. -Default value: ``undef`` +Default value: `undef` -##### `md_certificate_protocol` +##### `md_certificate_protocol` Data type: `Optional[Enum['ACME']]` The protocol to use with the Certificate Authority. -Default value: ``undef`` +Default value: `undef` -##### `md_certificate_status` +##### `md_certificate_status` Data type: `Optional[Apache::OnOff]` Exposes public certificate information in JSON. -Default value: ``undef`` +Default value: `undef` -##### `md_challenge_dns01` +##### `md_challenge_dns01` Data type: `Optional[Stdlib::Absolutepath]` Define a program to be called when the `dns-01` challenge needs to be setup/torn down. -Default value: ``undef`` +Default value: `undef` -##### `md_contact_email` +##### `md_contact_email` Data type: `Optional[String]` The ACME protocol requires you to give a contact url when you sign up. -Default value: ``undef`` +Default value: `undef` -##### `md_http_proxy` +##### `md_http_proxy` Data type: `Optional[Stdlib::HTTPUrl]` Define a proxy for outgoing connections. -Default value: ``undef`` +Default value: `undef` -##### `md_members` +##### `md_members` Data type: `Optional[Enum['auto', 'manual']]` Control if the alias domain names are automatically added. -Default value: ``undef`` +Default value: `undef` -##### `md_message_cmd` +##### `md_message_cmd` Data type: `Optional[Stdlib::Absolutepath]` Handle events for Manage Domains. -Default value: ``undef`` +Default value: `undef` -##### `md_must_staple` +##### `md_must_staple` Data type: `Optional[Apache::OnOff]` Control if new certificates carry the OCSP Must Staple flag. -Default value: ``undef`` +Default value: `undef` -##### `md_notify_cmd` +##### `md_notify_cmd` Data type: `Optional[Stdlib::Absolutepath]` Run a program when a Managed Domain is ready. -Default value: ``undef`` +Default value: `undef` -##### `md_port_map` +##### `md_port_map` Data type: `Optional[String]` Map external to internal ports for domain ownership verification. -Default value: ``undef`` +Default value: `undef` -##### `md_private_keys` +##### `md_private_keys` Data type: `Optional[String]` Set type and size of the private keys generated. -Default value: ``undef`` +Default value: `undef` -##### `md_renew_mode` +##### `md_renew_mode` Data type: `Optional[Enum['always', 'auto', 'manual']]` Controls if certificates shall be renewed. -Default value: ``undef`` +Default value: `undef` -##### `md_renew_window` +##### `md_renew_window` Data type: `Optional[String]` Control when a certificate will be renewed. -Default value: ``undef`` +Default value: `undef` -##### `md_require_https` +##### `md_require_https` Data type: `Optional[Enum['off', 'permanent', 'temporary']]` Redirects http: traffic to https: for Managed Domains. An http: Virtual Host must nevertheless be setup for that domain. -Default value: ``undef`` +Default value: `undef` -##### `md_server_status` +##### `md_server_status` Data type: `Optional[Apache::OnOff]` Control if Managed Domain information is added to server-status. -Default value: ``undef`` +Default value: `undef` -##### `md_staple_others` +##### `md_staple_others` Data type: `Optional[Apache::OnOff]` Enable stapling for certificates not managed by mod_md. -Default value: ``undef`` +Default value: `undef` -##### `md_stapling` +##### `md_stapling` Data type: `Optional[Apache::OnOff]` Enable stapling for all or a particular MDomain. -Default value: ``undef`` +Default value: `undef` -##### `md_stapling_keep_response` +##### `md_stapling_keep_response` Data type: `Optional[String]` Controls when old responses should be removed. -Default value: ``undef`` +Default value: `undef` -##### `md_stapling_renew_window` +##### `md_stapling_renew_window` Data type: `Optional[String]` Control when the stapling responses will be renewed. -Default value: ``undef`` +Default value: `undef` -##### `md_store_dir` +##### `md_store_dir` Data type: `Optional[Stdlib::Absolutepath]` Path on the local file system to store the Managed Domains data. -Default value: ``undef`` +Default value: `undef` -##### `md_warn_window` +##### `md_warn_window` Data type: `Optional[String]` Define the time window when you want to be warned about an expiring certificate. -Default value: ``undef`` +Default value: `undef` -### `apache::mod::mime` +### `apache::mod::mime` Installs and configures `mod_mime`. @@ -3900,11 +3912,11 @@ Installs and configures `mod_mime`. The following parameters are available in the `apache::mod::mime` class: -* [`mime_support_package`](#mime_support_package) -* [`mime_types_config`](#mime_types_config) -* [`mime_types_additional`](#mime_types_additional) +* [`mime_support_package`](#-apache--mod--mime--mime_support_package) +* [`mime_types_config`](#-apache--mod--mime--mime_types_config) +* [`mime_types_additional`](#-apache--mod--mime--mime_types_additional) -##### `mime_support_package` +##### `mime_support_package` Data type: `String` @@ -3912,7 +3924,7 @@ Name of the MIME package to be installed. Default value: `$apache::params::mime_support_package` -##### `mime_types_config` +##### `mime_types_config` Data type: `String` @@ -3920,15 +3932,15 @@ The location of the mime.types file. Default value: `$apache::params::mime_types_config` -##### `mime_types_additional` +##### `mime_types_additional` Data type: `Optional[Hash]` List of additional MIME types to include. -Default value: ``undef`` +Default value: `undef` -### `apache::mod::mime_magic` +### `apache::mod::mime_magic` Installs and configures `mod_mime_magic`. @@ -3940,17 +3952,17 @@ Installs and configures `mod_mime_magic`. The following parameters are available in the `apache::mod::mime_magic` class: -* [`magic_file`](#magic_file) +* [`magic_file`](#-apache--mod--mime_magic--magic_file) -##### `magic_file` +##### `magic_file` Data type: `Optional[String]` Enable MIME-type determination based on file contents using the specified magic file. -Default value: ``undef`` +Default value: `undef` -### `apache::mod::negotiation` +### `apache::mod::negotiation` Installs and configures `mod_negotiation`. @@ -3962,10 +3974,10 @@ Installs and configures `mod_negotiation`. The following parameters are available in the `apache::mod::negotiation` class: -* [`force_language_priority`](#force_language_priority) -* [`language_priority`](#language_priority) +* [`force_language_priority`](#-apache--mod--negotiation--force_language_priority) +* [`language_priority`](#-apache--mod--negotiation--language_priority) -##### `force_language_priority` +##### `force_language_priority` Data type: `Variant[Array[String], String]` @@ -3973,18 +3985,22 @@ Action to take if a single acceptable document is not found. Default value: `'Prefer Fallback'` -##### `language_priority` +##### `language_priority` Data type: `Variant[Array[String], String]` The precedence of language variants for cases where the client does not express a preference. -Default value: `['en', 'ca', 'cs', 'da', 'de', 'el', 'eo', 'es', 'et', +Default value: + +```puppet +['en', 'ca', 'cs', 'da', 'de', 'el', 'eo', 'es', 'et', 'fr', 'he', 'hr', 'it', 'ja', 'ko', 'ltz', 'nl', 'nn', 'no', 'pl', 'pt', 'pt-BR', 'ru', 'sv', 'zh-CN', - 'zh-TW']` + 'zh-TW'] +``` -### `apache::mod::nss` +### `apache::mod::nss` Installs and configures `mod_nss`. @@ -3996,12 +4012,12 @@ Installs and configures `mod_nss`. The following parameters are available in the `apache::mod::nss` class: -* [`transfer_log`](#transfer_log) -* [`error_log`](#error_log) -* [`passwd_file`](#passwd_file) -* [`port`](#port) +* [`transfer_log`](#-apache--mod--nss--transfer_log) +* [`error_log`](#-apache--mod--nss--error_log) +* [`passwd_file`](#-apache--mod--nss--passwd_file) +* [`port`](#-apache--mod--nss--port) -##### `transfer_log` +##### `transfer_log` Data type: `Stdlib::Absolutepath` @@ -4009,7 +4025,7 @@ Path to `access.log`. Default value: `"${apache::params::logroot}/access.log"` -##### `error_log` +##### `error_log` Data type: `Stdlib::Absolutepath` @@ -4017,15 +4033,15 @@ Path to `error.log` Default value: `"${apache::params::logroot}/error.log"` -##### `passwd_file` +##### `passwd_file` Data type: `Optional[String]` Path to file containing token passwords used for NSSPassPhraseDialog. -Default value: ``undef`` +Default value: `undef` -##### `port` +##### `port` Data type: `Stdlib::Port` @@ -4033,7 +4049,7 @@ Sets the SSL port that should be used by mod_nss. Default value: `8443` -### `apache::mod::pagespeed` +### `apache::mod::pagespeed` Installs and manages mod_pagespeed, which is a Google module that rewrites web pages to reduce latency and bandwidth. @@ -4098,42 +4114,42 @@ class { 'apache::mod::pagespeed': The following parameters are available in the `apache::mod::pagespeed` class: -* [`inherit_vhost_config`](#inherit_vhost_config) -* [`filter_xhtml`](#filter_xhtml) -* [`cache_path`](#cache_path) -* [`log_dir`](#log_dir) -* [`memcache_servers`](#memcache_servers) -* [`rewrite_level`](#rewrite_level) -* [`disable_filters`](#disable_filters) -* [`enable_filters`](#enable_filters) -* [`forbid_filters`](#forbid_filters) -* [`rewrite_deadline_per_flush_ms`](#rewrite_deadline_per_flush_ms) -* [`additional_domains`](#additional_domains) -* [`file_cache_size_kb`](#file_cache_size_kb) -* [`file_cache_clean_interval_ms`](#file_cache_clean_interval_ms) -* [`lru_cache_per_process`](#lru_cache_per_process) -* [`lru_cache_byte_limit`](#lru_cache_byte_limit) -* [`css_flatten_max_bytes`](#css_flatten_max_bytes) -* [`css_inline_max_bytes`](#css_inline_max_bytes) -* [`css_image_inline_max_bytes`](#css_image_inline_max_bytes) -* [`image_inline_max_bytes`](#image_inline_max_bytes) -* [`js_inline_max_bytes`](#js_inline_max_bytes) -* [`css_outline_min_bytes`](#css_outline_min_bytes) -* [`js_outline_min_bytes`](#js_outline_min_bytes) -* [`inode_limit`](#inode_limit) -* [`image_max_rewrites_at_once`](#image_max_rewrites_at_once) -* [`num_rewrite_threads`](#num_rewrite_threads) -* [`num_expensive_rewrite_threads`](#num_expensive_rewrite_threads) -* [`collect_statistics`](#collect_statistics) -* [`statistics_logging`](#statistics_logging) -* [`allow_view_stats`](#allow_view_stats) -* [`allow_pagespeed_console`](#allow_pagespeed_console) -* [`allow_pagespeed_message`](#allow_pagespeed_message) -* [`message_buffer_size`](#message_buffer_size) -* [`additional_configuration`](#additional_configuration) -* [`package_ensure`](#package_ensure) - -##### `inherit_vhost_config` +* [`inherit_vhost_config`](#-apache--mod--pagespeed--inherit_vhost_config) +* [`filter_xhtml`](#-apache--mod--pagespeed--filter_xhtml) +* [`cache_path`](#-apache--mod--pagespeed--cache_path) +* [`log_dir`](#-apache--mod--pagespeed--log_dir) +* [`memcache_servers`](#-apache--mod--pagespeed--memcache_servers) +* [`rewrite_level`](#-apache--mod--pagespeed--rewrite_level) +* [`disable_filters`](#-apache--mod--pagespeed--disable_filters) +* [`enable_filters`](#-apache--mod--pagespeed--enable_filters) +* [`forbid_filters`](#-apache--mod--pagespeed--forbid_filters) +* [`rewrite_deadline_per_flush_ms`](#-apache--mod--pagespeed--rewrite_deadline_per_flush_ms) +* [`additional_domains`](#-apache--mod--pagespeed--additional_domains) +* [`file_cache_size_kb`](#-apache--mod--pagespeed--file_cache_size_kb) +* [`file_cache_clean_interval_ms`](#-apache--mod--pagespeed--file_cache_clean_interval_ms) +* [`lru_cache_per_process`](#-apache--mod--pagespeed--lru_cache_per_process) +* [`lru_cache_byte_limit`](#-apache--mod--pagespeed--lru_cache_byte_limit) +* [`css_flatten_max_bytes`](#-apache--mod--pagespeed--css_flatten_max_bytes) +* [`css_inline_max_bytes`](#-apache--mod--pagespeed--css_inline_max_bytes) +* [`css_image_inline_max_bytes`](#-apache--mod--pagespeed--css_image_inline_max_bytes) +* [`image_inline_max_bytes`](#-apache--mod--pagespeed--image_inline_max_bytes) +* [`js_inline_max_bytes`](#-apache--mod--pagespeed--js_inline_max_bytes) +* [`css_outline_min_bytes`](#-apache--mod--pagespeed--css_outline_min_bytes) +* [`js_outline_min_bytes`](#-apache--mod--pagespeed--js_outline_min_bytes) +* [`inode_limit`](#-apache--mod--pagespeed--inode_limit) +* [`image_max_rewrites_at_once`](#-apache--mod--pagespeed--image_max_rewrites_at_once) +* [`num_rewrite_threads`](#-apache--mod--pagespeed--num_rewrite_threads) +* [`num_expensive_rewrite_threads`](#-apache--mod--pagespeed--num_expensive_rewrite_threads) +* [`collect_statistics`](#-apache--mod--pagespeed--collect_statistics) +* [`statistics_logging`](#-apache--mod--pagespeed--statistics_logging) +* [`allow_view_stats`](#-apache--mod--pagespeed--allow_view_stats) +* [`allow_pagespeed_console`](#-apache--mod--pagespeed--allow_pagespeed_console) +* [`allow_pagespeed_message`](#-apache--mod--pagespeed--allow_pagespeed_message) +* [`message_buffer_size`](#-apache--mod--pagespeed--message_buffer_size) +* [`additional_configuration`](#-apache--mod--pagespeed--additional_configuration) +* [`package_ensure`](#-apache--mod--pagespeed--package_ensure) + +##### `inherit_vhost_config` Data type: `String` @@ -4141,15 +4157,15 @@ Whether or not to inherit the vhost config Default value: `'on'` -##### `filter_xhtml` +##### `filter_xhtml` Data type: `Boolean` Whether to filter by xhtml -Default value: ``false`` +Default value: `false` -##### `cache_path` +##### `cache_path` Data type: `Stdlib::Absolutepath` @@ -4157,7 +4173,7 @@ Where to cache any files Default value: `'/var/cache/mod_pagespeed/'` -##### `log_dir` +##### `log_dir` Data type: `Stdlib::Absolutepath` @@ -4165,7 +4181,7 @@ The log directory Default value: `'/var/log/pagespeed'` -##### `memcache_servers` +##### `memcache_servers` Data type: `Array` @@ -4173,7 +4189,7 @@ Data type: `Array` Default value: `[]` -##### `rewrite_level` +##### `rewrite_level` Data type: `String` @@ -4182,7 +4198,7 @@ Can be `PassThrough`, `CoreFilters` or `OptimizeForBandwidth`. Default value: `'CoreFilters'` -##### `disable_filters` +##### `disable_filters` Data type: `Array` @@ -4190,7 +4206,7 @@ An array of filters that you wish to disable Default value: `[]` -##### `enable_filters` +##### `enable_filters` Data type: `Array` @@ -4198,7 +4214,7 @@ An array of filters that you wish to enable Default value: `[]` -##### `forbid_filters` +##### `forbid_filters` Data type: `Array` @@ -4206,7 +4222,7 @@ An array of filters that you wish to forbid Default value: `[]` -##### `rewrite_deadline_per_flush_ms` +##### `rewrite_deadline_per_flush_ms` Data type: `Integer` @@ -4214,15 +4230,15 @@ How long to wait after attempting to rewrite an uncache/expired resource. Default value: `10` -##### `additional_domains` +##### `additional_domains` Data type: `Optional[String]` Any additional domains that PageSpeed should optimize resources from. -Default value: ``undef`` +Default value: `undef` -##### `file_cache_size_kb` +##### `file_cache_size_kb` Data type: `Integer` @@ -4230,7 +4246,7 @@ The maximum size of the cache Default value: `102400` -##### `file_cache_clean_interval_ms` +##### `file_cache_clean_interval_ms` Data type: `Integer` @@ -4238,7 +4254,7 @@ The interval between which the cache is cleaned Default value: `3600000` -##### `lru_cache_per_process` +##### `lru_cache_per_process` Data type: `Integer` @@ -4246,7 +4262,7 @@ The amount of memory dedcated to each process Default value: `1024` -##### `lru_cache_byte_limit` +##### `lru_cache_byte_limit` Data type: `Integer` @@ -4254,7 +4270,7 @@ How large a cache entry the cache will accept Default value: `16384` -##### `css_flatten_max_bytes` +##### `css_flatten_max_bytes` Data type: `Integer` @@ -4262,7 +4278,7 @@ The maximum size in bytes of the flattened CSS Default value: `2048` -##### `css_inline_max_bytes` +##### `css_inline_max_bytes` Data type: `Integer` @@ -4270,7 +4286,7 @@ The maximum size in bytes of any image that will be inlined into CSS Default value: `2048` -##### `css_image_inline_max_bytes` +##### `css_image_inline_max_bytes` Data type: `Integer` @@ -4278,7 +4294,7 @@ The maximum size in bytes of any image that will be inlined into an HTML file Default value: `2048` -##### `image_inline_max_bytes` +##### `image_inline_max_bytes` Data type: `Integer` @@ -4286,7 +4302,7 @@ The maximum size in bytes of any inlined CSS file Default value: `2048` -##### `js_inline_max_bytes` +##### `js_inline_max_bytes` Data type: `Integer` @@ -4294,7 +4310,7 @@ The maximum size in bytes of any inlined JavaScript file Default value: `2048` -##### `css_outline_min_bytes` +##### `css_outline_min_bytes` Data type: `Integer` @@ -4302,7 +4318,7 @@ The minimum size in bytes for a CSS file to qualify as an outline Default value: `3000` -##### `js_outline_min_bytes` +##### `js_outline_min_bytes` Data type: `Integer` @@ -4310,7 +4326,7 @@ The minimum size in bytes for a JavaScript file to qualify as an outline Default value: `3000` -##### `inode_limit` +##### `inode_limit` Data type: `Integer` @@ -4318,7 +4334,7 @@ The file cache inode limit Default value: `500000` -##### `image_max_rewrites_at_once` +##### `image_max_rewrites_at_once` Data type: `Integer` @@ -4326,7 +4342,7 @@ The maximum number of images to optimize concurrently Default value: `8` -##### `num_rewrite_threads` +##### `num_rewrite_threads` Data type: `Integer` @@ -4335,7 +4351,7 @@ These threads are used for short, latency-sensitive work. Default value: `4` -##### `num_expensive_rewrite_threads` +##### `num_expensive_rewrite_threads` Data type: `Integer` @@ -4344,7 +4360,7 @@ These threads are used for full optimization. Default value: `4` -##### `collect_statistics` +##### `collect_statistics` Data type: `String` @@ -4352,7 +4368,7 @@ Whether to collect cross-process statistics Default value: `'on'` -##### `statistics_logging` +##### `statistics_logging` Data type: `String` @@ -4360,7 +4376,7 @@ Whether graphs should be drawn from collected statistics Default value: `'on'` -##### `allow_view_stats` +##### `allow_view_stats` Data type: `Array` @@ -4368,7 +4384,7 @@ What sources should be allowed to view the resultant graph Default value: `[]` -##### `allow_pagespeed_console` +##### `allow_pagespeed_console` Data type: `Array` @@ -4376,7 +4392,7 @@ What sources to draw the graphs from Default value: `[]` -##### `allow_pagespeed_message` +##### `allow_pagespeed_message` Data type: `Array` @@ -4384,7 +4400,7 @@ Data type: `Array` Default value: `[]` -##### `message_buffer_size` +##### `message_buffer_size` Data type: `Integer` @@ -4392,7 +4408,7 @@ The amount of bytes to allocate as a buffer to hold recent log messages Default value: `100000` -##### `additional_configuration` +##### `additional_configuration` Data type: `Variant[Array, Hash]` @@ -4400,15 +4416,15 @@ Any additional configuration no included as it's own option Default value: `{}` -##### `package_ensure` +##### `package_ensure` Data type: `Optional[String]` -Default value: ``undef`` +Default value: `undef` -### `apache::mod::passenger` +### `apache::mod::passenger` The current set of server configurations settings were taken directly from the Passenger Reference. To enable deprecation warnings and removal failure messages, set the passenger_installed_version to the version number installed on the server. @@ -4431,176 +4447,176 @@ There are also several undocumented settings. The following parameters are available in the `apache::mod::passenger` class: -* [`manage_repo`](#manage_repo) -* [`mod_id`](#mod_id) -* [`mod_lib`](#mod_lib) -* [`mod_lib_path`](#mod_lib_path) -* [`mod_package`](#mod_package) -* [`mod_package_ensure`](#mod_package_ensure) -* [`mod_path`](#mod_path) -* [`passenger_allow_encoded_slashes`](#passenger_allow_encoded_slashes) -* [`passenger_anonymous_telemetry_proxy`](#passenger_anonymous_telemetry_proxy) -* [`passenger_app_env`](#passenger_app_env) -* [`passenger_app_group_name`](#passenger_app_group_name) -* [`passenger_app_root`](#passenger_app_root) -* [`passenger_app_type`](#passenger_app_type) -* [`passenger_base_uri`](#passenger_base_uri) -* [`passenger_buffer_response`](#passenger_buffer_response) -* [`passenger_buffer_upload`](#passenger_buffer_upload) -* [`passenger_concurrency_model`](#passenger_concurrency_model) -* [`passenger_conf_file`](#passenger_conf_file) -* [`passenger_conf_package_file`](#passenger_conf_package_file) -* [`passenger_data_buffer_dir`](#passenger_data_buffer_dir) -* [`passenger_debug_log_file`](#passenger_debug_log_file) -* [`passenger_debugger`](#passenger_debugger) -* [`passenger_default_group`](#passenger_default_group) -* [`passenger_default_ruby`](#passenger_default_ruby) -* [`passenger_default_user`](#passenger_default_user) -* [`passenger_disable_anonymous_telemetry`](#passenger_disable_anonymous_telemetry) -* [`passenger_disable_log_prefix`](#passenger_disable_log_prefix) -* [`passenger_disable_security_update_check`](#passenger_disable_security_update_check) -* [`passenger_enabled`](#passenger_enabled) -* [`passenger_error_override`](#passenger_error_override) -* [`passenger_file_descriptor_log_file`](#passenger_file_descriptor_log_file) -* [`passenger_fly_with`](#passenger_fly_with) -* [`passenger_force_max_concurrent_requests_per_process`](#passenger_force_max_concurrent_requests_per_process) -* [`passenger_friendly_error_pages`](#passenger_friendly_error_pages) -* [`passenger_group`](#passenger_group) -* [`passenger_high_performance`](#passenger_high_performance) -* [`passenger_installed_version`](#passenger_installed_version) -* [`passenger_instance_registry_dir`](#passenger_instance_registry_dir) -* [`passenger_load_shell_envvars`](#passenger_load_shell_envvars) -* [`passenger_preload_bundler`](#passenger_preload_bundler) -* [`passenger_log_file`](#passenger_log_file) -* [`passenger_log_level`](#passenger_log_level) -* [`passenger_lve_min_uid`](#passenger_lve_min_uid) -* [`passenger_max_instances`](#passenger_max_instances) -* [`passenger_max_instances_per_app`](#passenger_max_instances_per_app) -* [`passenger_max_pool_size`](#passenger_max_pool_size) -* [`passenger_max_preloader_idle_time`](#passenger_max_preloader_idle_time) -* [`passenger_max_request_queue_size`](#passenger_max_request_queue_size) -* [`passenger_max_request_time`](#passenger_max_request_time) -* [`passenger_max_requests`](#passenger_max_requests) -* [`passenger_memory_limit`](#passenger_memory_limit) -* [`passenger_meteor_app_settings`](#passenger_meteor_app_settings) -* [`passenger_min_instances`](#passenger_min_instances) -* [`passenger_nodejs`](#passenger_nodejs) -* [`passenger_pool_idle_time`](#passenger_pool_idle_time) -* [`passenger_pre_start`](#passenger_pre_start) -* [`passenger_python`](#passenger_python) -* [`passenger_resist_deployment_errors`](#passenger_resist_deployment_errors) -* [`passenger_resolve_symlinks_in_document_root`](#passenger_resolve_symlinks_in_document_root) -* [`passenger_response_buffer_high_watermark`](#passenger_response_buffer_high_watermark) -* [`passenger_restart_dir`](#passenger_restart_dir) -* [`passenger_rolling_restarts`](#passenger_rolling_restarts) -* [`passenger_root`](#passenger_root) -* [`passenger_ruby`](#passenger_ruby) -* [`passenger_security_update_check_proxy`](#passenger_security_update_check_proxy) -* [`passenger_show_version_in_header`](#passenger_show_version_in_header) -* [`passenger_socket_backlog`](#passenger_socket_backlog) -* [`passenger_spawn_dir`](#passenger_spawn_dir) -* [`passenger_spawn_method`](#passenger_spawn_method) -* [`passenger_start_timeout`](#passenger_start_timeout) -* [`passenger_startup_file`](#passenger_startup_file) -* [`passenger_stat_throttle_rate`](#passenger_stat_throttle_rate) -* [`passenger_sticky_sessions`](#passenger_sticky_sessions) -* [`passenger_sticky_sessions_cookie_name`](#passenger_sticky_sessions_cookie_name) -* [`passenger_sticky_sessions_cookie_attributes`](#passenger_sticky_sessions_cookie_attributes) -* [`passenger_thread_count`](#passenger_thread_count) -* [`passenger_use_global_queue`](#passenger_use_global_queue) -* [`passenger_user`](#passenger_user) -* [`passenger_user_switching`](#passenger_user_switching) -* [`rack_auto_detect`](#rack_auto_detect) -* [`rack_autodetect`](#rack_autodetect) -* [`rack_base_uri`](#rack_base_uri) -* [`rack_env`](#rack_env) -* [`rails_allow_mod_rewrite`](#rails_allow_mod_rewrite) -* [`rails_app_spawner_idle_time`](#rails_app_spawner_idle_time) -* [`rails_auto_detect`](#rails_auto_detect) -* [`rails_autodetect`](#rails_autodetect) -* [`rails_base_uri`](#rails_base_uri) -* [`rails_default_user`](#rails_default_user) -* [`rails_env`](#rails_env) -* [`rails_framework_spawner_idle_time`](#rails_framework_spawner_idle_time) -* [`rails_ruby`](#rails_ruby) -* [`rails_spawn_method`](#rails_spawn_method) -* [`rails_user_switching`](#rails_user_switching) -* [`wsgi_auto_detect`](#wsgi_auto_detect) - -##### `manage_repo` +* [`manage_repo`](#-apache--mod--passenger--manage_repo) +* [`mod_id`](#-apache--mod--passenger--mod_id) +* [`mod_lib`](#-apache--mod--passenger--mod_lib) +* [`mod_lib_path`](#-apache--mod--passenger--mod_lib_path) +* [`mod_package`](#-apache--mod--passenger--mod_package) +* [`mod_package_ensure`](#-apache--mod--passenger--mod_package_ensure) +* [`mod_path`](#-apache--mod--passenger--mod_path) +* [`passenger_allow_encoded_slashes`](#-apache--mod--passenger--passenger_allow_encoded_slashes) +* [`passenger_anonymous_telemetry_proxy`](#-apache--mod--passenger--passenger_anonymous_telemetry_proxy) +* [`passenger_app_env`](#-apache--mod--passenger--passenger_app_env) +* [`passenger_app_group_name`](#-apache--mod--passenger--passenger_app_group_name) +* [`passenger_app_root`](#-apache--mod--passenger--passenger_app_root) +* [`passenger_app_type`](#-apache--mod--passenger--passenger_app_type) +* [`passenger_base_uri`](#-apache--mod--passenger--passenger_base_uri) +* [`passenger_buffer_response`](#-apache--mod--passenger--passenger_buffer_response) +* [`passenger_buffer_upload`](#-apache--mod--passenger--passenger_buffer_upload) +* [`passenger_concurrency_model`](#-apache--mod--passenger--passenger_concurrency_model) +* [`passenger_conf_file`](#-apache--mod--passenger--passenger_conf_file) +* [`passenger_conf_package_file`](#-apache--mod--passenger--passenger_conf_package_file) +* [`passenger_data_buffer_dir`](#-apache--mod--passenger--passenger_data_buffer_dir) +* [`passenger_debug_log_file`](#-apache--mod--passenger--passenger_debug_log_file) +* [`passenger_debugger`](#-apache--mod--passenger--passenger_debugger) +* [`passenger_default_group`](#-apache--mod--passenger--passenger_default_group) +* [`passenger_default_ruby`](#-apache--mod--passenger--passenger_default_ruby) +* [`passenger_default_user`](#-apache--mod--passenger--passenger_default_user) +* [`passenger_disable_anonymous_telemetry`](#-apache--mod--passenger--passenger_disable_anonymous_telemetry) +* [`passenger_disable_log_prefix`](#-apache--mod--passenger--passenger_disable_log_prefix) +* [`passenger_disable_security_update_check`](#-apache--mod--passenger--passenger_disable_security_update_check) +* [`passenger_enabled`](#-apache--mod--passenger--passenger_enabled) +* [`passenger_error_override`](#-apache--mod--passenger--passenger_error_override) +* [`passenger_file_descriptor_log_file`](#-apache--mod--passenger--passenger_file_descriptor_log_file) +* [`passenger_fly_with`](#-apache--mod--passenger--passenger_fly_with) +* [`passenger_force_max_concurrent_requests_per_process`](#-apache--mod--passenger--passenger_force_max_concurrent_requests_per_process) +* [`passenger_friendly_error_pages`](#-apache--mod--passenger--passenger_friendly_error_pages) +* [`passenger_group`](#-apache--mod--passenger--passenger_group) +* [`passenger_high_performance`](#-apache--mod--passenger--passenger_high_performance) +* [`passenger_installed_version`](#-apache--mod--passenger--passenger_installed_version) +* [`passenger_instance_registry_dir`](#-apache--mod--passenger--passenger_instance_registry_dir) +* [`passenger_load_shell_envvars`](#-apache--mod--passenger--passenger_load_shell_envvars) +* [`passenger_preload_bundler`](#-apache--mod--passenger--passenger_preload_bundler) +* [`passenger_log_file`](#-apache--mod--passenger--passenger_log_file) +* [`passenger_log_level`](#-apache--mod--passenger--passenger_log_level) +* [`passenger_lve_min_uid`](#-apache--mod--passenger--passenger_lve_min_uid) +* [`passenger_max_instances`](#-apache--mod--passenger--passenger_max_instances) +* [`passenger_max_instances_per_app`](#-apache--mod--passenger--passenger_max_instances_per_app) +* [`passenger_max_pool_size`](#-apache--mod--passenger--passenger_max_pool_size) +* [`passenger_max_preloader_idle_time`](#-apache--mod--passenger--passenger_max_preloader_idle_time) +* [`passenger_max_request_queue_size`](#-apache--mod--passenger--passenger_max_request_queue_size) +* [`passenger_max_request_time`](#-apache--mod--passenger--passenger_max_request_time) +* [`passenger_max_requests`](#-apache--mod--passenger--passenger_max_requests) +* [`passenger_memory_limit`](#-apache--mod--passenger--passenger_memory_limit) +* [`passenger_meteor_app_settings`](#-apache--mod--passenger--passenger_meteor_app_settings) +* [`passenger_min_instances`](#-apache--mod--passenger--passenger_min_instances) +* [`passenger_nodejs`](#-apache--mod--passenger--passenger_nodejs) +* [`passenger_pool_idle_time`](#-apache--mod--passenger--passenger_pool_idle_time) +* [`passenger_pre_start`](#-apache--mod--passenger--passenger_pre_start) +* [`passenger_python`](#-apache--mod--passenger--passenger_python) +* [`passenger_resist_deployment_errors`](#-apache--mod--passenger--passenger_resist_deployment_errors) +* [`passenger_resolve_symlinks_in_document_root`](#-apache--mod--passenger--passenger_resolve_symlinks_in_document_root) +* [`passenger_response_buffer_high_watermark`](#-apache--mod--passenger--passenger_response_buffer_high_watermark) +* [`passenger_restart_dir`](#-apache--mod--passenger--passenger_restart_dir) +* [`passenger_rolling_restarts`](#-apache--mod--passenger--passenger_rolling_restarts) +* [`passenger_root`](#-apache--mod--passenger--passenger_root) +* [`passenger_ruby`](#-apache--mod--passenger--passenger_ruby) +* [`passenger_security_update_check_proxy`](#-apache--mod--passenger--passenger_security_update_check_proxy) +* [`passenger_show_version_in_header`](#-apache--mod--passenger--passenger_show_version_in_header) +* [`passenger_socket_backlog`](#-apache--mod--passenger--passenger_socket_backlog) +* [`passenger_spawn_dir`](#-apache--mod--passenger--passenger_spawn_dir) +* [`passenger_spawn_method`](#-apache--mod--passenger--passenger_spawn_method) +* [`passenger_start_timeout`](#-apache--mod--passenger--passenger_start_timeout) +* [`passenger_startup_file`](#-apache--mod--passenger--passenger_startup_file) +* [`passenger_stat_throttle_rate`](#-apache--mod--passenger--passenger_stat_throttle_rate) +* [`passenger_sticky_sessions`](#-apache--mod--passenger--passenger_sticky_sessions) +* [`passenger_sticky_sessions_cookie_name`](#-apache--mod--passenger--passenger_sticky_sessions_cookie_name) +* [`passenger_sticky_sessions_cookie_attributes`](#-apache--mod--passenger--passenger_sticky_sessions_cookie_attributes) +* [`passenger_thread_count`](#-apache--mod--passenger--passenger_thread_count) +* [`passenger_use_global_queue`](#-apache--mod--passenger--passenger_use_global_queue) +* [`passenger_user`](#-apache--mod--passenger--passenger_user) +* [`passenger_user_switching`](#-apache--mod--passenger--passenger_user_switching) +* [`rack_auto_detect`](#-apache--mod--passenger--rack_auto_detect) +* [`rack_autodetect`](#-apache--mod--passenger--rack_autodetect) +* [`rack_base_uri`](#-apache--mod--passenger--rack_base_uri) +* [`rack_env`](#-apache--mod--passenger--rack_env) +* [`rails_allow_mod_rewrite`](#-apache--mod--passenger--rails_allow_mod_rewrite) +* [`rails_app_spawner_idle_time`](#-apache--mod--passenger--rails_app_spawner_idle_time) +* [`rails_auto_detect`](#-apache--mod--passenger--rails_auto_detect) +* [`rails_autodetect`](#-apache--mod--passenger--rails_autodetect) +* [`rails_base_uri`](#-apache--mod--passenger--rails_base_uri) +* [`rails_default_user`](#-apache--mod--passenger--rails_default_user) +* [`rails_env`](#-apache--mod--passenger--rails_env) +* [`rails_framework_spawner_idle_time`](#-apache--mod--passenger--rails_framework_spawner_idle_time) +* [`rails_ruby`](#-apache--mod--passenger--rails_ruby) +* [`rails_spawn_method`](#-apache--mod--passenger--rails_spawn_method) +* [`rails_user_switching`](#-apache--mod--passenger--rails_user_switching) +* [`wsgi_auto_detect`](#-apache--mod--passenger--wsgi_auto_detect) + +##### `manage_repo` Data type: `Boolean` Toggle whether to manage yum repo if on a RedHat node. -Default value: ``true`` +Default value: `true` -##### `mod_id` +##### `mod_id` Data type: `Optional[String]` Specifies the package id. -Default value: ``undef`` +Default value: `undef` -##### `mod_lib` +##### `mod_lib` Data type: `Optional[String]` Defines the module's shared object name. Do not configure manually without special reason. -Default value: ``undef`` +Default value: `undef` -##### `mod_lib_path` +##### `mod_lib_path` Data type: `Optional[String]` Specifies a path to the module's libraries. Do not manually set this parameter without special reason. The `path` parameter overrides this value. -Default value: ``undef`` +Default value: `undef` -##### `mod_package` +##### `mod_package` Data type: `Optional[String]` Name of the module package to install. -Default value: ``undef`` +Default value: `undef` -##### `mod_package_ensure` +##### `mod_package_ensure` Data type: `Optional[String]` Determines whether Puppet ensures the module should be installed. -Default value: ``undef`` +Default value: `undef` -##### `mod_path` +##### `mod_path` Data type: `Optional[String]` Specifies a path to the module. Do not manually set this parameter without a special reason. -Default value: ``undef`` +Default value: `undef` -##### `passenger_allow_encoded_slashes` +##### `passenger_allow_encoded_slashes` Data type: `Optional[Apache::OnOff]` Toggle whether URLs with encoded slashes (%2f) can be used (by default Apache does not support this). -Default value: ``undef`` +Default value: `undef` -##### `passenger_anonymous_telemetry_proxy` +##### `passenger_anonymous_telemetry_proxy` Data type: `Optional[String]` Set an intermediate proxy for the Passenger anonymous telemetry reporting. -Default value: ``undef`` +Default value: `undef` -##### `passenger_app_env` +##### `passenger_app_env` Data type: `Optional[String]` @@ -4611,66 +4627,66 @@ This option sets, for the current application, the value of the following enviro - NODE_ENV - PASSENGER_APP_ENV -Default value: ``undef`` +Default value: `undef` -##### `passenger_app_group_name` +##### `passenger_app_group_name` Data type: `Optional[String]` Sets the name of the application group that the current application should belong to. -Default value: ``undef`` +Default value: `undef` -##### `passenger_app_root` +##### `passenger_app_root` Data type: `Optional[String]` Path to the application root which allows access independent from the DocumentRoot. -Default value: ``undef`` +Default value: `undef` -##### `passenger_app_type` +##### `passenger_app_type` Data type: `Optional[String]` Specifies the type of the application. If you set this option, then you must also set PassengerAppRoot, otherwise Passenger will not properly recognize your application. -Default value: ``undef`` +Default value: `undef` -##### `passenger_base_uri` +##### `passenger_base_uri` Data type: `Optional[String]` Used to specify that the given URI is an distinct application that should be served by Passenger. -Default value: ``undef`` +Default value: `undef` -##### `passenger_buffer_response` +##### `passenger_buffer_response` Data type: `Optional[Apache::OnOff]` Toggle whether application-generated responses are buffered by Apache. Buffering will happen in memory. -Default value: ``undef`` +Default value: `undef` -##### `passenger_buffer_upload` +##### `passenger_buffer_upload` Data type: `Optional[Apache::OnOff]` Toggle whether HTTP client request bodies are buffered before they are sent to the application. -Default value: ``undef`` +Default value: `undef` -##### `passenger_concurrency_model` +##### `passenger_concurrency_model` Data type: `Optional[String]` Specifies the I/O concurrency model that should be used for Ruby application processes. -Default value: ``undef`` +Default value: `undef` -##### `passenger_conf_file` +##### `passenger_conf_file` Data type: `String` @@ -4678,7 +4694,7 @@ Data type: `String` Default value: `$apache::params::passenger_conf_file` -##### `passenger_conf_package_file` +##### `passenger_conf_package_file` Data type: `Optional[String]` @@ -4686,39 +4702,39 @@ Data type: `Optional[String]` Default value: `$apache::params::passenger_conf_package_file` -##### `passenger_data_buffer_dir` +##### `passenger_data_buffer_dir` Data type: `Optional[Stdlib::Absolutepath]` Specifies the directory in which to store data buffers. -Default value: ``undef`` +Default value: `undef` -##### `passenger_debug_log_file` +##### `passenger_debug_log_file` Data type: `Optional[String]` -Default value: ``undef`` +Default value: `undef` -##### `passenger_debugger` +##### `passenger_debugger` Data type: `Optional[Apache::OnOff]` Turns support for Ruby application debugging on or off. -Default value: ``undef`` +Default value: `undef` -##### `passenger_default_group` +##### `passenger_default_group` Data type: `Optional[String]` Allows you to specify the group that applications must run as, if user switching fails or is disabled. -Default value: ``undef`` +Default value: `undef` -##### `passenger_default_ruby` +##### `passenger_default_ruby` Data type: `Optional[String]` @@ -4726,318 +4742,318 @@ File path to desired ruby interpreter to use by default. Default value: `$apache::params::passenger_default_ruby` -##### `passenger_default_user` +##### `passenger_default_user` Data type: `Optional[String]` Allows you to specify the user that applications must run as, if user switching fails or is disabled. -Default value: ``undef`` +Default value: `undef` -##### `passenger_disable_anonymous_telemetry` +##### `passenger_disable_anonymous_telemetry` Data type: `Optional[Boolean]` Whether or not to disable the Passenger anonymous telemetry reporting. -Default value: ``undef`` +Default value: `undef` -##### `passenger_disable_log_prefix` +##### `passenger_disable_log_prefix` Data type: `Optional[Boolean]` Whether to stop Passenger from prefixing logs when they are written to a log file. -Default value: ``undef`` +Default value: `undef` -##### `passenger_disable_security_update_check` +##### `passenger_disable_security_update_check` Data type: `Optional[Apache::OnOff]` Allows disabling the Passenger security update check, a daily check with https://securitycheck.phusionpassenger.com for important security updates that might be available. -Default value: ``undef`` +Default value: `undef` -##### `passenger_enabled` +##### `passenger_enabled` Data type: `Optional[Apache::OnOff]` Toggles whether Passenger should be enabled for that particular context. -Default value: ``undef`` +Default value: `undef` -##### `passenger_error_override` +##### `passenger_error_override` Data type: `Optional[Apache::OnOff]` Toggles whether Apache will intercept and handle responses with HTTP status codes of 400 and higher. -Default value: ``undef`` +Default value: `undef` -##### `passenger_file_descriptor_log_file` +##### `passenger_file_descriptor_log_file` Data type: `Optional[String]` Log file descriptor debug tracing messages to the given file. -Default value: ``undef`` +Default value: `undef` -##### `passenger_fly_with` +##### `passenger_fly_with` Data type: `Optional[String]` Enables the Flying Passenger mode, and configures Apache to connect to the Flying Passenger daemon that's listening on the given socket filename. -Default value: ``undef`` +Default value: `undef` -##### `passenger_force_max_concurrent_requests_per_process` +##### `passenger_force_max_concurrent_requests_per_process` Data type: `Optional[Variant[Integer, String]]` Use this option to tell Passenger how many concurrent requests the application can handle per process. -Default value: ``undef`` +Default value: `undef` -##### `passenger_friendly_error_pages` +##### `passenger_friendly_error_pages` Data type: `Optional[Apache::OnOff]` Toggles whether Passenger should display friendly error pages whenever an application fails to start. -Default value: ``undef`` +Default value: `undef` -##### `passenger_group` +##### `passenger_group` Data type: `Optional[String]` Allows you to override that behavior and explicitly set a group to run the web application as, regardless of the ownership of the startup file. -Default value: ``undef`` +Default value: `undef` -##### `passenger_high_performance` +##### `passenger_high_performance` Data type: `Optional[Apache::OnOff]` Toggles whether to enable PassengerHighPerformance which will make Passenger will be a little faster, in return for reduced compatibility with other Apache modules. -Default value: ``undef`` +Default value: `undef` -##### `passenger_installed_version` +##### `passenger_installed_version` Data type: `Optional[String]` -Default value: ``undef`` +Default value: `undef` -##### `passenger_instance_registry_dir` +##### `passenger_instance_registry_dir` Data type: `Optional[String]` Specifies the directory that Passenger should use for registering its current instance. -Default value: ``undef`` +Default value: `undef` -##### `passenger_load_shell_envvars` +##### `passenger_load_shell_envvars` Data type: `Optional[Apache::OnOff]` Enables or disables the loading of shell environment variables before spawning the application. -Default value: ``undef`` +Default value: `undef` -##### `passenger_preload_bundler` +##### `passenger_preload_bundler` Data type: `Optional[Boolean]` Enables or disables loading bundler before loading your Ruby app. -Default value: ``undef`` +Default value: `undef` -##### `passenger_log_file` +##### `passenger_log_file` Data type: `Optional[Stdlib::Absolutepath]` File path to log file. By default Passenger log messages are written to the Apache global error log. -Default value: ``undef`` +Default value: `undef` -##### `passenger_log_level` +##### `passenger_log_level` Data type: `Optional[Integer]` Specifies how much information Passenger should log to its log file. A higher log level value means that more information will be logged. -Default value: ``undef`` +Default value: `undef` -##### `passenger_lve_min_uid` +##### `passenger_lve_min_uid` Data type: `Optional[Integer]` When using Passenger on a LVE-enabled kernel, a security check (enter) is run for spawning application processes. This options tells the check to only allow processes with UIDs equal to, or higher than, the specified value. -Default value: ``undef`` +Default value: `undef` -##### `passenger_max_instances` +##### `passenger_max_instances` Data type: `Optional[Integer]` The maximum number of application processes that may simultaneously exist for an application. -Default value: ``undef`` +Default value: `undef` -##### `passenger_max_instances_per_app` +##### `passenger_max_instances_per_app` Data type: `Optional[Integer]` The maximum number of application processes that may simultaneously exist for a single application. -Default value: ``undef`` +Default value: `undef` -##### `passenger_max_pool_size` +##### `passenger_max_pool_size` Data type: `Optional[Integer]` The maximum number of application processes that may simultaneously exist. -Default value: ``undef`` +Default value: `undef` -##### `passenger_max_preloader_idle_time` +##### `passenger_max_preloader_idle_time` Data type: `Optional[Integer]` Set the preloader's idle timeout, in seconds. A value of 0 means that it should never idle timeout. -Default value: ``undef`` +Default value: `undef` -##### `passenger_max_request_queue_size` +##### `passenger_max_request_queue_size` Data type: `Optional[Integer]` Specifies the maximum size for the queue of all incoming requests. -Default value: ``undef`` +Default value: `undef` -##### `passenger_max_request_time` +##### `passenger_max_request_time` Data type: `Optional[Integer]` The maximum amount of time, in seconds, that an application process may take to process a request. -Default value: ``undef`` +Default value: `undef` -##### `passenger_max_requests` +##### `passenger_max_requests` Data type: `Optional[Integer]` The maximum number of requests an application process will process. -Default value: ``undef`` +Default value: `undef` -##### `passenger_memory_limit` +##### `passenger_memory_limit` Data type: `Optional[Integer]` The maximum amount of memory that an application process may use, in megabytes. -Default value: ``undef`` +Default value: `undef` -##### `passenger_meteor_app_settings` +##### `passenger_meteor_app_settings` Data type: `Optional[String]` When using a Meteor application in non-bundled mode, use this option to specify a JSON file with settings for the application. -Default value: ``undef`` +Default value: `undef` -##### `passenger_min_instances` +##### `passenger_min_instances` Data type: `Optional[Integer]` Specifies the minimum number of application processes that should exist for a given application. -Default value: ``undef`` +Default value: `undef` -##### `passenger_nodejs` +##### `passenger_nodejs` Data type: `Optional[String]` Specifies the Node.js command to use for serving Node.js web applications. -Default value: ``undef`` +Default value: `undef` -##### `passenger_pool_idle_time` +##### `passenger_pool_idle_time` Data type: `Optional[Integer]` The maximum number of seconds that an application process may be idle. -Default value: ``undef`` +Default value: `undef` -##### `passenger_pre_start` +##### `passenger_pre_start` Data type: `Optional[Variant[String, Array[String]]]` URL of the web application you want to pre-start. -Default value: ``undef`` +Default value: `undef` -##### `passenger_python` +##### `passenger_python` Data type: `Optional[String]` Specifies the Python interpreter to use for serving Python web applications. -Default value: ``undef`` +Default value: `undef` -##### `passenger_resist_deployment_errors` +##### `passenger_resist_deployment_errors` Data type: `Optional[Apache::OnOff]` Enables or disables resistance against deployment errors. -Default value: ``undef`` +Default value: `undef` -##### `passenger_resolve_symlinks_in_document_root` +##### `passenger_resolve_symlinks_in_document_root` Data type: `Optional[Apache::OnOff]` This option is no longer available in version 5.2.0. Switch to PassengerAppRoot if you are setting the application root via a document root containing symlinks. -Default value: ``undef`` +Default value: `undef` -##### `passenger_response_buffer_high_watermark` +##### `passenger_response_buffer_high_watermark` Data type: `Optional[Variant[Integer, String]]` Configures the maximum size of the real-time disk-backed response buffering system. -Default value: ``undef`` +Default value: `undef` -##### `passenger_restart_dir` +##### `passenger_restart_dir` Data type: `Optional[String]` Path to directory containing restart.txt file. Can be either absolute or relative. -Default value: ``undef`` +Default value: `undef` -##### `passenger_rolling_restarts` +##### `passenger_rolling_restarts` Data type: `Optional[Apache::OnOff]` Enables or disables support for zero-downtime application restarts through restart.txt. -Default value: ``undef`` +Default value: `undef` -##### `passenger_root` +##### `passenger_root` Data type: `Optional[String]` @@ -5045,7 +5061,7 @@ Refers to the location to the Passenger root directory, or to a location configu Default value: `$apache::params::passenger_root` -##### `passenger_ruby` +##### `passenger_ruby` Data type: `Optional[String]` @@ -5053,257 +5069,257 @@ Specifies the Ruby interpreter to use for serving Ruby web applications. Default value: `$apache::params::passenger_ruby` -##### `passenger_security_update_check_proxy` +##### `passenger_security_update_check_proxy` Data type: `Optional[String]` Allows use of an intermediate proxy for the Passenger security update check. -Default value: ``undef`` +Default value: `undef` -##### `passenger_show_version_in_header` +##### `passenger_show_version_in_header` Data type: `Optional[Apache::OnOff]` Toggle whether Passenger will output its version number in the X-Powered-By header in all Passenger-served requests: -Default value: ``undef`` +Default value: `undef` -##### `passenger_socket_backlog` +##### `passenger_socket_backlog` Data type: `Optional[Variant[Integer, String]]` This option can be raised if Apache manages to overflow the backlog queue. -Default value: ``undef`` +Default value: `undef` -##### `passenger_spawn_dir` +##### `passenger_spawn_dir` Data type: `Optional[String]` The directory in which Passenger will record progress during startup -Default value: ``undef`` +Default value: `undef` -##### `passenger_spawn_method` +##### `passenger_spawn_method` Data type: `Optional[Enum['smart', 'direct', 'smart-lv2', 'conservative']]` Controls whether Passenger spawns applications directly, or using a prefork copy-on-write mechanism. -Default value: ``undef`` +Default value: `undef` -##### `passenger_start_timeout` +##### `passenger_start_timeout` Data type: `Optional[Integer]` Specifies a timeout for the startup of application processes. -Default value: ``undef`` +Default value: `undef` -##### `passenger_startup_file` +##### `passenger_startup_file` Data type: `Optional[String]` Specifies the startup file that Passenger should use when loading the application. -Default value: ``undef`` +Default value: `undef` -##### `passenger_stat_throttle_rate` +##### `passenger_stat_throttle_rate` Data type: `Optional[Integer]` Setting this option to a value of x means that certain filesystem checks will be performed at most once every x seconds. -Default value: ``undef`` +Default value: `undef` -##### `passenger_sticky_sessions` +##### `passenger_sticky_sessions` Data type: `Optional[Apache::OnOff]` Toggles whether all requests that a client sends will be routed to the same originating application process, whenever possible. -Default value: ``undef`` +Default value: `undef` -##### `passenger_sticky_sessions_cookie_name` +##### `passenger_sticky_sessions_cookie_name` Data type: `Optional[String]` Sets the name of the sticky sessions cookie. -Default value: ``undef`` +Default value: `undef` -##### `passenger_sticky_sessions_cookie_attributes` +##### `passenger_sticky_sessions_cookie_attributes` Data type: `Optional[String]` Sets the attributes of the sticky sessions cookie. -Default value: ``undef`` +Default value: `undef` -##### `passenger_thread_count` +##### `passenger_thread_count` Data type: `Optional[Integer]` Specifies the number of threads that Passenger should spawn per Ruby application process. -Default value: ``undef`` +Default value: `undef` -##### `passenger_use_global_queue` +##### `passenger_use_global_queue` Data type: `Optional[String]` N/A. -Default value: ``undef`` +Default value: `undef` -##### `passenger_user` +##### `passenger_user` Data type: `Optional[String]` Allows you to override that behavior and explicitly set a user to run the web application as, regardless of the ownership of the startup file. -Default value: ``undef`` +Default value: `undef` -##### `passenger_user_switching` +##### `passenger_user_switching` Data type: `Optional[Apache::OnOff]` Toggles whether to attempt to enable user account sandboxing, also known as user switching. -Default value: ``undef`` +Default value: `undef` -##### `rack_auto_detect` +##### `rack_auto_detect` Data type: `Optional[String]` This option has been removed in version 4.0.0 as part of an optimization. You should use PassengerEnabled instead. -Default value: ``undef`` +Default value: `undef` -##### `rack_autodetect` +##### `rack_autodetect` Data type: `Optional[String]` This option has been removed in version 4.0.0 as part of an optimization. You should use PassengerEnabled instead. -Default value: ``undef`` +Default value: `undef` -##### `rack_base_uri` +##### `rack_base_uri` Data type: `Optional[String]` Deprecated in 3.0.0 in favor of PassengerBaseURI. -Default value: ``undef`` +Default value: `undef` -##### `rack_env` +##### `rack_env` Data type: `Optional[String]` Alias for PassengerAppEnv. -Default value: ``undef`` +Default value: `undef` -##### `rails_allow_mod_rewrite` +##### `rails_allow_mod_rewrite` Data type: `Optional[String]` This option doesn't do anything anymore since version 4.0.0. -Default value: ``undef`` +Default value: `undef` -##### `rails_app_spawner_idle_time` +##### `rails_app_spawner_idle_time` Data type: `Optional[String]` This option has been removed in version 4.0.0, and replaced with PassengerMaxPreloaderIdleTime. -Default value: ``undef`` +Default value: `undef` -##### `rails_auto_detect` +##### `rails_auto_detect` Data type: `Optional[String]` This option has been removed in version 4.0.0 as part of an optimization. You should use PassengerEnabled instead. -Default value: ``undef`` +Default value: `undef` -##### `rails_autodetect` +##### `rails_autodetect` Data type: `Optional[String]` This option has been removed in version 4.0.0 as part of an optimization. You should use PassengerEnabled instead. -Default value: ``undef`` +Default value: `undef` -##### `rails_base_uri` +##### `rails_base_uri` Data type: `Optional[String]` Deprecated in 3.0.0 in favor of PassengerBaseURI. -Default value: ``undef`` +Default value: `undef` -##### `rails_default_user` +##### `rails_default_user` Data type: `Optional[String]` Deprecated in 3.0.0 in favor of PassengerDefaultUser -Default value: ``undef`` +Default value: `undef` -##### `rails_env` +##### `rails_env` Data type: `Optional[String]` Alias for PassengerAppEnv. -Default value: ``undef`` +Default value: `undef` -##### `rails_framework_spawner_idle_time` +##### `rails_framework_spawner_idle_time` Data type: `Optional[String]` This option is no longer available in version 4.0.0. There is no alternative because framework spawning has been removed altogether. You should use smart spawning instead. -Default value: ``undef`` +Default value: `undef` -##### `rails_ruby` +##### `rails_ruby` Data type: `Optional[String]` Deprecated in 3.0.0 in favor of PassengerRuby. -Default value: ``undef`` +Default value: `undef` -##### `rails_spawn_method` +##### `rails_spawn_method` Data type: `Optional[String]` Deprecated in 3.0.0 in favor of PassengerSpawnMethod. -Default value: ``undef`` +Default value: `undef` -##### `rails_user_switching` +##### `rails_user_switching` Data type: `Optional[String]` Deprecated in 3.0.0 in favor of PassengerUserSwitching. -Default value: ``undef`` +Default value: `undef` -##### `wsgi_auto_detect` +##### `wsgi_auto_detect` Data type: `Optional[String]` This option has been removed in version 4.0.0 as part of an optimization. You should use PassengerEnabled instead. -Default value: ``undef`` +Default value: `undef` -### `apache::mod::perl` +### `apache::mod::perl` Installs `mod_perl`. @@ -5311,7 +5327,7 @@ Installs `mod_perl`. * https://perl.apache.org * for additional documentation. -### `apache::mod::peruser` +### `apache::mod::peruser` Installs `mod_peruser`. @@ -5319,16 +5335,16 @@ Installs `mod_peruser`. The following parameters are available in the `apache::mod::peruser` class: -* [`minspareprocessors`](#minspareprocessors) -* [`minprocessors`](#minprocessors) -* [`maxprocessors`](#maxprocessors) -* [`maxclients`](#maxclients) -* [`maxrequestsperchild`](#maxrequestsperchild) -* [`idletimeout`](#idletimeout) -* [`expiretimeout`](#expiretimeout) -* [`keepalive`](#keepalive) +* [`minspareprocessors`](#-apache--mod--peruser--minspareprocessors) +* [`minprocessors`](#-apache--mod--peruser--minprocessors) +* [`maxprocessors`](#-apache--mod--peruser--maxprocessors) +* [`maxclients`](#-apache--mod--peruser--maxclients) +* [`maxrequestsperchild`](#-apache--mod--peruser--maxrequestsperchild) +* [`idletimeout`](#-apache--mod--peruser--idletimeout) +* [`expiretimeout`](#-apache--mod--peruser--expiretimeout) +* [`keepalive`](#-apache--mod--peruser--keepalive) -##### `minspareprocessors` +##### `minspareprocessors` Data type: `Integer` @@ -5336,7 +5352,7 @@ Data type: `Integer` Default value: `2` -##### `minprocessors` +##### `minprocessors` Data type: `Integer` @@ -5344,7 +5360,7 @@ The minimum amount of processors Default value: `2` -##### `maxprocessors` +##### `maxprocessors` Data type: `Integer` @@ -5352,7 +5368,7 @@ The maximum amount of processors Default value: `10` -##### `maxclients` +##### `maxclients` Data type: `Integer` @@ -5360,7 +5376,7 @@ The maximum amount of clients Default value: `150` -##### `maxrequestsperchild` +##### `maxrequestsperchild` Data type: `Integer` @@ -5368,7 +5384,7 @@ The maximum amount of requests per child Default value: `1000` -##### `idletimeout` +##### `idletimeout` Data type: `Integer` @@ -5376,7 +5392,7 @@ Data type: `Integer` Default value: `120` -##### `expiretimeout` +##### `expiretimeout` Data type: `Integer` @@ -5384,7 +5400,7 @@ Data type: `Integer` Default value: `120` -##### `keepalive` +##### `keepalive` Data type: `Apache::OnOff` @@ -5392,7 +5408,7 @@ Data type: `Apache::OnOff` Default value: `'Off'` -### `apache::mod::php` +### `apache::mod::php` Installs `mod_php`. @@ -5402,26 +5418,26 @@ Installs `mod_php`. The following parameters are available in the `apache::mod::php` class: -* [`package_name`](#package_name) -* [`package_ensure`](#package_ensure) -* [`path`](#path) -* [`extensions`](#extensions) -* [`content`](#content) -* [`template`](#template) -* [`source`](#source) -* [`root_group`](#root_group) -* [`php_version`](#php_version) -* [`libphp_prefix`](#libphp_prefix) +* [`package_name`](#-apache--mod--php--package_name) +* [`package_ensure`](#-apache--mod--php--package_ensure) +* [`path`](#-apache--mod--php--path) +* [`extensions`](#-apache--mod--php--extensions) +* [`content`](#-apache--mod--php--content) +* [`template`](#-apache--mod--php--template) +* [`source`](#-apache--mod--php--source) +* [`root_group`](#-apache--mod--php--root_group) +* [`php_version`](#-apache--mod--php--php_version) +* [`libphp_prefix`](#-apache--mod--php--libphp_prefix) -##### `package_name` +##### `package_name` Data type: `Optional[String]` The package name -Default value: ``undef`` +Default value: `undef` -##### `package_ensure` +##### `package_ensure` Data type: `String` @@ -5429,15 +5445,15 @@ Whether the package is `present` or `absent` Default value: `'present'` -##### `path` +##### `path` Data type: `Optional[String]` -Default value: ``undef`` +Default value: `undef` -##### `extensions` +##### `extensions` Data type: `Array` @@ -5445,15 +5461,15 @@ Data type: `Array` Default value: `['.php']` -##### `content` +##### `content` Data type: `Optional[String]` -Default value: ``undef`` +Default value: `undef` -##### `template` +##### `template` Data type: `String` @@ -5461,15 +5477,15 @@ Data type: `String` Default value: `'apache/mod/php.conf.erb'` -##### `source` +##### `source` Data type: `Optional[String]` -Default value: ``undef`` +Default value: `undef` -##### `root_group` +##### `root_group` Data type: `Optional[String]` @@ -5477,7 +5493,7 @@ UNIX group of the root user Default value: `$apache::params::root_group` -##### `php_version` +##### `php_version` Data type: `Optional[String]` @@ -5485,7 +5501,7 @@ The php version. This is a required parameter, but optional allows showing a cle Default value: `$apache::params::php_version` -##### `libphp_prefix` +##### `libphp_prefix` Data type: `String` @@ -5493,7 +5509,7 @@ Data type: `String` Default value: `'libphp'` -### `apache::mod::prefork` +### `apache::mod::prefork` Installs and configures MPM `prefork`. @@ -5505,17 +5521,17 @@ Installs and configures MPM `prefork`. The following parameters are available in the `apache::mod::prefork` class: -* [`startservers`](#startservers) -* [`minspareservers`](#minspareservers) -* [`maxspareservers`](#maxspareservers) -* [`serverlimit`](#serverlimit) -* [`maxclients`](#maxclients) -* [`maxrequestworkers`](#maxrequestworkers) -* [`maxrequestsperchild`](#maxrequestsperchild) -* [`maxconnectionsperchild`](#maxconnectionsperchild) -* [`listenbacklog`](#listenbacklog) +* [`startservers`](#-apache--mod--prefork--startservers) +* [`minspareservers`](#-apache--mod--prefork--minspareservers) +* [`maxspareservers`](#-apache--mod--prefork--maxspareservers) +* [`serverlimit`](#-apache--mod--prefork--serverlimit) +* [`maxclients`](#-apache--mod--prefork--maxclients) +* [`maxrequestworkers`](#-apache--mod--prefork--maxrequestworkers) +* [`maxrequestsperchild`](#-apache--mod--prefork--maxrequestsperchild) +* [`maxconnectionsperchild`](#-apache--mod--prefork--maxconnectionsperchild) +* [`listenbacklog`](#-apache--mod--prefork--listenbacklog) -##### `startservers` +##### `startservers` Data type: `Integer` @@ -5523,7 +5539,7 @@ Number of child server processes created at startup. Default value: `8` -##### `minspareservers` +##### `minspareservers` Data type: `Integer` @@ -5531,7 +5547,7 @@ Minimum number of idle child server processes. Default value: `5` -##### `maxspareservers` +##### `maxspareservers` Data type: `Integer` @@ -5539,7 +5555,7 @@ Maximum number of idle child server processes. Default value: `20` -##### `serverlimit` +##### `serverlimit` Data type: `Integer` @@ -5547,7 +5563,7 @@ Upper limit on configurable number of processes. Default value: `256` -##### `maxclients` +##### `maxclients` Data type: `Integer` @@ -5555,15 +5571,15 @@ Old alias for MaxRequestWorkers. Default value: `256` -##### `maxrequestworkers` +##### `maxrequestworkers` Data type: `Optional[Integer]` Maximum number of connections that will be processed simultaneously. -Default value: ``undef`` +Default value: `undef` -##### `maxrequestsperchild` +##### `maxrequestsperchild` Data type: `Integer` @@ -5571,15 +5587,15 @@ Old alias for MaxConnectionsPerChild. Default value: `4000` -##### `maxconnectionsperchild` +##### `maxconnectionsperchild` Data type: `Optional[Integer]` Limit on the number of connections that an individual child server will handle during its life. -Default value: ``undef`` +Default value: `undef` -##### `listenbacklog` +##### `listenbacklog` Data type: `Integer` @@ -5587,7 +5603,7 @@ Maximum length of the queue of pending connections. Default value: `511` -### `apache::mod::proxy` +### `apache::mod::proxy` Installs and configures `mod_proxy`. @@ -5599,14 +5615,14 @@ Installs and configures `mod_proxy`. The following parameters are available in the `apache::mod::proxy` class: -* [`proxy_requests`](#proxy_requests) -* [`allow_from`](#allow_from) -* [`package_name`](#package_name) -* [`proxy_via`](#proxy_via) -* [`proxy_timeout`](#proxy_timeout) -* [`proxy_iobuffersize`](#proxy_iobuffersize) +* [`proxy_requests`](#-apache--mod--proxy--proxy_requests) +* [`allow_from`](#-apache--mod--proxy--allow_from) +* [`package_name`](#-apache--mod--proxy--package_name) +* [`proxy_via`](#-apache--mod--proxy--proxy_via) +* [`proxy_timeout`](#-apache--mod--proxy--proxy_timeout) +* [`proxy_iobuffersize`](#-apache--mod--proxy--proxy_iobuffersize) -##### `proxy_requests` +##### `proxy_requests` Data type: `String` @@ -5614,23 +5630,23 @@ Enables forward (standard) proxy requests. Default value: `'Off'` -##### `allow_from` +##### `allow_from` Data type: `Optional[Variant[Stdlib::IP::Address, Array[Stdlib::IP::Address]]]` IP address or list of IPs allowed to access proxy. -Default value: ``undef`` +Default value: `undef` -##### `package_name` +##### `package_name` Data type: `Optional[String]` Name of the proxy package to install. -Default value: ``undef`` +Default value: `undef` -##### `proxy_via` +##### `proxy_via` Data type: `String` @@ -5638,23 +5654,23 @@ Set local IP address for outgoing proxy connections. Default value: `'On'` -##### `proxy_timeout` +##### `proxy_timeout` Data type: `Optional[Integer[0]]` Network timeout for proxied requests. -Default value: ``undef`` +Default value: `undef` -##### `proxy_iobuffersize` +##### `proxy_iobuffersize` Data type: `Optional[String]` Set the size of internal data throughput buffer -Default value: ``undef`` +Default value: `undef` -### `apache::mod::proxy_ajp` +### `apache::mod::proxy_ajp` Installs `mod_proxy_ajp`. @@ -5662,7 +5678,7 @@ Installs `mod_proxy_ajp`. * https://httpd.apache.org/docs/current/mod/mod_proxy_ajp.html * for additional documentation. -### `apache::mod::proxy_balancer` +### `apache::mod::proxy_balancer` Installs and configures `mod_proxy_balancer`. @@ -5674,19 +5690,19 @@ Installs and configures `mod_proxy_balancer`. The following parameters are available in the `apache::mod::proxy_balancer` class: -* [`manager`](#manager) -* [`manager_path`](#manager_path) -* [`allow_from`](#allow_from) +* [`manager`](#-apache--mod--proxy_balancer--manager) +* [`manager_path`](#-apache--mod--proxy_balancer--manager_path) +* [`allow_from`](#-apache--mod--proxy_balancer--allow_from) -##### `manager` +##### `manager` Data type: `Boolean` Toggle whether to enable balancer manager support. -Default value: ``false`` +Default value: `false` -##### `manager_path` +##### `manager_path` Data type: `Stdlib::Unixpath` @@ -5694,7 +5710,7 @@ Server relative path to balancer manager. Default value: `'/balancer-manager'` -##### `allow_from` +##### `allow_from` Data type: `Array[Stdlib::IP::Address]` @@ -5702,7 +5718,7 @@ List of IPs from which the balancer manager can be accessed. Default value: `['127.0.0.1', '::1']` -### `apache::mod::proxy_connect` +### `apache::mod::proxy_connect` Installs `mod_proxy_connect`. @@ -5710,7 +5726,7 @@ Installs `mod_proxy_connect`. * https://httpd.apache.org/docs/current/mod/mod_proxy_connect.html * for additional documentation. -### `apache::mod::proxy_fcgi` +### `apache::mod::proxy_fcgi` Installs `mod_proxy_fcgi`. @@ -5718,7 +5734,7 @@ Installs `mod_proxy_fcgi`. * https://httpd.apache.org/docs/current/mod/mod_proxy_fcgi.html * for additional documentation. -### `apache::mod::proxy_html` +### `apache::mod::proxy_html` Installs `mod_proxy_html`. @@ -5726,7 +5742,7 @@ Installs `mod_proxy_html`. * https://httpd.apache.org/docs/current/mod/mod_proxy_html.html * for additional documentation. -### `apache::mod::proxy_http` +### `apache::mod::proxy_http` Installs `mod_proxy_http`. @@ -5734,7 +5750,7 @@ Installs `mod_proxy_http`. * https://httpd.apache.org/docs/current/mod/mod_proxy_http.html * for additional documentation. -### `apache::mod::proxy_http2` +### `apache::mod::proxy_http2` Installs `mod_proxy_http2`. @@ -5742,7 +5758,7 @@ Installs `mod_proxy_http2`. * https://httpd.apache.org/docs/current/mod/mod_proxy_http2.html * for additional documentation. -### `apache::mod::proxy_wstunnel` +### `apache::mod::proxy_wstunnel` Installs `mod_proxy_wstunnel`. @@ -5750,7 +5766,7 @@ Installs `mod_proxy_wstunnel`. * https://httpd.apache.org/docs/current/mod/mod_proxy_wstunnel.html * for additional documentation. -### `apache::mod::python` +### `apache::mod::python` Installs and configures `mod_python`. @@ -5762,17 +5778,17 @@ Installs and configures `mod_python`. The following parameters are available in the `apache::mod::python` class: -* [`loadfile_name`](#loadfile_name) +* [`loadfile_name`](#-apache--mod--python--loadfile_name) -##### `loadfile_name` +##### `loadfile_name` Data type: `Optional[String]` Sets the name of the configuration file that is used to load the python module. -Default value: ``undef`` +Default value: `undef` -### `apache::mod::remoteip` +### `apache::mod::remoteip` Installs and configures `mod_remoteip`. @@ -5785,18 +5801,18 @@ Installs and configures `mod_remoteip`. The following parameters are available in the `apache::mod::remoteip` class: -* [`header`](#header) -* [`internal_proxy`](#internal_proxy) -* [`proxy_ips`](#proxy_ips) -* [`internal_proxy_list`](#internal_proxy_list) -* [`proxies_header`](#proxies_header) -* [`proxy_protocol`](#proxy_protocol) -* [`proxy_protocol_exceptions`](#proxy_protocol_exceptions) -* [`trusted_proxy`](#trusted_proxy) -* [`trusted_proxy_ips`](#trusted_proxy_ips) -* [`trusted_proxy_list`](#trusted_proxy_list) +* [`header`](#-apache--mod--remoteip--header) +* [`internal_proxy`](#-apache--mod--remoteip--internal_proxy) +* [`proxy_ips`](#-apache--mod--remoteip--proxy_ips) +* [`internal_proxy_list`](#-apache--mod--remoteip--internal_proxy_list) +* [`proxies_header`](#-apache--mod--remoteip--proxies_header) +* [`proxy_protocol`](#-apache--mod--remoteip--proxy_protocol) +* [`proxy_protocol_exceptions`](#-apache--mod--remoteip--proxy_protocol_exceptions) +* [`trusted_proxy`](#-apache--mod--remoteip--trusted_proxy) +* [`trusted_proxy_ips`](#-apache--mod--remoteip--trusted_proxy_ips) +* [`trusted_proxy_list`](#-apache--mod--remoteip--trusted_proxy_list) -##### `header` +##### `header` Data type: `String` @@ -5804,7 +5820,7 @@ The header field in which `mod_remoteip` will look for the useragent IP. Default value: `'X-Forwarded-For'` -##### `internal_proxy` +##### `internal_proxy` Data type: `Optional[Array[Stdlib::Host]]` @@ -5813,17 +5829,17 @@ valid value inside specified header. Unlike the `$trusted_proxy_ips` parameter, any IP address (including private addresses) presented by these proxies will trusted by `mod_remoteip`. -Default value: ``undef`` +Default value: `undef` -##### `proxy_ips` +##### `proxy_ips` Data type: `Optional[Array[Stdlib::Host]]` *Deprecated*: use `$internal_proxy` instead. -Default value: ``undef`` +Default value: `undef` -##### `internal_proxy_list` +##### `internal_proxy_list` Data type: `Optional[Stdlib::Absolutepath]` @@ -5831,9 +5847,9 @@ The path to a file containing a list of IP addresses, IP blocks or hostname that are trusted to set a valid value inside the specified header. See `$internal_proxy` for details. -Default value: ``undef`` +Default value: `undef` -##### `proxies_header` +##### `proxies_header` Data type: `Optional[String]` @@ -5841,27 +5857,27 @@ A header into which `mod_remoteip` will collect a list of all of the intermediate client IP addresses trusted to resolve the useragent IP of the request (e.g. `X-Forwarded-By`). -Default value: ``undef`` +Default value: `undef` -##### `proxy_protocol` +##### `proxy_protocol` Data type: `Boolean` Wether or not to enable the PROXY protocol header handling. If enabled upstream clients must set the header every time they open a connection. -Default value: ``false`` +Default value: `false` -##### `proxy_protocol_exceptions` +##### `proxy_protocol_exceptions` Data type: `Optional[Array[Stdlib::Host]]` A list of IP address or IP blocks that are not required to use the PROXY protocol. -Default value: ``undef`` +Default value: `undef` -##### `trusted_proxy` +##### `trusted_proxy` Data type: `Optional[Array[Stdlib::Host]]` @@ -5870,17 +5886,17 @@ valid value inside the specified header. Unlike the `$proxy_ips` parameter, any private IP presented by these proxies will be disgarded by `mod_remoteip`. -Default value: ``undef`` +Default value: `undef` -##### `trusted_proxy_ips` +##### `trusted_proxy_ips` Data type: `Optional[Array[Stdlib::Host]]` *Deprecated*: use `$trusted_proxy` instead. -Default value: ``undef`` +Default value: `undef` -##### `trusted_proxy_list` +##### `trusted_proxy_list` Data type: `Optional[Stdlib::Absolutepath]` @@ -5888,9 +5904,9 @@ The path to a file containing a list of IP addresses, IP blocks or hostname that are trusted to set a valid value inside the specified header. See `$trusted_proxy` for details. -Default value: ``undef`` +Default value: `undef` -### `apache::mod::reqtimeout` +### `apache::mod::reqtimeout` Installs and configures `mod_reqtimeout`. @@ -5902,9 +5918,9 @@ Installs and configures `mod_reqtimeout`. The following parameters are available in the `apache::mod::reqtimeout` class: -* [`timeouts`](#timeouts) +* [`timeouts`](#-apache--mod--reqtimeout--timeouts) -##### `timeouts` +##### `timeouts` Data type: `Variant[Array[String], String]` @@ -5912,7 +5928,7 @@ List of timeouts and data rates for receiving requests. Default value: `['header=20-40,minrate=500', 'body=10,minrate=500']` -### `apache::mod::rewrite` +### `apache::mod::rewrite` Installs `mod_rewrite`. @@ -5920,7 +5936,7 @@ Installs `mod_rewrite`. * https://httpd.apache.org/docs/current/mod/mod_rewrite.html * for additional documentation. -### `apache::mod::rpaf` +### `apache::mod::rpaf` Installs and configures `mod_rpaf`. @@ -5932,20 +5948,20 @@ Installs and configures `mod_rpaf`. The following parameters are available in the `apache::mod::rpaf` class: -* [`sethostname`](#sethostname) -* [`proxy_ips`](#proxy_ips) -* [`header`](#header) -* [`template`](#template) +* [`sethostname`](#-apache--mod--rpaf--sethostname) +* [`proxy_ips`](#-apache--mod--rpaf--proxy_ips) +* [`header`](#-apache--mod--rpaf--header) +* [`template`](#-apache--mod--rpaf--template) -##### `sethostname` +##### `sethostname` Data type: `Variant[Boolean, String]` Toggles whether to update vhost name so ServerName and ServerAlias work. -Default value: ``true`` +Default value: `true` -##### `proxy_ips` +##### `proxy_ips` Data type: `Array[Stdlib::IP::Address]` @@ -5953,7 +5969,7 @@ List of IPs & bitmasked subnets to adjust requests for Default value: `['127.0.0.1']` -##### `header` +##### `header` Data type: `String` @@ -5961,7 +5977,7 @@ Header to use for the real IP address. Default value: `'X-Forwarded-For'` -##### `template` +##### `template` Data type: `String` @@ -5969,7 +5985,7 @@ Path to template to use for configuring mod_rpaf. Default value: `'apache/mod/rpaf.conf.erb'` -### `apache::mod::security` +### `apache::mod::security` Installs and configures `mod_security`. @@ -5983,48 +5999,48 @@ Installs and configures `mod_security`. The following parameters are available in the `apache::mod::security` class: -* [`version`](#version) -* [`logroot`](#logroot) -* [`crs_package`](#crs_package) -* [`activated_rules`](#activated_rules) -* [`custom_rules`](#custom_rules) -* [`custom_rules_set`](#custom_rules_set) -* [`modsec_dir`](#modsec_dir) -* [`modsec_secruleengine`](#modsec_secruleengine) -* [`audit_log_relevant_status`](#audit_log_relevant_status) -* [`audit_log_parts`](#audit_log_parts) -* [`audit_log_type`](#audit_log_type) -* [`audit_log_storage_dir`](#audit_log_storage_dir) -* [`secpcrematchlimit`](#secpcrematchlimit) -* [`secpcrematchlimitrecursion`](#secpcrematchlimitrecursion) -* [`allowed_methods`](#allowed_methods) -* [`content_types`](#content_types) -* [`restricted_extensions`](#restricted_extensions) -* [`restricted_headers`](#restricted_headers) -* [`secdefaultaction`](#secdefaultaction) -* [`inbound_anomaly_threshold`](#inbound_anomaly_threshold) -* [`outbound_anomaly_threshold`](#outbound_anomaly_threshold) -* [`critical_anomaly_score`](#critical_anomaly_score) -* [`error_anomaly_score`](#error_anomaly_score) -* [`warning_anomaly_score`](#warning_anomaly_score) -* [`notice_anomaly_score`](#notice_anomaly_score) -* [`paranoia_level`](#paranoia_level) -* [`executing_paranoia_level`](#executing_paranoia_level) -* [`secrequestmaxnumargs`](#secrequestmaxnumargs) -* [`secrequestbodylimit`](#secrequestbodylimit) -* [`secrequestbodynofileslimit`](#secrequestbodynofileslimit) -* [`secrequestbodyinmemorylimit`](#secrequestbodyinmemorylimit) -* [`secrequestbodyaccess`](#secrequestbodyaccess) -* [`secrequestbodylimitaction`](#secrequestbodylimitaction) -* [`secresponsebodyaccess`](#secresponsebodyaccess) -* [`secresponsebodylimitaction`](#secresponsebodylimitaction) -* [`manage_security_crs`](#manage_security_crs) -* [`enable_dos_protection`](#enable_dos_protection) -* [`dos_burst_time_slice`](#dos_burst_time_slice) -* [`dos_counter_threshold`](#dos_counter_threshold) -* [`dos_block_timeout`](#dos_block_timeout) - -##### `version` +* [`version`](#-apache--mod--security--version) +* [`logroot`](#-apache--mod--security--logroot) +* [`crs_package`](#-apache--mod--security--crs_package) +* [`activated_rules`](#-apache--mod--security--activated_rules) +* [`custom_rules`](#-apache--mod--security--custom_rules) +* [`custom_rules_set`](#-apache--mod--security--custom_rules_set) +* [`modsec_dir`](#-apache--mod--security--modsec_dir) +* [`modsec_secruleengine`](#-apache--mod--security--modsec_secruleengine) +* [`audit_log_relevant_status`](#-apache--mod--security--audit_log_relevant_status) +* [`audit_log_parts`](#-apache--mod--security--audit_log_parts) +* [`audit_log_type`](#-apache--mod--security--audit_log_type) +* [`audit_log_storage_dir`](#-apache--mod--security--audit_log_storage_dir) +* [`secpcrematchlimit`](#-apache--mod--security--secpcrematchlimit) +* [`secpcrematchlimitrecursion`](#-apache--mod--security--secpcrematchlimitrecursion) +* [`allowed_methods`](#-apache--mod--security--allowed_methods) +* [`content_types`](#-apache--mod--security--content_types) +* [`restricted_extensions`](#-apache--mod--security--restricted_extensions) +* [`restricted_headers`](#-apache--mod--security--restricted_headers) +* [`secdefaultaction`](#-apache--mod--security--secdefaultaction) +* [`inbound_anomaly_threshold`](#-apache--mod--security--inbound_anomaly_threshold) +* [`outbound_anomaly_threshold`](#-apache--mod--security--outbound_anomaly_threshold) +* [`critical_anomaly_score`](#-apache--mod--security--critical_anomaly_score) +* [`error_anomaly_score`](#-apache--mod--security--error_anomaly_score) +* [`warning_anomaly_score`](#-apache--mod--security--warning_anomaly_score) +* [`notice_anomaly_score`](#-apache--mod--security--notice_anomaly_score) +* [`paranoia_level`](#-apache--mod--security--paranoia_level) +* [`executing_paranoia_level`](#-apache--mod--security--executing_paranoia_level) +* [`secrequestmaxnumargs`](#-apache--mod--security--secrequestmaxnumargs) +* [`secrequestbodylimit`](#-apache--mod--security--secrequestbodylimit) +* [`secrequestbodynofileslimit`](#-apache--mod--security--secrequestbodynofileslimit) +* [`secrequestbodyinmemorylimit`](#-apache--mod--security--secrequestbodyinmemorylimit) +* [`secrequestbodyaccess`](#-apache--mod--security--secrequestbodyaccess) +* [`secrequestbodylimitaction`](#-apache--mod--security--secrequestbodylimitaction) +* [`secresponsebodyaccess`](#-apache--mod--security--secresponsebodyaccess) +* [`secresponsebodylimitaction`](#-apache--mod--security--secresponsebodylimitaction) +* [`manage_security_crs`](#-apache--mod--security--manage_security_crs) +* [`enable_dos_protection`](#-apache--mod--security--enable_dos_protection) +* [`dos_burst_time_slice`](#-apache--mod--security--dos_burst_time_slice) +* [`dos_counter_threshold`](#-apache--mod--security--dos_counter_threshold) +* [`dos_block_timeout`](#-apache--mod--security--dos_block_timeout) + +##### `version` Data type: `Integer` @@ -6032,7 +6048,7 @@ Manage mod_security or mod_security2 Default value: `$apache::params::modsec_version` -##### `logroot` +##### `logroot` Data type: `Stdlib::Absolutepath` @@ -6040,7 +6056,7 @@ Configures the location of audit and debug logs. Default value: `$apache::params::logroot` -##### `crs_package` +##### `crs_package` Data type: `Optional[String]` @@ -6048,7 +6064,7 @@ Name of package that installs CRS rules. Default value: `$apache::params::modsec_crs_package` -##### `activated_rules` +##### `activated_rules` Data type: `Array[String]` @@ -6056,7 +6072,7 @@ An array of rules from the modsec_crs_path or absolute to activate via symlinks. Default value: `$apache::params::modsec_default_rules` -##### `custom_rules` +##### `custom_rules` Data type: `Boolean` @@ -6064,7 +6080,7 @@ Data type: `Boolean` Default value: `$apache::params::modsec_custom_rules` -##### `custom_rules_set` +##### `custom_rules_set` Data type: `Optional[Array[String]]` @@ -6072,7 +6088,7 @@ Data type: `Optional[Array[String]]` Default value: `$apache::params::modsec_custom_rules_set` -##### `modsec_dir` +##### `modsec_dir` Data type: `Stdlib::Absolutepath` @@ -6080,7 +6096,7 @@ Defines the path where Puppet installs the modsec configuration and activated ru Default value: `$apache::params::modsec_dir` -##### `modsec_secruleengine` +##### `modsec_secruleengine` Data type: `String` @@ -6088,7 +6104,7 @@ Configures the rules engine. Default value: `$apache::params::modsec_secruleengine` -##### `audit_log_relevant_status` +##### `audit_log_relevant_status` Data type: `String` @@ -6096,7 +6112,7 @@ Configures which response status code is to be considered relevant for the purpo Default value: `'^(?:5|4(?!04))'` -##### `audit_log_parts` +##### `audit_log_parts` Data type: `String` @@ -6105,7 +6121,7 @@ letter appears in the list then the equivalent part will be recorded. Default value: `$apache::params::modsec_audit_log_parts` -##### `audit_log_type` +##### `audit_log_type` Data type: `String` @@ -6113,15 +6129,15 @@ Defines the type of audit logging mechanism to be used. Default value: `$apache::params::modsec_audit_log_type` -##### `audit_log_storage_dir` +##### `audit_log_storage_dir` Data type: `Optional[Stdlib::Absolutepath]` Defines the directory where concurrent audit log entries are to be stored. This directive is only needed when concurrent audit logging is used. -Default value: ``undef`` +Default value: `undef` -##### `secpcrematchlimit` +##### `secpcrematchlimit` Data type: `Integer` @@ -6129,7 +6145,7 @@ Sets the match limit in the PCRE library. Default value: `$apache::params::secpcrematchlimit` -##### `secpcrematchlimitrecursion` +##### `secpcrematchlimitrecursion` Data type: `Integer` @@ -6137,7 +6153,7 @@ Sets the match limit recursion in the PCRE library. Default value: `$apache::params::secpcrematchlimitrecursion` -##### `allowed_methods` +##### `allowed_methods` Data type: `String` @@ -6145,7 +6161,7 @@ A space-separated list of allowed HTTP methods. Default value: `'GET HEAD POST OPTIONS'` -##### `content_types` +##### `content_types` Data type: `String` @@ -6153,7 +6169,7 @@ A list of one or more allowed MIME types. Default value: `'application/x-www-form-urlencoded|multipart/form-data|text/xml|application/xml|application/x-amf'` -##### `restricted_extensions` +##### `restricted_extensions` Data type: `String` @@ -6161,7 +6177,7 @@ A space-sparated list of prohibited file extensions. Default value: `'.asa/ .asax/ .ascx/ .axd/ .backup/ .bak/ .bat/ .cdx/ .cer/ .cfg/ .cmd/ .com/ .config/ .conf/ .cs/ .csproj/ .csr/ .dat/ .db/ .dbf/ .dll/ .dos/ .htr/ .htw/ .ida/ .idc/ .idq/ .inc/ .ini/ .key/ .licx/ .lnk/ .log/ .mdb/ .old/ .pass/ .pdb/ .pol/ .printer/ .pwd/ .resources/ .resx/ .sql/ .sys/ .vb/ .vbs/ .vbproj/ .vsdisco/ .webinfo/ .xsd/ .xsx/'` -##### `restricted_headers` +##### `restricted_headers` Data type: `String` @@ -6169,7 +6185,7 @@ A list of restricted headers separated by slashes and spaces. Default value: `'/Proxy-Connection/ /Lock-Token/ /Content-Range/ /Translate/ /via/ /if/'` -##### `secdefaultaction` +##### `secdefaultaction` Data type: `String` @@ -6177,7 +6193,7 @@ Defines the default list of actions, which will be inherited by the rules in the Default value: `'deny'` -##### `inbound_anomaly_threshold` +##### `inbound_anomaly_threshold` Data type: `Integer` @@ -6185,7 +6201,7 @@ Sets the scoring threshold level of the inbound blocking rules for the Collabora Default value: `5` -##### `outbound_anomaly_threshold` +##### `outbound_anomaly_threshold` Data type: `Integer` @@ -6193,7 +6209,7 @@ Sets the scoring threshold level of the outbound blocking rules for the Collabor Default value: `4` -##### `critical_anomaly_score` +##### `critical_anomaly_score` Data type: `Integer` @@ -6201,7 +6217,7 @@ Sets the Anomaly Score for rules assigned with a critical severity. Default value: `5` -##### `error_anomaly_score` +##### `error_anomaly_score` Data type: `Integer` @@ -6209,7 +6225,7 @@ Sets the Anomaly Score for rules assigned with a error severity. Default value: `4` -##### `warning_anomaly_score` +##### `warning_anomaly_score` Data type: `Integer` @@ -6217,7 +6233,7 @@ Sets the Anomaly Score for rules assigned with a warning severity. Default value: `3` -##### `notice_anomaly_score` +##### `notice_anomaly_score` Data type: `Integer` @@ -6225,7 +6241,7 @@ Sets the Anomaly Score for rules assigned with a notice severity. Default value: `2` -##### `paranoia_level` +##### `paranoia_level` Data type: `Integer[1,4]` @@ -6233,7 +6249,7 @@ Sets the paranoia level in the OWASP ModSecurity Core Rule Set. Default value: `1` -##### `executing_paranoia_level` +##### `executing_paranoia_level` Data type: `Integer[1,4]` @@ -6242,7 +6258,7 @@ The default is equal to, and cannot be lower than, $paranoia_level. Default value: `$paranoia_level` -##### `secrequestmaxnumargs` +##### `secrequestmaxnumargs` Data type: `Integer` @@ -6250,7 +6266,7 @@ Sets the maximum number of arguments in the request. Default value: `255` -##### `secrequestbodylimit` +##### `secrequestbodylimit` Data type: `Integer` @@ -6258,7 +6274,7 @@ Sets the maximum request body size ModSecurity will accept for buffering. Default value: `13107200` -##### `secrequestbodynofileslimit` +##### `secrequestbodynofileslimit` Data type: `Integer` @@ -6267,7 +6283,7 @@ in the request. Default value: `131072` -##### `secrequestbodyinmemorylimit` +##### `secrequestbodyinmemorylimit` Data type: `Integer` @@ -6275,7 +6291,7 @@ Configures the maximum request body size that ModSecurity will store in memory. Default value: `131072` -##### `secrequestbodyaccess` +##### `secrequestbodyaccess` Data type: `Apache::OnOff` @@ -6283,7 +6299,7 @@ Toggle SecRequestBodyAccess On or Off Default value: `'On'` -##### `secrequestbodylimitaction` +##### `secrequestbodylimitaction` Data type: `Enum['Reject', 'ProcessPartial']` @@ -6292,7 +6308,7 @@ SecRequestBodyLimit, is encountered Default value: `'Reject'` -##### `secresponsebodyaccess` +##### `secresponsebodyaccess` Data type: `Apache::OnOff` @@ -6300,7 +6316,7 @@ Toggle SecResponseBodyAccess On or Off Default value: `'Off'` -##### `secresponsebodylimitaction` +##### `secresponsebodylimitaction` Data type: `Enum['Reject', 'ProcessPartial']` @@ -6309,24 +6325,24 @@ SecResponseBodyLimitAction, is encountered. Default value: `'ProcessPartial'` -##### `manage_security_crs` +##### `manage_security_crs` Data type: `Boolean` Toggles whether to manage ModSecurity Core Rule Set -Default value: ``true`` +Default value: `true` -##### `enable_dos_protection` +##### `enable_dos_protection` Data type: `Boolean` Toggles the optional OWASP ModSecurity Core Rule Set DOS protection rule (rule id 900700) -Default value: ``true`` +Default value: `true` -##### `dos_burst_time_slice` +##### `dos_burst_time_slice` Data type: `Integer[1, default]` @@ -6335,7 +6351,7 @@ Configures time in which a burst is measured for the OWASP ModSecurity Core Rule Default value: `60` -##### `dos_counter_threshold` +##### `dos_counter_threshold` Data type: `Integer[1, default]` @@ -6344,7 +6360,7 @@ the OWASP ModSecurity Core Rule Set DOS protection rule (rule id 900700) Default value: `100` -##### `dos_block_timeout` +##### `dos_block_timeout` Data type: `Integer[1, default]` @@ -6353,7 +6369,7 @@ ModSecurity Core Rule Set DOS protection rule (rule id 900700) Default value: `600` -### `apache::mod::setenvif` +### `apache::mod::setenvif` Installs `mod_setenvif`. @@ -6361,7 +6377,7 @@ Installs `mod_setenvif`. * https://httpd.apache.org/docs/current/mod/mod_setenvif.html * for additional documentation. -### `apache::mod::shib` +### `apache::mod::shib` This class installs and configures only the Apache components of a web application that consumes Shibboleth SSO identities. You can manage the Shibboleth configuration manually, with Puppet, or using a [Shibboleth Puppet Module](https://github.com/aethylred/puppet-shibboleth). @@ -6377,45 +6393,45 @@ See the [Shibboleth Service Provider Installation Guide](http://wiki.aaf.edu.au/ The following parameters are available in the `apache::mod::shib` class: -* [`suppress_warning`](#suppress_warning) -* [`mod_full_path`](#mod_full_path) -* [`package_name`](#package_name) -* [`mod_lib`](#mod_lib) +* [`suppress_warning`](#-apache--mod--shib--suppress_warning) +* [`mod_full_path`](#-apache--mod--shib--mod_full_path) +* [`package_name`](#-apache--mod--shib--package_name) +* [`mod_lib`](#-apache--mod--shib--mod_lib) -##### `suppress_warning` +##### `suppress_warning` Data type: `Boolean` Toggles whether to trigger warning on RedHat nodes. -Default value: ``false`` +Default value: `false` -##### `mod_full_path` +##### `mod_full_path` Data type: `Optional[Stdlib::Absolutepath]` Specifies a path to the module. Do not manually set this parameter without a special reason. -Default value: ``undef`` +Default value: `undef` -##### `package_name` +##### `package_name` Data type: `Optional[String]` Name of the Shibboleth package to be installed. -Default value: ``undef`` +Default value: `undef` -##### `mod_lib` +##### `mod_lib` Data type: `Optional[String]` Specifies a path to the module's libraries. Do not manually set this parameter without special reason. The `path` parameter overrides this value. -Default value: ``undef`` +Default value: `undef` -### `apache::mod::socache_shmcb` +### `apache::mod::socache_shmcb` Installs `mod_socache_shmcb`. @@ -6423,7 +6439,7 @@ Installs `mod_socache_shmcb`. * https://httpd.apache.org/docs/current/mod/mod_socache_shmcb.html * for additional documentation. -### `apache::mod::speling` +### `apache::mod::speling` Installs `mod_spelling`. @@ -6431,7 +6447,7 @@ Installs `mod_spelling`. * https://httpd.apache.org/docs/current/mod/mod_speling.html * for additional documentation. -### `apache::mod::ssl` +### `apache::mod::ssl` On most operating systems, the ssl.conf is placed in the module configuration directory. On Red Hat based operating systems, this file is placed in /etc/httpd/conf.d, the same location in which the RPM stores the configuration. @@ -6447,47 +6463,47 @@ apache::vhost to true. The following parameters are available in the `apache::mod::ssl` class: -* [`ssl_compression`](#ssl_compression) -* [`ssl_sessiontickets`](#ssl_sessiontickets) -* [`ssl_cryptodevice`](#ssl_cryptodevice) -* [`ssl_options`](#ssl_options) -* [`ssl_openssl_conf_cmd`](#ssl_openssl_conf_cmd) -* [`ssl_cert`](#ssl_cert) -* [`ssl_key`](#ssl_key) -* [`ssl_ca`](#ssl_ca) -* [`ssl_cipher`](#ssl_cipher) -* [`ssl_honorcipherorder`](#ssl_honorcipherorder) -* [`ssl_protocol`](#ssl_protocol) -* [`ssl_proxy_protocol`](#ssl_proxy_protocol) -* [`ssl_proxy_cipher_suite`](#ssl_proxy_cipher_suite) -* [`ssl_pass_phrase_dialog`](#ssl_pass_phrase_dialog) -* [`ssl_random_seed_bytes`](#ssl_random_seed_bytes) -* [`ssl_sessioncache`](#ssl_sessioncache) -* [`ssl_sessioncachetimeout`](#ssl_sessioncachetimeout) -* [`ssl_stapling`](#ssl_stapling) -* [`stapling_cache`](#stapling_cache) -* [`ssl_stapling_return_errors`](#ssl_stapling_return_errors) -* [`ssl_mutex`](#ssl_mutex) -* [`ssl_reload_on_change`](#ssl_reload_on_change) -* [`package_name`](#package_name) - -##### `ssl_compression` +* [`ssl_compression`](#-apache--mod--ssl--ssl_compression) +* [`ssl_sessiontickets`](#-apache--mod--ssl--ssl_sessiontickets) +* [`ssl_cryptodevice`](#-apache--mod--ssl--ssl_cryptodevice) +* [`ssl_options`](#-apache--mod--ssl--ssl_options) +* [`ssl_openssl_conf_cmd`](#-apache--mod--ssl--ssl_openssl_conf_cmd) +* [`ssl_cert`](#-apache--mod--ssl--ssl_cert) +* [`ssl_key`](#-apache--mod--ssl--ssl_key) +* [`ssl_ca`](#-apache--mod--ssl--ssl_ca) +* [`ssl_cipher`](#-apache--mod--ssl--ssl_cipher) +* [`ssl_honorcipherorder`](#-apache--mod--ssl--ssl_honorcipherorder) +* [`ssl_protocol`](#-apache--mod--ssl--ssl_protocol) +* [`ssl_proxy_protocol`](#-apache--mod--ssl--ssl_proxy_protocol) +* [`ssl_proxy_cipher_suite`](#-apache--mod--ssl--ssl_proxy_cipher_suite) +* [`ssl_pass_phrase_dialog`](#-apache--mod--ssl--ssl_pass_phrase_dialog) +* [`ssl_random_seed_bytes`](#-apache--mod--ssl--ssl_random_seed_bytes) +* [`ssl_sessioncache`](#-apache--mod--ssl--ssl_sessioncache) +* [`ssl_sessioncachetimeout`](#-apache--mod--ssl--ssl_sessioncachetimeout) +* [`ssl_stapling`](#-apache--mod--ssl--ssl_stapling) +* [`stapling_cache`](#-apache--mod--ssl--stapling_cache) +* [`ssl_stapling_return_errors`](#-apache--mod--ssl--ssl_stapling_return_errors) +* [`ssl_mutex`](#-apache--mod--ssl--ssl_mutex) +* [`ssl_reload_on_change`](#-apache--mod--ssl--ssl_reload_on_change) +* [`package_name`](#-apache--mod--ssl--package_name) + +##### `ssl_compression` Data type: `Boolean` Enable compression on the SSL level. -Default value: ``false`` +Default value: `false` -##### `ssl_sessiontickets` +##### `ssl_sessiontickets` Data type: `Optional[Boolean]` Enable or disable use of TLS session tickets -Default value: ``undef`` +Default value: `undef` -##### `ssl_cryptodevice` +##### `ssl_cryptodevice` Data type: `String` @@ -6495,7 +6511,7 @@ Enable use of a cryptographic hardware accelerator. Default value: `'builtin'` -##### `ssl_options` +##### `ssl_options` Data type: `Array[String]` @@ -6503,39 +6519,39 @@ Configure various SSL engine run-time options. Default value: `['StdEnvVars']` -##### `ssl_openssl_conf_cmd` +##### `ssl_openssl_conf_cmd` Data type: `Optional[String]` Configure OpenSSL parameters through its SSL_CONF API. -Default value: ``undef`` +Default value: `undef` -##### `ssl_cert` +##### `ssl_cert` Data type: `Optional[Stdlib::Absolutepath]` Path to server PEM-encoded X.509 certificate data file. -Default value: ``undef`` +Default value: `undef` -##### `ssl_key` +##### `ssl_key` Data type: `Optional[Stdlib::Absolutepath]` Path to server PEM-encoded private key file -Default value: ``undef`` +Default value: `undef` -##### `ssl_ca` +##### `ssl_ca` Data type: `Optional[Stdlib::Absolutepath]` File of concatenated PEM-encoded CA Certificates for Client Auth. -Default value: ``undef`` +Default value: `undef` -##### `ssl_cipher` +##### `ssl_cipher` Data type: `Variant[String[1], Hash[String[1], String[1]]]` @@ -6543,15 +6559,15 @@ Cipher Suite available for negotiation in SSL handshake. Default value: `$apache::params::ssl_cipher` -##### `ssl_honorcipherorder` +##### `ssl_honorcipherorder` Data type: `Variant[Boolean, Apache::OnOff]` Option to prefer the server's cipher preference order. -Default value: ``true`` +Default value: `true` -##### `ssl_protocol` +##### `ssl_protocol` Data type: `Array[String]` @@ -6562,7 +6578,7 @@ Default based on the OS: Default value: `$apache::params::ssl_protocol` -##### `ssl_proxy_protocol` +##### `ssl_proxy_protocol` Data type: `Array` @@ -6570,7 +6586,7 @@ Configure usable SSL protocol flavors for proxy usage. Default value: `[]` -##### `ssl_proxy_cipher_suite` +##### `ssl_proxy_cipher_suite` Data type: `Optional[String[1]]` @@ -6578,7 +6594,7 @@ Configure usable SSL ciphers for proxy usage. Equivalent to ssl_cipher but for p Default value: `$apache::params::ssl_proxy_cipher_suite` -##### `ssl_pass_phrase_dialog` +##### `ssl_pass_phrase_dialog` Data type: `String` @@ -6586,7 +6602,7 @@ Type of pass phrase dialog for encrypted private keys. Default value: `'builtin'` -##### `ssl_random_seed_bytes` +##### `ssl_random_seed_bytes` Data type: `Integer` @@ -6594,7 +6610,7 @@ Pseudo Random Number Generator (PRNG) seeding source. Default value: `512` -##### `ssl_sessioncache` +##### `ssl_sessioncache` Data type: `String` @@ -6602,7 +6618,7 @@ Configures the storage type of the global/inter-process SSL Session Cache Default value: `$apache::params::ssl_sessioncache` -##### `ssl_sessioncachetimeout` +##### `ssl_sessioncachetimeout` Data type: `Integer` @@ -6610,32 +6626,32 @@ Number of seconds before an SSL session expires in the Session Cache. Default value: `300` -##### `ssl_stapling` +##### `ssl_stapling` Data type: `Boolean` Enable stapling of OCSP responses in the TLS handshake. -Default value: ``false`` +Default value: `false` -##### `stapling_cache` +##### `stapling_cache` Data type: `Optional[String]` Configures the cache used to store OCSP responses which get included in the TLS handshake if SSLUseStapling is enabled. -Default value: ``undef`` +Default value: `undef` -##### `ssl_stapling_return_errors` +##### `ssl_stapling_return_errors` Data type: `Optional[Boolean]` Pass stapling related OCSP errors on to client. -Default value: ``undef`` +Default value: `undef` -##### `ssl_mutex` +##### `ssl_mutex` Data type: `String` @@ -6647,23 +6663,23 @@ Default based on the OS and/or Apache version: Default value: `'default'` -##### `ssl_reload_on_change` +##### `ssl_reload_on_change` Data type: `Boolean` Enable reloading of apache if the content of ssl files have changed. It only affects ssl files configured here and not vhost ones. -Default value: ``false`` +Default value: `false` -##### `package_name` +##### `package_name` Data type: `Optional[String]` Name of ssl package to install. -Default value: ``undef`` +Default value: `undef` -### `apache::mod::status` +### `apache::mod::status` Installs and configures `mod_status`. @@ -6686,11 +6702,11 @@ class { 'apache::mod::status': The following parameters are available in the `apache::mod::status` class: -* [`requires`](#requires) -* [`extended_status`](#extended_status) -* [`status_path`](#status_path) +* [`requires`](#-apache--mod--status--requires) +* [`extended_status`](#-apache--mod--status--extended_status) +* [`status_path`](#-apache--mod--status--status_path) -##### `requires` +##### `requires` Data type: `Optional[Variant[String, Array, Hash]]` @@ -6707,9 +6723,9 @@ A Variant type that can be: This encloses "Require" directives in "" block Optional - If unspecified, "Require" directives follow current flow -Default value: ``undef`` +Default value: `undef` -##### `extended_status` +##### `extended_status` Data type: `Apache::OnOff` @@ -6717,7 +6733,7 @@ Determines whether to track extended status information for each request, via th Default value: `'On'` -##### `status_path` +##### `status_path` Data type: `String` @@ -6725,7 +6741,7 @@ Path assigned to the Location directive which defines the URL to access the serv Default value: `'/server-status'` -### `apache::mod::suexec` +### `apache::mod::suexec` Installs `mod_suexec`. @@ -6733,7 +6749,7 @@ Installs `mod_suexec`. * https://httpd.apache.org/docs/current/mod/mod_suexec.html * for additional documentation. -### `apache::mod::userdir` +### `apache::mod::userdir` Installs and configures `mod_userdir`. @@ -6745,49 +6761,49 @@ Installs and configures `mod_userdir`. The following parameters are available in the `apache::mod::userdir` class: -* [`home`](#home) -* [`dir`](#dir) -* [`userdir`](#userdir) -* [`disable_root`](#disable_root) -* [`path`](#path) -* [`overrides`](#overrides) -* [`options`](#options) -* [`unmanaged_path`](#unmanaged_path) -* [`custom_fragment`](#custom_fragment) +* [`home`](#-apache--mod--userdir--home) +* [`dir`](#-apache--mod--userdir--dir) +* [`userdir`](#-apache--mod--userdir--userdir) +* [`disable_root`](#-apache--mod--userdir--disable_root) +* [`path`](#-apache--mod--userdir--path) +* [`overrides`](#-apache--mod--userdir--overrides) +* [`options`](#-apache--mod--userdir--options) +* [`unmanaged_path`](#-apache--mod--userdir--unmanaged_path) +* [`custom_fragment`](#-apache--mod--userdir--custom_fragment) -##### `home` +##### `home` Data type: `Optional[String]` *Deprecated* Path to system home directory. -Default value: ``undef`` +Default value: `undef` -##### `dir` +##### `dir` Data type: `Optional[String]` *Deprecated* Path from user's home directory to public directory. -Default value: ``undef`` +Default value: `undef` -##### `userdir` +##### `userdir` Data type: `Optional[String[1]]` Path or directory name to be used as the UserDir. -Default value: ``undef`` +Default value: `undef` -##### `disable_root` +##### `disable_root` Data type: `Boolean` Toggles whether to allow use of root directory. -Default value: ``true`` +Default value: `true` -##### `path` +##### `path` Data type: `String` @@ -6795,7 +6811,7 @@ Path to directory or pattern from which to find user-specific directories. Default value: `'/home/*/public_html'` -##### `overrides` +##### `overrides` Data type: `Array[String]` @@ -6803,7 +6819,7 @@ Array of directives that are allowed in .htaccess files. Default value: `['FileInfo', 'AuthConfig', 'Limit', 'Indexes']` -##### `options` +##### `options` Data type: `Array[String]` @@ -6811,23 +6827,23 @@ Configures what features are available in a particular directory. Default value: `['MultiViews', 'Indexes', 'SymLinksIfOwnerMatch', 'IncludesNoExec']` -##### `unmanaged_path` +##### `unmanaged_path` Data type: `Boolean` Toggles whether to manage path in userdir.conf -Default value: ``false`` +Default value: `false` -##### `custom_fragment` +##### `custom_fragment` Data type: `Optional[String]` Custom configuration to be added to userdir.conf -Default value: ``undef`` +Default value: `undef` -### `apache::mod::version` +### `apache::mod::version` Installs `mod_version`. @@ -6835,7 +6851,7 @@ Installs `mod_version`. * https://httpd.apache.org/docs/current/mod/mod_version.html * for additional documentation. -### `apache::mod::vhost_alias` +### `apache::mod::vhost_alias` Installs Apache `mod_vhost_alias`. @@ -6843,7 +6859,7 @@ Installs Apache `mod_vhost_alias`. * https://httpd.apache.org/docs/current/mod/mod_vhost_alias.html * for additional documentation. -### `apache::mod::watchdog` +### `apache::mod::watchdog` Installs and configures `mod_watchdog`. @@ -6855,17 +6871,17 @@ Installs and configures `mod_watchdog`. The following parameters are available in the `apache::mod::watchdog` class: -* [`watchdog_interval`](#watchdog_interval) +* [`watchdog_interval`](#-apache--mod--watchdog--watchdog_interval) -##### `watchdog_interval` +##### `watchdog_interval` Data type: `Optional[Integer]` Sets the interval at which the watchdog_step hook runs. -Default value: ``undef`` +Default value: `undef` -### `apache::mod::worker` +### `apache::mod::worker` Installs and manages the MPM `worker`. @@ -6877,17 +6893,17 @@ Installs and manages the MPM `worker`. The following parameters are available in the `apache::mod::worker` class: -* [`startservers`](#startservers) -* [`minsparethreads`](#minsparethreads) -* [`maxsparethreads`](#maxsparethreads) -* [`threadsperchild`](#threadsperchild) -* [`maxrequestsperchild`](#maxrequestsperchild) -* [`serverlimit`](#serverlimit) -* [`threadlimit`](#threadlimit) -* [`listenbacklog`](#listenbacklog) -* [`maxrequestworkers`](#maxrequestworkers) +* [`startservers`](#-apache--mod--worker--startservers) +* [`minsparethreads`](#-apache--mod--worker--minsparethreads) +* [`maxsparethreads`](#-apache--mod--worker--maxsparethreads) +* [`threadsperchild`](#-apache--mod--worker--threadsperchild) +* [`maxrequestsperchild`](#-apache--mod--worker--maxrequestsperchild) +* [`serverlimit`](#-apache--mod--worker--serverlimit) +* [`threadlimit`](#-apache--mod--worker--threadlimit) +* [`listenbacklog`](#-apache--mod--worker--listenbacklog) +* [`maxrequestworkers`](#-apache--mod--worker--maxrequestworkers) -##### `startservers` +##### `startservers` Data type: `Integer` @@ -6895,7 +6911,7 @@ The number of child server processes created on startup Default value: `2` -##### `minsparethreads` +##### `minsparethreads` Data type: `Integer` @@ -6903,7 +6919,7 @@ Minimum number of idle threads to handle request spikes. Default value: `25` -##### `maxsparethreads` +##### `maxsparethreads` Data type: `Integer` @@ -6911,7 +6927,7 @@ Maximum number of idle threads. Default value: `75` -##### `threadsperchild` +##### `threadsperchild` Data type: `Integer` @@ -6919,7 +6935,7 @@ The number of threads created by each child process. Default value: `25` -##### `maxrequestsperchild` +##### `maxrequestsperchild` Data type: `Integer` @@ -6929,7 +6945,7 @@ name is MaxConnectionsPerChild as of 2.3.9+. Default value: `0` -##### `serverlimit` +##### `serverlimit` Data type: `Integer` @@ -6941,7 +6957,7 @@ MaxRequestWorkers and ThreadsPerChild. Default value: `25` -##### `threadlimit` +##### `threadlimit` Data type: `Integer` @@ -6950,7 +6966,7 @@ ThreadsPerChild for the lifetime of the Apache httpd process. Default value: `64` -##### `listenbacklog` +##### `listenbacklog` Data type: `Integer` @@ -6958,7 +6974,7 @@ Maximum length of the queue of pending connections. Default value: `511` -##### `maxrequestworkers` +##### `maxrequestworkers` Data type: `Integer` @@ -6966,7 +6982,7 @@ Maximum number of connections that will be processed simultaneously Default value: `150` -### `apache::mod::wsgi` +### `apache::mod::wsgi` Installs and configures `mod_wsgi`. @@ -6980,24 +6996,24 @@ Installs and configures `mod_wsgi`. The following parameters are available in the `apache::mod::wsgi` class: -* [`wsgi_restrict_embedded`](#wsgi_restrict_embedded) -* [`wsgi_socket_prefix`](#wsgi_socket_prefix) -* [`wsgi_python_path`](#wsgi_python_path) -* [`wsgi_python_home`](#wsgi_python_home) -* [`wsgi_python_optimize`](#wsgi_python_optimize) -* [`wsgi_application_group`](#wsgi_application_group) -* [`package_name`](#package_name) -* [`mod_path`](#mod_path) +* [`wsgi_restrict_embedded`](#-apache--mod--wsgi--wsgi_restrict_embedded) +* [`wsgi_socket_prefix`](#-apache--mod--wsgi--wsgi_socket_prefix) +* [`wsgi_python_path`](#-apache--mod--wsgi--wsgi_python_path) +* [`wsgi_python_home`](#-apache--mod--wsgi--wsgi_python_home) +* [`wsgi_python_optimize`](#-apache--mod--wsgi--wsgi_python_optimize) +* [`wsgi_application_group`](#-apache--mod--wsgi--wsgi_application_group) +* [`package_name`](#-apache--mod--wsgi--package_name) +* [`mod_path`](#-apache--mod--wsgi--mod_path) -##### `wsgi_restrict_embedded` +##### `wsgi_restrict_embedded` Data type: `Optional[String]` Enable restrictions on use of embedded mode. -Default value: ``undef`` +Default value: `undef` -##### `wsgi_socket_prefix` +##### `wsgi_socket_prefix` Data type: `Optional[String]` @@ -7005,55 +7021,55 @@ Configure directory to use for daemon sockets. Default value: `$apache::params::wsgi_socket_prefix` -##### `wsgi_python_path` +##### `wsgi_python_path` Data type: `Optional[Stdlib::Absolutepath]` Additional directories to search for Python modules. -Default value: ``undef`` +Default value: `undef` -##### `wsgi_python_home` +##### `wsgi_python_home` Data type: `Optional[Stdlib::Absolutepath]` Absolute path to Python prefix/exec_prefix directories. -Default value: ``undef`` +Default value: `undef` -##### `wsgi_python_optimize` +##### `wsgi_python_optimize` Data type: `Optional[Integer]` Enables basic Python optimisation features. -Default value: ``undef`` +Default value: `undef` -##### `wsgi_application_group` +##### `wsgi_application_group` Data type: `Optional[String]` Sets which application group WSGI application belongs to. -Default value: ``undef`` +Default value: `undef` -##### `package_name` +##### `package_name` Data type: `Optional[String]` Names of package that installs mod_wsgi. -Default value: ``undef`` +Default value: `undef` -##### `mod_path` +##### `mod_path` Data type: `Optional[String]` Defines the path to the mod_wsgi shared object (.so) file. -Default value: ``undef`` +Default value: `undef` -### `apache::mod::xsendfile` +### `apache::mod::xsendfile` Installs `mod_xsendfile`. @@ -7061,19 +7077,19 @@ Installs `mod_xsendfile`. * https://tn123.org/mod_xsendfile/ * for additional documentation. -### `apache::mpm::disable_mpm_event` +### `apache::mpm::disable_mpm_event` disable Apache-Module event -### `apache::mpm::disable_mpm_prefork` +### `apache::mpm::disable_mpm_prefork` disable Apache-Module prefork -### `apache::mpm::disable_mpm_worker` +### `apache::mpm::disable_mpm_worker` disable Apache-Module worker -### `apache::vhosts` +### `apache::vhosts` host parameters or Configuring virtual hosts in the README section. @@ -7098,9 +7114,9 @@ class { 'apache::vhosts': The following parameters are available in the `apache::vhosts` class: -* [`vhosts`](#vhosts) +* [`vhosts`](#-apache--vhosts--vhosts) -##### `vhosts` +##### `vhosts` Data type: `Hash` @@ -7111,7 +7127,7 @@ Default value: `{}` ## Defined types -### `apache::balancer` +### `apache::balancer` Each balancer cluster needs one or more balancer members (that can be declared with the apache::balancermember defined resource type). Using @@ -7135,18 +7151,18 @@ apache::balancer { 'puppet00': } The following parameters are available in the `apache::balancer` defined type: -* [`name`](#name) -* [`proxy_set`](#proxy_set) -* [`target`](#target) -* [`collect_exported`](#collect_exported) -* [`options`](#options) +* [`name`](#-apache--balancer--name) +* [`proxy_set`](#-apache--balancer--proxy_set) +* [`target`](#-apache--balancer--target) +* [`collect_exported`](#-apache--balancer--collect_exported) +* [`options`](#-apache--balancer--options) -##### `name` +##### `name` The namevar of the defined resource type is the balancer clusters name.
This name is also used in the name of the conf.d file -##### `proxy_set` +##### `proxy_set` Data type: `Hash` @@ -7154,15 +7170,15 @@ Configures key-value pairs to be used as a ProxySet lines in the configuration. Default value: `{}` -##### `target` +##### `target` Data type: `Optional[String]` The path to the file the balancer definition will be written in. -Default value: ``undef`` +Default value: `undef` -##### `collect_exported` +##### `collect_exported` Data type: `Boolean` @@ -7177,9 +7193,9 @@ If you don't use exported resources, a single Puppet run configures all balancer you use exported resources, Puppet has to run on the balanced nodes first, then run on the balancer. -Default value: ``true`` +Default value: `true` -##### `options` +##### `options` Data type: `Array[Pattern[/=/]]` @@ -7188,7 +7204,7 @@ after the balancer URL, and accepts any key-value pairs available to `ProxyPass` Default value: `[]` -### `apache::balancermember` +### `apache::balancermember` Sets up a balancer member inside a listening service configuration block in the load balancer's `apache.cfg`. @@ -7220,24 +7236,24 @@ from all balancer members. The following parameters are available in the `apache::balancermember` defined type: -* [`name`](#name) -* [`balancer_cluster`](#balancer_cluster) -* [`url`](#url) -* [`options`](#options) +* [`name`](#-apache--balancermember--name) +* [`balancer_cluster`](#-apache--balancermember--balancer_cluster) +* [`url`](#-apache--balancermember--url) +* [`options`](#-apache--balancermember--options) -##### `name` +##### `name` The title of the resource is arbitrary and only utilized in the concat fragment name. -##### `balancer_cluster` +##### `balancer_cluster` Data type: `String` The apache service's instance name (or, the title of the apache::balancer resource). This must match up with a declared apache::balancer resource. -##### `url` +##### `url` Data type: `Apache::ModProxyProtocol` @@ -7245,7 +7261,7 @@ The url used to contact the balancer member server. Default value: `"http://${$facts['networking']['fqdn']}/"` -##### `options` +##### `options` Data type: `Array` @@ -7254,7 +7270,7 @@ after the URL, and accepts any key-value pairs available to `ProxyPass`. Default value: `[]` -### `apache::custom_config` +### `apache::custom_config` If the file is invalid and this defined type's `verify_config` parameter's value is `true`, Puppet throws an error during a Puppet run. @@ -7263,20 +7279,20 @@ If the file is invalid and this defined type's `verify_config` parameter's value The following parameters are available in the `apache::custom_config` defined type: -* [`ensure`](#ensure) -* [`confdir`](#confdir) -* [`content`](#content) -* [`filename`](#filename) -* [`priority`](#priority) -* [`source`](#source) -* [`verify_command`](#verify_command) -* [`verify_config`](#verify_config) -* [`owner`](#owner) -* [`group`](#group) -* [`file_mode`](#file_mode) -* [`show_diff`](#show_diff) - -##### `ensure` +* [`ensure`](#-apache--custom_config--ensure) +* [`confdir`](#-apache--custom_config--confdir) +* [`content`](#-apache--custom_config--content) +* [`filename`](#-apache--custom_config--filename) +* [`priority`](#-apache--custom_config--priority) +* [`source`](#-apache--custom_config--source) +* [`verify_command`](#-apache--custom_config--verify_command) +* [`verify_config`](#-apache--custom_config--verify_config) +* [`owner`](#-apache--custom_config--owner) +* [`group`](#-apache--custom_config--group) +* [`file_mode`](#-apache--custom_config--file_mode) +* [`show_diff`](#-apache--custom_config--show_diff) + +##### `ensure` Data type: `Enum['absent', 'present']` @@ -7284,7 +7300,7 @@ Specifies whether the configuration file should be present. Default value: `'present'` -##### `confdir` +##### `confdir` Data type: `Stdlib::Absolutepath` @@ -7292,24 +7308,24 @@ Sets the directory in which Puppet places configuration files. Default value: `$apache::confd_dir` -##### `content` +##### `content` Data type: `Optional[Variant[Sensitive, String]]` Sets the configuration file's content. The `content` and `source` parameters are exclusive of each other. -Default value: ``undef`` +Default value: `undef` -##### `filename` +##### `filename` Data type: `Optional[String]` Sets the name of the file under `confdir` in which Puppet stores the configuration. -Default value: ``undef`` +Default value: `undef` -##### `priority` +##### `priority` Data type: `Apache::Vhost::Priority` @@ -7319,16 +7335,16 @@ To omit the priority prefix in the configuration file's name, set this parameter Default value: `25` -##### `source` +##### `source` Data type: `Optional[String]` Points to the configuration file's source. The `content` and `source` parameters are exclusive of each other. -Default value: ``undef`` +Default value: `undef` -##### `verify_command` +##### `verify_command` Data type: `Variant[String, Array[String], Array[Array[String]]]` @@ -7343,47 +7359,47 @@ Or an array of arrays with each one having to pass succesfully, i.e. `[['/usr/sb Default value: `$apache::params::verify_command` -##### `verify_config` +##### `verify_config` Data type: `Boolean` Specifies whether to validate the configuration file before notifying the Apache service. -Default value: ``true`` +Default value: `true` -##### `owner` +##### `owner` Data type: `Optional[String]` File owner of configuration file -Default value: ``undef`` +Default value: `undef` -##### `group` +##### `group` Data type: `Optional[String]` File group of configuration file -Default value: ``undef`` +Default value: `undef` -##### `file_mode` +##### `file_mode` Data type: `Optional[Stdlib::Filemode]` File mode of configuration file -Default value: ``undef`` +Default value: `undef` -##### `show_diff` +##### `show_diff` Data type: `Boolean` show_diff property for configuration file resource -Default value: ``true`` +Default value: `true` -### `apache::fastcgi::server` +### `apache::fastcgi::server` Defines one or more external FastCGI servers to handle specific file types. Use this defined type with `mod_fastcgi`. @@ -7392,15 +7408,15 @@ defined type with `mod_fastcgi`. The following parameters are available in the `apache::fastcgi::server` defined type: -* [`host`](#host) -* [`timeout`](#timeout) -* [`flush`](#flush) -* [`faux_path`](#faux_path) -* [`fcgi_alias`](#fcgi_alias) -* [`file_type`](#file_type) -* [`pass_header`](#pass_header) +* [`host`](#-apache--fastcgi--server--host) +* [`timeout`](#-apache--fastcgi--server--timeout) +* [`flush`](#-apache--fastcgi--server--flush) +* [`faux_path`](#-apache--fastcgi--server--faux_path) +* [`fcgi_alias`](#-apache--fastcgi--server--fcgi_alias) +* [`file_type`](#-apache--fastcgi--server--file_type) +* [`pass_header`](#-apache--fastcgi--server--pass_header) -##### `host` +##### `host` Data type: `String` @@ -7408,7 +7424,7 @@ Determines the FastCGI's hostname or IP address and TCP port number (1-65535). Default value: `'127.0.0.1:9000'` -##### `timeout` +##### `timeout` Data type: `Integer` @@ -7421,7 +7437,7 @@ the client (the response is buffered), the timeout does not apply. Default value: `15` -##### `flush` +##### `flush` Data type: `Boolean` @@ -7429,9 +7445,9 @@ Forces `mod_fastcgi` to write to the client as data is received from the application. By default, `mod_fastcgi` buffers data in order to free the application as quickly as possible. -Default value: ``false`` +Default value: `false` -##### `faux_path` +##### `faux_path` Data type: `Stdlib::Absolutepath` @@ -7440,7 +7456,7 @@ parameter does not have to exist in the local filesystem. Default value: `"/var/www/${name}.fcgi"` -##### `fcgi_alias` +##### `fcgi_alias` Data type: `Stdlib::Unixpath` @@ -7448,7 +7464,7 @@ Internally links actions with the FastCGI server. This alias must be unique. Default value: `"/${name}.fcgi"` -##### `file_type` +##### `file_type` Data type: `String` @@ -7456,20 +7472,20 @@ Sets the MIME `content-type` of the file to be processed by the FastCGI server. Default value: `'application/x-httpd-php'` -##### `pass_header` +##### `pass_header` Data type: `Optional[String]` Sets a header for the server -Default value: ``undef`` +Default value: `undef` -### `apache::listen` +### `apache::listen` The `apache::vhost` class uses this defined type, and titles take the form ``, `:`, or `:`. -### `apache::mod` +### `apache::mod` Checks for or places the module's default configuration files in the Apache server's `module` and `enable` directories. The default locations depend on your operating system. @@ -7478,25 +7494,25 @@ Checks for or places the module's default configuration files in the Apache serv The following parameters are available in the `apache::mod` defined type: -* [`package`](#package) -* [`package_ensure`](#package_ensure) -* [`lib`](#lib) -* [`lib_path`](#lib_path) -* [`loadfile_name`](#loadfile_name) -* [`id`](#id) -* [`loadfiles`](#loadfiles) -* [`path`](#path) +* [`package`](#-apache--mod--package) +* [`package_ensure`](#-apache--mod--package_ensure) +* [`lib`](#-apache--mod--lib) +* [`lib_path`](#-apache--mod--lib_path) +* [`loadfile_name`](#-apache--mod--loadfile_name) +* [`id`](#-apache--mod--id) +* [`loadfiles`](#-apache--mod--loadfiles) +* [`path`](#-apache--mod--path) -##### `package` +##### `package` Data type: `Optional[String]` **Required**.
Names the package Puppet uses to install the Apache module. -Default value: ``undef`` +Default value: `undef` -##### `package_ensure` +##### `package_ensure` Data type: `String` @@ -7504,15 +7520,15 @@ Determines whether Puppet ensures the Apache module should be installed. Default value: `'present'` -##### `lib` +##### `lib` Data type: `Optional[String]` Defines the module's shared object name. Do not configure manually without special reason. -Default value: ``undef`` +Default value: `undef` -##### `lib_path` +##### `lib_path` Data type: `String` @@ -7521,46 +7537,46 @@ without special reason. The `path` parameter overrides this value. Default value: `$apache::lib_path` -##### `loadfile_name` +##### `loadfile_name` Data type: `Optional[String]` Sets the filename for the module's `LoadFile` directive, which can also set the module load order as Apache processes them in alphanumeric order. -Default value: ``undef`` +Default value: `undef` -##### `id` +##### `id` Data type: `Optional[String]` Specifies the package id -Default value: ``undef`` +Default value: `undef` -##### `loadfiles` +##### `loadfiles` Data type: `Optional[Array]` Specifies an array of `LoadFile` directives. -Default value: ``undef`` +Default value: `undef` -##### `path` +##### `path` Data type: `Optional[String]` Specifies a path to the module. Do not manually set this parameter without a special reason. -Default value: ``undef`` +Default value: `undef` -### `apache::namevirtualhost` +### `apache::namevirtualhost` Adds all related directives to the `ports.conf` file in the Apache HTTPD configuration directory. Titles can take the forms `\*`, `\*:\`, `\_default\_:\`, `\`, or `\:\`. -### `apache::vhost` +### `apache::vhost` The apache module allows a lot of flexibility in the setup and configuration of virtual hosts. This flexibility is due, in part, to `vhost` being a defined resource type, which allows Apache @@ -7581,81 +7597,6 @@ override `Apache::Vhost['default']` or `Apache::Vhost['default-ssl]` resources. workaround is to create a vhost named something else, such as `my default`, and ensure that the `default` and `default_ssl` vhosts are set to `false`: -TODO: check, if this Documentation is obsolete -lint:ignore:parameter_documentation -lint:endignore - Specfies mod_auth_gssapi parameters for particular directories in a virtual host directory - ```puppet - apache::vhost { 'sample.example.net': - docroot => '/path/to/directory', - directories => [ - { path => '/path/to/different/dir', - gssapi => { - acceptor_name => '{HOSTNAME}', - allowed_mech => ['krb5', 'iakerb', 'ntlmssp'], - authname => 'Kerberos 5', - authtype => 'GSSAPI', - basic_auth => true, - basic_auth_mech => ['krb5', 'iakerb', 'ntlmssp'], - basic_ticket_timeout => 300, - connection_bound => true, - cred_store => { - ccache => ['/path/to/directory'], - client_keytab => ['/path/to/example.keytab'], - keytab => ['/path/to/example.keytab'], - }, - deleg_ccache_dir => '/path/to/directory', - deleg_ccache_env_var => 'KRB5CCNAME', - deleg_ccache_perms => { - mode => '0600', - uid => 'example-user', - gid => 'example-group', - }, - deleg_ccache_unique => true, - impersonate => true, - local_name => true, - name_attributes => 'json', - negotiate_once => true, - publish_errors => true, - publish_mech => true, - required_name_attributes => 'auth-indicators=high', - session_key => 'file:/path/to/example.key', - signal_persistent_auth => true, - ssl_only => true, - use_s4u2_proxy => true, - use_sessions => true, - } - }, - ], - } - ``` - -lint:ignore:parameter_documentation -lint:endignore - Specifies mod_authz_core parameters for particular directories in a virtual host directory - ```puppet - apache::vhost { 'sample.example.net': - docroot => '/path/to/directory', - directories => [ - { path => '/path/to/different/dir', - authz_core => { - require_all => { - 'require_any' => { - 'require' => ['user superadmin'], - 'require_all' => { - 'require' => ['group admins', 'ldap-group "cn=Administrators,o=Airius"'], - }, - }, - 'require_none' => { - 'require' => ['group temps', 'ldap-group "cn=Temporary Employees,o=Airius"'] - } - } - } - }, - ], - } - ``` - #### Examples ##### @@ -7671,267 +7612,265 @@ class { 'apache': The following parameters are available in the `apache::vhost` defined type: -* [`access_log`](#access_log) -* [`access_log_env_var`](#access_log_env_var) -* [`access_log_file`](#access_log_file) -* [`access_log_format`](#access_log_format) -* [`access_log_pipe`](#access_log_pipe) -* [`access_log_syslog`](#access_log_syslog) -* [`access_logs`](#access_logs) -* [`add_default_charset`](#add_default_charset) -* [`add_listen`](#add_listen) -* [`use_optional_includes`](#use_optional_includes) -* [`aliases`](#aliases) -* [`allow_encoded_slashes`](#allow_encoded_slashes) -* [`block`](#block) -* [`cas_attribute_prefix`](#cas_attribute_prefix) -* [`cas_attribute_delimiter`](#cas_attribute_delimiter) -* [`cas_login_url`](#cas_login_url) -* [`cas_root_proxied_as`](#cas_root_proxied_as) -* [`cas_scrub_request_headers`](#cas_scrub_request_headers) -* [`cas_sso_enabled`](#cas_sso_enabled) -* [`cas_validate_saml`](#cas_validate_saml) -* [`cas_validate_url`](#cas_validate_url) -* [`cas_cookie_path`](#cas_cookie_path) -* [`comment`](#comment) -* [`default_vhost`](#default_vhost) -* [`directoryindex`](#directoryindex) -* [`docroot`](#docroot) -* [`docroot_group`](#docroot_group) -* [`docroot_owner`](#docroot_owner) -* [`docroot_mode`](#docroot_mode) -* [`manage_docroot`](#manage_docroot) -* [`error_log`](#error_log) -* [`error_log_file`](#error_log_file) -* [`error_log_pipe`](#error_log_pipe) -* [`error_log_syslog`](#error_log_syslog) -* [`error_log_format`](#error_log_format) -* [`error_documents`](#error_documents) -* [`ensure`](#ensure) -* [`fallbackresource`](#fallbackresource) -* [`filters`](#filters) -* [`h2_copy_files`](#h2_copy_files) -* [`h2_direct`](#h2_direct) -* [`h2_early_hints`](#h2_early_hints) -* [`h2_max_session_streams`](#h2_max_session_streams) -* [`h2_modern_tls_only`](#h2_modern_tls_only) -* [`h2_push`](#h2_push) -* [`h2_push_diary_size`](#h2_push_diary_size) -* [`h2_push_priority`](#h2_push_priority) -* [`h2_push_resource`](#h2_push_resource) -* [`h2_serialize_headers`](#h2_serialize_headers) -* [`h2_stream_max_mem_size`](#h2_stream_max_mem_size) -* [`h2_tls_cool_down_secs`](#h2_tls_cool_down_secs) -* [`h2_tls_warm_up_size`](#h2_tls_warm_up_size) -* [`h2_upgrade`](#h2_upgrade) -* [`h2_window_size`](#h2_window_size) -* [`ip`](#ip) -* [`ip_based`](#ip_based) -* [`itk`](#itk) -* [`action`](#action) -* [`jk_mounts`](#jk_mounts) -* [`http_protocol_options`](#http_protocol_options) -* [`keepalive`](#keepalive) -* [`keepalive_timeout`](#keepalive_timeout) -* [`max_keepalive_requests`](#max_keepalive_requests) -* [`auth_kerb`](#auth_kerb) -* [`krb_method_negotiate`](#krb_method_negotiate) -* [`krb_method_k5passwd`](#krb_method_k5passwd) -* [`krb_authoritative`](#krb_authoritative) -* [`krb_auth_realms`](#krb_auth_realms) -* [`krb_5keytab`](#krb_5keytab) -* [`krb_local_user_mapping`](#krb_local_user_mapping) -* [`krb_verify_kdc`](#krb_verify_kdc) -* [`krb_servicename`](#krb_servicename) -* [`krb_save_credentials`](#krb_save_credentials) -* [`logroot`](#logroot) -* [`logroot_ensure`](#logroot_ensure) -* [`logroot_mode`](#logroot_mode) -* [`logroot_owner`](#logroot_owner) -* [`logroot_group`](#logroot_group) -* [`log_level`](#log_level) -* [`modsec_body_limit`](#modsec_body_limit) -* [`modsec_disable_vhost`](#modsec_disable_vhost) -* [`modsec_disable_ids`](#modsec_disable_ids) -* [`modsec_disable_ips`](#modsec_disable_ips) -* [`modsec_disable_msgs`](#modsec_disable_msgs) -* [`modsec_disable_tags`](#modsec_disable_tags) -* [`modsec_audit_log_file`](#modsec_audit_log_file) -* [`modsec_audit_log_pipe`](#modsec_audit_log_pipe) -* [`modsec_audit_log`](#modsec_audit_log) -* [`modsec_inbound_anomaly_threshold`](#modsec_inbound_anomaly_threshold) -* [`modsec_outbound_anomaly_threshold`](#modsec_outbound_anomaly_threshold) -* [`modsec_allowed_methods`](#modsec_allowed_methods) -* [`no_proxy_uris`](#no_proxy_uris) -* [`no_proxy_uris_match`](#no_proxy_uris_match) -* [`proxy_preserve_host`](#proxy_preserve_host) -* [`proxy_add_headers`](#proxy_add_headers) -* [`proxy_error_override`](#proxy_error_override) -* [`options`](#options) -* [`override`](#override) -* [`passenger_enabled`](#passenger_enabled) -* [`passenger_base_uri`](#passenger_base_uri) -* [`passenger_ruby`](#passenger_ruby) -* [`passenger_python`](#passenger_python) -* [`passenger_nodejs`](#passenger_nodejs) -* [`passenger_meteor_app_settings`](#passenger_meteor_app_settings) -* [`passenger_app_env`](#passenger_app_env) -* [`passenger_app_root`](#passenger_app_root) -* [`passenger_app_group_name`](#passenger_app_group_name) -* [`passenger_app_start_command`](#passenger_app_start_command) -* [`passenger_app_type`](#passenger_app_type) -* [`passenger_startup_file`](#passenger_startup_file) -* [`passenger_restart_dir`](#passenger_restart_dir) -* [`passenger_spawn_method`](#passenger_spawn_method) -* [`passenger_load_shell_envvars`](#passenger_load_shell_envvars) -* [`passenger_preload_bundler`](#passenger_preload_bundler) -* [`passenger_rolling_restarts`](#passenger_rolling_restarts) -* [`passenger_resist_deployment_errors`](#passenger_resist_deployment_errors) -* [`passenger_user`](#passenger_user) -* [`passenger_group`](#passenger_group) -* [`passenger_friendly_error_pages`](#passenger_friendly_error_pages) -* [`passenger_min_instances`](#passenger_min_instances) -* [`passenger_max_instances`](#passenger_max_instances) -* [`passenger_max_preloader_idle_time`](#passenger_max_preloader_idle_time) -* [`passenger_force_max_concurrent_requests_per_process`](#passenger_force_max_concurrent_requests_per_process) -* [`passenger_start_timeout`](#passenger_start_timeout) -* [`passenger_concurrency_model`](#passenger_concurrency_model) -* [`passenger_thread_count`](#passenger_thread_count) -* [`passenger_max_requests`](#passenger_max_requests) -* [`passenger_max_request_time`](#passenger_max_request_time) -* [`passenger_memory_limit`](#passenger_memory_limit) -* [`passenger_stat_throttle_rate`](#passenger_stat_throttle_rate) -* [`passenger_pre_start`](#passenger_pre_start) -* [`passenger_high_performance`](#passenger_high_performance) -* [`passenger_buffer_upload`](#passenger_buffer_upload) -* [`passenger_buffer_response`](#passenger_buffer_response) -* [`passenger_error_override`](#passenger_error_override) -* [`passenger_max_request_queue_size`](#passenger_max_request_queue_size) -* [`passenger_max_request_queue_time`](#passenger_max_request_queue_time) -* [`passenger_sticky_sessions`](#passenger_sticky_sessions) -* [`passenger_sticky_sessions_cookie_name`](#passenger_sticky_sessions_cookie_name) -* [`passenger_sticky_sessions_cookie_attributes`](#passenger_sticky_sessions_cookie_attributes) -* [`passenger_allow_encoded_slashes`](#passenger_allow_encoded_slashes) -* [`passenger_app_log_file`](#passenger_app_log_file) -* [`passenger_debugger`](#passenger_debugger) -* [`passenger_lve_min_uid`](#passenger_lve_min_uid) -* [`php_values`](#php_values) -* [`php_flags`](#php_flags) -* [`php_admin_values`](#php_admin_values) -* [`php_admin_flags`](#php_admin_flags) -* [`port`](#port) -* [`priority`](#priority) -* [`protocols`](#protocols) -* [`protocols_honor_order`](#protocols_honor_order) -* [`proxy_dest`](#proxy_dest) -* [`proxy_pass`](#proxy_pass) -* [`proxy_dest_match`](#proxy_dest_match) -* [`proxy_dest_reverse_match`](#proxy_dest_reverse_match) -* [`proxy_pass_match`](#proxy_pass_match) -* [`redirect_dest`](#redirect_dest) -* [`redirect_source`](#redirect_source) -* [`redirect_status`](#redirect_status) -* [`redirectmatch_regexp`](#redirectmatch_regexp) -* [`redirectmatch_status`](#redirectmatch_status) -* [`redirectmatch_dest`](#redirectmatch_dest) -* [`request_headers`](#request_headers) -* [`rewrites`](#rewrites) -* [`rewrite_base`](#rewrite_base) -* [`rewrite_rule`](#rewrite_rule) -* [`rewrite_cond`](#rewrite_cond) -* [`rewrite_inherit`](#rewrite_inherit) -* [`scriptalias`](#scriptalias) -* [`scriptaliases`](#scriptaliases) -* [`serveradmin`](#serveradmin) -* [`serveraliases`](#serveraliases) -* [`servername`](#servername) -* [`setenv`](#setenv) -* [`setenvif`](#setenvif) -* [`setenvifnocase`](#setenvifnocase) -* [`suexec_user_group`](#suexec_user_group) -* [`vhost_name`](#vhost_name) -* [`virtual_docroot`](#virtual_docroot) -* [`virtual_use_default_docroot`](#virtual_use_default_docroot) -* [`wsgi_daemon_process`](#wsgi_daemon_process) -* [`wsgi_daemon_process_options`](#wsgi_daemon_process_options) -* [`wsgi_application_group`](#wsgi_application_group) -* [`wsgi_import_script`](#wsgi_import_script) -* [`wsgi_import_script_options`](#wsgi_import_script_options) -* [`wsgi_chunked_request`](#wsgi_chunked_request) -* [`wsgi_process_group`](#wsgi_process_group) -* [`wsgi_script_aliases`](#wsgi_script_aliases) -* [`wsgi_script_aliases_match`](#wsgi_script_aliases_match) -* [`wsgi_pass_authorization`](#wsgi_pass_authorization) -* [`directories`](#directories) -* [`custom_fragment`](#custom_fragment) -* [`headers`](#headers) -* [`shib_compat_valid_user`](#shib_compat_valid_user) -* [`ssl_options`](#ssl_options) -* [`additional_includes`](#additional_includes) -* [`gssapi`](#gssapi) -* [`authz_core`](#authz_core) -* [`ssl`](#ssl) -* [`ssl_ca`](#ssl_ca) -* [`ssl_cert`](#ssl_cert) -* [`ssl_protocol`](#ssl_protocol) -* [`ssl_cipher`](#ssl_cipher) -* [`ssl_honorcipherorder`](#ssl_honorcipherorder) -* [`ssl_certs_dir`](#ssl_certs_dir) -* [`ssl_chain`](#ssl_chain) -* [`ssl_crl`](#ssl_crl) -* [`ssl_crl_path`](#ssl_crl_path) -* [`ssl_crl_check`](#ssl_crl_check) -* [`ssl_key`](#ssl_key) -* [`ssl_verify_client`](#ssl_verify_client) -* [`ssl_verify_depth`](#ssl_verify_depth) -* [`ssl_proxy_protocol`](#ssl_proxy_protocol) -* [`ssl_proxy_verify`](#ssl_proxy_verify) -* [`ssl_proxy_verify_depth`](#ssl_proxy_verify_depth) -* [`ssl_proxy_cipher_suite`](#ssl_proxy_cipher_suite) -* [`ssl_proxy_ca_cert`](#ssl_proxy_ca_cert) -* [`ssl_proxy_machine_cert`](#ssl_proxy_machine_cert) -* [`ssl_proxy_machine_cert_chain`](#ssl_proxy_machine_cert_chain) -* [`ssl_proxy_check_peer_cn`](#ssl_proxy_check_peer_cn) -* [`ssl_proxy_check_peer_name`](#ssl_proxy_check_peer_name) -* [`ssl_proxy_check_peer_expire`](#ssl_proxy_check_peer_expire) -* [`ssl_openssl_conf_cmd`](#ssl_openssl_conf_cmd) -* [`ssl_proxyengine`](#ssl_proxyengine) -* [`ssl_stapling`](#ssl_stapling) -* [`ssl_stapling_timeout`](#ssl_stapling_timeout) -* [`ssl_stapling_return_errors`](#ssl_stapling_return_errors) -* [`ssl_user_name`](#ssl_user_name) -* [`ssl_reload_on_change`](#ssl_reload_on_change) -* [`use_canonical_name`](#use_canonical_name) -* [`define`](#define) -* [`auth_oidc`](#auth_oidc) -* [`oidc_settings`](#oidc_settings) -* [`limitreqfields`](#limitreqfields) -* [`limitreqfieldsize`](#limitreqfieldsize) -* [`limitreqline`](#limitreqline) -* [`limitreqbody`](#limitreqbody) -* [`use_servername_for_filenames`](#use_servername_for_filenames) -* [`use_port_for_filenames`](#use_port_for_filenames) -* [`mdomain`](#mdomain) -* [`proxy_requests`](#proxy_requests) -* [`userdir`](#userdir) - -##### `access_log` +* [`access_log`](#-apache--vhost--access_log) +* [`access_log_env_var`](#-apache--vhost--access_log_env_var) +* [`access_log_file`](#-apache--vhost--access_log_file) +* [`access_log_format`](#-apache--vhost--access_log_format) +* [`access_log_pipe`](#-apache--vhost--access_log_pipe) +* [`access_log_syslog`](#-apache--vhost--access_log_syslog) +* [`access_logs`](#-apache--vhost--access_logs) +* [`add_default_charset`](#-apache--vhost--add_default_charset) +* [`add_listen`](#-apache--vhost--add_listen) +* [`use_optional_includes`](#-apache--vhost--use_optional_includes) +* [`aliases`](#-apache--vhost--aliases) +* [`allow_encoded_slashes`](#-apache--vhost--allow_encoded_slashes) +* [`block`](#-apache--vhost--block) +* [`cas_attribute_prefix`](#-apache--vhost--cas_attribute_prefix) +* [`cas_attribute_delimiter`](#-apache--vhost--cas_attribute_delimiter) +* [`cas_login_url`](#-apache--vhost--cas_login_url) +* [`cas_root_proxied_as`](#-apache--vhost--cas_root_proxied_as) +* [`cas_scrub_request_headers`](#-apache--vhost--cas_scrub_request_headers) +* [`cas_sso_enabled`](#-apache--vhost--cas_sso_enabled) +* [`cas_validate_saml`](#-apache--vhost--cas_validate_saml) +* [`cas_validate_url`](#-apache--vhost--cas_validate_url) +* [`cas_cookie_path`](#-apache--vhost--cas_cookie_path) +* [`comment`](#-apache--vhost--comment) +* [`default_vhost`](#-apache--vhost--default_vhost) +* [`directoryindex`](#-apache--vhost--directoryindex) +* [`docroot`](#-apache--vhost--docroot) +* [`docroot_group`](#-apache--vhost--docroot_group) +* [`docroot_owner`](#-apache--vhost--docroot_owner) +* [`docroot_mode`](#-apache--vhost--docroot_mode) +* [`manage_docroot`](#-apache--vhost--manage_docroot) +* [`error_log`](#-apache--vhost--error_log) +* [`error_log_file`](#-apache--vhost--error_log_file) +* [`error_log_pipe`](#-apache--vhost--error_log_pipe) +* [`error_log_syslog`](#-apache--vhost--error_log_syslog) +* [`error_log_format`](#-apache--vhost--error_log_format) +* [`error_documents`](#-apache--vhost--error_documents) +* [`ensure`](#-apache--vhost--ensure) +* [`fallbackresource`](#-apache--vhost--fallbackresource) +* [`filters`](#-apache--vhost--filters) +* [`h2_copy_files`](#-apache--vhost--h2_copy_files) +* [`h2_direct`](#-apache--vhost--h2_direct) +* [`h2_early_hints`](#-apache--vhost--h2_early_hints) +* [`h2_max_session_streams`](#-apache--vhost--h2_max_session_streams) +* [`h2_modern_tls_only`](#-apache--vhost--h2_modern_tls_only) +* [`h2_push`](#-apache--vhost--h2_push) +* [`h2_push_diary_size`](#-apache--vhost--h2_push_diary_size) +* [`h2_push_priority`](#-apache--vhost--h2_push_priority) +* [`h2_push_resource`](#-apache--vhost--h2_push_resource) +* [`h2_serialize_headers`](#-apache--vhost--h2_serialize_headers) +* [`h2_stream_max_mem_size`](#-apache--vhost--h2_stream_max_mem_size) +* [`h2_tls_cool_down_secs`](#-apache--vhost--h2_tls_cool_down_secs) +* [`h2_tls_warm_up_size`](#-apache--vhost--h2_tls_warm_up_size) +* [`h2_upgrade`](#-apache--vhost--h2_upgrade) +* [`h2_window_size`](#-apache--vhost--h2_window_size) +* [`ip`](#-apache--vhost--ip) +* [`ip_based`](#-apache--vhost--ip_based) +* [`itk`](#-apache--vhost--itk) +* [`action`](#-apache--vhost--action) +* [`jk_mounts`](#-apache--vhost--jk_mounts) +* [`http_protocol_options`](#-apache--vhost--http_protocol_options) +* [`keepalive`](#-apache--vhost--keepalive) +* [`keepalive_timeout`](#-apache--vhost--keepalive_timeout) +* [`max_keepalive_requests`](#-apache--vhost--max_keepalive_requests) +* [`auth_kerb`](#-apache--vhost--auth_kerb) +* [`krb_method_negotiate`](#-apache--vhost--krb_method_negotiate) +* [`krb_method_k5passwd`](#-apache--vhost--krb_method_k5passwd) +* [`krb_authoritative`](#-apache--vhost--krb_authoritative) +* [`krb_auth_realms`](#-apache--vhost--krb_auth_realms) +* [`krb_5keytab`](#-apache--vhost--krb_5keytab) +* [`krb_local_user_mapping`](#-apache--vhost--krb_local_user_mapping) +* [`krb_verify_kdc`](#-apache--vhost--krb_verify_kdc) +* [`krb_servicename`](#-apache--vhost--krb_servicename) +* [`krb_save_credentials`](#-apache--vhost--krb_save_credentials) +* [`logroot`](#-apache--vhost--logroot) +* [`logroot_ensure`](#-apache--vhost--logroot_ensure) +* [`logroot_mode`](#-apache--vhost--logroot_mode) +* [`logroot_owner`](#-apache--vhost--logroot_owner) +* [`logroot_group`](#-apache--vhost--logroot_group) +* [`log_level`](#-apache--vhost--log_level) +* [`modsec_body_limit`](#-apache--vhost--modsec_body_limit) +* [`modsec_disable_vhost`](#-apache--vhost--modsec_disable_vhost) +* [`modsec_disable_ids`](#-apache--vhost--modsec_disable_ids) +* [`modsec_disable_ips`](#-apache--vhost--modsec_disable_ips) +* [`modsec_disable_msgs`](#-apache--vhost--modsec_disable_msgs) +* [`modsec_disable_tags`](#-apache--vhost--modsec_disable_tags) +* [`modsec_audit_log_file`](#-apache--vhost--modsec_audit_log_file) +* [`modsec_audit_log_pipe`](#-apache--vhost--modsec_audit_log_pipe) +* [`modsec_audit_log`](#-apache--vhost--modsec_audit_log) +* [`modsec_inbound_anomaly_threshold`](#-apache--vhost--modsec_inbound_anomaly_threshold) +* [`modsec_outbound_anomaly_threshold`](#-apache--vhost--modsec_outbound_anomaly_threshold) +* [`modsec_allowed_methods`](#-apache--vhost--modsec_allowed_methods) +* [`no_proxy_uris`](#-apache--vhost--no_proxy_uris) +* [`no_proxy_uris_match`](#-apache--vhost--no_proxy_uris_match) +* [`proxy_preserve_host`](#-apache--vhost--proxy_preserve_host) +* [`proxy_add_headers`](#-apache--vhost--proxy_add_headers) +* [`proxy_error_override`](#-apache--vhost--proxy_error_override) +* [`options`](#-apache--vhost--options) +* [`override`](#-apache--vhost--override) +* [`passenger_enabled`](#-apache--vhost--passenger_enabled) +* [`passenger_base_uri`](#-apache--vhost--passenger_base_uri) +* [`passenger_ruby`](#-apache--vhost--passenger_ruby) +* [`passenger_python`](#-apache--vhost--passenger_python) +* [`passenger_nodejs`](#-apache--vhost--passenger_nodejs) +* [`passenger_meteor_app_settings`](#-apache--vhost--passenger_meteor_app_settings) +* [`passenger_app_env`](#-apache--vhost--passenger_app_env) +* [`passenger_app_root`](#-apache--vhost--passenger_app_root) +* [`passenger_app_group_name`](#-apache--vhost--passenger_app_group_name) +* [`passenger_app_start_command`](#-apache--vhost--passenger_app_start_command) +* [`passenger_app_type`](#-apache--vhost--passenger_app_type) +* [`passenger_startup_file`](#-apache--vhost--passenger_startup_file) +* [`passenger_restart_dir`](#-apache--vhost--passenger_restart_dir) +* [`passenger_spawn_method`](#-apache--vhost--passenger_spawn_method) +* [`passenger_load_shell_envvars`](#-apache--vhost--passenger_load_shell_envvars) +* [`passenger_preload_bundler`](#-apache--vhost--passenger_preload_bundler) +* [`passenger_rolling_restarts`](#-apache--vhost--passenger_rolling_restarts) +* [`passenger_resist_deployment_errors`](#-apache--vhost--passenger_resist_deployment_errors) +* [`passenger_user`](#-apache--vhost--passenger_user) +* [`passenger_group`](#-apache--vhost--passenger_group) +* [`passenger_friendly_error_pages`](#-apache--vhost--passenger_friendly_error_pages) +* [`passenger_min_instances`](#-apache--vhost--passenger_min_instances) +* [`passenger_max_instances`](#-apache--vhost--passenger_max_instances) +* [`passenger_max_preloader_idle_time`](#-apache--vhost--passenger_max_preloader_idle_time) +* [`passenger_force_max_concurrent_requests_per_process`](#-apache--vhost--passenger_force_max_concurrent_requests_per_process) +* [`passenger_start_timeout`](#-apache--vhost--passenger_start_timeout) +* [`passenger_concurrency_model`](#-apache--vhost--passenger_concurrency_model) +* [`passenger_thread_count`](#-apache--vhost--passenger_thread_count) +* [`passenger_max_requests`](#-apache--vhost--passenger_max_requests) +* [`passenger_max_request_time`](#-apache--vhost--passenger_max_request_time) +* [`passenger_memory_limit`](#-apache--vhost--passenger_memory_limit) +* [`passenger_stat_throttle_rate`](#-apache--vhost--passenger_stat_throttle_rate) +* [`passenger_pre_start`](#-apache--vhost--passenger_pre_start) +* [`passenger_high_performance`](#-apache--vhost--passenger_high_performance) +* [`passenger_buffer_upload`](#-apache--vhost--passenger_buffer_upload) +* [`passenger_buffer_response`](#-apache--vhost--passenger_buffer_response) +* [`passenger_error_override`](#-apache--vhost--passenger_error_override) +* [`passenger_max_request_queue_size`](#-apache--vhost--passenger_max_request_queue_size) +* [`passenger_max_request_queue_time`](#-apache--vhost--passenger_max_request_queue_time) +* [`passenger_sticky_sessions`](#-apache--vhost--passenger_sticky_sessions) +* [`passenger_sticky_sessions_cookie_name`](#-apache--vhost--passenger_sticky_sessions_cookie_name) +* [`passenger_sticky_sessions_cookie_attributes`](#-apache--vhost--passenger_sticky_sessions_cookie_attributes) +* [`passenger_allow_encoded_slashes`](#-apache--vhost--passenger_allow_encoded_slashes) +* [`passenger_app_log_file`](#-apache--vhost--passenger_app_log_file) +* [`passenger_debugger`](#-apache--vhost--passenger_debugger) +* [`passenger_lve_min_uid`](#-apache--vhost--passenger_lve_min_uid) +* [`php_values`](#-apache--vhost--php_values) +* [`php_flags`](#-apache--vhost--php_flags) +* [`php_admin_values`](#-apache--vhost--php_admin_values) +* [`php_admin_flags`](#-apache--vhost--php_admin_flags) +* [`port`](#-apache--vhost--port) +* [`priority`](#-apache--vhost--priority) +* [`protocols`](#-apache--vhost--protocols) +* [`protocols_honor_order`](#-apache--vhost--protocols_honor_order) +* [`proxy_dest`](#-apache--vhost--proxy_dest) +* [`proxy_pass`](#-apache--vhost--proxy_pass) +* [`proxy_dest_match`](#-apache--vhost--proxy_dest_match) +* [`proxy_dest_reverse_match`](#-apache--vhost--proxy_dest_reverse_match) +* [`proxy_pass_match`](#-apache--vhost--proxy_pass_match) +* [`redirect_dest`](#-apache--vhost--redirect_dest) +* [`redirect_source`](#-apache--vhost--redirect_source) +* [`redirect_status`](#-apache--vhost--redirect_status) +* [`redirectmatch_regexp`](#-apache--vhost--redirectmatch_regexp) +* [`redirectmatch_status`](#-apache--vhost--redirectmatch_status) +* [`redirectmatch_dest`](#-apache--vhost--redirectmatch_dest) +* [`request_headers`](#-apache--vhost--request_headers) +* [`rewrites`](#-apache--vhost--rewrites) +* [`rewrite_base`](#-apache--vhost--rewrite_base) +* [`rewrite_rule`](#-apache--vhost--rewrite_rule) +* [`rewrite_cond`](#-apache--vhost--rewrite_cond) +* [`rewrite_inherit`](#-apache--vhost--rewrite_inherit) +* [`scriptalias`](#-apache--vhost--scriptalias) +* [`scriptaliases`](#-apache--vhost--scriptaliases) +* [`serveradmin`](#-apache--vhost--serveradmin) +* [`serveraliases`](#-apache--vhost--serveraliases) +* [`servername`](#-apache--vhost--servername) +* [`setenv`](#-apache--vhost--setenv) +* [`setenvif`](#-apache--vhost--setenvif) +* [`setenvifnocase`](#-apache--vhost--setenvifnocase) +* [`suexec_user_group`](#-apache--vhost--suexec_user_group) +* [`vhost_name`](#-apache--vhost--vhost_name) +* [`virtual_docroot`](#-apache--vhost--virtual_docroot) +* [`virtual_use_default_docroot`](#-apache--vhost--virtual_use_default_docroot) +* [`wsgi_daemon_process`](#-apache--vhost--wsgi_daemon_process) +* [`wsgi_daemon_process_options`](#-apache--vhost--wsgi_daemon_process_options) +* [`wsgi_application_group`](#-apache--vhost--wsgi_application_group) +* [`wsgi_import_script`](#-apache--vhost--wsgi_import_script) +* [`wsgi_import_script_options`](#-apache--vhost--wsgi_import_script_options) +* [`wsgi_chunked_request`](#-apache--vhost--wsgi_chunked_request) +* [`wsgi_process_group`](#-apache--vhost--wsgi_process_group) +* [`wsgi_script_aliases`](#-apache--vhost--wsgi_script_aliases) +* [`wsgi_script_aliases_match`](#-apache--vhost--wsgi_script_aliases_match) +* [`wsgi_pass_authorization`](#-apache--vhost--wsgi_pass_authorization) +* [`directories`](#-apache--vhost--directories) +* [`custom_fragment`](#-apache--vhost--custom_fragment) +* [`headers`](#-apache--vhost--headers) +* [`shib_compat_valid_user`](#-apache--vhost--shib_compat_valid_user) +* [`ssl_options`](#-apache--vhost--ssl_options) +* [`additional_includes`](#-apache--vhost--additional_includes) +* [`ssl`](#-apache--vhost--ssl) +* [`ssl_ca`](#-apache--vhost--ssl_ca) +* [`ssl_cert`](#-apache--vhost--ssl_cert) +* [`ssl_protocol`](#-apache--vhost--ssl_protocol) +* [`ssl_cipher`](#-apache--vhost--ssl_cipher) +* [`ssl_honorcipherorder`](#-apache--vhost--ssl_honorcipherorder) +* [`ssl_certs_dir`](#-apache--vhost--ssl_certs_dir) +* [`ssl_chain`](#-apache--vhost--ssl_chain) +* [`ssl_crl`](#-apache--vhost--ssl_crl) +* [`ssl_crl_path`](#-apache--vhost--ssl_crl_path) +* [`ssl_crl_check`](#-apache--vhost--ssl_crl_check) +* [`ssl_key`](#-apache--vhost--ssl_key) +* [`ssl_verify_client`](#-apache--vhost--ssl_verify_client) +* [`ssl_verify_depth`](#-apache--vhost--ssl_verify_depth) +* [`ssl_proxy_protocol`](#-apache--vhost--ssl_proxy_protocol) +* [`ssl_proxy_verify`](#-apache--vhost--ssl_proxy_verify) +* [`ssl_proxy_verify_depth`](#-apache--vhost--ssl_proxy_verify_depth) +* [`ssl_proxy_cipher_suite`](#-apache--vhost--ssl_proxy_cipher_suite) +* [`ssl_proxy_ca_cert`](#-apache--vhost--ssl_proxy_ca_cert) +* [`ssl_proxy_machine_cert`](#-apache--vhost--ssl_proxy_machine_cert) +* [`ssl_proxy_machine_cert_chain`](#-apache--vhost--ssl_proxy_machine_cert_chain) +* [`ssl_proxy_check_peer_cn`](#-apache--vhost--ssl_proxy_check_peer_cn) +* [`ssl_proxy_check_peer_name`](#-apache--vhost--ssl_proxy_check_peer_name) +* [`ssl_proxy_check_peer_expire`](#-apache--vhost--ssl_proxy_check_peer_expire) +* [`ssl_openssl_conf_cmd`](#-apache--vhost--ssl_openssl_conf_cmd) +* [`ssl_proxyengine`](#-apache--vhost--ssl_proxyengine) +* [`ssl_stapling`](#-apache--vhost--ssl_stapling) +* [`ssl_stapling_timeout`](#-apache--vhost--ssl_stapling_timeout) +* [`ssl_stapling_return_errors`](#-apache--vhost--ssl_stapling_return_errors) +* [`ssl_user_name`](#-apache--vhost--ssl_user_name) +* [`ssl_reload_on_change`](#-apache--vhost--ssl_reload_on_change) +* [`use_canonical_name`](#-apache--vhost--use_canonical_name) +* [`define`](#-apache--vhost--define) +* [`auth_oidc`](#-apache--vhost--auth_oidc) +* [`oidc_settings`](#-apache--vhost--oidc_settings) +* [`limitreqfields`](#-apache--vhost--limitreqfields) +* [`limitreqfieldsize`](#-apache--vhost--limitreqfieldsize) +* [`limitreqline`](#-apache--vhost--limitreqline) +* [`limitreqbody`](#-apache--vhost--limitreqbody) +* [`use_servername_for_filenames`](#-apache--vhost--use_servername_for_filenames) +* [`use_port_for_filenames`](#-apache--vhost--use_port_for_filenames) +* [`mdomain`](#-apache--vhost--mdomain) +* [`proxy_requests`](#-apache--vhost--proxy_requests) +* [`userdir`](#-apache--vhost--userdir) + +##### `access_log` Data type: `Boolean` Determines whether to configure `*_access.log` directives (`*_file`, `*_pipe`, or `*_syslog`). -Default value: ``true`` +Default value: `true` -##### `access_log_env_var` +##### `access_log_env_var` Data type: `Optional[Variant[Boolean, String]]` Specifies that only requests with particular environment variables be logged. -Default value: ``undef`` +Default value: `undef` -##### `access_log_file` +##### `access_log_file` Data type: `Optional[String[1]]` @@ -7940,52 +7879,52 @@ instance, example.com--- it defaults to 'example.com_ssl.log' for [SSL-encrypted](https://httpd.apache.org/docs/current/ssl/index.html) virtual hosts and `example.com_access.log` for unencrypted virtual hosts. -Default value: ``undef`` +Default value: `undef` -##### `access_log_format` +##### `access_log_format` Data type: `Optional[String[1]]` Specifies the use of either a `LogFormat` nickname or a custom-formatted string for the access log. -Default value: ``undef`` +Default value: `undef` -##### `access_log_pipe` +##### `access_log_pipe` Data type: `Optional[String[1]]` Specifies a pipe where Apache sends access log messages. -Default value: ``undef`` +Default value: `undef` -##### `access_log_syslog` +##### `access_log_syslog` Data type: `Optional[Variant[String, Boolean]]` Sends all access log messages to syslog. -Default value: ``undef`` +Default value: `undef` -##### `access_logs` +##### `access_logs` Data type: `Optional[Array[Hash]]` Allows you to give a hash that specifies the state of each of the `access_log_*` directives shown above, i.e. `access_log_pipe` and `access_log_syslog`. -Default value: ``undef`` +Default value: `undef` -##### `add_default_charset` +##### `add_default_charset` Data type: `Optional[String]` Sets a default media charset value for the `AddDefaultCharset` directive, which is added to `text/plain` and `text/html` responses. -Default value: ``undef`` +Default value: `undef` -##### `add_listen` +##### `add_listen` Data type: `Boolean` @@ -7994,9 +7933,9 @@ Setting `add_listen` to `false` prevents the virtual host from creating a `Liste statement. This is important when combining virtual hosts that aren't passed an `ip` parameter with those that are. -Default value: ``true`` +Default value: `true` -##### `use_optional_includes` +##### `use_optional_includes` Data type: `Boolean` @@ -8005,7 +7944,7 @@ Specifies whether Apache uses the `IncludeOptional` directive instead of `Includ Default value: `$apache::use_optional_includes` -##### `aliases` +##### `aliases` Data type: `Array[Hash[String[1], String[1]]]` @@ -8048,7 +7987,7 @@ directive might not be able to honor the `PassengerEnabled => off` statement. Se Default value: `[]` -##### `allow_encoded_slashes` +##### `allow_encoded_slashes` Data type: `Optional[Variant[Apache::OnOff, Enum['nodecode']]]` @@ -8057,9 +7996,9 @@ default. This modifies the virtual host responses to URLs with `\` and `/` chara default setting omits the declaration from the server configuration and selects the Apache default setting of `Off`. -Default value: ``undef`` +Default value: `undef` -##### `block` +##### `block` Data type: `Variant[Array[String], String]` @@ -8068,83 +8007,83 @@ blocks web access to `.svn`), `.git`, and `.bzr` directories. Default value: `[]` -##### `cas_attribute_prefix` +##### `cas_attribute_prefix` Data type: `Optional[String]` Adds a header with the value of this header being the attribute values when SAML validation is enabled. -Default value: ``undef`` +Default value: `undef` -##### `cas_attribute_delimiter` +##### `cas_attribute_delimiter` Data type: `Optional[String]` Sets the delimiter between attribute values in the header created by `cas_attribute_prefix`. -Default value: ``undef`` +Default value: `undef` -##### `cas_login_url` +##### `cas_login_url` Data type: `Optional[String]` Sets the URL to which the module redirects users when they attempt to access a CAS-protected resource and don't have an active session. -Default value: ``undef`` +Default value: `undef` -##### `cas_root_proxied_as` +##### `cas_root_proxied_as` Data type: `Optional[String]` Sets the URL end users see when access to this Apache server is proxied per vhost. This URL should not include a trailing slash. -Default value: ``undef`` +Default value: `undef` -##### `cas_scrub_request_headers` +##### `cas_scrub_request_headers` Data type: `Boolean` Remove inbound request headers that may have special meaning within mod_auth_cas. -Default value: ``false`` +Default value: `false` -##### `cas_sso_enabled` +##### `cas_sso_enabled` Data type: `Boolean` Enables experimental support for single sign out (may mangle POST data). -Default value: ``false`` +Default value: `false` -##### `cas_validate_saml` +##### `cas_validate_saml` Data type: `Boolean` Parse response from CAS server for SAML. -Default value: ``false`` +Default value: `false` -##### `cas_validate_url` +##### `cas_validate_url` Data type: `Optional[String]` Sets the URL to use when validating a client-presented ticket in an HTTP query string. -Default value: ``undef`` +Default value: `undef` -##### `cas_cookie_path` +##### `cas_cookie_path` Data type: `Optional[String]` Sets the location where information on the current session should be stored. This should be writable by the web server only. -Default value: ``undef`` +Default value: `undef` -##### `comment` +##### `comment` Data type: `Optional[Variant[String, Array[String]]]` @@ -8161,18 +8100,18 @@ comment => [ ] ``` -Default value: ``undef`` +Default value: `undef` -##### `default_vhost` +##### `default_vhost` Data type: `Boolean` Sets a given `apache::vhost` defined type as the default to serve requests that do not match any other `apache::vhost` defined types. -Default value: ``false`` +Default value: `false` -##### `directoryindex` +##### `directoryindex` Data type: `Optional[String]` @@ -8180,9 +8119,9 @@ Sets the list of resources to look for when a client requests an index of the di by specifying a '/' at the end of the directory name. See the `DirectoryIndex` directive documentation for details. -Default value: ``undef`` +Default value: `undef` -##### `docroot` +##### `docroot` Data type: `Variant[Stdlib::Absolutepath, Boolean]` @@ -8191,7 +8130,7 @@ Sets the `DocumentRoot` location, from which Apache serves files.
If `docroot` and `manage_docroot` are both set to `false`, no `DocumentRoot` will be set and the accompanying `` block will not be created. -##### `docroot_group` +##### `docroot_group` Data type: `String` @@ -8199,7 +8138,7 @@ Sets group access to the `docroot` directory. Default value: `$apache::params::root_group` -##### `docroot_owner` +##### `docroot_owner` Data type: `String` @@ -8207,31 +8146,31 @@ Sets individual user access to the `docroot` directory. Default value: `'root'` -##### `docroot_mode` +##### `docroot_mode` Data type: `Optional[Stdlib::Filemode]` Sets access permissions for the `docroot` directory, in numeric notation. -Default value: ``undef`` +Default value: `undef` -##### `manage_docroot` +##### `manage_docroot` Data type: `Boolean` Determines whether Puppet manages the `docroot` directory. -Default value: ``true`` +Default value: `true` -##### `error_log` +##### `error_log` Data type: `Boolean` Specifies whether `*_error.log` directives should be configured. -Default value: ``true`` +Default value: `true` -##### `error_log_file` +##### `error_log_file` Data type: `Optional[String]` @@ -8241,9 +8180,9 @@ If none of these parameters is set, given a virtual host `example.com`, Puppet d to `$logroot/example.com_error_ssl.log` for SSL virtual hosts and `$logroot/example.com_error.log` for non-SSL virtual hosts. -Default value: ``undef`` +Default value: `undef` -##### `error_log_pipe` +##### `error_log_pipe` Data type: `Optional[String]` @@ -8251,9 +8190,9 @@ Specifies a pipe to send error log messages to.
This parameter has no effect if the `error_log_file` parameter has a value. If neither this parameter nor `error_log_file` has a value, Puppet then checks `error_log_syslog`. -Default value: ``undef`` +Default value: `undef` -##### `error_log_syslog` +##### `error_log_syslog` Data type: `Optional[Variant[String, Boolean]]` @@ -8263,18 +8202,22 @@ parameters has a value. If none of these parameters has a value, given a virtual `example.com`, Puppet defaults to `$logroot/example.com_error_ssl.log` for SSL virtual hosts and `$logroot/example.com_error.log` for non-SSL virtual hosts. -Default value: ``undef`` +Default value: `undef` + +##### `error_log_format` -##### `error_log_format` +Data type: -Data type: `Optional[ +```puppet +Optional[ Array[ Variant[ String, Hash[String, Enum['connection', 'request']] ] ] - ]` + ] +``` Sets the [ErrorLogFormat](https://httpd.apache.org/docs/current/mod/core.html#errorlogformat) format specification for error log entries inside virtual host @@ -8292,9 +8235,9 @@ apache::vhost { 'site.name.fdqn': } ``` -Default value: ``undef`` +Default value: `undef` -##### `error_documents` +##### `error_documents` Data type: `Variant[Array[Hash], String]` @@ -8313,7 +8256,7 @@ apache::vhost { 'sample.example.net': Default value: `[]` -##### `ensure` +##### `ensure` Data type: `Enum['absent', 'present']` @@ -8321,7 +8264,7 @@ Specifies if the virtual host is present or absent.
Default value: `'present'` -##### `fallbackresource` +##### `fallbackresource` Data type: `Optional[Variant[Stdlib::Absolutepath, Enum['disabled']]]` @@ -8330,9 +8273,9 @@ directive, which specifies an action to take for any URL that doesn't map to any your filesystem and would otherwise return 'HTTP 404 (Not Found)'. Values must either begin with a `/` or be `disabled`. -Default value: ``undef`` +Default value: `undef` -##### `filters` +##### `filters` Data type: `Array[String[1]]` @@ -8351,25 +8294,25 @@ apache::vhost { "$::fqdn": Default value: `[]` -##### `h2_copy_files` +##### `h2_copy_files` Data type: `Optional[Boolean]` Sets the [H2CopyFiles](https://httpd.apache.org/docs/current/mod/mod_http2.html#h2copyfiles) directive which influences how the requestion process pass files to the main connection. -Default value: ``undef`` +Default value: `undef` -##### `h2_direct` +##### `h2_direct` Data type: `Optional[Boolean]` Sets the [H2Direct](https://httpd.apache.org/docs/current/mod/mod_http2.html#h2direct) directive which toggles the usage of the HTTP/2 Direct Mode. -Default value: ``undef`` +Default value: `undef` -##### `h2_early_hints` +##### `h2_early_hints` Data type: `Optional[Boolean]` @@ -8377,9 +8320,9 @@ Sets the [H2EarlyHints](https://httpd.apache.org/docs/current/mod/mod_http2.html directive which controls if HTTP status 103 interim responses are forwarded to the client or not. -Default value: ``undef`` +Default value: `undef` -##### `h2_max_session_streams` +##### `h2_max_session_streams` Data type: `Optional[Integer]` @@ -8387,27 +8330,27 @@ Sets the [H2MaxSessionStreams](https://httpd.apache.org/docs/current/mod/mod_htt directive which sets the maximum number of active streams per HTTP/2 session that the server allows. -Default value: ``undef`` +Default value: `undef` -##### `h2_modern_tls_only` +##### `h2_modern_tls_only` Data type: `Optional[Boolean]` Sets the [H2ModernTLSOnly](https://httpd.apache.org/docs/current/mod/mod_http2.html#h2moderntlsonly) directive which toggles the security checks on HTTP/2 connections in TLS mode. -Default value: ``undef`` +Default value: `undef` -##### `h2_push` +##### `h2_push` Data type: `Optional[Boolean]` Sets the [H2Push](https://httpd.apache.org/docs/current/mod/mod_http2.html#h2push) directive which toggles the usage of the HTTP/2 server push protocol feature. -Default value: ``undef`` +Default value: `undef` -##### `h2_push_diary_size` +##### `h2_push_diary_size` Data type: `Optional[Integer]` @@ -8415,9 +8358,9 @@ Sets the [H2PushDiarySize](https://httpd.apache.org/docs/current/mod/mod_http2.h directive which toggles the maximum number of HTTP/2 server pushes that are remembered per HTTP/2 connection. -Default value: ``undef`` +Default value: `undef` -##### `h2_push_priority` +##### `h2_push_priority` Data type: `Array[String]` @@ -8427,7 +8370,7 @@ content-type of the response. Default value: `[]` -##### `h2_push_resource` +##### `h2_push_resource` Data type: `Array[String]` @@ -8436,7 +8379,7 @@ directive which declares resources for early pushing to the client. Default value: `[]` -##### `h2_serialize_headers` +##### `h2_serialize_headers` Data type: `Optional[Boolean]` @@ -8444,9 +8387,9 @@ Sets the [H2SerializeHeaders](https://httpd.apache.org/docs/current/mod/mod_http directive which toggles if HTTP/2 requests are serialized in HTTP/1.1 format for processing by httpd core. -Default value: ``undef`` +Default value: `undef` -##### `h2_stream_max_mem_size` +##### `h2_stream_max_mem_size` Data type: `Optional[Integer]` @@ -8454,9 +8397,9 @@ Sets the [H2StreamMaxMemSize](https://httpd.apache.org/docs/current/mod/mod_http directive which sets the maximum number of outgoing data bytes buffered in memory for an active stream. -Default value: ``undef`` +Default value: `undef` -##### `h2_tls_cool_down_secs` +##### `h2_tls_cool_down_secs` Data type: `Optional[Integer]` @@ -8464,9 +8407,9 @@ Sets the [H2TLSCoolDownSecs](https://httpd.apache.org/docs/current/mod/mod_http2 directive which sets the number of seconds of idle time on a TLS connection before the TLS write size falls back to a small (~1300 bytes) length. -Default value: ``undef`` +Default value: `undef` -##### `h2_tls_warm_up_size` +##### `h2_tls_warm_up_size` Data type: `Optional[Integer]` @@ -8474,9 +8417,9 @@ Sets the [H2TLSWarmUpSize](https://httpd.apache.org/docs/current/mod/mod_http2.h directive which sets the number of bytes to be sent in small TLS records (~1300 bytes) until doing maximum sized writes (16k) on https: HTTP/2 connections. -Default value: ``undef`` +Default value: `undef` -##### `h2_upgrade` +##### `h2_upgrade` Data type: `Optional[Boolean]` @@ -8484,9 +8427,9 @@ Sets the [H2Upgrade](https://httpd.apache.org/docs/current/mod/mod_http2.html#h2 directive which toggles the usage of the HTTP/1.1 Upgrade method for switching to HTTP/2. -Default value: ``undef`` +Default value: `undef` -##### `h2_window_size` +##### `h2_window_size` Data type: `Optional[Integer]` @@ -8494,23 +8437,27 @@ Sets the [H2WindowSize](https://httpd.apache.org/docs/current/mod/mod_http2.html directive which sets the size of the window that is used for flow control from client to server and limits the amount of data the server has to buffer. -Default value: ``undef`` +Default value: `undef` + +##### `ip` -##### `ip` +Data type: -Data type: `Optional[ +```puppet +Optional[ Variant[ Array[Variant[Stdlib::IP::Address, Enum['*']]], Variant[Stdlib::IP::Address, Enum['*']] ] - ]` + ] +``` Sets the IP address the virtual host listens on. By default, uses Apache's default behavior of listening on all IPs. -Default value: ``undef`` +Default value: `undef` -##### `ip_based` +##### `ip_based` Data type: `Boolean` @@ -8518,9 +8465,9 @@ Enables an [IP-based](https://httpd.apache.org/docs/current/vhosts/ip-based.html host. This parameter inhibits the creation of a NameVirtualHost directive, since those are used to funnel requests to name-based virtual hosts. -Default value: ``false`` +Default value: `false` -##### `itk` +##### `itk` Data type: `Optional[Hash]` @@ -8544,18 +8491,18 @@ Valid values are: a hash, which can include the keys: * `limituidrange` (Linux 3.5.0 or newer) * `limitgidrange` (Linux 3.5.0 or newer) -Default value: ``undef`` +Default value: `undef` -##### `action` +##### `action` Data type: `Optional[String]` Specifies whether you wish to configure mod_actions action directive which will activate cgi-script when triggered by a request. -Default value: ``undef`` +Default value: `undef` -##### `jk_mounts` +##### `jk_mounts` Data type: `Array[Hash]` @@ -8575,15 +8522,15 @@ apache::vhost { 'sample.example.net': Default value: `[]` -##### `http_protocol_options` +##### `http_protocol_options` Data type: `Optional[Pattern[/^((Strict|Unsafe)?\s*(\b(Registered|Lenient)Methods)?\s*(\b(Allow0\.9|Require1\.0))?)$/]]` Specifies the strictness of HTTP protocol checks. -Default value: ``undef`` +Default value: `undef` -##### `keepalive` +##### `keepalive` Data type: `Optional[Apache::OnOff]` @@ -8592,9 +8539,9 @@ for the virtual host. By default, the global, server-wide `KeepAlive` setting is Use the `keepalive_timeout` and `max_keepalive_requests` parameters to set relevant options for the virtual host. -Default value: ``undef`` +Default value: `undef` -##### `keepalive_timeout` +##### `keepalive_timeout` Data type: `Optional[Variant[Integer, String]]` @@ -8604,9 +8551,9 @@ global, server-wide `KeepAlive` setting is in effect.
This parameter is only relevant if either the global, server-wide `keepalive` parameter or the per-vhost `keepalive` parameter is enabled. -Default value: ``undef`` +Default value: `undef` -##### `max_keepalive_requests` +##### `max_keepalive_requests` Data type: `Optional[Variant[Integer, String]]` @@ -8615,9 +8562,9 @@ the global, server-wide `KeepAlive` setting is in effect.
This parameter is only relevant if either the global, server-wide `keepalive` parameter or the per-vhost `keepalive` parameter is enabled. -Default value: ``undef`` +Default value: `undef` -##### `auth_kerb` +##### `auth_kerb` Data type: `Boolean` @@ -8640,9 +8587,9 @@ apache::vhost { 'sample.example.net': } ``` -Default value: ``false`` +Default value: `false` -##### `krb_method_negotiate` +##### `krb_method_negotiate` Data type: `Apache::OnOff` @@ -8650,7 +8597,7 @@ Determines whether to use the Negotiate method. Default value: `'on'` -##### `krb_method_k5passwd` +##### `krb_method_k5passwd` Data type: `Apache::OnOff` @@ -8658,7 +8605,7 @@ Determines whether to use password-based authentication for Kerberos v5. Default value: `'on'` -##### `krb_authoritative` +##### `krb_authoritative` Data type: `Apache::OnOff` @@ -8666,7 +8613,7 @@ If set to `off`, authentication controls can be passed on to another module. Default value: `'on'` -##### `krb_auth_realms` +##### `krb_auth_realms` Data type: `Array[String]` @@ -8674,23 +8621,23 @@ Specifies an array of Kerberos realms to use for authentication. Default value: `[]` -##### `krb_5keytab` +##### `krb_5keytab` Data type: `Optional[String]` Specifies the Kerberos v5 keytab file's location. -Default value: ``undef`` +Default value: `undef` -##### `krb_local_user_mapping` +##### `krb_local_user_mapping` Data type: `Optional[Apache::OnOff]` Strips @REALM from usernames for further use. -Default value: ``undef`` +Default value: `undef` -##### `krb_verify_kdc` +##### `krb_verify_kdc` Data type: `Apache::OnOff` @@ -8699,7 +8646,7 @@ KDC spoofing attacks. Default value: `'on'` -##### `krb_servicename` +##### `krb_servicename` Data type: `String` @@ -8708,7 +8655,7 @@ key of this name must be stored in the keytab. Default value: `'HTTP'` -##### `krb_save_credentials` +##### `krb_save_credentials` Data type: `Apache::OnOff` @@ -8716,7 +8663,7 @@ This option enables credential saving functionality. Default value: `'off'` -##### `logroot` +##### `logroot` Data type: `Stdlib::Absolutepath` @@ -8724,7 +8671,7 @@ Specifies the location of the virtual host's logfiles. Default value: `$apache::logroot` -##### `logroot_ensure` +##### `logroot_ensure` Data type: `Enum['directory', 'absent']` @@ -8732,7 +8679,7 @@ Determines whether or not to remove the logroot directory for a virtual host. Default value: `'directory'` -##### `logroot_mode` +##### `logroot_mode` Data type: `Optional[Stdlib::Filemode]` @@ -8740,49 +8687,49 @@ Overrides the mode the logroot directory is set to. Do *not* grant write access directory the logs are stored in without being aware of the consequences; for more information, see [Apache's log security documentation](https://httpd.apache.org/docs/2.4/logs.html#security). -Default value: ``undef`` +Default value: `undef` -##### `logroot_owner` +##### `logroot_owner` Data type: `Optional[String]` Sets individual user access to the logroot directory. -Default value: ``undef`` +Default value: `undef` -##### `logroot_group` +##### `logroot_group` Data type: `Optional[String]` Sets group access to the `logroot` directory. -Default value: ``undef`` +Default value: `undef` -##### `log_level` +##### `log_level` Data type: `Optional[Apache::LogLevel]` Specifies the verbosity of the error log. -Default value: ``undef`` +Default value: `undef` -##### `modsec_body_limit` +##### `modsec_body_limit` Data type: `Optional[String]` Configures the maximum request body size (in bytes) ModSecurity accepts for buffering. -Default value: ``undef`` +Default value: `undef` -##### `modsec_disable_vhost` +##### `modsec_disable_vhost` Data type: `Boolean` Disables `mod_security` on a virtual host. Only valid if `apache::mod::security` is included. -Default value: ``false`` +Default value: `false` -##### `modsec_disable_ids` +##### `modsec_disable_ids` Data type: `Optional[Variant[Hash, Array]]` @@ -8800,9 +8747,9 @@ apache::vhost { 'sample.example.net': } ``` -Default value: ``undef`` +Default value: `undef` -##### `modsec_disable_ips` +##### `modsec_disable_ips` Data type: `Array[String[1]]` @@ -8810,7 +8757,7 @@ Specifies an array of IP addresses to exclude from `mod_security` rule matching. Default value: `[]` -##### `modsec_disable_msgs` +##### `modsec_disable_msgs` Data type: `Optional[Variant[Hash, Array]]` @@ -8827,9 +8774,9 @@ apache::vhost { 'sample.example.net': } ``` -Default value: ``undef`` +Default value: `undef` -##### `modsec_disable_tags` +##### `modsec_disable_tags` Data type: `Optional[Variant[Hash, Array]]` @@ -8846,9 +8793,9 @@ apache::vhost { 'sample.example.net': } ``` -Default value: ``undef`` +Default value: `undef` -##### `modsec_audit_log_file` +##### `modsec_audit_log_file` Data type: `Optional[String]` @@ -8858,9 +8805,9 @@ log ([SecAuditLog](https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manu If none of those parameters are set, the global audit log is used (`/var/log/httpd/modsec\_audit.log`; Debian and derivatives: `/var/log/apache2/modsec\_audit.log`; others: ). -Default value: ``undef`` +Default value: `undef` -##### `modsec_audit_log_pipe` +##### `modsec_audit_log_pipe` Data type: `Optional[String]` @@ -8871,9 +8818,9 @@ log ([SecAuditLog](https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manu If none of those parameters are set, the global audit log is used (`/var/log/httpd/modsec\_audit.log`; Debian and derivatives: `/var/log/apache2/modsec\_audit.log`; others: ). -Default value: ``undef`` +Default value: `undef` -##### `modsec_audit_log` +##### `modsec_audit_log` Data type: `Optional[Variant[String, Boolean]]` @@ -8885,9 +8832,9 @@ log ([SecAuditLog](https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manu If none of those parameters are set, the global audit log is used (`/var/log/httpd/modsec\_audit.log`; Debian and derivatives: `/var/log/apache2/modsec\_audit.log`; others: ). -Default value: ``undef`` +Default value: `undef` -##### `modsec_inbound_anomaly_threshold` +##### `modsec_inbound_anomaly_threshold` Data type: `Optional[Integer[1, default]]` @@ -8895,9 +8842,9 @@ Override the global scoring threshold level of the inbound blocking rules for the Collaborative Detection Mode in the OWASP ModSecurity Core Rule Set. -Default value: ``undef`` +Default value: `undef` -##### `modsec_outbound_anomaly_threshold` +##### `modsec_outbound_anomaly_threshold` Data type: `Optional[Integer[1, default]]` @@ -8905,17 +8852,17 @@ Override the global scoring threshold level of the outbound blocking rules for the Collaborative Detection Mode in the OWASP ModSecurity Core Rule Set. -Default value: ``undef`` +Default value: `undef` -##### `modsec_allowed_methods` +##### `modsec_allowed_methods` Data type: `Optional[String]` Override global allowed methods. A space-separated list of allowed HTTP methods. -Default value: ``undef`` +Default value: `undef` -##### `no_proxy_uris` +##### `no_proxy_uris` Data type: `Variant[Array[String], String]` @@ -8924,7 +8871,7 @@ with [`proxy_dest`](#proxy_dest). Default value: `[]` -##### `no_proxy_uris_match` +##### `no_proxy_uris_match` Data type: `Variant[Array[String], String]` @@ -8932,7 +8879,7 @@ This directive is equivalent to `no_proxy_uris`, but takes regular expressions. Default value: `[]` -##### `proxy_preserve_host` +##### `proxy_preserve_host` Data type: `Boolean` @@ -8940,9 +8887,9 @@ Sets the [ProxyPreserveHost Directive](https://httpd.apache.org/docs/current/mod Setting this parameter to `true` enables the `Host:` line from an incoming request to be proxied to the host instead of hostname. Setting it to `false` sets this directive to 'Off'. -Default value: ``false`` +Default value: `false` -##### `proxy_add_headers` +##### `proxy_add_headers` Data type: `Optional[Variant[String, Boolean]]` @@ -8950,18 +8897,18 @@ Sets the [ProxyAddHeaders Directive](https://httpd.apache.org/docs/current/mod/m This parameter controlls whether proxy-related HTTP headers (X-Forwarded-For, X-Forwarded-Host and X-Forwarded-Server) get sent to the backend server. -Default value: ``undef`` +Default value: `undef` -##### `proxy_error_override` +##### `proxy_error_override` Data type: `Boolean` Sets the [ProxyErrorOverride Directive](https://httpd.apache.org/docs/current/mod/mod_proxy.html#proxyerroroverride). This directive controls whether Apache should override error pages for proxied content. -Default value: ``false`` +Default value: `false` -##### `options` +##### `options` Data type: `Array[String]` @@ -8977,7 +8924,7 @@ apache::vhost { 'site.name.fdqn': Default value: `['Indexes', 'FollowSymLinks', 'MultiViews']` -##### `override` +##### `override` Data type: `Array[String]` @@ -8986,7 +8933,7 @@ Sets the overrides for the specified virtual host. Accepts an array of Default value: `['None']` -##### `passenger_enabled` +##### `passenger_enabled` Data type: `Optional[Boolean]` @@ -9005,45 +8952,45 @@ apache::vhost { 'sample.example.net': > **Note:** There is an [issue](http://www.conandalton.net/2010/06/passengerenabled-off-not-working.html) using the PassengerEnabled directive with the PassengerHighPerformance directive. -Default value: ``undef`` +Default value: `undef` -##### `passenger_base_uri` +##### `passenger_base_uri` Data type: `Optional[String]` Sets [PassengerBaseURI](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerbase_rui), to specify that the given URI is a distinct application served by Passenger. -Default value: ``undef`` +Default value: `undef` -##### `passenger_ruby` +##### `passenger_ruby` Data type: `Optional[Stdlib::Absolutepath]` Sets [PassengerRuby](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerruby), specifying the Ruby interpreter to use when serving the relevant web applications. -Default value: ``undef`` +Default value: `undef` -##### `passenger_python` +##### `passenger_python` Data type: `Optional[Stdlib::Absolutepath]` Sets [PassengerPython](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerpython), specifying the Python interpreter to use when serving the relevant web applications. -Default value: ``undef`` +Default value: `undef` -##### `passenger_nodejs` +##### `passenger_nodejs` Data type: `Optional[Stdlib::Absolutepath]` Sets the [`PassengerNodejs`](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengernodejs), specifying Node.js command to use when serving the relevant web applications. -Default value: ``undef`` +Default value: `undef` -##### `passenger_meteor_app_settings` +##### `passenger_meteor_app_settings` Data type: `Optional[String]` @@ -9051,9 +8998,9 @@ Sets [PassengerMeteorAppSettings](https://www.phusionpassenger.com/docs/referenc specifying a JSON file with settings for the application when using a Meteor application in non-bundled mode. -Default value: ``undef`` +Default value: `undef` -##### `passenger_app_env` +##### `passenger_app_env` Data type: `Optional[String]` @@ -9061,126 +9008,126 @@ Sets [PassengerAppEnv](https://www.phusionpassenger.com/docs/references/config_r the environment for the Passenger application. If not specified, defaults to the global setting or 'production'. -Default value: ``undef`` +Default value: `undef` -##### `passenger_app_root` +##### `passenger_app_root` Data type: `Optional[Stdlib::Absolutepath]` Sets [PassengerRoot](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerapproot), the location of the Passenger application root if different from the DocumentRoot. -Default value: ``undef`` +Default value: `undef` -##### `passenger_app_group_name` +##### `passenger_app_group_name` Data type: `Optional[String]` Sets [PassengerAppGroupName](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerappgroupname), the name of the application group that the current application should belong to. -Default value: ``undef`` +Default value: `undef` -##### `passenger_app_start_command` +##### `passenger_app_start_command` Data type: `Optional[String]` Sets [PassengerAppStartCommand](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerappstartcommand), how Passenger should start your app on a specific port. -Default value: ``undef`` +Default value: `undef` -##### `passenger_app_type` +##### `passenger_app_type` Data type: `Optional[Enum['meteor', 'node', 'rack', 'wsgi']]` Sets [PassengerAppType](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerapptype), to force Passenger to recognize the application as a specific type. -Default value: ``undef`` +Default value: `undef` -##### `passenger_startup_file` +##### `passenger_startup_file` Data type: `Optional[String]` Sets the [PassengerStartupFile](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerstartupfile), path. This path is relative to the application root. -Default value: ``undef`` +Default value: `undef` -##### `passenger_restart_dir` +##### `passenger_restart_dir` Data type: `Optional[String]` Sets the [PassengerRestartDir](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerrestartdir), to customize the directory in which `restart.txt` is searched for. -Default value: ``undef`` +Default value: `undef` -##### `passenger_spawn_method` +##### `passenger_spawn_method` Data type: `Optional[Enum['direct', 'smart']]` Sets [PassengerSpawnMethod](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerspawnmethod), whether Passenger spawns applications directly, or using a prefork copy-on-write mechanism. -Default value: ``undef`` +Default value: `undef` -##### `passenger_load_shell_envvars` +##### `passenger_load_shell_envvars` Data type: `Optional[Boolean]` Sets [PassengerLoadShellEnvvars](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerloadshellenvvars), to enable or disable the loading of shell environment variables before spawning the application. -Default value: ``undef`` +Default value: `undef` -##### `passenger_preload_bundler` +##### `passenger_preload_bundler` Data type: `Optional[Boolean]` Sets [PassengerPreloadBundler](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerpreloadbundler), to enable or disable the loading of bundler before loading the application. -Default value: ``undef`` +Default value: `undef` -##### `passenger_rolling_restarts` +##### `passenger_rolling_restarts` Data type: `Optional[Boolean]` Sets [PassengerRollingRestarts](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerrollingrestarts), to enable or disable support for zero-downtime application restarts through `restart.txt`. -Default value: ``undef`` +Default value: `undef` -##### `passenger_resist_deployment_errors` +##### `passenger_resist_deployment_errors` Data type: `Optional[Boolean]` Sets [PassengerResistDeploymentErrors](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerresistdeploymenterrors), to enable or disable resistance against deployment errors. -Default value: ``undef`` +Default value: `undef` -##### `passenger_user` +##### `passenger_user` Data type: `Optional[String]` Sets [PassengerUser](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengeruser), the running user for sandboxing applications. -Default value: ``undef`` +Default value: `undef` -##### `passenger_group` +##### `passenger_group` Data type: `Optional[String]` Sets [PassengerGroup](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengergroup), the running group for sandboxing applications. -Default value: ``undef`` +Default value: `undef` -##### `passenger_friendly_error_pages` +##### `passenger_friendly_error_pages` Data type: `Optional[Boolean]` @@ -9189,54 +9136,54 @@ which can display friendly error pages whenever an application fails to start. T friendly error page presents the startup error message, some suggestions for solving the problem, a backtrace and a dump of the environment variables. -Default value: ``undef`` +Default value: `undef` -##### `passenger_min_instances` +##### `passenger_min_instances` Data type: `Optional[Integer]` Sets [PassengerMinInstances](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengermininstances), the minimum number of application processes to run. -Default value: ``undef`` +Default value: `undef` -##### `passenger_max_instances` +##### `passenger_max_instances` Data type: `Optional[Integer]` Sets [PassengerMaxInstances](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengermaxinstances), the maximum number of application processes to run. -Default value: ``undef`` +Default value: `undef` -##### `passenger_max_preloader_idle_time` +##### `passenger_max_preloader_idle_time` Data type: `Optional[Integer]` Sets [PassengerMaxPreloaderIdleTime](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengermaxpreloaderidletime), the maximum amount of time the preloader waits before shutting down an idle process. -Default value: ``undef`` +Default value: `undef` -##### `passenger_force_max_concurrent_requests_per_process` +##### `passenger_force_max_concurrent_requests_per_process` Data type: `Optional[Integer]` Sets [PassengerForceMaxConcurrentRequestsPerProcess](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerforcemaxconcurrentrequestsperprocess), the maximum amount of concurrent requests the application can handle per process. -Default value: ``undef`` +Default value: `undef` -##### `passenger_start_timeout` +##### `passenger_start_timeout` Data type: `Optional[Integer]` Sets [PassengerStartTimeout](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerstarttimeout), the timeout for the application startup. -Default value: ``undef`` +Default value: `undef` -##### `passenger_concurrency_model` +##### `passenger_concurrency_model` Data type: `Optional[Enum['process', 'thread']]` @@ -9246,9 +9193,9 @@ Passenger supports two concurrency models:
* `process` - single-threaded, multi-processed I/O concurrency. * `thread` - multi-threaded, multi-processed I/O concurrency. -Default value: ``undef`` +Default value: `undef` -##### `passenger_thread_count` +##### `passenger_thread_count` Data type: `Optional[Integer]` @@ -9256,18 +9203,18 @@ Sets [PassengerThreadCount](https://www.phusionpassenger.com/docs/references/con the number of threads that Passenger should spawn per Ruby application process.
This option only has effect if PassengerConcurrencyModel is `thread`. -Default value: ``undef`` +Default value: `undef` -##### `passenger_max_requests` +##### `passenger_max_requests` Data type: `Optional[Integer]` Sets [PassengerMaxRequests](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengermaxrequests), the maximum number of requests an application process will process. -Default value: ``undef`` +Default value: `undef` -##### `passenger_max_request_time` +##### `passenger_max_request_time` Data type: `Optional[Integer]` @@ -9275,63 +9222,63 @@ Sets [PassengerMaxRequestTime](https://www.phusionpassenger.com/docs/references/ the maximum amount of time, in seconds, that an application process may take to process a request. -Default value: ``undef`` +Default value: `undef` -##### `passenger_memory_limit` +##### `passenger_memory_limit` Data type: `Optional[Integer]` Sets [PassengerMemoryLimit](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengermemorylimit), the maximum amount of memory that an application process may use, in megabytes. -Default value: ``undef`` +Default value: `undef` -##### `passenger_stat_throttle_rate` +##### `passenger_stat_throttle_rate` Data type: `Optional[Integer]` Sets [PassengerStatThrottleRate](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerstatthrottlerate), to set a limit, in seconds, on how often Passenger will perform it's filesystem checks. -Default value: ``undef`` +Default value: `undef` -##### `passenger_pre_start` +##### `passenger_pre_start` Data type: `Optional[Variant[String, Array[String]]]` Sets [PassengerPreStart](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerprestart), the URL of the application if pre-starting is required. -Default value: ``undef`` +Default value: `undef` -##### `passenger_high_performance` +##### `passenger_high_performance` Data type: `Optional[Boolean]` Sets [PassengerHighPerformance](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerhighperformance), to enhance performance in return for reduced compatibility. -Default value: ``undef`` +Default value: `undef` -##### `passenger_buffer_upload` +##### `passenger_buffer_upload` Data type: `Optional[Boolean]` Sets [PassengerBufferUpload](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerbufferupload), to buffer HTTP client request bodies before they are sent to the application. -Default value: ``undef`` +Default value: `undef` -##### `passenger_buffer_response` +##### `passenger_buffer_response` Data type: `Optional[Boolean]` Sets [PassengerBufferResponse](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerbufferresponse), to buffer Happlication-generated responses. -Default value: ``undef`` +Default value: `undef` -##### `passenger_error_override` +##### `passenger_error_override` Data type: `Optional[Boolean]` @@ -9339,9 +9286,9 @@ Sets [PassengerErrorOverride](https://www.phusionpassenger.com/docs/references/c to specify whether Apache will intercept and handle response with HTTP status codes of 400 and higher. -Default value: ``undef`` +Default value: `undef` -##### `passenger_max_request_queue_size` +##### `passenger_max_request_queue_size` Data type: `Optional[Integer]` @@ -9351,9 +9298,9 @@ concurrent request limit is reached. If the queue is already at this specified l Passenger immediately sends a "503 Service Unavailable" error to any incoming requests.
A value of 0 means that the queue size is unbounded. -Default value: ``undef`` +Default value: `undef` -##### `passenger_max_request_queue_time` +##### `passenger_max_request_queue_time` Data type: `Optional[Integer]` @@ -9363,9 +9310,9 @@ whenever the maximum concurrent request limit is reached. If a request reaches t limit, then Passenger immeaditly sends a "504 Gateway Timeout" error for that request.
A value of 0 means that the queue time is unbounded. -Default value: ``undef`` +Default value: `undef` -##### `passenger_sticky_sessions` +##### `passenger_sticky_sessions` Data type: `Optional[Boolean]` @@ -9373,27 +9320,27 @@ Sets [PassengerStickySessions](https://www.phusionpassenger.com/docs/references/ to specify that, whenever possible, all requests sent by a client will be routed to the same originating application process. -Default value: ``undef`` +Default value: `undef` -##### `passenger_sticky_sessions_cookie_name` +##### `passenger_sticky_sessions_cookie_name` Data type: `Optional[String]` Sets [PassengerStickySessionsCookieName](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerstickysessionscookiename), to specify the name of the sticky sessions cookie. -Default value: ``undef`` +Default value: `undef` -##### `passenger_sticky_sessions_cookie_attributes` +##### `passenger_sticky_sessions_cookie_attributes` Data type: `Optional[String]` Sets [PassengerStickySessionsCookieAttributes](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerstickysessionscookieattributes), the attributes of the sticky sessions cookie. -Default value: ``undef`` +Default value: `undef` -##### `passenger_allow_encoded_slashes` +##### `passenger_allow_encoded_slashes` Data type: `Optional[Boolean]` @@ -9401,27 +9348,27 @@ Sets [PassengerAllowEncodedSlashes](https://www.phusionpassenger.com/docs/refere to allow URLs with encoded slashes. Please note that this feature will not work properly unless Apache's `AllowEncodedSlashes` is also enabled. -Default value: ``undef`` +Default value: `undef` -##### `passenger_app_log_file` +##### `passenger_app_log_file` Data type: `Optional[String]` Sets [PassengerAppLogFile](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerapplogfile), app specific messages logged to a different file in addition to Passenger log file. -Default value: ``undef`` +Default value: `undef` -##### `passenger_debugger` +##### `passenger_debugger` Data type: `Optional[Boolean]` Sets [PassengerDebugger](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerdebugger), to turn support for Ruby application debugging on or off. -Default value: ``undef`` +Default value: `undef` -##### `passenger_lve_min_uid` +##### `passenger_lve_min_uid` Data type: `Optional[Integer]` @@ -9429,9 +9376,9 @@ Sets [PassengerLveMinUid](https://www.phusionpassenger.com/docs/references/confi to only allow the spawning of application processes with UIDs equal to, or higher than, this specified value on LVE-enabled kernels. -Default value: ``undef`` +Default value: `undef` -##### `php_values` +##### `php_values` Data type: `Hash` @@ -9444,7 +9391,7 @@ Within a vhost declaration: Default value: `{}` -##### `php_flags` +##### `php_flags` Data type: `Hash` @@ -9453,7 +9400,7 @@ These flags or values can be overwritten by a user or an application. Default value: `{}` -##### `php_admin_values` +##### `php_admin_values` Data type: `Variant[Array[String], Hash]` @@ -9462,7 +9409,7 @@ These flags or values cannot be overwritten by a user or an application. Default value: `{}` -##### `php_admin_flags` +##### `php_admin_flags` Data type: `Variant[Array[String], Hash]` @@ -9471,7 +9418,7 @@ These flags or values cannot be overwritten by a user or an application. Default value: `{}` -##### `port` +##### `port` Data type: `Optional[Variant[Array[Stdlib::Port], Stdlib::Port]]` @@ -9479,9 +9426,9 @@ Sets the port the host is configured on. The module's defaults ensure the host l on port 80 for non-SSL virtual hosts and port 443 for SSL virtual hosts. The host only listens on the port set in this parameter. -Default value: ``undef`` +Default value: `undef` -##### `priority` +##### `priority` Data type: `Optional[Apache::Vhost::Priority]` @@ -9493,9 +9440,9 @@ used if no other names match.
aware that the `default_vhost` parameter for `apache::vhost` passes a priority of 15.
To omit the priority prefix in file names, pass a priority of `false`. -Default value: ``undef`` +Default value: `undef` -##### `protocols` +##### `protocols` Data type: `Array[Enum['h2', 'h2c', 'http/1.1']]` @@ -9504,24 +9451,24 @@ directive, which lists available protocols for the virutal host. Default value: `[]` -##### `protocols_honor_order` +##### `protocols_honor_order` Data type: `Optional[Boolean]` Sets the [ProtocolsHonorOrder](https://httpd.apache.org/docs/current/en/mod/core.html#protocolshonororder) directive which determines wether the order of Protocols sets precedence during negotiation. -Default value: ``undef`` +Default value: `undef` -##### `proxy_dest` +##### `proxy_dest` Data type: `Optional[String]` Specifies the destination address of a [ProxyPass](https://httpd.apache.org/docs/current/mod/mod_proxy.html#proxypass) configuration. -Default value: ``undef`` +Default value: `undef` -##### `proxy_pass` +##### `proxy_pass` Data type: `Optional[Variant[Array[Hash], Hash]]` @@ -9554,9 +9501,9 @@ apache::vhost { 'site.name.fdqn': * `params`. *Optional.* Allows for ProxyPass key-value parameters, such as connection settings. * `setenv`. *Optional.* Sets [environment variables](https://httpd.apache.org/docs/current/mod/mod_proxy.html#envsettings) for the proxy directive. Values: array. -Default value: ``undef`` +Default value: `undef` -##### `proxy_dest_match` +##### `proxy_dest_match` Data type: `Optional[String]` @@ -9564,9 +9511,9 @@ This directive is equivalent to `proxy_dest`, but takes regular expressions, see [ProxyPassMatch](https://httpd.apache.org/docs/current/mod/mod_proxy.html#proxypassmatch) for details. -Default value: ``undef`` +Default value: `undef` -##### `proxy_dest_reverse_match` +##### `proxy_dest_reverse_match` Data type: `Optional[String]` @@ -9574,9 +9521,9 @@ Allows you to pass a ProxyPassReverse if `proxy_dest_match` is specified. See [ProxyPassReverse](https://httpd.apache.org/docs/current/mod/mod_proxy.html#proxypassreverse) for details. -Default value: ``undef`` +Default value: `undef` -##### `proxy_pass_match` +##### `proxy_pass_match` Data type: `Optional[Variant[Array[Hash], Hash]]` @@ -9584,17 +9531,17 @@ This directive is equivalent to `proxy_pass`, but takes regular expressions, see [ProxyPassMatch](https://httpd.apache.org/docs/current/mod/mod_proxy.html#proxypassmatch) for details. -Default value: ``undef`` +Default value: `undef` -##### `redirect_dest` +##### `redirect_dest` Data type: `Optional[Variant[Array[String], String]]` Specifies the address to redirect to. -Default value: ``undef`` +Default value: `undef` -##### `redirect_source` +##### `redirect_source` Data type: `Variant[String, Array[String]]` @@ -9611,7 +9558,7 @@ apache::vhost { 'site.name.fdqn': Default value: `'/'` -##### `redirect_status` +##### `redirect_status` Data type: `Optional[Variant[Array[String], String]]` @@ -9623,9 +9570,9 @@ Specifies the status to append to the redirect. } ``` -Default value: ``undef`` +Default value: `undef` -##### `redirectmatch_regexp` +##### `redirectmatch_regexp` Data type: `Optional[Variant[Array[String], String]]` @@ -9641,9 +9588,9 @@ apache::vhost { 'site.name.fdqn': } ``` -Default value: ``undef`` +Default value: `undef` -##### `redirectmatch_status` +##### `redirectmatch_status` Data type: `Optional[Variant[Array[String], String]]` @@ -9659,9 +9606,9 @@ apache::vhost { 'site.name.fdqn': } ``` -Default value: ``undef`` +Default value: `undef` -##### `redirectmatch_dest` +##### `redirectmatch_dest` Data type: `Optional[Variant[Array[String], String]]` @@ -9677,9 +9624,9 @@ apache::vhost { 'site.name.fdqn': } ``` -Default value: ``undef`` +Default value: `undef` -##### `request_headers` +##### `request_headers` Data type: `Array[String[1]]` @@ -9698,7 +9645,7 @@ apache::vhost { 'site.name.fdqn': Default value: `[]` -##### `rewrites` +##### `rewrites` Data type: `Array[Hash]` @@ -9775,7 +9722,7 @@ than setting the rewrites in the virtual host's directories. Default value: `[]` -##### `rewrite_base` +##### `rewrite_base` Data type: `Optional[String[1]]` @@ -9783,18 +9730,18 @@ The parameter [`rewrite_base`](https://httpd.apache.org/docs/current/mod/mod_rew specifies the URL prefix to be used for per-directory (htaccess) RewriteRule directives that substitue a relative path. -Default value: ``undef`` +Default value: `undef` -##### `rewrite_rule` +##### `rewrite_rule` Data type: `Optional[Variant[Array[String[1]], String[1]]]` The parameter [`rewrite_rile`](https://httpd.apache.org/docs/current/mod/mod_rewrite.html#rewriterule) allows the user to define the rules that will be used by the rewrite engine. -Default value: ``undef`` +Default value: `undef` -##### `rewrite_cond` +##### `rewrite_cond` Data type: `Array[String[1]]` @@ -9804,7 +9751,7 @@ rewrite engine. Default value: `[]` -##### `rewrite_inherit` +##### `rewrite_inherit` Data type: `Boolean` @@ -9832,18 +9779,18 @@ RewriteOptions Inherit Refer to the official [`mod_rewrite`](https://httpd.apache.org/docs/2.2/mod/mod_rewrite.html) documentation, section "Rewriting in Virtual Hosts". -Default value: ``false`` +Default value: `false` -##### `scriptalias` +##### `scriptalias` Data type: `Optional[String]` Defines a directory of CGI scripts to be aliased to the path '/cgi-bin', such as '/usr/scripts'. -Default value: ``undef`` +Default value: `undef` -##### `scriptaliases` +##### `scriptaliases` Data type: `Array[Hash]` @@ -9876,15 +9823,15 @@ before more general ones to avoid shadowing. Default value: `[]` -##### `serveradmin` +##### `serveradmin` Data type: `Optional[String]` Specifies the email address Apache displays when it renders one of its error pages. -Default value: ``undef`` +Default value: `undef` -##### `serveraliases` +##### `serveraliases` Data type: `Variant[Array[String], String]` @@ -9893,7 +9840,7 @@ of the site. Default value: `[]` -##### `servername` +##### `servername` Data type: `Optional[String]` @@ -9901,7 +9848,7 @@ Sets the servername corresponding to the hostname you connect to the virtual hos Default value: `$name` -##### `setenv` +##### `setenv` Data type: `Variant[Array[String], String]` @@ -9915,7 +9862,7 @@ apache::vhost { 'setenv.example.com': Default value: `[]` -##### `setenvif` +##### `setenvif` Data type: `Variant[Array[String], String]` @@ -9923,7 +9870,7 @@ Used by HTTPD to conditionally set environment variables for virtual hosts. Default value: `[]` -##### `setenvifnocase` +##### `setenvifnocase` Data type: `Variant[Array[String], String]` @@ -9931,16 +9878,16 @@ Used by HTTPD to conditionally set environment variables for virtual hosts (case Default value: `[]` -##### `suexec_user_group` +##### `suexec_user_group` Data type: `Optional[Pattern[/^[\w-]+ [\w-]+$/]]` Allows the spcification of user and group execution privileges for CGI programs through inclusion of the `mod_suexec` module. -Default value: ``undef`` +Default value: `undef` -##### `vhost_name` +##### `vhost_name` Data type: `String` @@ -9951,7 +9898,7 @@ title of the resource. Default value: `'*'` -##### `virtual_docroot` +##### `virtual_docroot` Data type: `Variant[Stdlib::Absolutepath, Boolean]` @@ -9969,9 +9916,9 @@ apache::vhost { 'subdomain.loc': } ``` -Default value: ``false`` +Default value: `false` -##### `virtual_use_default_docroot` +##### `virtual_use_default_docroot` Data type: `Boolean` @@ -9988,9 +9935,9 @@ apache::vhost { 'subdomain.loc': } ``` -Default value: ``false`` +Default value: `false` -##### `wsgi_daemon_process` +##### `wsgi_daemon_process` Data type: `Optional[Variant[String, Hash]]` @@ -10016,9 +9963,9 @@ apache::vhost { 'wsgi.example.com': } ``` -Default value: ``undef`` +Default value: `undef` -##### `wsgi_daemon_process_options` +##### `wsgi_daemon_process_options` Data type: `Optional[Hash]` @@ -10027,9 +9974,9 @@ wsgi_daemon_process, wsgi_process_group, wsgi_script_aliases and wsgi_pass_authorization.
Sets the group ID that the virtual host runs under. -Default value: ``undef`` +Default value: `undef` -##### `wsgi_application_group` +##### `wsgi_application_group` Data type: `Optional[String]` @@ -10041,9 +9988,9 @@ thus allowing you to specify which application group the WSGI application belong with all WSGI applications within the same group executing within the context of the same Python sub interpreter. -Default value: ``undef`` +Default value: `undef` -##### `wsgi_import_script` +##### `wsgi_import_script` Data type: `Optional[String]` @@ -10053,9 +10000,9 @@ and wsgi_pass_authorization.
This parameter defines the [`WSGIImportScript directive`](https://modwsgi.readthedocs.io/en/develop/configuration-directives/WSGIImportScript.html), which can be used in order to specify a script file to be loaded upon a process starting. -Default value: ``undef`` +Default value: `undef` -##### `wsgi_import_script_options` +##### `wsgi_import_script_options` Data type: `Optional[Hash]` @@ -10066,9 +10013,9 @@ This parameter defines the [`WSGIImportScript directive`](https://modwsgi.readth which can be used in order to specify a script file to be loaded upon a process starting.
Specifies the process and aplication groups of the script. -Default value: ``undef`` +Default value: `undef` -##### `wsgi_chunked_request` +##### `wsgi_chunked_request` Data type: `Optional[Apache::OnOff]` @@ -10080,9 +10027,9 @@ allowing you to enable support for chunked request content.
WSGI is technically incapable of supporting chunked request content without all chunked request content having first been read in and buffered. -Default value: ``undef`` +Default value: `undef` -##### `wsgi_process_group` +##### `wsgi_process_group` Data type: `Optional[String]` @@ -10091,9 +10038,9 @@ wsgi_daemon_process, wsgi_daemon_process_options, wsgi_script_aliases and wsgi_pass_authorization.
Requires a hash of web paths to filesystem `.wsgi paths/`. -Default value: ``undef`` +Default value: `undef` -##### `wsgi_script_aliases` +##### `wsgi_script_aliases` Data type: `Optional[Hash]` @@ -10103,9 +10050,9 @@ and wsgi_pass_authorization.
Uses the WSGI application to handle authorization instead of Apache when set to `On`.
For more information, see mod_wsgi's [WSGIPassAuthorization documentation](https://modwsgi.readthedocs.org/en/latest/configuration-directives/WSGIPassAuthorization.html). -Default value: ``undef`` +Default value: `undef` -##### `wsgi_script_aliases_match` +##### `wsgi_script_aliases_match` Data type: `Optional[Hash]` @@ -10117,9 +10064,9 @@ This directive is similar to `wsgi_script_aliases`, but makes use of regular exp in place of simple prefix matching.
For more information, see mod_wsgi's [WSGIPassAuthorization documentation](https://modwsgi.readthedocs.org/en/latest/configuration-directives/WSGIPassAuthorization.html). -Default value: ``undef`` +Default value: `undef` -##### `wsgi_pass_authorization` +##### `wsgi_pass_authorization` Data type: `Optional[Apache::OnOff]` @@ -10128,9 +10075,9 @@ wsgi_daemon_process, wsgi_daemon_process_options, wsgi_process_group and wsgi_script_aliases.
Enables support for chunked requests. -Default value: ``undef`` +Default value: `undef` -##### `directories` +##### `directories` Data type: `Optional[Array[Hash]]` @@ -10181,9 +10128,86 @@ apache::vhost { 'sample.example.net': Any handlers you do not set in these hashes are considered `undefined` within Puppet and are not added to the virtual host, resulting in the module using their default values. -Default value: ``undef`` +The `directories` param can accepts the different authentication ways, including `gssapi`, `Basic (authz_core)`, +and others. + + * `gssapi` - Specifies mod_auth_gssapi parameters for particular directories in a virtual host directory + TODO: check, if this Documentation is obsolete + + ```puppet + apache::vhost { 'sample.example.net': + docroot => '/path/to/directory', + directories => [ + { path => '/path/to/different/dir', + gssapi => { + acceptor_name => '{HOSTNAME}', + allowed_mech => ['krb5', 'iakerb', 'ntlmssp'], + authname => 'Kerberos 5', + authtype => 'GSSAPI', + basic_auth => true, + basic_auth_mech => ['krb5', 'iakerb', 'ntlmssp'], + basic_ticket_timeout => 300, + connection_bound => true, + cred_store => { + ccache => ['/path/to/directory'], + client_keytab => ['/path/to/example.keytab'], + keytab => ['/path/to/example.keytab'], + }, + deleg_ccache_dir => '/path/to/directory', + deleg_ccache_env_var => 'KRB5CCNAME', + deleg_ccache_perms => { + mode => '0600', + uid => 'example-user', + gid => 'example-group', + }, + deleg_ccache_unique => true, + impersonate => true, + local_name => true, + name_attributes => 'json', + negotiate_once => true, + publish_errors => true, + publish_mech => true, + required_name_attributes => 'auth-indicators=high', + session_key => 'file:/path/to/example.key', + signal_persistent_auth => true, + ssl_only => true, + use_s4u2_proxy => true, + use_sessions => true, + } + }, + ], + } + ``` + + * `Basic` - Specifies mod_authz_core parameters for particular directories in a virtual host directory + ```puppet + apache::vhost { 'sample.example.net': + docroot => '/path/to/directory', + directories => [ + { + path => '/path/to/different/dir', + auth_type => 'Basic', + authz_core => { + require_all => { + 'require_any' => { + 'require' => ['user superadmin'], + 'require_all' => { + 'require' => ['group admins', 'ldap-group "cn=Administrators,o=Airius"'], + }, + }, + 'require_none' => { + 'require' => ['group temps', 'ldap-group "cn=Temporary Employees,o=Airius"'] + } + } + } + }, + ], + } + ``` + +Default value: `undef` -##### `custom_fragment` +##### `custom_fragment` Data type: `Optional[String]` @@ -10212,9 +10236,9 @@ ProxyStatus On', } ``` -Default value: ``undef`` +Default value: `undef` -##### `headers` +##### `headers` Data type: `Array[String[1]]` @@ -10233,7 +10257,7 @@ apache::vhost { 'sample.example.net': Default value: `[]` -##### `shib_compat_valid_user` +##### `shib_compat_valid_user` Data type: `Optional[String]` @@ -10244,9 +10268,9 @@ Apache behavior when processing the `valid-user` and `user` Require rules. See t and [NativeSPhtaccess](https://wiki.shibboleth.net/confluence/display/SHIB2/NativeSPhtaccess) topic for more details. This key is disabled if `apache::mod::shib` is not defined. -Default value: ``undef`` +Default value: `undef` -##### `ssl_options` +##### `ssl_options` Data type: `Optional[Variant[Array[String], String]]` @@ -10267,9 +10291,9 @@ apache::vhost { 'secure.example.net': } ``` -Default value: ``undef`` +Default value: `undef` -##### `additional_includes` +##### `additional_includes` Data type: `Variant[Array[String], String]` @@ -10288,23 +10312,15 @@ apache::vhost { 'sample.example.net': Default value: `[]` -##### `gssapi` - - - -##### `authz_core` - - - -##### `ssl` +##### `ssl` Data type: `Boolean` Enables SSL for the virtual host. SSL virtual hosts only respond to HTTPS queries. -Default value: ``false`` +Default value: `false` -##### `ssl_ca` +##### `ssl_ca` Data type: `Optional[Stdlib::Absolutepath]` @@ -10313,7 +10329,7 @@ for authentication. Default value: `$apache::default_ssl_ca` -##### `ssl_cert` +##### `ssl_cert` Data type: `Optional[Stdlib::Absolutepath]` @@ -10321,24 +10337,24 @@ Specifies the SSL certification. Default value: `$apache::default_ssl_cert` -##### `ssl_protocol` +##### `ssl_protocol` Data type: `Optional[Variant[Array[String], String]]` Specifies [SSLProtocol](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslprotocol). Expects an array or space separated string of accepted protocols. -Default value: ``undef`` +Default value: `undef` -##### `ssl_cipher` +##### `ssl_cipher` Data type: `Optional[Variant[Array[String[1]], String[1], Hash[String[1], String[1]]]]` Specifies [SSLCipherSuite](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslciphersuite). -Default value: ``undef`` +Default value: `undef` -##### `ssl_honorcipherorder` +##### `ssl_honorcipherorder` Data type: `Variant[Boolean, Apache::OnOff, Undef]` @@ -10346,9 +10362,9 @@ Sets [SSLHonorCipherOrder](https://httpd.apache.org/docs/current/mod/mod_ssl.htm to cause Apache to use the server's preferred order of ciphers rather than the client's preferred order. -Default value: ``undef`` +Default value: `undef` -##### `ssl_certs_dir` +##### `ssl_certs_dir` Data type: `Optional[Stdlib::Absolutepath]` @@ -10356,7 +10372,7 @@ Specifies the location of the SSL certification directory to verify client certs Default value: `$apache::params::ssl_certs_dir` -##### `ssl_chain` +##### `ssl_chain` Data type: `Optional[Stdlib::Absolutepath]` @@ -10366,7 +10382,7 @@ production. Default value: `$apache::default_ssl_chain` -##### `ssl_crl` +##### `ssl_crl` Data type: `Optional[Stdlib::Absolutepath]` @@ -10376,7 +10392,7 @@ before being used in production.) Default value: `$apache::default_ssl_crl` -##### `ssl_crl_path` +##### `ssl_crl_path` Data type: `Optional[Stdlib::Absolutepath]` @@ -10387,7 +10403,7 @@ production.) Default value: `$apache::default_ssl_crl_path` -##### `ssl_crl_check` +##### `ssl_crl_check` Data type: `Optional[String]` @@ -10398,7 +10414,7 @@ older versions. Default value: `$apache::default_ssl_crl_check` -##### `ssl_key` +##### `ssl_key` Data type: `Optional[Stdlib::Absolutepath]` @@ -10409,7 +10425,7 @@ being used in production. Default value: `$apache::default_ssl_key` -##### `ssl_verify_client` +##### `ssl_verify_client` Data type: `Optional[Enum['none', 'optional', 'require', 'optional_no_ca']]` @@ -10422,9 +10438,9 @@ apache::vhost { 'sample.example.net': } ``` -Default value: ``undef`` +Default value: `undef` -##### `ssl_verify_depth` +##### `ssl_verify_depth` Data type: `Optional[Integer]` @@ -10439,9 +10455,9 @@ apache::vhost { 'sample.example.net': } ``` -Default value: ``undef`` +Default value: `undef` -##### `ssl_proxy_protocol` +##### `ssl_proxy_protocol` Data type: `Optional[String]` @@ -10450,9 +10466,9 @@ directive, which controls which SSL protocol flavors `mod_ssl` should use when e its server environment for proxy. It connects to servers using only one of the provided protocols. -Default value: ``undef`` +Default value: `undef` -##### `ssl_proxy_verify` +##### `ssl_proxy_verify` Data type: `Optional[Enum['none', 'optional', 'require', 'optional_no_ca']]` @@ -10460,9 +10476,9 @@ Sets the [SSLProxyVerify](https://httpd.apache.org/docs/current/mod/mod_ssl.html directive, which configures certificate verification of the remote server when a proxy is configured to forward requests to a remote SSL server. -Default value: ``undef`` +Default value: `undef` -##### `ssl_proxy_verify_depth` +##### `ssl_proxy_verify_depth` Data type: `Optional[Integer[0]]` @@ -10473,18 +10489,18 @@ A depth of 0 means that only self-signed remote server certificates are accepted the default depth of 1 means the remote server certificate can be self-signed or signed by a CA that is directly known to the server. -Default value: ``undef`` +Default value: `undef` -##### `ssl_proxy_cipher_suite` +##### `ssl_proxy_cipher_suite` Data type: `Optional[String]` Sets the [SSLProxyCipherSuite](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslproxyciphersuite) directive, which controls cipher suites supported for ssl proxy traffic. -Default value: ``undef`` +Default value: `undef` -##### `ssl_proxy_ca_cert` +##### `ssl_proxy_ca_cert` Data type: `Optional[Stdlib::Absolutepath]` @@ -10494,9 +10510,9 @@ of Certification Authorities (CA) whose remote servers you deal with. These are for Remote Server Authentication. This file should be a concatenation of the PEM-encoded certificate files in order of preference. -Default value: ``undef`` +Default value: `undef` -##### `ssl_proxy_machine_cert` +##### `ssl_proxy_machine_cert` Data type: `Optional[Stdlib::Absolutepath]` @@ -10511,9 +10527,9 @@ apache::vhost { 'sample.example.net': } ``` -Default value: ``undef`` +Default value: `undef` -##### `ssl_proxy_machine_cert_chain` +##### `ssl_proxy_machine_cert_chain` Data type: `Optional[Stdlib::Absolutepath]` @@ -10525,9 +10541,9 @@ client certificates. This referenced file is simply the concatenation of the var PEM-encoded certificate files. Upon startup, each client certificate configured will be examined and a chain of trust will be constructed. -Default value: ``undef`` +Default value: `undef` -##### `ssl_proxy_check_peer_cn` +##### `ssl_proxy_check_peer_cn` Data type: `Optional[Apache::OnOff]` @@ -10535,9 +10551,9 @@ Sets the [SSLProxyCheckPeerCN](https://httpd.apache.org/docs/current/mod/mod_ssl directive, which specifies whether the remote server certificate's CN field is compared against the hostname of the request URL. -Default value: ``undef`` +Default value: `undef` -##### `ssl_proxy_check_peer_name` +##### `ssl_proxy_check_peer_name` Data type: `Optional[Apache::OnOff]` @@ -10545,9 +10561,9 @@ Sets the [SSLProxyCheckPeerName](https://httpd.apache.org/docs/current/mod/mod_s directive, which specifies whether the remote server certificate's CN field is compared against the hostname of the request URL. -Default value: ``undef`` +Default value: `undef` -##### `ssl_proxy_check_peer_expire` +##### `ssl_proxy_check_peer_expire` Data type: `Optional[Apache::OnOff]` @@ -10555,26 +10571,26 @@ Sets the [SSLProxyCheckPeerExpire](https://httpd.apache.org/docs/current/mod/mod directive, which specifies whether the remote server certificate is checked for expiration or not. -Default value: ``undef`` +Default value: `undef` -##### `ssl_openssl_conf_cmd` +##### `ssl_openssl_conf_cmd` Data type: `Optional[String]` Sets the [SSLOpenSSLConfCmd](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslopensslconfcmd) directive, which provides direct configuration of OpenSSL parameters. -Default value: ``undef`` +Default value: `undef` -##### `ssl_proxyengine` +##### `ssl_proxyengine` Data type: `Boolean` Specifies whether or not to use [SSLProxyEngine](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslproxyengine). -Default value: ``false`` +Default value: `false` -##### `ssl_stapling` +##### `ssl_stapling` Data type: `Optional[Boolean]` @@ -10582,35 +10598,35 @@ Specifies whether or not to use [SSLUseStapling](http://httpd.apache.org/docs/cu By default, uses what is set globally.
This parameter only applies to Apache 2.4 or higher and is ignored on older versions. -Default value: ``undef`` +Default value: `undef` -##### `ssl_stapling_timeout` +##### `ssl_stapling_timeout` Data type: `Optional[Integer]` Can be used to set the [SSLStaplingResponderTimeout](http://httpd.apache.org/docs/current/mod/mod_ssl.html#sslstaplingrespondertimeout) directive.
This parameter only applies to Apache 2.4 or higher and is ignored on older versions. -Default value: ``undef`` +Default value: `undef` -##### `ssl_stapling_return_errors` +##### `ssl_stapling_return_errors` Data type: `Optional[Apache::OnOff]` Can be used to set the [SSLStaplingReturnResponderErrors](http://httpd.apache.org/docs/current/mod/mod_ssl.html#sslstaplingreturnrespondererrors) directive.
This parameter only applies to Apache 2.4 or higher and is ignored on older versions. -Default value: ``undef`` +Default value: `undef` -##### `ssl_user_name` +##### `ssl_user_name` Data type: `Optional[String]` Sets the [SSLUserName](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslusername) directive. -Default value: ``undef`` +Default value: `undef` -##### `ssl_reload_on_change` +##### `ssl_reload_on_change` Data type: `Boolean` @@ -10618,16 +10634,16 @@ Enable reloading of apache if the content of ssl files have changed. Default value: `$apache::default_ssl_reload_on_change` -##### `use_canonical_name` +##### `use_canonical_name` Data type: `Optional[Variant[Apache::OnOff, Enum['DNS', 'dns']]]` Specifies whether to use the [`UseCanonicalName directive`](https://httpd.apache.org/docs/2.4/mod/core.html#usecanonicalname), which allows you to configure how the server determines it's own name and port. -Default value: ``undef`` +Default value: `undef` -##### `define` +##### `define` Data type: `Hash` @@ -10636,15 +10652,15 @@ these can then be used to replace configuration values. All Defines are Undefine Default value: `{}` -##### `auth_oidc` +##### `auth_oidc` Data type: `Boolean` Enable `mod_auth_openidc` parameters for OpenID Connect authentication. -Default value: ``false`` +Default value: `false` -##### `oidc_settings` +##### `oidc_settings` Data type: `Apache::OIDCSettings` @@ -10652,7 +10668,7 @@ An Apache::OIDCSettings Struct containing (mod_auth_openidc settings)[https://gi Default value: `{}` -##### `limitreqfields` +##### `limitreqfields` Data type: `Optional[Integer]` @@ -10662,18 +10678,18 @@ abnormal client request behavior, which may be useful for avoiding some forms of denial-of-service attacks. The value should be increased if normal clients see an error response from the server that indicates too many fields were sent in the request. -Default value: ``undef`` +Default value: `undef` -##### `limitreqfieldsize` +##### `limitreqfieldsize` Data type: `Optional[Integer]` The `limitreqfieldsize` parameter sets the maximum ammount of _bytes_ that will be allowed within a request header. -Default value: ``undef`` +Default value: `undef` -##### `limitreqline` +##### `limitreqline` Data type: `Optional[Integer]` @@ -10687,9 +10703,9 @@ allowed for a request on the server. A server needs this value to be large enough to hold any of its resource names, including any information that might be passed in the query part of a GET request. -Default value: ``undef`` +Default value: `undef` -##### `limitreqbody` +##### `limitreqbody` Data type: `Optional[Integer]` @@ -10700,9 +10716,9 @@ directive is given (server, per-directory, per-file or per-location). If the client request exceeds that limit, the server will return an error response instead of servicing the request. -Default value: ``undef`` +Default value: `undef` -##### `use_servername_for_filenames` +##### `use_servername_for_filenames` Data type: `Boolean` @@ -10711,9 +10727,9 @@ value of the $servername parameter. When set to false (default), the existing behaviour of using the $name parameter will remain. -Default value: ``false`` +Default value: `false` -##### `use_port_for_filenames` +##### `use_port_for_filenames` Data type: `Boolean` @@ -10723,34 +10739,34 @@ $port parameters. When set to false (default), the port is not included in the file names and may lead to duplicate declarations if two virtual hosts use the same domain. -Default value: ``false`` +Default value: `false` -##### `mdomain` +##### `mdomain` Data type: `Optional[Variant[Boolean, String]]` All the names in the list are managed as one Managed Domain (MD). mod_md will request one single certificate that is valid for all these names. -Default value: ``undef`` +Default value: `undef` -##### `proxy_requests` +##### `proxy_requests` Data type: `Boolean` Whether to accept proxy requests -Default value: ``false`` +Default value: `false` -##### `userdir` +##### `userdir` Data type: `Optional[Variant[String[1], Array[String[1]]]]` Instances of apache::mod::userdir -Default value: ``undef`` +Default value: `undef` -### `apache::vhost::custom` +### `apache::vhost::custom` The `apache::vhost::custom` defined type is a thin wrapper around the `apache::custom_config` defined type, and simply overrides some of its default settings specific to the virtual host directory in Apache. @@ -10758,18 +10774,18 @@ The `apache::vhost::custom` defined type is a thin wrapper around the `apache::c The following parameters are available in the `apache::vhost::custom` defined type: -* [`content`](#content) -* [`ensure`](#ensure) -* [`priority`](#priority) -* [`verify_config`](#verify_config) +* [`content`](#-apache--vhost--custom--content) +* [`ensure`](#-apache--vhost--custom--ensure) +* [`priority`](#-apache--vhost--custom--priority) +* [`verify_config`](#-apache--vhost--custom--verify_config) -##### `content` +##### `content` Data type: `String` Sets the configuration file's content. -##### `ensure` +##### `ensure` Data type: `String` @@ -10777,7 +10793,7 @@ Specifies if the virtual host file is present or absent. Default value: `'present'` -##### `priority` +##### `priority` Data type: `Apache::Vhost::Priority` @@ -10785,15 +10801,15 @@ Sets the relative load order for Apache HTTPD VirtualHost configuration files. Default value: `25` -##### `verify_config` +##### `verify_config` Data type: `Boolean` Specifies whether to validate the configuration file before notifying the Apache service. -Default value: ``true`` +Default value: `true` -### `apache::vhost::fragment` +### `apache::vhost::fragment` Define a fragment within a vhost @@ -10854,37 +10870,37 @@ apache::vhost::fragment { 'myfragment': The following parameters are available in the `apache::vhost::fragment` defined type: -* [`vhost`](#vhost) -* [`priority`](#priority) -* [`content`](#content) -* [`order`](#order) -* [`port`](#port) +* [`vhost`](#-apache--vhost--fragment--vhost) +* [`priority`](#-apache--vhost--fragment--priority) +* [`content`](#-apache--vhost--fragment--content) +* [`order`](#-apache--vhost--fragment--order) +* [`port`](#-apache--vhost--fragment--port) -##### `vhost` +##### `vhost` Data type: `String[1]` The title of the vhost resource to append to -##### `priority` +##### `priority` Data type: `Optional[Apache::Vhost::Priority]` Set the priority to match the one `apache::vhost` sets. This must match the one `apache::vhost` sets or else the concat fragment won't be found. -Default value: ``undef`` +Default value: `undef` -##### `content` +##### `content` Data type: `Optional[String]` The content to put in the fragment. Only when it's non-empty the actual fragment will be created. -Default value: ``undef`` +Default value: `undef` -##### `order` +##### `order` Data type: `Integer[0]` @@ -10892,15 +10908,15 @@ The order to insert the fragment at Default value: `900` -##### `port` +##### `port` Data type: `Optional[Stdlib::Port]` The port to use -Default value: ``undef`` +Default value: `undef` -### `apache::vhost::proxy` +### `apache::vhost::proxy` Configure a reverse proxy for a vhost @@ -10951,39 +10967,39 @@ apache::vhost::proxy { 'myvhost-proxy': The following parameters are available in the `apache::vhost::proxy` defined type: -* [`vhost`](#vhost) -* [`priority`](#priority) -* [`order`](#order) -* [`port`](#port) -* [`proxy_dest`](#proxy_dest) -* [`proxy_dest_match`](#proxy_dest_match) -* [`proxy_dest_reverse_match`](#proxy_dest_reverse_match) -* [`no_proxy_uris`](#no_proxy_uris) -* [`no_proxy_uris_match`](#no_proxy_uris_match) -* [`proxy_pass`](#proxy_pass) -* [`proxy_pass_match`](#proxy_pass_match) -* [`proxy_requests`](#proxy_requests) -* [`proxy_preserve_host`](#proxy_preserve_host) -* [`proxy_add_headers`](#proxy_add_headers) -* [`proxy_error_override`](#proxy_error_override) - -##### `vhost` +* [`vhost`](#-apache--vhost--proxy--vhost) +* [`priority`](#-apache--vhost--proxy--priority) +* [`order`](#-apache--vhost--proxy--order) +* [`port`](#-apache--vhost--proxy--port) +* [`proxy_dest`](#-apache--vhost--proxy--proxy_dest) +* [`proxy_dest_match`](#-apache--vhost--proxy--proxy_dest_match) +* [`proxy_dest_reverse_match`](#-apache--vhost--proxy--proxy_dest_reverse_match) +* [`no_proxy_uris`](#-apache--vhost--proxy--no_proxy_uris) +* [`no_proxy_uris_match`](#-apache--vhost--proxy--no_proxy_uris_match) +* [`proxy_pass`](#-apache--vhost--proxy--proxy_pass) +* [`proxy_pass_match`](#-apache--vhost--proxy--proxy_pass_match) +* [`proxy_requests`](#-apache--vhost--proxy--proxy_requests) +* [`proxy_preserve_host`](#-apache--vhost--proxy--proxy_preserve_host) +* [`proxy_add_headers`](#-apache--vhost--proxy--proxy_add_headers) +* [`proxy_error_override`](#-apache--vhost--proxy--proxy_error_override) + +##### `vhost` Data type: `String[1]` The title of the vhost resource to which reverse proxy configuration will be appended. -##### `priority` +##### `priority` Data type: `Optional[Apache::Vhost::Priority]` Set the priority to match the one `apache::vhost` sets. This must match the one `apache::vhost` sets or else the vhost's `concat` resource won't be found. -Default value: ``undef`` +Default value: `undef` -##### `order` +##### `order` Data type: `Integer[0]` @@ -10993,24 +11009,24 @@ vhost's configuration. Default value: `170` -##### `port` +##### `port` Data type: `Optional[Stdlib::Port]` Set the port to match the one `apache::vhost` sets. This must match the one `apache::vhost` sets or else the vhost's `concat` resource won't be found. -Default value: ``undef`` +Default value: `undef` -##### `proxy_dest` +##### `proxy_dest` Data type: `Optional[String[1]]` Specifies the destination address of a [ProxyPass](https://httpd.apache.org/docs/current/mod/mod_proxy.html#proxypass) configuration for the `/` path. -Default value: ``undef`` +Default value: `undef` -##### `proxy_dest_match` +##### `proxy_dest_match` Data type: `Optional[String[1]]` @@ -11018,9 +11034,9 @@ This directive is equivalent to `proxy_dest`, but takes regular expressions, see [ProxyPassMatch](https://httpd.apache.org/docs/current/mod/mod_proxy.html#proxypassmatch) for details. -Default value: ``undef`` +Default value: `undef` -##### `proxy_dest_reverse_match` +##### `proxy_dest_reverse_match` Data type: `Optional[String[1]]` @@ -11028,9 +11044,9 @@ Allows you to pass a ProxyPassReverse if `proxy_dest_match` is specified. See [ProxyPassReverse](https://httpd.apache.org/docs/current/mod/mod_proxy.html#proxypassreverse) for details. -Default value: ``undef`` +Default value: `undef` -##### `no_proxy_uris` +##### `no_proxy_uris` Data type: `Variant[Array[String[1]], String[1]]` @@ -11043,7 +11059,7 @@ data type. This configuration uses the [ProxyPass](https://httpd.apache.org/docs Default value: `[]` -##### `no_proxy_uris_match` +##### `no_proxy_uris_match` Data type: `Variant[Array[String[1]], String[1]]` @@ -11052,7 +11068,7 @@ as it instead uses [ProxyPassMatch](https://httpd.apache.org/docs/current/mod/mo Default value: `[]` -##### `proxy_pass` +##### `proxy_pass` Data type: `Optional[Array[Apache::Vhost::ProxyPass]]` @@ -11061,9 +11077,9 @@ configuration. See the documentation for the Apache::Vhost::ProxyPass data type for a detailed description of the structure including optional parameters. -Default value: ``undef`` +Default value: `undef` -##### `proxy_pass_match` +##### `proxy_pass_match` Data type: `Optional[Array[Apache::Vhost::ProxyPass]]` @@ -11071,35 +11087,35 @@ This directive is equivalent to `proxy_pass`, but takes regular expressions, see [ProxyPassMatch](https://httpd.apache.org/docs/current/mod/mod_proxy.html#proxypassmatch) for details. -Default value: ``undef`` +Default value: `undef` -##### `proxy_requests` +##### `proxy_requests` Data type: `Boolean` Enables forward (standard) proxy requests. See [ProxyRequests](https://httpd.apache.org/docs/current/mod/mod_proxy.html#proxyrequests) for details. -Default value: ``false`` +Default value: `false` -##### `proxy_preserve_host` +##### `proxy_preserve_host` Data type: `Boolean` When enabled, pass the `Host:` line from the incoming request to the proxied host. See [ProxyPreserveHost](https://httpd.apache.org/docs/current/mod/mod_proxy.html#proxypreservehost) for details. -Default value: ``false`` +Default value: `false` -##### `proxy_add_headers` +##### `proxy_add_headers` Data type: `Optional[Boolean]` Add X-Forwarded-For, X-Forwarded-Host, and X-Forwarded-Server HTTP headers. See [ProxyAddHeaders](https://httpd.apache.org/docs/current/mod/mod_proxy.html#proxyaddheaders) for details. -Default value: ``undef`` +Default value: `undef` -##### `proxy_error_override` +##### `proxy_error_override` Data type: `Boolean` @@ -11107,11 +11123,11 @@ Override error pages from the proxied host. The current Puppet implementation supports enabling or disabling the directive, but not specifying a custom list of status codes. See [ProxyErrorOverride](https://httpd.apache.org/docs/current/mod/mod_proxy.html#proxyerroroverride) for details. -Default value: ``false`` +Default value: `false` ## Functions -### `apache::apache_pw_hash` +### `apache::apache_pw_hash` Type: Ruby 4.x API @@ -11129,7 +11145,7 @@ Data type: `Any` -### `apache::authz_core_config` +### `apache::authz_core_config` Type: Ruby 4.x API @@ -11225,7 +11241,7 @@ Data type: `Hash` The input as JSON format. -### `apache::bool2httpd` +### `apache::bool2httpd` Type: Ruby 4.x API @@ -11270,7 +11286,7 @@ Data type: `Any` The value to be converted into a string. -### `apache::pw_hash` +### `apache::pw_hash` Type: Ruby 4.x API @@ -11328,7 +11344,7 @@ Data type: `Any` ## Data types -### `Apache::LogLevel` +### `Apache::LogLevel` A string that conforms to the Apache `LogLevel` syntax. Different levels can be specified for individual apache modules. @@ -11356,26 +11372,18 @@ The levels are (in order of decreasing significance): * **See also** * https://httpd.apache.org/docs/current/mod/core.html#loglevel -Alias of +Alias of `Pattern[/\A([a-z_\.]+:)?(emerg|alert|crit|error|warn|notice|info|debug|trace[1-8])(\s+([a-z_\.]+:)?(emerg|alert|crit|error|warn|notice|info|debug|trace[1-8]))*\Z/]` -```puppet -Pattern[/(emerg|alert|crit|error|warn|notice|info|debug|trace[1-8])/] -``` - -### `Apache::ModProxyProtocol` +### `Apache::ModProxyProtocol` Supported protocols / schemes by mod_proxy * **See also** * https://httpd.apache.org/docs/2.4/mod/mod_proxy.html -Alias of - -```puppet -Pattern[/(\A(ajp|fcgi|ftp|h2c?|https?|scgi|uwsgi|wss?):\/\/.+\z)/, /(\Aunix:\/([^\n\/\0]+\/*)*\z)/] -``` +Alias of `Pattern[/(\A(ajp|fcgi|ftp|h2c?|https?|scgi|uwsgi|wss?):\/\/.+\z)/, /(\Aunix:\/([^\n\/\0]+\/*)*\z)/]` -### `Apache::OIDCSettings` +### `Apache::OIDCSettings` https://github.com/zmartzone/mod_auth_openidc/blob/master/auth_openidc.conf @@ -11493,40 +11501,28 @@ Struct[{ }] ``` -### `Apache::OnOff` +### `Apache::OnOff` A string that is accepted in Apache config to turn something on or off -Alias of - -```puppet -Enum['On', 'on', 'Off', 'off'] -``` +Alias of `Enum['On', 'on', 'Off', 'off']` -### `Apache::ServerTokens` +### `Apache::ServerTokens` A string that conforms to the Apache `ServerTokens` syntax. * **See also** * https://httpd.apache.org/docs/2.4/mod/core.html#servertokens -Alias of - -```puppet -Enum['Major', 'Minor', 'Min', 'Minimal', 'Prod', 'ProductOnly', 'OS', 'Full'] -``` +Alias of `Enum['Major', 'Minor', 'Min', 'Minimal', 'Prod', 'ProductOnly', 'OS', 'Full']` -### `Apache::Vhost::Priority` +### `Apache::Vhost::Priority` The priority on vhost -Alias of - -```puppet -Variant[Pattern[/^\d+$/], Integer, Boolean] -``` +Alias of `Variant[Pattern[/^\d+$/], Integer, Boolean]` -### `Apache::Vhost::ProxyPass` +### `Apache::Vhost::ProxyPass` host context. Because the implementation uses SetEnv, you must `include apache::mod::env`; for the same reason, this cannot set the newer `no-proxy` environment variable, which @@ -11614,35 +11610,35 @@ Struct[{ The following parameters are available in the `Apache::Vhost::ProxyPass` data type: -* [`path`](#path) -* [`url`](#url) -* [`params`](#params) -* [`reverse_urls`](#reverse_urls) -* [`reverse_cookies`](#reverse_cookies) -* [`keywords`](#keywords) -* [`setenv`](#setenv) -* [`no_proxy_uris`](#no_proxy_uris) -* [`no_proxy_uris_match`](#no_proxy_uris_match) +* [`path`](#-Apache--Vhost--ProxyPass--path) +* [`url`](#-Apache--Vhost--ProxyPass--url) +* [`params`](#-Apache--Vhost--ProxyPass--params) +* [`reverse_urls`](#-Apache--Vhost--ProxyPass--reverse_urls) +* [`reverse_cookies`](#-Apache--Vhost--ProxyPass--reverse_cookies) +* [`keywords`](#-Apache--Vhost--ProxyPass--keywords) +* [`setenv`](#-Apache--Vhost--ProxyPass--setenv) +* [`no_proxy_uris`](#-Apache--Vhost--ProxyPass--no_proxy_uris) +* [`no_proxy_uris_match`](#-Apache--Vhost--ProxyPass--no_proxy_uris_match) -##### `path` +##### `path` Data type: `String[1]` The virtual path on the local server to map. -##### `url` +##### `url` Data type: `String[1]` The URL to which the path and its children will be mapped. -##### `params` +##### `params` Data type: `Optional[Hash]` Optional [ProxyPass](https://httpd.apache.org/docs/current/mod/mod_proxy.html#proxypass) key-value parameters, such as connection settings. -##### `reverse_urls` +##### `reverse_urls` Data type: `Array[String[1]]` @@ -11650,7 +11646,7 @@ Optional (but usually recommended) URLs for [ProxyPassReverse](https://httpd.apa Allows Apache to adjust certain headers on HTTP redirect responses, to prevent redirects on the back-end from bypassing the reverse proxy. -##### `reverse_cookies` +##### `reverse_cookies` Data type: `Optional[Array[Hash]]` @@ -11666,7 +11662,7 @@ Options: * **:path** `Optional[String[1]]`: Internal path for [ProxyPassReverseCookiePath](https://httpd.apache.org/docs/current/mod/mod_proxy.html#proxypassreversecookiepath) configuration. * **:domain** `Optional[String[1]]`: Internal domain for [ProxyPassReverseCookieDomain](https://httpd.apache.org/docs/current/mod/mod_proxy.html#proxypassreversecookiedomain) configuration. -##### `keywords` +##### `keywords` Data type: `Optional[Array[String[1]]]` @@ -11674,20 +11670,20 @@ Array of optional keywords such as `nocanon`, `interpolate`, or `noquery` suppor by [ProxyPass](https://httpd.apache.org/docs/current/mod/mod_proxy.html#proxypass) (refer to subsection under heading "Additional ProxyPass Keywords"). -##### `setenv` +##### `setenv` Data type: `Optional[Array[String[1]]]` Optional Array of Strings of the form "${env_var_name} ${value}". Uses [SetEnv](https://httpd.apache.org/docs/current/mod/mod_env.html#setenv) to make [Protocol Adjustments](https://httpd.apache.org/docs/current/mod/mod_proxy.html#envsettings) to mod_proxy in the virtual -##### `no_proxy_uris` +##### `no_proxy_uris` Data type: `Optional[Array[String[1]]]` Optional Array of paths to exclude from proxying, using the `!` directive to [ProxyPass](https://httpd.apache.org/docs/current/mod/mod_proxy.html#proxypass). -##### `no_proxy_uris_match` +##### `no_proxy_uris_match` Data type: `Optional[Array[String[1]]]` diff --git a/manifests/vhost.pp b/manifests/vhost.pp index 75e77c2ed1..0c73e9e21e 100644 --- a/manifests/vhost.pp +++ b/manifests/vhost.pp @@ -1325,6 +1325,83 @@ # Any handlers you do not set in these hashes are considered `undefined` within Puppet and # are not added to the virtual host, resulting in the module using their default values. # +# The `directories` param can accepts the different authentication ways, including `gssapi`, `Basic (authz_core)`, +# and others. +# +# * `gssapi` - Specifies mod_auth_gssapi parameters for particular directories in a virtual host directory +# TODO: check, if this Documentation is obsolete +# +# ```puppet +# apache::vhost { 'sample.example.net': +# docroot => '/path/to/directory', +# directories => [ +# { path => '/path/to/different/dir', +# gssapi => { +# acceptor_name => '{HOSTNAME}', +# allowed_mech => ['krb5', 'iakerb', 'ntlmssp'], +# authname => 'Kerberos 5', +# authtype => 'GSSAPI', +# basic_auth => true, +# basic_auth_mech => ['krb5', 'iakerb', 'ntlmssp'], +# basic_ticket_timeout => 300, +# connection_bound => true, +# cred_store => { +# ccache => ['/path/to/directory'], +# client_keytab => ['/path/to/example.keytab'], +# keytab => ['/path/to/example.keytab'], +# }, +# deleg_ccache_dir => '/path/to/directory', +# deleg_ccache_env_var => 'KRB5CCNAME', +# deleg_ccache_perms => { +# mode => '0600', +# uid => 'example-user', +# gid => 'example-group', +# }, +# deleg_ccache_unique => true, +# impersonate => true, +# local_name => true, +# name_attributes => 'json', +# negotiate_once => true, +# publish_errors => true, +# publish_mech => true, +# required_name_attributes => 'auth-indicators=high', +# session_key => 'file:/path/to/example.key', +# signal_persistent_auth => true, +# ssl_only => true, +# use_s4u2_proxy => true, +# use_sessions => true, +# } +# }, +# ], +# } +# ``` +# +# * `Basic` - Specifies mod_authz_core parameters for particular directories in a virtual host directory +# ```puppet +# apache::vhost { 'sample.example.net': +# docroot => '/path/to/directory', +# directories => [ +# { +# path => '/path/to/different/dir', +# auth_type => 'Basic', +# authz_core => { +# require_all => { +# 'require_any' => { +# 'require' => ['user superadmin'], +# 'require_all' => { +# 'require' => ['group admins', 'ldap-group "cn=Administrators,o=Airius"'], +# }, +# }, +# 'require_none' => { +# 'require' => ['group temps', 'ldap-group "cn=Temporary Employees,o=Airius"'] +# } +# } +# } +# }, +# ], +# } +# ``` +# # @param custom_fragment # Pass a string of custom configuration directives to be placed at the end of the directory # configuration. @@ -1405,83 +1482,6 @@ # } # ``` # -# TODO: check, if this Documentation is obsolete -# lint:ignore:parameter_documentation -# @param gssapi -# lint:endignore -# Specfies mod_auth_gssapi parameters for particular directories in a virtual host directory -# ```puppet -# apache::vhost { 'sample.example.net': -# docroot => '/path/to/directory', -# directories => [ -# { path => '/path/to/different/dir', -# gssapi => { -# acceptor_name => '{HOSTNAME}', -# allowed_mech => ['krb5', 'iakerb', 'ntlmssp'], -# authname => 'Kerberos 5', -# authtype => 'GSSAPI', -# basic_auth => true, -# basic_auth_mech => ['krb5', 'iakerb', 'ntlmssp'], -# basic_ticket_timeout => 300, -# connection_bound => true, -# cred_store => { -# ccache => ['/path/to/directory'], -# client_keytab => ['/path/to/example.keytab'], -# keytab => ['/path/to/example.keytab'], -# }, -# deleg_ccache_dir => '/path/to/directory', -# deleg_ccache_env_var => 'KRB5CCNAME', -# deleg_ccache_perms => { -# mode => '0600', -# uid => 'example-user', -# gid => 'example-group', -# }, -# deleg_ccache_unique => true, -# impersonate => true, -# local_name => true, -# name_attributes => 'json', -# negotiate_once => true, -# publish_errors => true, -# publish_mech => true, -# required_name_attributes => 'auth-indicators=high', -# session_key => 'file:/path/to/example.key', -# signal_persistent_auth => true, -# ssl_only => true, -# use_s4u2_proxy => true, -# use_sessions => true, -# } -# }, -# ], -# } -# ``` -# -# lint:ignore:parameter_documentation -# @param authz_core -# lint:endignore -# Specifies mod_authz_core parameters for particular directories in a virtual host directory -# ```puppet -# apache::vhost { 'sample.example.net': -# docroot => '/path/to/directory', -# directories => [ -# { path => '/path/to/different/dir', -# authz_core => { -# require_all => { -# 'require_any' => { -# 'require' => ['user superadmin'], -# 'require_all' => { -# 'require' => ['group admins', 'ldap-group "cn=Administrators,o=Airius"'], -# }, -# }, -# 'require_none' => { -# 'require' => ['group temps', 'ldap-group "cn=Temporary Employees,o=Airius"'] -# } -# } -# } -# }, -# ], -# } -# ``` -# # @param ssl # Enables SSL for the virtual host. SSL virtual hosts only respond to HTTPS queries. #