Skip to content

Commit

Permalink
Update REFERENCE section of README
Browse files Browse the repository at this point in the history
  • Loading branch information
eimlav committed May 1, 2019
1 parent 1019640 commit e9e97f4
Showing 1 changed file with 0 additions and 108 deletions.
108 changes: 0 additions & 108 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -794,120 +794,12 @@ Load balancing scheduler algorithms (`lbmethod`) are listed [in mod_proxy_balanc
<a id="reference"></a>
## Reference

<<<<<<< HEAD
For information on classes, types and functions see the [REFERENCE.md](https://github.com/puppetlabs/puppetlabs-apache/blob/master/REFERENCE.md)
=======
### Public Classes

For information on classes and types, see the [REFERENCE.md](https://github.com/puppetlabs/puppetlabs-java/blob/master/REFERENCE.md). For reference information on `apache::mod::*` classes or types that might be present in the module, but are not supported, see below. For information on the templates, tasks and functions in the module, see below.

#### Classes: `apache::mod::<MODULE NAME>`

Enable and configure specific Apache modules by declaring the class.

For example, to install and enable `mod_alias` with no icons, declare the `apache::mod::alias` class with the `icons_options` parameter set to 'None':

``` puppet
class { 'apache::mod::alias':
icons_options => 'None',
}
```

The following Apache modules have supported classes, many of which allow for parameterized configuration. You can install other Apache modules with the `apache::mod` defined type.

* `actions`
* `alias` (see [`apache::mod::alias`][])
* `auth_basic`
* `auth_cas`\* (see [`apache::mod::auth_cas`][])
* `auth_mellon`\* (see [`apache::mod::auth_mellon`][])
* `auth_kerb`
* `auth_gssapi`
* `authn_core`
* `authn_dbd`\* (see [`apache::mod::authn_dbd`][])
* `authn_file`
* `authnz_ldap`\* (see [`apache::mod::authnz_ldap`][])
* `authnz_pam`
* `authz_default`
* `authz_user`
* `autoindex`
* `cache`
* `cgi`
* `cgid`
* `cluster` (see [`apache::mod::cluster`][])
* `data`
* `dav`
* `dav_fs`
* `dav_svn`\*
* `dbd`
* `deflate\`
* `dev`
* `dir`\*
* `disk_cache` (see [`apache::mod::disk_cache`][])
* `dumpio` (see [`apache::mod::dumpio`][])
* `env`
* `event` (see [`apache::mod::event`][])
* `expires`
* `ext_filter` (see [`apache::mod::ext_filter`][])
* `fastcgi`
* `fcgid`
* `filter`
* `geoip` (see [`apache::mod::geoip`][])
* `headers`
* `http2` (see [`apache::mod::http2`][])
* `include`
* `info`\*
* `intercept_form_submit`
* `itk`
* `jk` (see [`apache::mod::jk`])
* `ldap` (see [`apache::mod::ldap`][])
* `lookup_identity`
* `macro` (see [`apache:mod:macro`][])
* `mime`
* `mime_magic`\*
* `negotiation`
* `nss`\* (see [`apache::mod::nss`][])
* `pagespeed` (see [`apache::mod::pagespeed`][])
* `passenger`\* (see [`apache::mod::passenger`][])
* `perl`
* `peruser`
* `php` (requires [`mpm_module`][] set to `prefork`)
* `prefork`\*
* `proxy`\* (see [`apache::mod::proxy`][])
* `proxy_ajp`
* `proxy_balancer`\* (see [`apache::mod::proxy_balancer`][])
* `proxy_balancer`
* `proxy_html` (see [`apache::mod::proxy_html`][])
* `proxy_http`
* `python` (see [`apache::mod::python`][])
* `reqtimeout`
* `remoteip`\*
* `rewrite`
* `rpaf`\*
* `setenvif`
* `security`
* `shib`\* (see [`apache::mod::shib`])
* `speling`
* `ssl`\* (see [`apache::mod::ssl`][])
* `status`\* (see [`apache::mod::status`][])
* `suphp`
* `userdir`\* (see [`apache::mod::userdir`][])
* `version`
* `vhost_alias`
* `worker`\*
* `wsgi` (see [`apache::mod::wsgi`][])
* `xsendfile`

Modules noted with a * have settings and a template with parameters that allow you to configure the module. Most Apache module class parameters have default values and don't require configuration. For modules with templates, Puppet installs template files with the module. The template files are required for the module to work.
>>>>>>> (FM-7923) Docs edit

### Templates

The Apache module relies heavily on templates to enable the [`apache::vhost`][] and [`apache::mod`][] defined types. These templates are built based on [Facter][] facts specific to your operating system. Unless explicitly called out, most templates are not meant for configuration.

### Tasks

The Apache module has a task that allows a user to reload the Apache config without restarting the service. Please refer to to the [PE documentation](https://puppet.com/docs/pe/2017.3/orchestrator/running_tasks.html) or [Bolt documentation](https://puppet.com/docs/bolt/latest/bolt.html) on how to execute a task.

<a id="limitations"></a>
## Limitations

Expand Down

0 comments on commit e9e97f4

Please sign in to comment.