Reference

apache: Guides the basic setup and installation of Apache on your system.
apache::dev: Installs Apache development libraries.
apache::mod::actions: Installs Apache mod_actions
apache::mod::alias: Installs and configures mod_alias.
apache::mod::auth_basic: Installs mod_auth_basic
apache::mod::auth_cas: Installs and configures mod_auth_cas.
apache::mod::auth_gssapi: Installs mod_auth_gsappi.
apache::mod::auth_kerb: Installs mod_auth_kerb
apache::mod::auth_mellon: Installs and configures mod_auth_mellon.
apache::mod::authn_core: Installs mod_authn_core.
apache::mod::authn_dbd: Installs mod_authn_dbd.
apache::mod::authn_file: Installs mod_authn_file.
apache::mod::authnz_ldap: Installs mod_authnz_ldap.
apache::mod::authnz_pam: Installs mod_authnz_pam.
apache::mod::authz_default: Installs and configures mod_authz_default.
apache::mod::authz_user: Installs mod_authz_user
apache::mod::autoindex: Installs mod_autoindex
apache::mod::cache: Installs mod_cache
apache::mod::cgi: Installs mod_cgi.
apache::mod::cgid: Installs mod_cgid.
apache::mod::cluster: Installs mod_cluster.
apache::mod::data: Installs and configures mod_data.
apache::mod::dav: Installs mod_dav.
apache::mod::dav_fs: Installs mod_dav_fs.
apache::mod::dav_svn: Installs and configures mod_dav_svn.
apache::mod::dbd: Installs mod_dbd.
apache::mod::deflate: Installs and configures mod_deflate.
apache::mod::dev: Installs mod_dev.
apache::mod::dir: Installs and configures mod_dir.
apache::mod::disk_cache: Installs and configures mod_disk_cache.
apache::mod::dumpio: Installs and configures mod_dumpio.
apache::mod::env: Installs mod_env.
apache::mod::event: Installs and configures mod_event.
apache::mod::expires: Installs and configures mod_expires.
apache::mod::ext_filter: Installs and configures mod_ext_filter.
apache::mod::fastcgi: Installs mod_fastcgi.
apache::mod::fcgid: Installs and configures mod_fcgid.
apache::mod::filter: Installs mod_filter.
apache::mod::geoip: Installs and configures mod_geoip.
apache::mod::headers: Installs and configures mod_headers.
apache::mod::http2: Installs and configures mod_http2.
apache::mod::include: Installs mod_include.
apache::mod::info: Installs and configures mod_info.
apache::mod::intercept_form_submit: Installs mod_intercept_form_submit.
apache::mod::itk: Installs MPM mod_itk.
apache::mod::jk: Installs mod_jk.
apache::mod::ldap: Installs and configures mod_ldap.
apache::mod::lookup_identity: Installs mod_lookup_identity
apache::mod::macro: Installs mod_macro.
apache::mod::mime: Installs and configures mod_mime.
apache::mod::mime_magic: Installs and configures mod_mime_magic.
apache::mod::negotiation: Installs and configures mod_negotiation.
apache::mod::nss: Installs and configures mod_nss.
apache::mod::pagespeed: Installs and configures mod_pagespeed.
apache::mod::passenger: Installs mod_pasenger.
apache::mod::perl: Installs mod_perl.
apache::mod::peruser: Installs mod_peruser.
apache::mod::php: Installs mod_php.
apache::mod::prefork: Installs and configures MPM prefork.
apache::mod::proxy: Installs and configures mod_proxy.
apache::mod::proxy_ajp: Installs mod_proxy_ajp.
apache::mod::proxy_balancer: Installs and configures mod_proxy_balancer.
apache::mod::proxy_connect: Installs mod_proxy_connect.
apache::mod::proxy_fcgi: Installs mod_proxy_fcgi.
apache::mod::proxy_html: Installs mod_proxy_html.
apache::mod::proxy_http: Installs mod_proxy_http.
apache::mod::proxy_wstunnel: Installs mod_proxy_wstunnel.
apache::mod::python: Installs and configures mod_python.
apache::mod::remoteip: Installs and configures mod_remoteip.
apache::mod::reqtimeout: Installs and configures mod_reqtimeout.
apache::mod::rewrite: Installs mod_rewrite.
apache::mod::rpaf: Installs and configures mod_rpaf.
apache::mod::security: Installs and configures mod_security.
apache::mod::setenvif: Installs mod_setenvif.
apache::mod::shib: Installs and configures mod_shib.
apache::mod::socache_shmcb: Installs mod_socache_shmcb.
apache::mod::speling: Installs mod_spelling.
apache::mod::ssl: Installs mod_ssl.
apache::mod::status: Installs and configures mod_status.
apache::mod::suexec: Installs mod_suexec.
apache::mod::suphp: Installs mod_suphp.
apache::mod::userdir: Installs and configures mod_userdir.
apache::mod::version: Installs mod_version.
apache::mod::vhost_alias: Installs Apache mod_vhost_alias.
apache::mod::worker: Installs and manages the MPM worker.
apache::mod::wsgi: Installs and configures mod_wsgi.
apache::mod::xsendfile: Installs mod_xsendfile.
apache::vhosts: Creates apache::vhost defined types.

Private Classes

apache::confd::no_accf: Manages the no-accf.conf file.
apache::default_confd_files: Helper for setting up default conf.d files.
apache::default_mods: Installs and congfigures default mods for Apache
apache::package: Installs an Apache MPM.
apache::params: This class manages Apache parameters
apache::php: This class installs PHP for Apache.
apache::proxy: This class enabled the proxy module for Apache.
apache::python: This class installs Python for Apache
apache::service: Installs and configures Apache service.
apache::ssl: This class installs Apache SSL capabilities
apache::version: Try to automatically detect the version by OS

Defined types

Public Defined types

apache::balancer: This type will create an apache balancer cluster file inside the conf.d directory.
apache::balancermember: Defines members of mod_proxy_balancer
apache::custom_config: Adds a custom configuration file to the Apache server's conf.d directory.
apache::fastcgi::server: Defines one or more external FastCGI servers to handle specific file types. Use this defined type with mod_fastcgi.
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: Installs packages for an Apache module that doesn't have a corresponding apache::mod::<MODULE NAME> class.
apache::namevirtualhost: Enables name-based virtual hosts
apache::vhost: Allows specialised configurations for virtual hosts that possess requirements outside of the defaults.
apache::vhost::custom: A wrapper around the apache::custom_config defined type.

Private Defined types

apache::default_mods::load: Helper used by apache::default_mods
apache::mpm: Enables the use of Apache MPMs.
apache::peruser::multiplexer: Checks if an Apache module has a class.
apache::peruser::processor: Enables the Peruser module for FreeBSD only.
apache::security::rule_link: Links the activated_rules from apache::mod::security to the respective CRS rules on disk.

Resource types

a2mod: Manage Apache 2 modules

Functions

apache::apache_pw_hash: Hashes a password in a format suitable for htpasswd files read by apache.
apache::bool2httpd: Transform a supposed boolean to On or Off. Passes all other values through.
apache::validate_apache_log_level: Perform simple validation of a string against the list of known log levels.
apache_pw_hash: Hashes a password in a format suitable for htpasswd files read by apache.
bool2httpd: Transform a supposed boolean to On or Off. Pass all other values through.
validate_apache_log_level: Perform simple validation of a string against the list of known log levels.

Tasks

init: Allows you to perform apache service functions

Classes

apache

When this class is declared with the default options, Puppet:

Installs the appropriate Apache software package and required Apache modules for your operating system.
Places the required configuration files in a directory, with the default location determined by your operating system.
Configures the server with a default virtual host and standard port (80) and address (\*) bindings.
Creates a document root directory determined by your operating system, typically /var/www.
Starts the Apache service.

Examples

class { 'apache': }

Configures a default SSL virtual host. If true, Puppet automatically configures the following virtual host using the apache::vhost defined type:

apache::vhost { 'default-ssl':
  port            => 443,
  ssl             => true,
  docroot         => $docroot,
  scriptalias     => $scriptalias,
  serveradmin     => $serveradmin,
  access_log_file => "ssl_${access_log_file}",
}

Note: SSL virtual hosts only respond to HTTPS queries.

Default value: false

`default_type`

Data type: Any

Apache 2.2 only. Sets the MIME content-type sent if the server cannot otherwise determine an appropriate content-type. This directive is deprecated in Apache 2.4 and newer, and is only for backwards compatibility in configuration files.

Default value: 'none'

`default_vhost`

Data type: Boolean

Configures a default virtual host when the class is declared.
To configure customized virtual hosts, set this parameter's 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

`dev_packages`

Data type: Any

Configures a specific dev package to use.
For example, using httpd 2.4 from the IUS yum repo:

include ::apache::dev
class { 'apache':
  apache_name  => 'httpd24u',
  dev_packages => 'httpd24u-devel',
}

Default value: $::apache::params::dev_packages

`docroot`

Data type: Any

Sets the default DocumentRoot location.

Default value: $::apache::params::docroot

`error_documents`

Data type: Any

Determines whether to enable custom error documents on the Apache server.

Default value: false

`group`

Data type: Any

Sets the group ID that owns any Apache processes spawned to answer requests.
By default, Puppet attempts to manage this group as a resource under the apache class, determining the group based on the operating system as detected by the apache::params class. To prevent the group resource from being created and use a group created by another Puppet module, set the manage_group parameter's value to false.

Note: Modifying this parameter only changes the group ID that Apache uses to spawn child processes to access resources. It does not change the user that owns the parent server process.

Note: If enabled, it impacts performance significantly.

Default value: $::apache::params::hostname_lookups

`lib_path`

Data type: Any

Specifies the location whereApache module files are stored.

Note: Do not configure this parameter manually without special reason.

Default value: $::apache::params::lib_path

`log_level`

Data type: Any

Changes the error log's verbosity. Valid options are: alert, crit, debug, emerg, error, info, notice and warn.

Default value: $::apache::params::log_level

`log_formats`

Data type: Any

Define additional LogFormat directives. Values: A hash, such as:

$log_formats = { vhost_common => '%v %h %l %u %t \"%r\" %>s %b' }

There are a number of predefined LogFormats in the httpd.conf that Puppet creates:

  LogFormat "%h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-Agent}i\"" combined
  LogFormat "%h %l %u %t \"%r\" %>s %b" common
  LogFormat "%{Referer}i -> %U" referer
  LogFormat "%{User-agent}i" agent
  LogFormat "%{X-Forwarded-For}i %l %u %t \"%r\" %s %b \"%{Referer}i\" \"%{User-agent}i\"" forwarded

If your log_formats parameter contains one of those, it will be overwritten with your definition.

Default value: {}

`logroot`

Data type: Any

Changes the directory of Apache log files for the virtual host.

Default value: $::apache::params::logroot

`logroot_mode`

Data type: Any

Overrides the default logroot directory's mode.

Note: Do not grant write access to the directory where the logs are stored without being aware of the consequences. See the Apache documentation for details.

Default value: $::apache::params::logroot_mode

`manage_group`

Data type: Boolean

When false, stops Puppet from creating the group resource.
If you have a group created from another Puppet module that you want to use to run Apache, set this to false. Without this parameter, attempting to use a previously established group results in a duplicate resource error.

Default value: true

`supplementary_groups`

Data type: Any

A list of groups to which the user belongs. These groups are in addition to the primary group.
Notice: This option only has an effect when manage_user is set to true.

Default value: []

`manage_user`

Data type: Boolean

When false, stops Puppet from creating the user resource.
This is for instances when you have a user, created from another Puppet module, you want 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

`mod_dir`

Data type: Any

Sets where Puppet places configuration files for your Apache modules.

Default value: $::apache::params::mod_dir

`mod_libs`

Data type: Any

Allows the user to override default module library names.

include apache::params
class { 'apache':
  mod_libs => merge($::apache::params::mod_libs, {
    'wsgi' => 'mod_wsgi_python3.so',
  })
}

Default value: $::apache::params::mod_libs

`mod_packages`

Data type: Any

Allows the user to override default module package names.

include apache::params
class { 'apache':
  mod_packages => merge($::apache::params::mod_packages, {
    'auth_kerb' => 'httpd24-mod_auth_kerb',
  })
}

Default value: $::apache::params::mod_packages

`mpm_module`

Data type: Any

Determines which multi-processing module (MPM) is loaded and configured for the HTTPD process. Valid values are: event, itk, peruser, prefork, worker or false.
You must set this to false to explicitly declare the following classes with custom parameters:

apache::mod::event
apache::mod::itk
apache::mod::peruser
apache::mod::prefork
apache::mod::worker

Default value: undef

`purge_vdir`

Data type: Any

Removes all other Apache configs and virtual hosts.

Note: This parameter is deprecated in favor of the purge_config parameter.

apache::mod::actions

Installs Apache mod_actions

See also https://httpd.apache.org/docs/current/mod/mod_actions.html for additional documentation.

apache::mod::alias

Installs and configures mod_alias.

See also https://httpd.apache.org/docs/current/mod/mod_alias.html for additional documentation.

Sets the local path for an /icons/ Alias. Default depends on operating system:

Debian: /usr/share/apache2/icons
FreeBSD: /usr/local/www/apache24/icons
Gentoo: /var/www/icons
Red Hat: /var/www/icons, except on Apache 2.4, where it's /usr/share/httpd/icons

Default value: $::apache::params::alias_icons_path

apache::mod::auth_basic

Installs mod_auth_basic

See also https://httpd.apache.org/docs/current/mod/mod_auth_basic.html for additional documentation.

apache::mod::auth_cas

Installs and configures mod_auth_cas.

Note The auth_cas module isn't available on RH/CentOS without providing dependency packages provided by EPEL.
See also https://github.com/apereo/mod_auth_cas for additional documentation.

Parameters

The following parameters are available in the apache::mod::auth_cas class.

`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.

Data type: Any

Default value: undef

`cas_certificate_path`

Data type: Any

Default value: undef

apache::mod::auth_gssapi

Installs mod_auth_gsappi.

See also https://github.com/modauthgssapi/mod_auth_gssapi for additional documentation.

apache::mod::auth_kerb

Installs mod_auth_kerb

See also http://modauthkerb.sourceforge.net for additional documentation.

apache::mod::auth_mellon

Installs and configures mod_auth_mellon.

See also https://github.com/Uninett/mod_auth_mellon for additional documentation.

See also https://httpd.apache.org/docs/current/mod/mod_authn_core.html for additional documentation.

Parameters

The following parameters are available in the apache::mod::authn_core class.

`apache_version`

Data type: Any

The version of apache being run.

Default value: $::apache::apache_version

apache::mod::authn_dbd

Installs mod_authn_dbd.

See also https://httpd.apache.org/docs/current/mod/mod_authn_dbd.html for additional documentation.

Parameters

The following parameters are available in the apache::mod::authn_dbd class.

`authn_dbd_params`

Data type: Any

The params needed for the mod to function.

`authn_dbd_dbdriver`

Data type: Any

Selects an apr_dbd driver by name.

Default value: 'mysql'

Installs mod_authn_file.

See also https://httpd.apache.org/docs/2.4/mod/mod_authn_file.html for additional documentation.

apache::mod::authnz_ldap

Installs mod_authnz_ldap.

See also https://httpd.apache.org/docs/current/mod/mod_authnz_ldap.html for additional documentation.

Parameters

The following parameters are available in the apache::mod::authnz_ldap class.

`verify_server_cert`

Data type: Boolean

Whether to force te verification of a server cert or not.

Default value: true

`package_name`

Data type: Any

The name of the ldap package.

Default value: undef

apache::mod::authnz_pam

Installs mod_authnz_pam.

See also https://www.adelton.com/apache/mod_authnz_pam for additional documentation.

apache::mod::authz_default

Installs and configures mod_authz_default.

See also https://httpd.apache.org/docs/current/mod/mod_authz_default.html for additional documentation.

Parameters

The following parameters are available in the apache::mod::authz_default class.

`apache_version`

Data type: Any

Version of Apache to install module on.

Default value: $::apache::apache_version

apache::mod::authz_user

Installs mod_authz_user

See also https://httpd.apache.org/docs/current/mod/mod_authz_user.html for additional documentation.

apache::mod::autoindex

Installs mod_autoindex

See also https://httpd.apache.org/docs/current/mod/mod_autoindex.html for additional documentation.

apache::mod::cache

Installs mod_cache

See also https://httpd.apache.org/docs/current/mod/mod_cache.html for additional documentation.

apache::mod::cgi

Installs mod_cgi.

See also https://httpd.apache.org/docs/current/mod/mod_cgi.html for additional documentation.

apache::mod::cgid

Installs mod_cgid.

See also https://httpd.apache.org/docs/current/mod/mod_cgid.html

apache::mod::cluster

Installs mod_cluster.

Note There is no official package available for mod_cluster, so you must make it available outside of the apache module. Binaries can be found here.
See also https://modcluster.io/ for additional documentation.

Examples

class { '::apache::mod::cluster':
  ip                      => '172.17.0.1',
  allowed_network         => '172.17.0.',
  balancer_name           => 'mycluster',
  version                 => '1.3.1'
}

Parameters

The following parameters are available in the apache::mod::cluster class.

`allowed_network`

Data type: Any

Balanced members network.

`balancer_name`

Data type: Any

Name of balancer.

`ip`

Data type: Any

Specifies the IP address to listen to.

Installs and configures mod_data.

See also https://httpd.apache.org/docs/current/mod/mod_data.html for additional documentation.

Parameters

The following parameters are available in the apache::mod::data class.

`apache_version`

Data type: Any

Version of Apache to install module on.

Default value: undef

apache::mod::dav

Installs mod_dav.

See also https://httpd.apache.org/docs/current/mod/mod_dav.html for additional documentation.

apache::mod::dav_fs

Installs mod_dav_fs.

See also https://httpd.apache.org/docs/current/mod/mod_dav_fs.html for additional documentation.

apache::mod::dav_svn

Installs and configures mod_dav_svn.

See also https://httpd.apache.org/docs/current/mod/mod_dav_svn.html for additional documentation.

Parameters

The following parameters are available in the apache::mod::dav_svn class.

`authz_svn_enabled`

Data type: Any

Specifies whether to install Apache mod_authz_svn

Default value: false

apache::mod::dbd

Installs mod_dbd.

See also https://httpd.apache.org/docs/current/mod/mod_dbd.html for additional documentation.

Parameters

The following parameters are available in the apache::mod::dbd class.

`apache_version`

Used to verify that the Apache version you have requested is compatible with the module.

apache::mod::deflate

Installs and configures mod_deflate.

See also https://httpd.apache.org/docs/current/mod/mod_deflate.html for additional documentation.

Parameters

The following parameters are available in the apache::mod::deflate class.

`types`

Data type: Any

An array of MIME types to be deflated. See https://www.iana.org/assignments/media-types/media-types.xhtml.

Default value: [ 'text/html text/plain text/xml', 'text/css', 'application/x-javascript application/javascript application/ecmascript', 'application/rss+xml', 'application/json', ]

`notes`

Data type: Any

A Hash where the key represents the type and the value represents the note name.

Default value: { 'Input' => 'instream', 'Output' => 'outstream', 'Ratio' => 'ratio', }

apache::mod::dev

Installs mod_dev.

Note This module is deprecated. Please use apache::dev.

apache::mod::dir

Installs and configures mod_dir.

TODO This sets the global DirectoryIndex directive, so it may be necessary to consider being able to modify the apache::vhost to declare DirectoryIndex statements in a vhost configuration
See also https://httpd.apache.org/docs/current/mod/mod_dir.html for additional documentation.

Parameters

The following parameters are available in the apache::mod::dir class.

`types`

Specifies the text-based content types to compress.

`indexes`

Data type: Array[String]

Provides a string for the DirectoryIndex directive

Default value: ['index.html','index.html.var','index.cgi','index.pl','index.php','index.xhtml']

`dir`

Data type: Any

Default value: 'public_html'

apache::mod::disk_cache

Installs and configures mod_disk_cache.

Note Apache 2.2, mod_disk_cache installed. On Apache 2.4, mod_cache_disk installed.
See also https://httpd.apache.org/docs/2.2/mod/mod_disk_cache.html for additional documentation.

Parameters

The following parameters are available in the apache::mod::disk_cache class.

`cache_root`

Data type: Any

Defines the name of the directory on the disk to contain cache files. Default depends on the Apache version and operating system:

Debian: /var/cache/apache2/mod_cache_disk
FreeBSD: /var/cache/mod_cache_disk
Red Hat, Apache 2.4: /var/cache/httpd/proxy
Red Hat, Apache 2.2: /var/cache/mod_proxy

Default value: undef

`cache_ignore_headers`

Data type: Any

Specifies HTTP header(s) that should not be stored in the cache.

Default value: undef

apache::mod::dumpio

Installs and configures mod_dumpio.

See also https://httpd.apache.org/docs/current/mod/mod_dumpio.html for additional documentation.

Examples

class{'apache':
  default_mods => false,
  log_level    => 'dumpio:trace7',
}
class{'apache::mod::dumpio':
  dump_io_input  => 'On',
  dump_io_output => 'Off',
}

Parameters

The following parameters are available in the apache::mod::dumpio class.

`dump_io_input`

Data type: Enum['Off', 'On', 'off', 'on']

Dump all input data to the error log

Default value: 'Off'

`dump_io_output`

Data type: Enum['Off', 'On', 'off', 'on']

Dump all output data to the error log

Default value: 'Off'

apache::mod::env

Installs mod_env.

See also https://httpd.apache.org/docs/current/mod/mod_env.html for additional documentation.

apache::mod::event

Installs and configures mod_event.

Note You cannot include apache::mod::event with apache::mod::itk, apache::mod::peruser, apache::mod::prefork, or apache::mod::worker on the same server.
See also https://httpd.apache.org/docs/current/mod/event.html for additional documentation.

Sets the maximum length of the pending connections queue via the module's ListenBackLog directive. Setting this to false removes the parameter.

Default value: '511'

apache::mod::expires

Installs and configures mod_expires.

See also https://httpd.apache.org/docs/current/mod/mod_expires.html for additional documentation.

Parameters

The following parameters are available in the apache::mod::expires class.

`expires_active`

Data type: Any

Enables generation of Expires headers.

Default value: true

`expires_default`

Data type: Any

Specifies the default algorithm for calculating expiration time using ExpiresByType syntax or interval syntax.

Default value: undef

`expires_by_type`

Data type: Any

Describes a set of MIME content-types and their expiration 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

apache::mod::ext_filter

Installs and configures mod_ext_filter.

See also https://httpd.apache.org/docs/current/mod/mod_ext_filter.html for additional documentation.

Examples

class { 'apache::mod::ext_filter':
  ext_filter_define => {
    'slowdown'       => 'mode=output cmd=/bin/cat preservescontentlength',
    'puppetdb-strip' => 'mode=output outtype=application/json cmd="pdb-resource-filter"',
  },
}

Parameters

The following parameters are available in the apache::mod::ext_filter class.

`ext_filter_define`

Data type: Optional[Hash]

Hash of filter names and their parameters.

Default value: undef

apache::mod::fastcgi

Installs mod_fastcgi.

See also https://github.com/FastCGI-Archives/mod_fastcgi for additional documentation.

apache::mod::fcgid

loaded first; Puppet will not automatically enable it if you set the fcgiwrapper parameter in apache::vhost. include apache::mod::fcgid

apache::vhost { 'example.org': docroot => '/var/www/html', directories => { path => '/var/www/html', fcgiwrapper => { command => '/usr/local/bin/fcgiwrapper', } }, }

See also https://httpd.apache.org/docs/current/mod/mod_fcgid.html for additional documentation.

Examples

The class does not individually parameterize all available options. Instead, configure mod_fcgid using the options hash.

class { 'apache::mod::fcgid':
  options => {
    'FcgidIPCDir'  => '/var/run/fcgidsock',
    'SharememPath' => '/var/run/fcgid_shm',
    'AddHandler'   => 'fcgid-script .fcgi',
  },
}

If you include apache::mod::fcgid, you can set the [FcgidWrapper][] per directory, per virtual host. The module must be

Parameters

The following parameters are available in the apache::mod::fcgid class.

`expires_active`

Enables generation of Expires headers.

`expires_default`

Default algorithm for calculating expiration time.

`expires_by_type`

Value of the Expires header configured by MIME type.

`options`

Data type: Any

Default value: {}

apache::mod::filter

Installs mod_filter.

See also https://httpd.apache.org/docs/current/mod/mod_filter.html for additional documentation.

apache::mod::geoip

Installs and configures mod_geoip.

See also https://dev.maxmind.com/geoip/legacy/mod_geoip2 for additional documentation.

Enables the GeoIPScanProxyHeaders option.

Default value: undef

`scan_proxy_headers_field`

Specifies the header mod_geoip uses to determine the client's IP address.

`use_last_xforwarededfor_ip`

Data type: Any

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

`scan_proxy_header_field`

Data type: Any

Default value: undef

apache::mod::headers

Installs and configures mod_headers.

See also https://httpd.apache.org/docs/current/mod/mod_headers.html for additional documentation.

Parameters

The following parameters are available in the apache::mod::headers class.

`apache_version`

Version of Apache to install module on.

apache::mod::http2

Installs and configures mod_http2.

See also https://httpd.apache.org/docs/current/mod/mod_http2.html for additional documentation.

Sets maximum number of HTTP/2 server pushes that are remembered per HTTP/2 connection.

Data type: Optional[String]

Version of Apache to install module on.

Default value: undef

`h2_push_priority`

Data type: Array[String]

Default value: []

apache::mod::include

Installs mod_include.

See also https://httpd.apache.org/docs/current/mod/mod_include.html for additional documentation.

apache::mod::info

Installs and configures mod_info.

See also https://httpd.apache.org/docs/current/mod/mod_info.html for additional documentation.

Parameters

The following parameters are available in the apache::mod::info class.

`allow_from`

Data type: Any

Whitelist of IPv4 or IPv6 addresses or ranges that can access the info path.

Default value: ['127.0.0.1','::1']

`apache_version`

Data type: Any

Version of Apache to install module on.

Default value: undef

`restrict_access`

Data type: Any

Toggles whether to restrict access to info path. If false, the allow_from whitelist is ignored and any IP address can access the info path.

Default value: true

`info_path`

Data type: Any

Path on server to file containing server configuration information.

Default value: '/server-info'

apache::mod::intercept_form_submit

Installs mod_intercept_form_submit.

See also https://www.adelton.com/apache/mod_intercept_form_submit for additional documentation.

apache::mod::itk

Installs MPM mod_itk.

See also http://mpm-itk.sesse.net for additional documentation.

Used to verify that the Apache version you have requested is compatible with the module.

Default value: undef

apache::mod::jk

Installs mod_jk.

Note shm_file and log_file Depending on how these files are specified, the class creates their final path differently:

Relative path: prepends supplied path with logroot (see below) Absolute path or pipe: uses supplied path as-is

shm_file => 'shm_file'
# Ends up in
$shm_path = '/var/log/httpd/shm_file'

shm_file => '/run/shm_file'
# Ends up in
$shm_path = '/run/shm_file'

shm_file => '"|rotatelogs /var/log/httpd/mod_jk.log.%Y%m%d 86400 -180"'
# Ends up in
$shm_path = '"|rotatelogs /var/log/httpd/mod_jk.log.%Y%m%d 86400 -180"'

See also https://tomcat.apache.org/connectors-doc/reference/apache.html for additional documentation.

Examples

class { '::apache::mod::jk':
  ip                   => '192.168.2.15',
  workers_file         => 'conf/workers.properties',
  mount_file           => 'conf/uriworkermap.properties',
  shm_file             => 'run/jk.shm',
  shm_size             => '50M',
  workers_file_content => {
    <Content>
  },
}

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

`workers_file_content`

Data type: Any

Each directive has the format worker..=. This maps as a hash of hashes, where the outer hash specifies workers, and each inner hash specifies each worker properties and values. Plus, there are two global directives, 'worker.list' and 'worker.maintain' For example, the workers file below should be parameterized as follows:

Worker file:

worker.list = status
worker.list = some_name,other_name

worker.maintain = 60

# Optional comment
worker.some_name.type=ajp13
worker.some_name.socket_keepalive=true

# I just like comments
worker.other_name.type=ajp12 (why would you?)
worker.other_name.socket_keepalive=false

Puppet file:

$workers_file_content = {
  worker_lists    => ['status', 'some_name,other_name'],
  worker_maintain => '60',
  some_name       => {
    comment          => 'Optional comment',
    type             => 'ajp13',
    socket_keepalive => 'true',
  },
  other_name      => {
    comment          => 'I just like comments',
    type             => 'ajp12',
    socket_keepalive => 'false',
  },
}

Default value: {}

`mount_file_content`

Data type: Any

Each directive has the format = . This maps as a hash of hashes, where the outer hash specifies workers, and each inner hash contains two items:

uri_list—an array with URIs to be mapped to the worker
comment—an optional string with a comment for the worker. For example, the mount file below should be parameterized as Figure 2:

Worker file:

# Worker 1
/context_1/ = worker_1
/context_1/* = worker_1

# Worker 2
/ = worker_2
/context_2/ = worker_2
/context_2/* = worker_2

Puppet file:

$mount_file_content = {
  worker_1 => {
    uri_list => ['/context_1/', '/context_1/*'],
    comment  => 'Worker 1',
  },
  worker_2 => {
    uri_list => ['/context_2/', '/context_2/*'],
    comment  => 'Worker 2',
  },
},

Default value: {}

`location_list`

Data type: Any

Default value: []

apache::mod::ldap

Installs and configures mod_ldap.

See also https://httpd.apache.org/docs/current/mod/mod_ldap.html for additional documentation.

Examples

class { 'apache::mod::ldap':
  ldap_trusted_global_cert_file => '/etc/pki/tls/certs/ldap-trust.crt',
  ldap_trusted_global_cert_type => 'CA_DER',
  ldap_trusted_mode             => 'TLS',
  ldap_shared_cache_size        => '500000',
  ldap_cache_entries            => '1024',
  ldap_cache_ttl                => '600',
  ldap_opcache_entries          => '1024',
  ldap_opcache_ttl              => '600',
}

Specifies the SSL/TLS mode to be used when connecting to an LDAP server.

Default value: undef

apache::mod::lookup_identity

Installs mod_lookup_identity

See also https://www.adelton.com/apache/mod_lookup_identity for additional documentation.

apache::mod::macro

Installs mod_macro.

See also https://httpd.apache.org/docs/current/mod/mod_macro.html for additional documentation.

apache::mod::mime

Installs and configures mod_mime.

See also https://httpd.apache.org/docs/current/mod/mod_mime.html for additional documentation.

Parameters

The following parameters are available in the apache::mod::mime class.

`mime_support_package`

Data type: Any

Name of the MIME package to be installed.

Default value: $::apache::params::mime_support_package

`mime_types_config`

Data type: Any

The location of the mime.types file.

Default value: $::apache::params::mime_types_config

`mime_types_additional`

Data type: Any

List of additional MIME types to include.

Default value: undef

apache::mod::mime_magic

Installs and configures mod_mime_magic.

See also https://httpd.apache.org/docs/current/mod/mod_mime_magic.html for additional documentation.

Parameters

The following parameters are available in the apache::mod::mime_magic class.

`magic_file`

Data type: Any

Enable MIME-type determination based on file contents using the specified magic file.

Default value: undef

apache::mod::negotiation

Installs and configures mod_negotiation.

See also [https://httpd.apache.org/docs/current/mod/mod_negotiation.html for additional documentation.

Parameters

The following parameters are available in the apache::mod::negotiation class.

`force_language_priority`

Data type: Variant[Array[String], String]

Action to take if a single acceptable document is not found.

Default value: 'Prefer Fallback'

`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', 'fr', 'he', 'hr', 'it', 'ja', 'ko', 'ltz', 'nl', 'nn', 'no', 'pl', 'pt', 'pt-BR', 'ru', 'sv', 'zh-CN', 'zh-TW' ]

apache::mod::nss

Installs and configures mod_nss.

See also https://pagure.io/mod_nss for additional documentation.

Parameters

The following parameters are available in the apache::mod::nss class.

`transfer_log`

Data type: Any

Path to access.log.

Default value: "${::apache::params::logroot}/access.log"

`error_Log`

Path to error.log

`passwd_file`

Data type: Any

Path to file containing token passwords used for NSSPassPhraseDialog.

Default value: undef

`port`

Data type: Any

Sets the SSL port that should be used by mod_nss.

Default value: 8443

`error_log`

Data type: Any

Default value: "${::apache::params::logroot}/error.log"

apache::mod::pagespeed

Although this apache module requires the mod-pagespeed-stable package, Puppet does not manage the software repositories required to automatically install the package. If you declare this class when the package is either not installed or not available to your package manager, your Puppet run will fail.

TODO Add docs
Note Verify that your system is compatible with the latest Google Pagespeed requirements.
See also https://developers.google.com/speed/pagespeed/module/ for additional documentation.

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.

Change Log:

As of 08/13/2017 there are 84 available/deprecated/removed settings.
Around 08/20/2017 UnionStation was discontinued options were removed.
As of 08/20/2017 there are 77 available/deprecated/removed settings.

Note In Passenger source code you can strip out what are all the available options by looking in
- src/apache2_module/Configuration.cpp
- src/apache2_module/ConfigurationCommands.cpp There are also several undocumented settings.
See also https://www.phusionpassenger.com/library/config/apache/reference/ for additional documentation.

This option sets, for the current application, the value of the following environment variables:

RAILS_ENV
RACK_ENV
WSGI_ENV
NODE_ENV
PASSENGER_APP_ENV

`passenger_conf_package_file`

Data type: Any

Default value: $::apache::params::passenger_conf_package_file

`passenger_data_buffer_dir`

Data type: Any

Specifies the directory in which to store data buffers.

Default value: undef

See also https://perl.apache.org for additional documentation.

apache::mod::peruser

Installs mod_peruser.

TODO Add docs

Data type: Any

Default value: 'Off'

apache::mod::php

Installs mod_php.

TODO Add docs

Parameters

The following parameters are available in the apache::mod::php class.

apache::mod::prefork

Installs and configures MPM prefork.

See also https://httpd.apache.org/docs/current/mod/prefork.html for additional documentation.

Maximum length of the queue of pending connections.

Default value: '511'

apache::mod::proxy

Installs and configures mod_proxy.

See also https://httpd.apache.org/docs/current/mod/mod_proxy.html for additional documentation.

Network timeout for proxied requests.

Default value: '60'

apache::mod::proxy_ajp

Installs mod_proxy_ajp.

See also https://httpd.apache.org/docs/current/mod/mod_proxy_ajp.html for additional documentation.

apache::mod::proxy_balancer

Installs and configures mod_proxy_balancer.

See also https://httpd.apache.org/docs/current/mod/mod_proxy_balancer.html for additional documentation.

Parameters

The following parameters are available in the apache::mod::proxy_balancer class.

`manager`

Data type: Boolean

Toggle whether to enable balancer manager support.

Default value: false

`maanger_path`

Server relative path to balancer manager.

`allow_from`

Data type: Array

List of IPs from which the balancer manager can be accessed.

Default value: ['127.0.0.1','::1']

`apache_version`

Data type: Any

Version of Apache to install module on.

Default value: $::apache::apache_version

`manager_path`

Data type: Stdlib::Absolutepath

Default value: '/balancer-manager'

apache::mod::proxy_connect

Installs mod_proxy_connect.

See also https://httpd.apache.org/docs/current/mod/mod_proxy_connect.html for additional documentation.

Parameters

The following parameters are available in the apache::mod::proxy_connect class.

`apache_version`

Data type: Any

Used to verify that the Apache version you have requested is compatible with the module.

Default value: undef

apache::mod::proxy_fcgi

Installs mod_proxy_fcgi.

See also https://httpd.apache.org/docs/current/mod/mod_proxy_fcgi.html for additional documentation.

apache::mod::proxy_html

Installs mod_proxy_html.

See also https://httpd.apache.org/docs/current/mod/mod_proxy_html.html for additional documentation.

apache::mod::proxy_http

Installs mod_proxy_http.

See also https://httpd.apache.org/docs/current/mod/mod_proxy_http.html for additional documentation.

apache::mod::proxy_wstunnel

Installs mod_proxy_wstunnel.

See also https://httpd.apache.org/docs/current/mod/mod_proxy_wstunnel.html for additional documentation.

apache::mod::python

Installs and configures mod_python.

See also https://github.com/grisha/mod_python for additional documentation.

Parameters

The following parameters are available in the apache::mod::python class.

`loadfile_name`

Data type: Optional[String]

Sets the name of the configuration file that is used to load the python module.

Default value: undef

apache::mod::remoteip

Installs and configures mod_remoteip.

See also https://httpd.apache.org/docs/current/mod/mod_remoteip.html https://httpd.apache.org/docs/current/mod/mod_remoteip.html for additional documentation.

See also https://httpd.apache.org/docs/current/mod/mod_reqtimeout.html for additional documentation.

Parameters

The following parameters are available in the apache::mod::reqtimeout class.

`timeouts`

Data type: Any

List of timeouts and data rates for receiving requests.

Default value: ['header=20-40,minrate=500', 'body=10,minrate=500']

apache::mod::rewrite

Installs mod_rewrite.

See also https://httpd.apache.org/docs/current/mod/mod_rewrite.html for additional documentation.

apache::mod::rpaf

Installs and configures mod_rpaf.

See also https://github.com/gnif/mod_rpaf for additional documentation.

Parameters

The following parameters are available in the apache::mod::rpaf class.

`sethostname`

Data type: Any

Toggles whether to update vhost name so ServerName and ServerAlias work.

Default value: true

`proxy_ips`

Data type: Any

List of IPs & bitmasked subnets to adjust requests for

Default value: [ '127.0.0.1' ]

`header`

Data type: Any

Header to use for the real IP address.

Default value: 'X-Forwarded-For'

`template`

Data type: Any

Path to template to use for configuring mod_rpaf.

Default value: 'apache/mod/rpaf.conf.erb'

apache::mod::security

Installs and configures mod_security.

See also https://github.com/SpiderLabs/ModSecurity/wiki for additional documentation.

Toggles whether to manage ModSecurity Core Rule Set

Default value: true

apache::mod::setenvif

Installs mod_setenvif.

See also https://httpd.apache.org/docs/current/mod/mod_setenvif.html for additional documentation.

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.

Note The Shibboleth module isn't available on RH/CentOS without providing dependency packages provided by Shibboleth's repositories. See the Shibboleth Service Provider Installation Guide.
See also https://wiki.shibboleth.net/confluence/display/SHIB2/NativeSPApacheConfig for additional documentation.

Parameters

The following parameters are available in the apache::mod::shib class.

`suppress_warning`

Data type: Any

Toggles whether to trigger warning on RedHat nodes.

Default value: false

`mod_full_path`

Data type: Any

Specifies a path to the module. Do not manually set this parameter without a special reason.

Default value: undef

`package_name`

Data type: Any

Name of the Shibboleth package to be installed.

Default value: undef

`mod_lib`

Data type: Any

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

apache::mod::socache_shmcb

Installs mod_socache_shmcb.

See also https://httpd.apache.org/docs/current/mod/mod_socache_shmcb.html for additional documentation.

apache::mod::speling

Installs mod_spelling.

See also https://httpd.apache.org/docs/current/mod/mod_speling.html for additional documentation.

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.

To use SSL with a virtual host, you must either set the default_ssl_vhost parameter in ::apache to true or the ssl parameter in apache::vhost to true.

See also https://httpd.apache.org/docs/current/mod/mod_ssl.html for additional documentation.

Pass stapling related OCSP errors on to client.

Default value: undef

`stapling_cache`

Data type: String

Configures the storage type of the global/inter-process SSL Stapling Cache. Only cache type 'shmcb' is supported. Default based on the OS:

Debian/Ubuntu: '${APACHE_RUN_DIR}/ocsp(32768)'.
RedHat: '/run/httpd/ssl_stapling(32768)'.
FreeBSD/Gentoo: '/var/run/ssl_stapling(32768)'.
Suse: '/var/lib/apache2/ssl_stapling(32768)'.

Default value: undef

`ssl_mutex`

Data type: Any

Configures mutex mechanism and lock file directory for all or specified mutexes. Default based on the OS and/or Apache version:

RedHat/FreeBSD/Suse/Gentoo: 'default'.
Debian/Ubuntu + Apache >= 2.4: 'default'.
Debian/Ubuntu + Apache < 2.4: 'file:${APACHE_RUN_DIR}/ssl_mutex'.
Ubuntu 10.04: 'file:/var/run/apache2/ssl_mutex'.

Default value: undef

`apache_version`

Data type: Any

Used to verify that the Apache version you have requested is compatible with the module.

Default value: undef

`package_name`

Data type: Any

Name of ssl package to install.

Default value: undef

apache::mod::status

Installs and configures mod_status.

See also http://httpd.apache.org/docs/current/mod/mod_status.html for additional documentation.

Examples

# Simple usage allowing access from localhost and a private subnet
class { 'apache::mod::status':
  $allow_from => ['127.0.0.1', '10.10.10.10/24'],
}

Parameters

The following parameters are available in the apache::mod::status class.

`allow_from`

Data type: Optional[Array]

Array of hosts, ip addresses, partial network numbers or networks, in CIDR notation specifying what hosts can view the special /server-status URL. Defaults to ['127.0.0.1', '::1'].

Creates Apache < 2.4 directive "Allow from".

Default value: undef

`requires`

Data type: Optional[Variant[String, Array, Hash]]

A Variant type that can be:

String with:
- '' or 'unmanaged' - Host auth control done elsewhere
- 'ip ' - Allowed IPs/ranges
- 'host ' - Allowed names/domains
- 'all [granted|denied]'
Array of strings with ip or host as above
Hash with following keys:
- 'requires' - Value => Array as above
- 'enforce' - Value => String 'Any', 'All' or 'None' This encloses "Require" directives in "<Require(Any|All|None)>" block Optional - If unspecified, "Require" directives follow current flow

Creates Apache >= 2.4 directives "Require"

Default value: undef

`extended_status`

Data type: Enum['On', 'Off', 'on', 'off']

Determines whether to track extended status information for each request, via the ExtendedStatus directive.

Default value: 'On'

`status_path`

Data type: Any

Path assigned to the Location directive which defines the URL to access the server status.

Default value: '/server-status'

`apache_version`

Data type: Any

Used to verify that the Apache version you have requested is compatible with the module.

Default value: undef

apache::mod::suexec

Installs mod_suexec.

See also https://httpd.apache.org/docs/current/mod/mod_suexec.html for additional documentation.

apache::mod::suphp

Installs mod_suphp.

See also https://www.suphp.org/DocumentationView.html?file=apache/INSTALL for additional documentation.

apache::mod::userdir

Installs and configures mod_userdir.

See also https://httpd.apache.org/docs/current/mod/mod_userdir.html for additional documentation.

See also https://httpd.apache.org/docs/current/mod/mod_version.html for additional documentation.

Parameters

The following parameters are available in the apache::mod::version class.

`apache_version`

Data type: Any

Used to verify that the Apache version you have requested is compatible with the module.

Default value: $::apache::apache_version

apache::mod::vhost_alias

Installs Apache mod_vhost_alias.

See also https://httpd.apache.org/docs/current/mod/mod_vhost_alias.html for additional documentation.

apache::mod::worker

Installs and manages the MPM worker.

See also https://httpd.apache.org/docs/current/mod/worker.html for additional documentation.

Used to verify that the Apache version you have requested is compatible with the module.

Default value: undef

apache::mod::wsgi

Installs and configures mod_wsgi.

See also https://github.com/GrahamDumpleton/mod_wsgi for additional documentation.

Defines the path to the mod_wsgi shared object (.so) file.

Default value: undef

apache::mod::xsendfile

Installs mod_xsendfile.

See also https://tn123.org/mod_xsendfile/ for additional documentation.

apache::vhosts

host parameters or Configuring virtual hosts in the README section.

Note See the apache::vhost defined type's reference for a list of all virtual

Examples

To create a name-based virtual host `custom_vhost_1`

class { 'apache::vhosts':
  vhosts => {
    'custom_vhost_1' => {
      'docroot' => '/var/www/custom_vhost_1',
      'port'    => '81',
    },
  },
}

Parameters

The following parameters are available in the apache::vhosts class.

`vhosts`

Data type: Any

A hash, where the key represents the name and the value represents a hash of apache::vhost defined type's parameters.

Default value: {}

Defined types

apache::balancer

Each balancer cluster needs one or more balancer members (that can be declared with the apache::balancermember defined resource type). Using storeconfigs, you can export the apache::balancermember resources on all balancer members, and then collect them on a single apache load balancer server.

Note Currently requires the puppetlabs/concat module on the Puppet Forge and uses storeconfigs on the Puppet Master to export/collect resources from all balancer members.

Examples

apache::balancer { 'puppet00': }

Parameters

The following parameters are available in the apache::balancer defined type.

`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`

Data type: Any

Configures key-value pairs to be used as a ProxySet lines in the configuration.

Default value: {}

`target`

Data type: Any

The path to the file the balancer definition will be written in.

Default value: undef

`collect_exported`

Data type: Any

Determines whether to use exported resources.
If you statically declare all of your backend servers, set this parameter to false to rely on existing, declared balancer member resources. Also, use apache::balancermember with array arguments.
To dynamically declare backend servers via exported resources collected on a central node, set this parameter to true to collect the balancer member resources exported by the balancer member nodes.
If you don't use exported resources, a single Puppet run configures all balancer members. If you use exported resources, Puppet has to run on the balanced nodes first, then run on the balancer.

Default value: true

`options`

Data type: Any

Specifies an array of options after the balancer URL, and accepts any key-value pairs available to ProxyPass.

Default value: []

apache::balancermember

Sets up a balancer member inside a listening service configuration block in the load balancer's apache.cfg.

This type will setup a balancer member inside a listening service configuration block in /etc/apache/apache.cfg on the load balancer. Currently it only has the ability to specify the instance name, url and an array of options. More features can be added as needed. The best way to implement this is to export this resource for all apache balancer member servers, and then collect them on the main apache load balancer.

Note Currently requires the puppetlabs/concat module on the Puppet Forge and uses storeconfigs on the Puppet Master to export/collect resources from all balancer members.

Examples

@@apache::balancermember { 'apache':
  balancer_cluster => 'puppet00',
  url              => "ajp://${::fqdn}:8009"
  options          => ['ping=5', 'disablereuse=on', 'retry=5', 'ttl=120'],
}

Parameters

The following parameters are available in the apache::balancermember defined type.

`name`

The title of the resource is arbitrary and only utilized in the concat fragment name.

Data type: Any

Default value: undef

apache::listen

Default value: undef

`path`

Data type: Any

Specifies a path to the module. Do not manually set this parameter without a special reason.

Default value: undef

apache::namevirtualhost

Adds all related directives to the ports.conf file in the Apache HTTPD configuration directory. Titles can take the forms \*, \*:\<PORT\>, \_default\_:\<PORT\>, \<IP\>, or \<IP\>:\<PORT\>.

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 to evaluate it multiple times with different parameters.
The apache::vhost defined type allows you to have specialized configurations for virtual hosts that have requirements outside the defaults. You can set up a default virtual host within the base ::apache class, as well as set a customized virtual host as the default. Customized virtual hosts have a lower numeric priority than the base class's, causing Apache to process the customized virtual host first.
The apache::vhost defined type uses concat::fragment to build the configuration file. To inject custom fragments for pieces of the configuration that the defined type doesn't inherently support, add a custom fragment.
For the custom fragment's order parameter, the apache::vhost defined type uses multiples of 10, so any order that isn't a multiple of 10 should work.

Note: When creating an apache::vhost, it cannot be named default or default-ssl, because vhosts with these titles are always managed by the module. This means that you cannot override Apache::Vhost['default'] or Apache::Vhost['default-ssl] resources. An optional 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:

Examples

class { 'apache':
  default_vhost     => false,
  default_ssl_vhost => false,
}

Specifies paths to additional static, virtual host-specific Apache configuration files. You can use this parameter to implement a unique, custom configuration not supported by this module.

Default value: []

`aliases`

Data type: Any

Passes a list of [hashes][hash] to the virtual host to create Alias, AliasMatch, ScriptAlias or ScriptAliasMatch directives as per the mod_alias documentation.
For example:

aliases => [
  { aliasmatch       => '^/image/(.*)\.jpg$',
    path             => '/files/jpg.images/$1.jpg',
  },
  { alias            => '/image',
    path             => '/ftp/pub/image',
  },
  { scriptaliasmatch => '^/cgi-bin(.*)',
    path             => '/usr/local/share/cgi-bin$1',
  },
  { scriptalias      => '/nagios/cgi-bin/',
    path             => '/usr/lib/nagios/cgi-bin/',
  },
  { alias            => '/nagios',
    path             => '/usr/share/nagios/html',
  },
],

For the alias, aliasmatch, scriptalias and scriptaliasmatch keys to work, each needs a corresponding context, such as <Directory /path/to/directory> or <Location /some/location/here>. Puppet creates the directives in the order specified in the aliases parameter. As described in the mod_alias documentation, add more specific alias, aliasmatch, scriptalias or scriptaliasmatch parameters before the more general ones to avoid shadowing.

Note: Use the aliases parameter instead of the scriptaliases parameter because you can precisely control the order of various alias directives. Defining ScriptAliases using the scriptaliases parameter means all ScriptAlias directives will come after all Alias directives, which can lead to Alias directives shadowing ScriptAlias directives. This often causes problems; for example, this could cause problems with Nagios.
If apache::mod::passenger is loaded and PassengerHighPerformance is true, the Alias directive might not be able to honor the PassengerEnabled => off statement. See this article for details.

Default value: undef

`comment`

Data type: Optional[Variant[String,Array[String]]]

Adds comments to the header of the configuration file. Pass as string or an array of strings. For example:

comment => "Account number: 123B",

Or:

comment => [
  "Customer: X",
  "Frontend domain: x.example.org",
]

Default value: undef

`custom_fragment`

Data type: Optional[String]

Passes a string of custom configuration directives to place at the end of the virtual host configuration.

Default value: undef

`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

`directoryindex`

Data type: Any

Sets the list of resources to look for when a client requests an index of the directory by specifying a '/' at the end of the directory name. See the DirectoryIndex directive documentation for details.

Default value: ''

Data type: Any

Determines whether to send all error log messages to syslog. This parameter has no effect if either of the error_log_file or error_log_pipe parameters has a value. If none of these parameters has a value, given a virtual host 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

`error_documents`

Data type: Any

A list of hashes which can be used to override the ErrorDocument settings for this virtual host.
For example:

apache::vhost { 'sample.example.net':
  error_documents => [
    { 'error_code' => '503', 'document' => '/service-unavail' },
    { 'error_code' => '407', 'document' => 'https://example.com/proxy/login' },
  ],
}

Default value: undef

`filters`

Data type: Any

Filters enable smart, context-sensitive configuration of output content filters.

apache::vhost { "$::fqdn":
  filters => [
    'FilterDeclare   COMPRESS',
    'FilterProvider  COMPRESS DEFLATE resp=Content-Type $text/html',
    'FilterChain     COMPRESS',
    'FilterProtocol  COMPRESS DEFLATE change=yes;byteranges=no',
  ],
}

Default value: false

`itk`

Data type: Optional[Hash]

Configures ITK in a hash.
Usage typically looks something like:

apache::vhost { 'sample.example.net':
  docroot => '/path/to/directory',
  itk     => {
    user  => 'someuser',
    group => 'somegroup',
  },
}

Valid values are: a hash, which can include the keys:

user + group
assignuseridexpr
assigngroupidexpr
maxclientvhost
nice
limituidrange (Linux 3.5.0 or newer)
limitgidrange (Linux 3.5.0 or newer)

Default value: undef

`action`

Data type: Any

Specifies whether you wish to configure mod_actions action directive which will activate cgi-script when triggered by a request.

Default value: undef

`jk_mounts`

Data type: Any

Sets up a virtual host with JkMount and JkUnMount directives to handle the paths for URL mapping between Tomcat and Apache.
The parameter must be an array of hashes where each hash must contain the worker and either the mount or unmount keys.
Usage typically looks like:

apache::vhost { 'sample.example.net':
  jk_mounts => [
    { mount   => '/*',     worker => 'tcnode1', },
    { unmount => '/*.jpg', worker => 'tcnode1', },
  ],
}

Default value: undef

`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

`keepalive`

Data type: Optional[Enum['on', 'off']]

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

`keepalive_timeout`

Data type: Any

Sets the KeepAliveTimeout directive for the virtual host, which determines the amount of time to wait for subsequent requests on a persistent HTTP connection. By default, 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

`max_keepalive_requests`

Data type: Any

Limits the number of requests allowed per connection to the virtual host. By default, 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

`auth_kerb`

Data type: Boolean

Enable mod_auth_kerb parameters for a virtual host.
Usage typically looks like:

apache::vhost { 'sample.example.net':
  auth_kerb              => `true`,
  krb_method_negotiate   => 'on',
  krb_auth_realms        => ['EXAMPLE.ORG'],
  krb_local_user_mapping => 'on',
  directories            => {
    path         => '/var/www/html',
    auth_name    => 'Kerberos Login',
    auth_type    => 'Kerberos',
    auth_require => 'valid-user',
  },
}

apache::vhost { 'sample.example.net':
  modsec_disable_ids => [ 90015, 90016 ],
}

apache::vhost { 'sample.example.net':
  modsec_disable_ids => { '/location1' => [ 90015, 90016 ] },
}

Default value: undef

`modsec_disable_ips`

Data type: Any

Specifies an array of IP addresses to exclude from mod_security rule matching.

Default value: undef

`modsec_disable_msgs`

Data type: Optional[Variant[Hash, Array]]

Array of mod_security Msgs to remove from the virtual host. Also takes a hash allowing removal of an Msg from a specific location.

apache::vhost { 'sample.example.net':
  modsec_disable_msgs => ['Blind SQL Injection Attack', 'Session Fixation Attack'],
}

apache::vhost { 'sample.example.net':
  modsec_disable_msgs => { '/location1' => ['Blind SQL Injection Attack', 'Session Fixation Attack'] },
}

Default value: undef

`modsec_disable_tags`

Data type: Optional[Variant[Hash, Array]]

Array of mod_security Tags to remove from the virtual host. Also takes a hash allowing removal of an Tag from a specific location.

apache::vhost { 'sample.example.net':
  modsec_disable_tags => ['WEB_ATTACK/SQL_INJECTION', 'WEB_ATTACK/XSS'],
}

apache::vhost { 'sample.example.net':
  modsec_disable_tags => { '/location1' => ['WEB_ATTACK/SQL_INJECTION', 'WEB_ATTACK/XSS'] },
}

Default value: false

`options`

Data type: Any

Sets the Options for the specified virtual host. For example:

apache::vhost { 'site.name.fdqn':
  …
  options => ['Indexes','FollowSymLinks','MultiViews'],
}

Note: If you use the directories parameter of apache::vhost, 'Options', 'Override', and 'DirectoryIndex' are ignored because they are parameters within directories.

Default value: ['Indexes','FollowSymLinks','MultiViews']

`override`

Data type: Any

Sets the overrides for the specified virtual host. Accepts an array of AllowOverride arguments.

Default value: ['None']

`passenger_enabled`

Data type: Optional[Boolean]

Sets the value for the PassengerEnabled directive to on or off. Requires apache::mod::passenger to be included.

apache::vhost { 'sample.example.net':
  docroot     => '/path/to/directory',
  directories => [
    { path              => '/path/to/directory',
      passenger_enabled => 'on',
    },
  ],
}

Note: There is an issue using the PassengerEnabled directive with the PassengerHighPerformance directive.

process – single-threaded, multi-processed I/O concurrency.
thread – multi-threaded, multi-processed I/O concurrency.

  php_values    => [ 'include_path ".:/usr/local/example-app/include"' ],

Default value: {}

`php_flags`

Data type: Any

Allows per-virtual host setting `php_flags``. These flags or values can be overwritten by a user or an application.

Default value: {}

`php_admin_values`

Data type: Any

Allows per-virtual host setting php_admin_value. These flags or values cannot be overwritten by a user or an application.

Default value: {}

`php_admin_flags`

Data type: Any

Allows per-virtual host setting php_admin_flag. These flags or values cannot be overwritten by a user or an application.

Default value: {}

`port`

Data type: Any

Sets the port the host is configured on. The module's defaults ensure the host listens 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

`priority`

Data type: Any

Sets the relative load-order for Apache HTTPD VirtualHost configuration files.
If nothing matches the priority, the first name-based virtual host is used. Likewise, passing a higher priority causes the alphabetically first name-based virtual host to be used if no other names match.

Note: You should not need to use this parameter. However, if you do use it, be 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

`protocols`

Data type: Array[Enum['h2', 'h2c', 'http/1.1']]

Sets the Protocols directive, which lists available protocols for the virutal host.

Default value: []

`protocols_honor_order`

Data type: Optional[Boolean]

Sets the ProtocolsHonorOrder directive which determines wether the order of Protocols sets precedence during negotiation.

Default value: undef

`proxy_dest`

Data type: Any

Specifies the destination address of a ProxyPass configuration.

Default value: undef

`proxy_pass`

Data type: Any

Specifies an array of path => URI values for a ProxyPass configuration. Optionally, parameters can be added as an array.

apache::vhost { 'site.name.fdqn':
  …
  proxy_pass => [
    { 'path' => '/a', 'url' => 'http://backend-a/' },
    { 'path' => '/b', 'url' => 'http://backend-b/' },
    { 'path' => '/c', 'url' => 'http://backend-a/c', 'params' => {'max'=>20, 'ttl'=>120, 'retry'=>300}},
    { 'path' => '/l', 'url' => 'http://backend-xy',
      'reverse_urls' => ['http://backend-x', 'http://backend-y'] },
    { 'path' => '/d', 'url' => 'http://backend-a/d',
      'params' => { 'retry' => '0', 'timeout' => '5' }, },
    { 'path' => '/e', 'url' => 'http://backend-a/e',
      'keywords' => ['nocanon', 'interpolate'] },
    { 'path' => '/f', 'url' => 'http://backend-f/',
      'setenv' => ['proxy-nokeepalive 1','force-proxy-request-1.0 1']},
    { 'path' => '/g', 'url' => 'http://backend-g/',
      'reverse_cookies' => [{'path' => '/g', 'url' => 'http://backend-g/',}, {'domain' => 'http://backend-g', 'url' => 'http:://backend-g',},], },
    { 'path' => '/h', 'url' => 'http://backend-h/h',
      'no_proxy_uris' => ['/h/admin', '/h/server-status'] },
  ],
}

reverse_urls. Optional. This setting is useful when used with mod_proxy_balancer. Values: an array or string.
reverse_cookies. Optional. Sets ProxyPassReverseCookiePath and ProxyPassReverseCookieDomain.
params. Optional. Allows for ProxyPass key-value parameters, such as connection settings.
setenv. Optional. Sets environment variables for the proxy directive. Values: array.

Default value: undef

`proxy_dest_match`

Data type: Any

This directive is equivalent to proxy_dest, but takes regular expressions, see ProxyPassMatch for details.

Default value: undef

`proxy_dest_reverse_match`

Data type: Any

Allows you to pass a ProxyPassReverse if proxy_dest_match is specified. See ProxyPassReverse for details.

Default value: undef

`proxy_pass_match`

Data type: Any

This directive is equivalent to proxy_pass, but takes regular expressions, see ProxyPassMatch for details.

Default value: undef

`redirect_dest`

Data type: Any

Specifies the address to redirect to.

Default value: undef

`redirect_source`

Data type: Any

Specifies the source URIs that redirect to the destination specified in redirect_dest. If more than one item for redirect is supplied, the source and destination must be the same length, and the items are order-dependent.

apache::vhost { 'site.name.fdqn':
  …
  redirect_source => ['/images','/downloads'],
  redirect_dest   => ['http://img.example.com/','http://downloads.example.com/'],
}

Default value: '/'

`redirect_status`

Data type: Any

Specifies the status to append to the redirect.

  apache::vhost { 'site.name.fdqn':
  …
  redirect_status => ['temp','permanent'],
}

Default value: undef

`redirectmatch_regexp`

Data type: Any

Determines which server status should be raised for a given regular expression and where to forward the user to. Entered as an array alongside redirectmatch_status and redirectmatch_dest.

apache::vhost { 'site.name.fdqn':
  …
  redirectmatch_status => ['404','404'],
  redirectmatch_regexp => ['\.git(/.*|$)/','\.svn(/.*|$)'],
  redirectmatch_dest => ['http://www.example.com/$1','http://www.example.com/$2'],
}

Default value: undef

`redirectmatch_status`

Data type: Any

Determines which server status should be raised for a given regular expression and where to forward the user to. Entered as an array alongside redirectmatch_regexp and redirectmatch_dest.

apache::vhost { 'site.name.fdqn':
  …
  redirectmatch_status => ['404','404'],
  redirectmatch_regexp => ['\.git(/.*|$)/','\.svn(/.*|$)'],
  redirectmatch_dest => ['http://www.example.com/$1','http://www.example.com/$2'],
}

Default value: undef

`redirectmatch_dest`

Data type: Any

Determines which server status should be raised for a given regular expression and where to forward the user to. Entered as an array alongside redirectmatch_status and redirectmatch_regexp.

apache::vhost { 'site.name.fdqn':
  …
  redirectmatch_status => ['404','404'],
  redirectmatch_regexp => ['\.git(/.*|$)/','\.svn(/.*|$)'],
  redirectmatch_dest => ['http://www.example.com/$1','http://www.example.com/$2'],
}

Default value: undef

`request_headers`

Data type: Any

Modifies collected request headers in various ways, including adding additional request headers, removing request headers, and so on.

apache::vhost { 'site.name.fdqn':
  …
  request_headers => [
    'append MirrorID "mirror 12"',
    'unset MirrorID',
  ],
}

Default value: undef

`rewrites`

Data type: Optional[Array]

Creates URL rewrite rules. Expects an array of hashes.
Valid Hash keys include comment, rewrite_base, rewrite_cond, rewrite_rule or rewrite_map.
For example, you can specify that anyone trying to access index.html is served welcome.html

apache::vhost { 'site.name.fdqn':
  …
  rewrites => [ { rewrite_rule => ['^index\.html$ welcome.html'] } ]
}

The parameter allows rewrite conditions that, when true, execute the associated rule. For instance, if you wanted to rewrite URLs only if the visitor is using IE

apache::vhost { 'site.name.fdqn':
  …
  rewrites => [
    {
      comment      => 'redirect IE',
      rewrite_cond => ['%{HTTP_USER_AGENT} ^MSIE'],
      rewrite_rule => ['^index\.html$ welcome.html'],
    },
  ],
}

You can also apply multiple conditions. For instance, rewrite index.html to welcome.html only when the browser is Lynx or Mozilla (version 1 or 2)

apache::vhost { 'site.name.fdqn':
  …
  rewrites => [
    {
      comment      => 'Lynx or Mozilla v1/2',
      rewrite_cond => ['%{HTTP_USER_AGENT} ^Lynx/ [OR]', '%{HTTP_USER_AGENT} ^Mozilla/[12]'],
      rewrite_rule => ['^index\.html$ welcome.html'],
    },
  ],
}

Multiple rewrites and conditions are also possible

apache::vhost { 'site.name.fdqn':
  …
  rewrites => [
    {
      comment      => 'Lynx or Mozilla v1/2',
      rewrite_cond => ['%{HTTP_USER_AGENT} ^Lynx/ [OR]', '%{HTTP_USER_AGENT} ^Mozilla/[12]'],
      rewrite_rule => ['^index\.html$ welcome.html'],
    },
    {
      comment      => 'Internet Explorer',
      rewrite_cond => ['%{HTTP_USER_AGENT} ^MSIE'],
      rewrite_rule => ['^index\.html$ /index.IE.html [L]'],
    },
    {
      rewrite_base => /apps/,
      rewrite_rule => ['^index\.cgi$ index.php', '^index\.html$ index.php', '^index\.asp$ index.html'],
    },
    { comment      => 'Rewrite to lower case',
      rewrite_cond => ['%{REQUEST_URI} [A-Z]'],
      rewrite_map  => ['lc int:tolower'],
      rewrite_rule => ['(.*) ${lc:$1} [R=301,L]'],
    },
  ],
}

Refer to the mod_rewrite documentation for more details on what is possible with rewrite rules and conditions.

Note: If you include rewrites in your directories, also include apache::mod::rewrite and consider setting the rewrites using the rewrites parameter in apache::vhost rather than setting the rewrites in the virtual host's directories.

Default value: undef

`rewrite_base`

Data type: Any

The parameter rewrite_base specifies the URL prefix to be used for per-directory (htaccess) RewriteRule directives that substitue a relative path.

Default value: undef

`rewrite_rule`

Data type: Any

The parameter rewrite_rile allows the user to define the rules that will be used by the rewrite engine.

Default value: undef

`rewrite_cond`

Data type: Any

The parameter rewrite_cond defines a rule condition, that when satisfied will implement that rule within the rewrite engine.

Default value: undef

`rewrite_inherit`

Data type: Any

Determines whether the virtual host inherits global rewrite rules.
Rewrite rules may be specified globally (in $conf_file or $confd_dir) or inside the virtual host .conf file. By default, virtual hosts do not inherit global settings. To activate inheritance, specify the rewrites parameter and set rewrite_inherit parameter to true:

apache::vhost { 'site.name.fdqn':
  …
  rewrites => [
    <rules>,
  ],
  rewrite_inherit => `true`,
}

Note: The rewrites parameter is required for this to have effect
Apache activates global Rewrite rules inheritance if the virtual host files contains the following directives:

RewriteEngine On
RewriteOptions Inherit

Refer to the official mod_rewrite documentation, section "Rewriting in Virtual Hosts".

Default value: false

`scriptalias`

Data type: Any

Defines a directory of CGI scripts to be aliased to the path '/cgi-bin', such as '/usr/scripts'.

Default value: undef

`scriptaliases`

Data type: Any

Note: This parameter is deprecated in favor of the aliases parameter.
Passes an array of hashes to the virtual host to create either ScriptAlias or ScriptAliasMatch statements per the mod_alias documentation.

scriptaliases => [
  {
    alias => '/myscript',
    path  => '/usr/share/myscript',
  },
  {
    aliasmatch => '^/foo(.*)',
    path       => '/usr/share/fooscripts$1',
  },
  {
    aliasmatch => '^/bar/(.*)',
    path       => '/usr/share/bar/wrapper.sh/$1',
  },
  {
    alias => '/neatscript',
    path  => '/usr/share/neatscript',
  },
]

The ScriptAlias and ScriptAliasMatch directives are created in the order specified. As with Alias and AliasMatch directives, specify more specific aliases before more general ones to avoid shadowing.

Default value: []

`serveradmin`

Data type: Any

Specifies the email address Apache displays when it renders one of its error pages.

Default value: undef

`serveraliases`

Data type: Any

Sets the ServerAliases of the site.

Default value: []

`servername`

Data type: Any

Sets the servername corresponding to the hostname you connect to the virtual host at.

Default value: $name

`setenv`

Data type: Any

Used by HTTPD to set environment variables for virtual hosts.
Example:

apache::vhost { 'setenv.example.com':
  setenv => ['SPECIAL_PATH /foo/bin'],
}

Default value: []

`setenvif`

Data type: Any

Used by HTTPD to conditionally set environment variables for virtual hosts.

Default value: []

`setenvifnocase`

Data type: Any

Used by HTTPD to conditionally set environment variables for virtual hosts (caseless matching).

Default value: []

`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

`suphp_addhandler`

Data type: Any

Sets up a virtual host with suPHP working together with suphp_configpath and suphp_engine.
An example virtual host configuration with suPHP:

apache::vhost { 'suphp.example.com':
  port             => '80',
  docroot          => '/home/appuser/myphpapp',
  suphp_addhandler => 'x-httpd-php',
  suphp_engine     => 'on',
  suphp_configpath => '/etc/php5/apache2',
  directories      => { path => '/home/appuser/myphpapp',
    'suphp'        => { user => 'myappuser', group => 'myappgroup' },
  }
}

Default value: $::apache::params::suphp_addhandler

`suphp_configpath`

Data type: Any

Sets up a virtual host with suPHP working together with suphp_addhandler and suphp_engine.
An example virtual host configuration with suPHP:

apache::vhost { 'suphp.example.com':
  port             => '80',
  docroot          => '/home/appuser/myphpapp',
  suphp_addhandler => 'x-httpd-php',
  suphp_engine     => 'on',
  suphp_configpath => '/etc/php5/apache2',
  directories      => { path => '/home/appuser/myphpapp',
    'suphp'        => { user => 'myappuser', group => 'myappgroup' },
  }
}

Default value: $::apache::params::suphp_configpath

`suphp_engine`

Data type: Enum['on', 'off']

Sets up a virtual host with suPHP working together with suphp_configpath and suphp_addhandler.
An example virtual host configuration with suPHP:

apache::vhost { 'suphp.example.com':
  port             => '80',
  docroot          => '/home/appuser/myphpapp',
  suphp_addhandler => 'x-httpd-php',
  suphp_engine     => 'on',
  suphp_configpath => '/etc/php5/apache2',
  directories      => { path => '/home/appuser/myphpapp',
    'suphp'        => { user => 'myappuser', group => 'myappgroup' },
  }
}

Default value: $::apache::params::suphp_engine

`vhost_name`

Data type: Any

Enables name-based virtual hosting. If no IP is passed to the virtual host, but the virtual host is assigned a port, then the virtual host name is vhost_name:port. If the virtual host has no assigned IP or port, the virtual host name is set to the title of the resource.

Default value: '*'

`virtual_docroot`

Data type: Any

Sets up a virtual host with a wildcard alias subdomain mapped to a directory with the same name. For example, http://example.com would map to /var/www/example.com.

apache::vhost { 'subdomain.loc':
  vhost_name      => '*',
  port            => '80',
  virtual_docroot => '/var/www/%-2+',
  docroot         => '/var/www',
  serveraliases   => ['*.loc',],
}

Default value: false

`wsgi_daemon_process`

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

Sets up a virtual host with WSGI alongside wsgi_daemon_process_options, wsgi_process_group, wsgi_script_aliases and wsgi_pass_authorization.
A hash that sets the name of the WSGI daemon, accepting certain keys.
An example virtual host configuration with WSGI:

apache::vhost { 'wsgi.example.com':
  port                        => '80',
  docroot                     => '/var/www/pythonapp',
  wsgi_daemon_process         => 'wsgi',
  wsgi_daemon_process_options =>
    { processes    => '2',
      threads      => '15',
      display-name => '%{GROUP}',
    },
  wsgi_process_group          => 'wsgi',
  wsgi_script_aliases         => { '/' => '/var/www/demo.wsgi' },
  wsgi_chunked_request        => 'On',
}

apache::vhost { 'files.example.net':
  docroot     => '/var/www/files',
  directories => [
    { 'path'     => '/var/www/files',
      'provider' => 'files',
      'deny'     => 'from all',
    },
  ],
}

Note: At least one directory should match the docroot parameter. After you start declaring directories, apache::vhost assumes that all required Directory blocks will be declared. If not defined, a single default Directory block is created that matches the docroot parameter.
Available handlers, represented as keys, should be placed within the directory, files, or location hashes. This looks like

apache::vhost { 'sample.example.net':
  docroot     => '/path/to/directory',
  directories => [ { path => '/path/to/directory', handler => value } ],
}

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

`custom_fragment`

Pass a string of custom configuration directives to be placed at the end of the directory configuration.

apache::vhost { 'monitor':
  …
  directories => [
    {
      path => '/path/to/directory',
      custom_fragment => '
<Location /balancer-manager>
  SetHandler balancer-manager
  Order allow,deny
  Allow from all
</Location>
<Location /server-status>
  SetHandler server-status
  Order allow,deny
  Allow from all
</Location>
ProxyStatus On',
    },
  ]
}

Default value: undef

`error_documents`

An array of hashes used to override the ErrorDocument settings for the directory.

apache::vhost { 'sample.example.net':
  directories => [
    { path            => '/srv/www',
      error_documents => [
        { 'error_code' => '503',
          'document'   => '/service-unavail',
        },
      ],
    },
  ],
}

Default value: []

`h2_copy_files`

Sets the H2CopyFiles directive.
Note that you must declare class {'apache::mod::http2': } before using this directive.

Default value: undef

`h2_push_resource`

Sets the H2PushResource directive.
Note that you must declare class {'apache::mod::http2': } before using this directive.

Default value: []

`headers`

Adds lines for Header directives.

apache::vhost { 'sample.example.net':
  docroot     => '/path/to/directory',
  directories => {
    path    => '/path/to/directory',
    headers => 'Set X-Robots-Tag "noindex, noarchive, nosnippet"',
  },
}

Default value: undef

`options`

Lists the Options for the given Directory block.

apache::vhost { 'sample.example.net':
  docroot     => '/path/to/directory',
  directories => [
    { path    => '/path/to/directory',
      options => ['Indexes','FollowSymLinks','MultiViews'],
    },
  ],
}

Default value: ['Indexes','FollowSymLinks','MultiViews']

`shib_compat_valid_user`

Data type: Optional[String]

Default is Off, matching the behavior prior to this command's existence. Addresses a conflict when using Shibboleth in conjunction with other auth/auth modules by restoring standard Apache behavior when processing the valid-user and user Require rules. See the mod_shibdocumentation, and NativeSPhtaccess topic for more details. This key is disabled if apache::mod::shib is not defined.

Default value: undef

`ssl_options`

Data type: Any

String or list of SSLOptions, which configure SSL engine run-time options. This handler takes precedence over SSLOptions set in the parent block of the virtual host.

apache::vhost { 'secure.example.net':
  docroot     => '/path/to/directory',
  directories => [
    { path        => '/path/to/directory',
      ssl_options => '+ExportCertData',
    },
    { path        => '/path/to/different/dir',
      ssl_options => ['-StdEnvVars', '+ExportCertData'],
    },
  ],
}

Default value: undef

`additional_includes`

Specifies paths to additional static, specific Apache configuration files in virtual host directories.

apache::vhost { 'sample.example.net':
  docroot     => '/path/to/directory',
  directories => [
    { path  => '/path/to/different/dir',
      additional_includes => ['/custom/path/includes', '/custom/path/another_includes',],
    },
  ],
}

Default value: $::apache::default_ssl_key

`ssl_verify_client`

Data type: Any

Sets the SSLVerifyClient directive, which sets the certificate verification level for client authentication.

apache::vhost { 'sample.example.net':
  …
  ssl_verify_client => 'optional',
}

Default value: undef

`ssl_verify_depth`

Data type: Any

Sets the SSLVerifyDepth directive, which specifies the maximum depth of CA certificates in client certificate verification. You must set ssl_verify_client for it to take effect.

apache::vhost { 'sample.example.net':
  …
  ssl_verify_client => 'require',
  ssl_verify_depth => 1,
}

apache::vhost { 'sample.example.net':
  …
  ssl_proxy_machine_cert => '/etc/httpd/ssl/client_certificate.pem',
}

Default value: undef

`ssl_proxy_check_peer_cn`

Data type: Optional[Enum['on', 'off']]

Sets the SSLProxyCheckPeerCN directive, which specifies whether the remote server certificate's CN field is compared against the hostname of the request URL.

Default value: undef

`ssl_proxy_check_peer_name`

Data type: Optional[Enum['on', 'off']]

Sets the SSLProxyCheckPeerName directive, which specifies whether the remote server certificate's CN field is compared against the hostname of the request URL.

Default value: undef

`ssl_proxy_check_peer_expire`

Data type: Optional[Enum['on', 'off']]

Sets the SSLProxyCheckPeerExpire directive, which specifies whether the remote server certificate is checked for expiration or not.

Default value: undef

`ssl_options`

Sets the SSLOptions directive, which configures various SSL engine run-time options. This is the global setting for the given virtual host and can be a string or an array.
A string:

apache::vhost { 'sample.example.net':
  …
  ssl_options => '+ExportCertData',
}

An array:

apache::vhost { 'sample.example.net':
  …
  ssl_options => ['+StrictRequire', '+ExportCertData'],
}

a2mod

Manage Apache 2 modules

Properties

The following properties are available in the a2mod type.

`ensure`

Valid values: present, absent

The basic property that the resource should be in.

Default value: present

Parameters

The following parameters are available in the a2mod type.

`name`

namevar

The name of the module to be managed

`lib`

The name of the .so library to be loaded

`identifier`

Module identifier string used by LoadModule. Default: module-name_module

Functions

apache::apache_pw_hash

Type: Ruby 4.x API

Currently uses SHA-hashes, because although this format is considered insecure, its the most secure format supported by the most platforms.

`apache::apache_pw_hash(String[1] $password)`

Currently uses SHA-hashes, because although this format is considered insecure, its the most secure format supported by the most platforms.

Returns: String Return's the hash of the input that was given.

`password`

Data type: String[1]

The input that is to be hashed.

apache::bool2httpd

Type: Ruby 4.x API

Transform a supposed boolean to On or Off. Passes all other values through.

Examples

$trace_enable     = false
$server_signature = 'mail'

bool2httpd($trace_enable) # returns 'Off'
bool2httpd($server_signature) # returns 'mail'
bool2httpd(undef) # returns 'Off'

`apache::bool2httpd(Any $arg)`

The apache::bool2httpd function.

Returns: Any Will return either On or Off if given a boolean value. Return's a string of any other given value.

Examples

$trace_enable     = false
$server_signature = 'mail'

bool2httpd($trace_enable) # returns 'Off'
bool2httpd($server_signature) # returns 'mail'
bool2httpd(undef) # returns 'Off'

`arg`

Data type: Any

The value to be converted into a string.

apache::validate_apache_log_level

Type: Ruby 4.x API

As per http://httpd.apache.org/docs/current/mod/core.html#loglevel * validate_apache_loglevel('info')

Modules maybe specified with their own levels like these: * validate_apache_loglevel('warn ssl:info') * validate_apache_loglevel('warn mod_ssl.c:info') * validate_apache_loglevel('warn ssl_module:info')

Expected to be used from the main or vhost. Might be used from directory too later as apache supports that

`apache::validate_apache_log_level(String $log_level)`

As per http://httpd.apache.org/docs/current/mod/core.html#loglevel * validate_apache_loglevel('info')

Modules maybe specified with their own levels like these: * validate_apache_loglevel('warn ssl:info') * validate_apache_loglevel('warn mod_ssl.c:info') * validate_apache_loglevel('warn ssl_module:info')

Expected to be used from the main or vhost. Might be used from directory too later as apache supports that

Returns: Any Return's an error if the validation fails.

`log_level`

Data type: String

The string that is to be validated.

apache_pw_hash

Type: Ruby 3.x API

Currently uses SHA-hashes, because although this format is considered insecure, its the most secure format supported by the most platforms.

`apache_pw_hash(Any $password)`

Currently uses SHA-hashes, because although this format is considered insecure, its the most secure format supported by the most platforms.

Returns: Any Return's the hash of the input that was given.

`password`

Data type: Any

The input that is to be hashed.

bool2httpd

Type: Ruby 3.x API

Transform a supposed boolean to On or Off. Pass all other values through.

Examples

$trace_enable     = false
$server_signature = 'mail'

bool2httpd($trace_enable) # returns 'Off'
bool2httpd($server_signature) # returns 'mail'
bool2httpd(undef) # returns 'Off'

`bool2httpd(Any $arg)`

The bool2httpd function.

Returns: Any Will return either On or Off if given a boolean value. Return's a string of any other given value.

Examples

$trace_enable     = false
$server_signature = 'mail'

bool2httpd($trace_enable) # returns 'Off'
bool2httpd($server_signature) # returns 'mail'
bool2httpd(undef) # returns 'Off'

`arg`

Data type: Any

The value to be converted into a string.

validate_apache_log_level

Type: Ruby 3.x API

As per http://httpd.apache.org/docs/current/mod/core.html#loglevel * validate_apache_loglevel('info') Modules maybe specified with their own levels like these: * validate_apache_loglevel('warn ssl:info') * validate_apache_loglevel('warn mod_ssl.c:info') * validate_apache_loglevel('warn ssl_module:info') Expected to be used from the main or vhost. Might be used from directory too later as apaceh supports that

`validate_apache_log_level(Any $log_level)`

As per http://httpd.apache.org/docs/current/mod/core.html#loglevel * validate_apache_loglevel('info') Modules maybe specified with their own levels like these: * validate_apache_loglevel('warn ssl:info') * validate_apache_loglevel('warn mod_ssl.c:info') * validate_apache_loglevel('warn ssl_module:info') Expected to be used from the main or vhost. Might be used from directory too later as apaceh supports that

Returns: Any Return's an error if the validation fails.

`log_level`

Data type: Any

The string that is to be validated.

Tasks

init

Allows you to perform apache service functions

Supports noop? false

Parameters

`action`

Data type: Enum[reload]

Action to perform

`service_name`

Data type: Optional[String[1]]

The name of the apache service

Files

REFERENCE.md

Latest commit

History

REFERENCE.md

File metadata and controls

Reference

Table of Contents

Classes

apache

Examples

Parameters

allow_encoded_slashes

apache_version

conf_dir

conf_template

confd_dir

default_charset

default_confd_files

default_mods

default_ssl_ca

default_ssl_cert

default_ssl_chain

default_ssl_crl

default_ssl_crl_path

default_ssl_crl_check

default_ssl_key

default_ssl_vhost

default_type

default_vhost

dev_packages

docroot

error_documents

group

httpd_dir

http_protocol_options

keepalive

keepalive_timeout

max_keepalive_requests

hostname_lookups

lib_path

log_level

log_formats

logroot

logroot_mode

manage_group

supplementary_groups

manage_user

mod_dir

mod_libs

mod_packages

mpm_module

package_ensure

pidfile

ports_file

protocols

protocols_honor_order

purge_configs

purge_vhost_dir

rewrite_lock

sendfile

serveradmin

servername

server_root

server_signature

server_tokens

service_enable

service_ensure

service_name

service_manage

service_restart

timeout

trace_enable

use_canonical_name

use_systemd

file_mode

root_directory_options

root_directory_secured

vhost_dir

vhost_include_pattern

`allow_encoded_slashes`

`apache_version`

`conf_dir`

`conf_template`

`confd_dir`

`default_charset`

`default_confd_files`

`default_mods`

`default_ssl_ca`

`default_ssl_cert`

`default_ssl_chain`

`default_ssl_crl`

`default_ssl_crl_path`

`default_ssl_crl_check`

`default_ssl_key`

`default_ssl_vhost`

`default_type`

`default_vhost`

`dev_packages`

`docroot`

`error_documents`

`group`

`httpd_dir`

`http_protocol_options`

`keepalive`

`keepalive_timeout`

`max_keepalive_requests`

`hostname_lookups`

`lib_path`

`log_level`

`log_formats`

`logroot`

`logroot_mode`

`manage_group`

`supplementary_groups`

`manage_user`

`mod_dir`

`mod_libs`

`mod_packages`

`mpm_module`

`package_ensure`

`pidfile`

`ports_file`

`protocols`

`protocols_honor_order`

`purge_configs`

`purge_vhost_dir`

`rewrite_lock`

`sendfile`

`serveradmin`

`servername`

`server_root`

`server_signature`

`server_tokens`

`service_enable`

`service_ensure`

`service_name`

`service_manage`

`service_restart`

`timeout`

`trace_enable`

`use_canonical_name`

`use_systemd`

`file_mode`

`root_directory_options`

`root_directory_secured`

`vhost_dir`

`vhost_include_pattern`

`user`

`apache_name`

`error_log`

`scriptalias`

`access_log_file`

`limitreqfields`

`limitreqfieldsize`

`ip`

`purge_vdir`

`conf_enabled`

`vhost_enable_dir`

`mod_enable_dir`