Forge Home

nginx

NGINX web server module.

35,778 downloads

5,458 latest version

5.0 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Version information

  • 1.0.10 (latest)
  • 1.0.9
  • 1.0.8
  • 1.0.7
  • 1.0.6
  • 1.0.5
  • 1.0.4
  • 1.0.3
  • 1.0.2
  • 1.0.1
  • 1.0.0
  • 0.1.9
  • 0.1.8
  • 0.1.7
  • 0.1.6
  • 0.1.5
  • 0.1.4
  • 0.1.3
  • 0.1.2
  • 0.1.1
released Sep 17th 2019
This version is compatible with:
  • Puppet Enterprise 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x, 2018.1.x, 2017.3.x, 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
  • Puppet >=2.7.20 <7.0.0
  • ,

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'thias-nginx', '1.0.10'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add thias-nginx
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install thias-nginx --version 1.0.10

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download

Documentation

thias/nginx — version 1.0.10 Sep 17th 2019

puppet-nginx

Overview

Install, enable and configure an NGINX web server instance with its main configuration file options as well as additional configuration snippets.

The module is very Red Hat Enterprise Linux focused, as the defaults try to change everything in ways which are typical for RHEL, but it also works on other distributions and is very easy to port if needed.

  • nginx : Main class for the NGINX web server.
  • nginx::file : Manage additional configuration snippets.

Modules

Starting with nginx 1.10, there are now loadable modules available. The modular parameter is set to true by default for Fedora 24+ and RHEL 8+ but may also be explicitly set on other releases when using 1.10+ packages.

The $modules array is used to set modules to be installed and the $modules_absent array is used to set modules to be purged.

Examples

Modular nginx 1.10+ packages with two non-default modules installed :

class { '::nginx:'
  modular => true,
  modules => [ 'http-perl', 'stream' ],
}

Default server, with a typical minimal virtualhost and ready for PHP-FPM :

class { '::nginx':
  # Fix for "upstream sent too big header ..." errors
  fastcgi_buffers     => '8 8k',
  fastcgi_buffer_size => '8k',
  upstream => {
    fpmbackend => 'server unix:/var/run/php-fpm-www.sock',
  },
}
nginx::file { 'www.example.com.conf':
  content => template('mymodule/www.example.com.conf.erb'),
}
# Use the included example FastCGI for PHP configuration
nginx::file { 'php.conf.inc':
  source => 'puppet:///modules/nginx/php.conf.inc',
}

Sample configuration file mymodule/www.example.com.conf.erb mentioned above :

# Main virtualhost
server {
  listen 80;
  server_name www.example.com;
  root /var/www/www.example.com;
  include /etc/nginx/conf.d/php.conf.inc;
  #include /etc/nginx/conf.d/php-to-index.conf.inc
  access_log /var/log/nginx/www.example.com-access.log main;
  error_log /var/log/nginx/www.example.com-error.log;
}

If you intend to use a PHP framework where all non-existing requests must be handled by /index.php, then also install and include php-to-index.conf.inc.