Merge pull request #1496 from voxpupuli/rel400

CHANGELOG.md

@@ -4,6 +4,47 @@ All notable changes to this project will be documented in this file.
 Each new release typically also includes the latest modulesync defaults.
 These should not affect the functionality of the module.
 
+## [v4.0.0](https://github.com/voxpupuli/puppet-nginx/tree/v4.0.0) (2022-08-24)
+
+[Full Changelog](https://github.com/voxpupuli/puppet-nginx/compare/v3.3.0...v4.0.0)
+
+**Breaking changes:**
+
+- Allow to set log\_format's "escape" parameter [\#1513](https://github.com/voxpupuli/puppet-nginx/pull/1513) ([smortex](https://github.com/smortex))
+- Move header escaping responsibility from the end user to Puppet [\#1512](https://github.com/voxpupuli/puppet-nginx/pull/1512) ([smortex](https://github.com/smortex))
+- Drop Debian 9 \(EOL\) [\#1508](https://github.com/voxpupuli/puppet-nginx/pull/1508) ([smortex](https://github.com/smortex))
+- Drop Ubuntu 16.04 \(EOL\) [\#1507](https://github.com/voxpupuli/puppet-nginx/pull/1507) ([smortex](https://github.com/smortex))
+- Drop run\_dir and make client\_body\_temp\_path/proxy\_temp\_path optional [\#1478](https://github.com/voxpupuli/puppet-nginx/pull/1478) ([b4ldr](https://github.com/b4ldr))
+
+**Implemented enhancements:**
+
+- Add support for Ubuntu 22.04 [\#1514](https://github.com/voxpupuli/puppet-nginx/pull/1514) ([smortex](https://github.com/smortex))
+- Add support for Debian 11 [\#1511](https://github.com/voxpupuli/puppet-nginx/pull/1511) ([smortex](https://github.com/smortex))
+- Add support for RedHat 8 [\#1506](https://github.com/voxpupuli/puppet-nginx/pull/1506) ([stevenzerbe](https://github.com/stevenzerbe))
+- Add create\_resources for nginx\_snippets [\#1487](https://github.com/voxpupuli/puppet-nginx/pull/1487) ([aba-rechsteiner](https://github.com/aba-rechsteiner))
+- proxy: set header X-Forwarded-Host [\#1483](https://github.com/voxpupuli/puppet-nginx/pull/1483) ([nod0n](https://github.com/nod0n))
+- Add support for sieve protocol [\#1477](https://github.com/voxpupuli/puppet-nginx/pull/1477) ([tjikkun](https://github.com/tjikkun))
+
+**Fixed bugs:**
+
+- Fix `log_user` on FreeBSD [\#1503](https://github.com/voxpupuli/puppet-nginx/pull/1503) ([kapouik](https://github.com/kapouik))
+- Switch away from os.distro.codename fact [\#1498](https://github.com/voxpupuli/puppet-nginx/pull/1498) ([root-expert](https://github.com/root-expert))
+
+**Closed issues:**
+
+- nginx::nginx\_servers locations no longer produces valid nginx configuration \(Regression\) [\#1500](https://github.com/voxpupuli/puppet-nginx/issues/1500)
+- Issue with run files for nginx start with system start [\#1372](https://github.com/voxpupuli/puppet-nginx/issues/1372)
+- \(non-Docker\) acceptance test fails because of SELinux when trying to bind to mail ports [\#1114](https://github.com/voxpupuli/puppet-nginx/issues/1114)
+- Error when creating location '/' when $use\_default\_location not false [\#902](https://github.com/voxpupuli/puppet-nginx/issues/902)
+
+**Merged pull requests:**
+
+- Fix acceptance tests on Arch and Ubuntu w/ Puppet 6 [\#1501](https://github.com/voxpupuli/puppet-nginx/pull/1501) ([ekohl](https://github.com/ekohl))
+- README: remove note about "undergoing structural maintenance" [\#1497](https://github.com/voxpupuli/puppet-nginx/pull/1497) ([kenyon](https://github.com/kenyon))
+- do not recreate log\_dir if it is already a symlink [\#1490](https://github.com/voxpupuli/puppet-nginx/pull/1490) ([level-a](https://github.com/level-a))
+- remove allow/deny lists duplicates [\#1489](https://github.com/voxpupuli/puppet-nginx/pull/1489) ([level-a](https://github.com/level-a))
+- Update mime types with upstream [\#1482](https://github.com/voxpupuli/puppet-nginx/pull/1482) ([adriankirchner](https://github.com/adriankirchner))
+
 ## [v3.3.0](https://github.com/voxpupuli/puppet-nginx/tree/v3.3.0) (2021-10-06)
 
 [Full Changelog](https://github.com/voxpupuli/puppet-nginx/compare/v3.2.1...v3.3.0)

REFERENCE.md

@@ -35,6 +35,7 @@
 
 * [`Nginx::DebugConnection`](#nginxdebugconnection)
 * [`Nginx::ErrorLogSeverity`](#nginxerrorlogseverity)
+* [`Nginx::LogFormat`](#nginxlogformat)
 * [`Nginx::Size`](#nginxsize)
 * [`Nginx::Time`](#nginxtime)
 * [`Nginx::UpstreamCustomParameters`](#nginxupstreamcustomparameters)
@@ -78,6 +79,8 @@ The following parameters are available in the `nginx` class:
 * [`service_config_check`](#service_config_check)
 * [`service_config_check_command`](#service_config_check_command)
 * [`reset_timedout_connection`](#reset_timedout_connection)
+* [`nginx_snippets`](#nginx_snippets)
+* [`nginx_snippets_defaults`](#nginx_snippets_defaults)
 * [`client_body_temp_path`](#client_body_temp_path)
 * [`confd_only`](#confd_only)
 * [`confd_purge`](#confd_purge)
@@ -91,6 +94,7 @@ The following parameters are available in the `nginx` class:
 * [`global_mode`](#global_mode)
 * [`limit_req_zone`](#limit_req_zone)
 * [`log_dir`](#log_dir)
+* [`manage_log_dir`](#manage_log_dir)
 * [`log_user`](#log_user)
 * [`log_group`](#log_group)
 * [`log_mode`](#log_mode)
@@ -101,7 +105,6 @@ The following parameters are available in the `nginx` class:
 * [`pid`](#pid)
 * [`proxy_temp_path`](#proxy_temp_path)
 * [`root_group`](#root_group)
-* [`run_dir`](#run_dir)
 * [`sites_available_owner`](#sites_available_owner)
 * [`sites_available_group`](#sites_available_group)
 * [`sites_available_mode`](#sites_available_mode)
@@ -306,13 +309,29 @@ with the non-standard code 444.
 
 Default value: ``undef``
 
+##### <a name="nginx_snippets"></a>`nginx_snippets`
+
+Data type: `Hash`
+
+Specifies a hash from which to generate `nginx::resource::snippet` resources.
+
+Default value: `{}`
+
+##### <a name="nginx_snippets_defaults"></a>`nginx_snippets_defaults`
+
+Data type: `Hash`
+
+Can be used to define default values for the parameter `nginx_snippets`.
+
+Default value: `{}`
+
 ##### <a name="client_body_temp_path"></a>`client_body_temp_path`
 
-Data type: `Variant[Stdlib::Absolutepath, Boolean]`
+Data type: `Optional[Stdlib::Absolutepath]`
 
 
 
-Default value: `$nginx::params::client_body_temp_path`
+Default value: ``undef``
 
 ##### <a name="confd_only"></a>`confd_only`
 
@@ -410,6 +429,14 @@ Data type: `Stdlib::Absolutepath`
 
 Default value: `$nginx::params::log_dir`
 
+##### <a name="manage_log_dir"></a>`manage_log_dir`
+
+Data type: `Boolean`
+
+
+
+Default value: ``true``
+
 ##### <a name="log_user"></a>`log_user`
 
 Data type: `String[1]`
@@ -476,11 +503,11 @@ Default value: `$nginx::params::pid`
 
 ##### <a name="proxy_temp_path"></a>`proxy_temp_path`
 
-Data type: `Variant[Stdlib::Absolutepath, Boolean]`
+Data type: `Optional[Stdlib::Absolutepath]`
 
 
 
-Default value: `$nginx::params::proxy_temp_path`
+Default value: ``undef``
 
 ##### <a name="root_group"></a>`root_group`
 
@@ -490,14 +517,6 @@ Data type: `Any`
 
 Default value: `$nginx::params::root_group`
 
-##### <a name="run_dir"></a>`run_dir`
-
-Data type: `Any`
-
-
-
-Default value: `$nginx::params::run_dir`
-
 ##### <a name="sites_available_owner"></a>`sites_available_owner`
 
 Data type: `Any`
@@ -868,7 +887,7 @@ Default value: `'100'`
 
 ##### <a name="log_format"></a>`log_format`
 
-Data type: `Any`
+Data type: `Hash[String[1], Nginx::LogFormat]`
 
 
 
@@ -1076,6 +1095,7 @@ Default value: `[
     'Host $host',
     'X-Real-IP $remote_addr',
     'X-Forwarded-For $proxy_add_x_forwarded_for',
+    'X-Forwarded-Host $host',
     'X-Forwarded-Proto $scheme',
     'Proxy ""',
   ]`
@@ -2793,7 +2813,7 @@ Default value: `'off'`
 
 ##### <a name="protocol"></a>`protocol`
 
-Data type: `Optional[Enum['imap', 'pop3', 'smtp']]`
+Data type: `Optional[Enum['imap', 'pop3', 'sieve', 'smtp']]`
 
 Mail protocol to use
 
@@ -5022,6 +5042,19 @@ Alias of
 Enum['debug', 'info', 'notice', 'warn', 'error', 'crit', 'alert', 'emerg']
 ```
 
+### <a name="nginxlogformat"></a>`Nginx::LogFormat`
+
+The Nginx::LogFormat data type.
+
+Alias of
+
+```puppet
+Variant[String[1], Struct[{
+    Optional[escape] => Enum['default', 'json', 'none'],
+    format           => String[1],
+  }]]
+```
+
 ### <a name="nginxsize"></a>`Nginx::Size`
 
 The Nginx::Size data type.

metadata.json

@@ -1,6 +1,6 @@
 {
   "name": "puppet-nginx",
-  "version": "3.3.1-rc0",
+  "version": "4.0.0",
   "author": "Vox Pupuli",
   "summary": "Puppet NGINX management module",
   "license": "MIT",