refactor: modernize apache2 custom resources

LIMITATIONS.md

@@ -0,0 +1,5 @@
+# Apache2 Cookbook Limitations
+
+- Supported platforms are limited to the distributions covered by the Kitchen and CI matrices: AlmaLinux 8+, Amazon Linux 2023, CentOS Stream 9+, Debian 12+, Fedora, openSUSE Leap 15+, Oracle Linux 8+, Rocky Linux 8+, and Ubuntu 22.04+.
+- Platform-specific module package availability still depends on the underlying distribution repositories.
+- This modernization branch no longer advertises legacy CentOS, Scientific Linux, FreeBSD, openSUSE classic, SUSE, or Arch support.

documentation/resource_apache2_mod_actions.md

@@ -0,0 +1,25 @@
+# apache2_mod_actions
+
+[Back to resource list](../README.md#resources)
+
+Manages the Apache `mod_actions` configuration file.
+
+## Actions
+
+| Action  | Description               |
+|---------|---------------------------|
+| :create | Create the configuration. |
+
+## Properties
+
+| Name    | Type | Default | Description                                                                                                                        |
+|---------|------|---------|------------------------------------------------------------------------------------------------------------------------------------|
+| actions | Hash | `{}`    | A hash of actions where key is the action-type and value is the cgi-script, e.g. `{ news-handler: '"/cgi-bin/news.cgi" virtual' }` |
+
+## Examples
+
+```ruby
+apache2_mod_actions '' do
+  actions({ 'image/gif' => '/cgi-bin/image.cgi' })
+end
+```

documentation/resource_apache2_mod_alias.md

@@ -0,0 +1,28 @@
+# apache2_mod_alias
+
+[Back to resource list](../README.md#resources)
+
+Manages the Apache `mod_alias` configuration file.
+
+## Actions
+
+| Action  | Description               |
+|---------|---------------------------|
+| :create | Create the configuration. |
+
+## Properties
+
+| Name           | Type   | Default                                             | Description                                                                                 |
+|----------------|--------|-----------------------------------------------------|---------------------------------------------------------------------------------------------|
+| options        | Array  | `['Indexes', 'MultiViews', 'SymLinksIfOwnerMatch']` | Options for the alias directory block.                                                      |
+| icondir        | String | platform-specific (see helpers.rb)                  | The icon directory path.                                                                    |
+| allow_override | Array  | `['None']`                                          | AllowOverride settings. See <https://httpd.apache.org/docs/2.4/mod/core.html#allowoverride> |
+| require        | String | `'all granted'`                                     | Require directive. See <https://httpd.apache.org/docs/2.4/mod/mod_authz_core.html#require>  |
+
+## Examples
+
+```ruby
+apache2_mod_alias '' do
+  options %w(Indexes MultiViews SymLinksIfOwnerMatch)
+end
+```

documentation/resource_apache2_mod_autoindex.md

@@ -0,0 +1,31 @@
+# apache2_mod_autoindex
+
+[Back to resource list](../README.md#resources)
+
+Manages the Apache `mod_autoindex` configuration file.
+
+## Actions
+
+| Action  | Description               |
+|---------|---------------------------|
+| :create | Create the configuration. |
+
+## Properties
+
+| Name                 | Type   | Default                                                                  | Description                                                                                                              |
+|----------------------|--------|--------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------|
+| index_options        | Array  | `['FancyIndexing', 'VersionSort', 'HTMLTable', ...]`                     | Array of directory indexing options. See <https://httpd.apache.org/docs/2.4/mod/mod_autoindex.html#indexoptions>         |
+| readme_name          | String | `'README.html'`                                                          | File inserted at the end of the index listing. See <https://httpd.apache.org/docs/2.4/mod/mod_autoindex.html#readmename> |
+| header_name          | String | `'HEADER.html'`                                                          | File inserted at the top of the index listing. See <https://httpd.apache.org/docs/2.4/mod/mod_autoindex.html#headername> |
+| index_ignore         | Array  | `['.??*', '*~', '*#', 'HEADER*', 'README*', 'RCS', 'CVS', '*,v', '*,t']` | Files to exclude from directory listings.                                                                                |
+| add_icon_by_type     | Array  | platform-specific                                                        | List of icon directives by type.                                                                                         |
+| add_icon_by_encoding | Array  | `['(CMP,/icons/compressed.gif) x-compress x-gzip x-bzip2']`              | Icon directives by encoding.                                                                                             |
+| add_icon             | Array  | platform-specific                                                        | Icon directives by file name or extension.                                                                               |
+| default_icon         | String | `'/icons/unknown.gif'`                                                   | Default icon for unrecognised file types.                                                                                |
+| add_description      | Array  | platform-specific                                                        | Description strings for file types.                                                                                      |
+
+## Examples
+
+```ruby
+apache2_mod_autoindex ''
+```

documentation/resource_apache2_mod_cache_disk.md

@@ -0,0 +1,28 @@
+# apache2_mod_cache_disk
+
+[Back to resource list](../README.md#resources)
+
+Manages the Apache `mod_cache_disk` configuration file.
+
+## Actions
+
+| Action  | Description               |
+|---------|---------------------------|
+| :create | Create the configuration. |
+
+## Properties
+
+| Name                | Type   | Default                            | Description                                                                                                                 |
+|---------------------|--------|------------------------------------|-----------------------------------------------------------------------------------------------------------------------------|
+| cache_root          | String | platform-specific (see helpers.rb) | Root directory for the disk cache.                                                                                          |
+| cache_dir_levels    | String | `'2'`                              | Number of sub-directory levels in the cache. See <https://httpd.apache.org/docs/2.4/mod/mod_cache_disk.html#cachedirlevels> |
+| cache_dir_length    | String | `'1'`                              | Number of characters in sub-directory names. See <https://httpd.apache.org/docs/2.4/mod/mod_cache_disk.html#cachedirlength> |
+| cache_max_file_size | String | `'1000000'`                        | Maximum size of a cached file in bytes. See <https://httpd.apache.org/docs/2.4/mod/mod_cache_disk.html#cachemaxfilesize>    |
+
+## Examples
+
+```ruby
+apache2_mod_cache_disk '' do
+  cache_root '/var/cache/apache2/mod_cache_disk'
+end
+```

documentation/resource_apache2_mod_cgid.md

@@ -0,0 +1,23 @@
+# apache2_mod_cgid
+
+[Back to resource list](../README.md#resources)
+
+Manages the Apache `mod_cgid` configuration file.
+
+## Actions
+
+| Action  | Description               |
+| ------- | ------------------------- |
+| :create | Create the configuration. |
+
+## Properties
+
+| Name        | Type   | Default                                        | Description                         |
+| ----------- | ------ | ---------------------------------------------- | ----------------------------------- |
+| script_sock | String | `<run_dir>/cgisock` (platform-specific)        | Path to the CGI daemon socket file. |
+
+## Examples
+
+```ruby
+apache2_mod_cgid ''
+```

documentation/resource_apache2_mod_dav_fs.md

@@ -0,0 +1,23 @@
+# apache2_mod_dav_fs
+
+[Back to resource list](../README.md#resources)
+
+Manages the Apache `mod_dav_fs` configuration file.
+
+## Actions
+
+| Action  | Description               |
+| ------- | ------------------------- |
+| :create | Create the configuration. |
+
+## Properties
+
+| Name        | Type   | Default                                         | Description                                    |
+| ----------- | ------ | ----------------------------------------------- | ---------------------------------------------- |
+| dav_lock_db | String | `<lock_dir>/DAVLock` (platform-specific)        | Path to the DAV lock database file.            |
+
+## Examples
+
+```ruby
+apache2_mod_dav_fs ''
+```

documentation/resource_apache2_mod_deflate.md

@@ -0,0 +1,24 @@
+# apache2_mod_deflate
+
+[Back to resource list](../README.md#resources)
+
+Manages the Apache `mod_deflate` configuration file.
+
+## Actions
+
+| Action  | Description               |
+|---------|---------------------------|
+| :create | Create the configuration. |
+
+## Properties
+
+| Name                      | Type  | Default                                    | Description                                                                    |
+|---------------------------|-------|--------------------------------------------|--------------------------------------------------------------------------------|
+| add_output_filter_by_type | Hash  | (common MIME types, see resource file)     | An ordered hash of `AddOutputFilterByType DEFLATE <types>` directives.         |
+| browser_match             | Array | (common browser quirks, see resource file) | An array of `BrowserMatch` directives to disable compression for old browsers. |
+
+## Examples
+
+```ruby
+apache2_mod_deflate ''
+```

documentation/resource_apache2_mod_dir.md

@@ -0,0 +1,25 @@
+# apache2_mod_dir
+
+[Back to resource list](../README.md#resources)
+
+Manages the Apache `mod_dir` configuration file.
+
+## Actions
+
+| Action  | Description               |
+|---------|---------------------------|
+| :create | Create the configuration. |
+
+## Properties
+
+| Name            | Type  | Default                                                                            | Description                                        |
+|-----------------|-------|------------------------------------------------------------------------------------|----------------------------------------------------|
+| directory_index | Array | `['index.html', 'index.cgi', 'index.pl', 'index.php', 'index.xhtml', 'index.htm']` | Ordered list of files to serve as directory index. |
+
+## Examples
+
+```ruby
+apache2_mod_dir '' do
+  directory_index %w(index.html index.php)
+end
+```

documentation/resource_apache2_mod_fastcgi.md

@@ -0,0 +1,24 @@
+# apache2_mod_fastcgi
+
+[Back to resource list](../README.md#resources)
+
+Manages the Apache `mod_fastcgi` configuration file.
+
+## Actions
+
+| Action | Description |
+| ------ | ----------- |
+| :create | Create the configuration. |
+
+## Properties
+
+| Name | Type | Default | Description |
+| ---- | ---- | ------- | ----------- |
+| fast_cgi_wrapper | String | `''` | Path to the FastCGI wrapper script. |
+| add_handler | Hash | `{ 1 => 'fastcgi-script .fcgi' }` | An ordered hash of AddHandler directives. |
+
+## Examples
+
+```ruby
+apache2_mod_fastcgi ''
+```

documentation/resource_apache2_mod_fcgid.md

@@ -0,0 +1,24 @@
+# apache2_mod_fcgid
+
+[Back to resource list](../README.md#resources)
+
+Manages the Apache `mod_fcgid` configuration file.
+
+## Actions
+
+| Action | Description |
+| ------ | ----------- |
+| :create | Create the configuration. |
+
+## Properties
+
+| Name | Type | Default | Description |
+| ---- | ---- | ------- | ----------- |
+| add_handler | Hash | `{ 1 => 'fcgid-script .fcgi' }` | An ordered hash of AddHandler directives. |
+| ipc_connect_timeout | Integer | `20` | IPC connection timeout in seconds. |
+
+## Examples
+
+```ruby
+apache2_mod_fcgid ''
+```

documentation/resource_apache2_mod_include.md

@@ -0,0 +1,24 @@
+# apache2_mod_include
+
+[Back to resource list](../README.md#resources)
+
+Manages the Apache `mod_include` (Server Side Includes) configuration file.
+
+## Actions
+
+| Action | Description |
+| ------ | ----------- |
+| :create | Create the configuration. |
+
+## Properties
+
+| Name | Type | Default | Description |
+| ---- | ---- | ------- | ----------- |
+| add_type | Hash | `{ 1 => 'text/html .shtml' }` | An ordered hash of AddType directives. |
+| add_output_filter | Hash | `{ 1 => 'INCLUDES .shtml' }` | An ordered hash of AddOutputFilter directives. |
+
+## Examples
+
+```ruby
+apache2_mod_include ''
+```

documentation/resource_apache2_mod_info.md

@@ -0,0 +1,25 @@
+# apache2_mod_info
+
+[Back to resource list](../README.md#resources)
+
+Manages the Apache `mod_info` configuration file.
+
+## Actions
+
+| Action | Description |
+| ------ | ----------- |
+| :create | Create the configuration. |
+
+## Properties
+
+| Name | Type | Default | Description |
+| ---- | ---- | ------- | ----------- |
+| info_allow_list | String, Array | `['127.0.0.1', '::1']` | IP addresses allowed to access `/server-info`. |
+
+## Examples
+
+```ruby
+apache2_mod_info '' do
+  info_allow_list %w(127.0.0.1 ::1 10.0.0.0/8)
+end
+```

documentation/resource_apache2_mod_ldap.md

@@ -0,0 +1,25 @@
+# apache2_mod_ldap
+
+[Back to resource list](../README.md#resources)
+
+Manages the Apache `mod_ldap` configuration file.
+
+## Actions
+
+| Action | Description |
+| ------ | ----------- |
+| :create | Create the configuration. |
+
+## Properties
+
+| Name | Type | Default | Description |
+| ---- | ---- | ------- | ----------- |
+| location | String | `'/ldap-status'` | URL path for the LDAP status page. |
+| set_handler | String | `'ldap-status'` | Handler for the LDAP status location. |
+| require | String | `'all denied'` | Access control for the LDAP status location. |
+
+## Examples
+
+```ruby
+apache2_mod_ldap ''
+```

documentation/resource_apache2_mod_mime.md

@@ -0,0 +1,25 @@
+# apache2_mod_mime
+
+[Back to resource list](../README.md#resources)
+
+Manages the Apache `mod_mime` configuration file.
+
+## Actions
+
+| Action | Description |
+| ------ | ----------- |
+| :create | Create the configuration. |
+
+## Properties
+
+| Name | Type | Default | Description |
+| ---- | ---- | ------- | ----------- |
+| types_config | String | platform-specific (see helpers.rb) | Path to the MIME types configuration file. |
+| add_type | Hash | (common MIME type mappings, see resource file) | An ordered hash of AddType directives. |
+| add_handler | Hash | `{}` | An ordered hash of AddHandler directives. |
+
+## Examples
+
+```ruby
+apache2_mod_mime ''
+```

documentation/resource_apache2_mod_mime_magic.md

@@ -0,0 +1,23 @@
+# apache2_mod_mime_magic
+
+[Back to resource list](../README.md#resources)
+
+Manages the Apache `mod_mime_magic` configuration file.
+
+## Actions
+
+| Action | Description |
+| ------ | ----------- |
+| :create | Create the configuration. |
+
+## Properties
+
+| Name | Type | Default | Description |
+| ---- | ---- | ------- | ----------- |
+| mime_magic_file | String | platform-specific (see helpers.rb) | Path to the mime magic file. |
+
+## Examples
+
+```ruby
+apache2_mod_mime_magic ''
+```