Installs nginx from package OR source code and sets up configuration handling similar to Debian's Apache2 scripts.
This cookbook is a fork from the 2.7.x branch of the community nginx cookbook. This branch will be actively supported by Chef Software.
We will continue to migrate the cookbook to a more resource driven model, with incremental changes that are non-breaking when possible.
If this cookbook is eventually merged into the nginx
namespace on the supermarket, this chef_nginx
cookbook will receive updates in parallel (mirroring) in order to minimize disruption to users that have adopted this cookbook.
The following cookbooks are direct dependencies because they're used for common "default" functionality.
build-essential
for source installationsohai
for setting up the ohai pluginrunit
for source installs using the runit init systemcompat_resource
for setting up the nginx.org repository on Chef 12.1 - 12.13yum-epel
for setting up the EPEL repository on RHEL platformszypper
for setting up the nginx.org repository on Suse platforms
The following platforms are supported and tested with Test Kitchen:
- Ubuntu 12.04+
- CentOS 5+
- Debian 7+
- openSUSE 13.2+
- FreeBSD 9+
Other Debian and RHEL family distributions are assumed to work.
- Chef 12.1+
Node attributes for this cookbook are logically separated into different files. Some attributes are set only via a specific recipe.
These attributes are used in the chef_nginx::auth_request
recipe.
node['nginx']['auth_request']['url']
- The url to the auth_request module tar.gz filenode['nginx']['auth_request']['checksum']
- The checksum of the auth_request module tar.gz file
Generally used attributes. Some have platform specific values. See attributes/default.rb
. "The Config" refers to "nginx.conf" the main config file.
node['nginx']['dir']
- Location for nginx configuration.node['nginx']['conf_template']
- Thesource
template to use when creating thenginx.conf
.node['nginx']['conf_cookbook']
- The cookbook wherenode['nginx']['conf_template']
resides.node['nginx']['log_dir']
- Location for nginx logs.node['nginx']['log_dir_perm']
- Permissions for nginx logs folder.node['nginx']['user']
- User that nginx will run as.node['nginx']['group]
- Group for nginx.node['nginx']['port']
- Port for nginx to listen on.node['nginx']['binary']
- Path to the nginx binary.node['nginx']['init_style']
- How to run nginx as a service when usingchef_nginx::source
. Values can be "runit", "upstart", or "init". When using runit that recipes will be included as well. Recipes are not included for upstart, it is assumed that upstart is built into the platform you are using (ubuntu). This attribute is not used in thepackage
recipe because the package manager's init script style for the platform is assumed.node['nginx']['upstart']['foreground']
- Set this to true if you want upstart to run nginx in the foreground, set to false if you want upstart to detach and track the process via pid.node['nginx']['upstart']['runlevels']
- String of runlevels in the format '2345' which determines which runlevels nginx will start at when entering and stop at when leaving.node['nginx']['upstart']['respawn_limit']
- Respawn limit in upstart stanza format, count followed by space followed by interval in seconds.node['nginx']['pid']
- Location of the PID file.node['nginx']['keepalive']
- Whether to usekeepalive_timeout
, any value besides "on" will leave that option out of the config.node['nginx']['keepalive_requests']
- used for config value ofkeepalive_requests
.node['nginx']['keepalive_timeout']
- used for config value ofkeepalive_timeout
.node['nginx']['worker_processes']
- used for config value ofworker_processes
.node['nginx']['worker_connections']
- used for config value ofevents { worker_connections }
node['nginx']['worker_rlimit_nofile']
- used for config value ofworker_rlimit_nofile
. Can replace any "ulimit -n" command. The value depend on your usage (cache or not) but must always be superior than worker_connections.node['nginx']['multi_accept']
- used for config value ofevents { multi_accept }
. Try to accept() as many connections as possible. Disable by default.node['nginx']['event']
- used for config value ofevents { use }
. Set the event-model. By default nginx looks for the most suitable method for your OS.node['nginx']['accept_mutex_delay']
- used for config value ofaccept_mutex_delay
node['nginx']['server_tokens']
- used for config value ofserver_tokens
.node['nginx']['server_names_hash_bucket_size']
- used for config value ofserver_names_hash_bucket_size
.node['nginx']['disable_access_log']
- set to true to disable the general access log, may be useful on high traffic sites.node['nginx']['access_log_options']
- Set to a string of additional options to be appended to the access log directivenode['nginx']['error_log_options']
- Set to a string of additional options to be appended to the error log directivenode['nginx']['default_site_enabled']
- enable the default sitenode['nginx']['sendfile']
- Whether to usesendfile
. Defaults to "on".node['nginx']['tcp_nopush']
- Whether to usetcp_nopush
. Defaults to "on".node['nginx']['tcp_nodelay']
- Whether to usetcp_nodelay
. Defaults to "on".node['nginx']['install_method']
- Whether nginx is installed from packages or from source.node['nginx']['types_hash_max_size']
- Used for thetypes_hash_max_size
configuration directive.node['nginx']['types_hash_bucket_size']
- Used for thetypes_hash_bucket_size
configuration directive.node['nginx']['proxy_read_timeout']
- defines a timeout (between two successive read operations) for reading a response from the proxied server.node['nginx']['client_body_buffer_size']
- used for config value ofclient_body_buffer_size
.node['nginx']['client_max_body_size']
- specifies the maximum accepted body size of a client request, as indicated by the request header Content-Length.node['nginx']['repo_source']
- when installed from a package this attribute affects which yum repositories, if any, will be added before installing the nginx package. The default value of 'epel' will use theyum-epel
cookbook, 'nginx' will use thechef_nginx::repo
recipe, 'passenger' will use the 'chef_nginx::repo_passenger' recipe, and setting no value will not add any additional repositories.node['nginx']['sts_max_age']
- Enable Strict Transport Security for all apps (See: http://en.wikipedia.org/wiki/HTTP_Strict_Transport_Security). This attribute adds the following header: Strict-Transport-Security max-age=SECONDS to all incoming requests and takes an integer (in seconds) as its argument.node['nginx']['default']['modules']
- Array specifying which modules to enable via the conf-enabled config include function. Currently the only valid value is "socketproxy".
node['nginx']['remote_ip_var']
- The remote ip variable name to use.node['nginx']['authorized_ips']
- IPs authorized by the module
node['nginx']['gzip']
- Whether to use gzip, can be "on" or "off"node['nginx']['gzip_http_version']
- used for config value ofgzip_http_version
.node['nginx']['gzip_comp_level']
- used for config value ofgzip_comp_level
.node['nginx']['gzip_proxied']
- used for config value ofgzip_proxied
.node['nginx']['gzip_vary']
- used for config value ofgzip_vary
.node['nginx']['gzip_buffers']
- used for config value ofgzip_buffers
.node['nginx']['gzip_types']
- used for config value ofgzip_types
- must be an Array.node['nginx']['gzip_min_length']
- used for config value ofgzip_min_length
.node['nginx']['gzip_disable']
- used for config value ofgzip_disable
.node['nginx']['gzip_static']
- used for config value ofgzip_static
(http_gzip_static_module
must be enabled)
node['nginx']['extra_configs']
- a Hash of key/values to nginx configuration.
These attributes are used in the chef_nginx::http_echo_module
recipe.
node['nginx']['echo']['version']
- The version ofhttp_echo
you want (default: 0.59)node['nginx']['echo']['url']
- URL for the tarball.node['nginx']['echo']['checksum']
- Checksum of the tarball.
These attributes are used in the chef_nginx::ngx_devel_module
recipe.
node['nginx']['devel']['version']
- The version of the nginx devel modulenode['nginx']['devel']['url']
- The URL of the nginx devel module tar.gz filenode['nginx']['devel']['checksum']
- The checksum of the nginx devel module tar.gz file
These attributes are used in the chef_nginx::http_geoip_module
recipe. Please note that the country_dat_checksum
and city_dat_checksum
are based on downloads from a datacenter in Fremont, CA, USA. You really should override these with checksums for the geo tarballs from your node location.
Note The upstream, maxmind.com, may block access for repeated downloads of the data files. It is recommended that you download and host the data files, and change the URLs in the attributes.
node['nginx']['geoip']['path']
- Location where to install the geoip libraries.node['nginx']['geoip']['enable_city']
- Whether to enable City datanode['nginx']['geoip']['country_dat_url']
- Country data tarball URLnode['nginx']['geoip']['country_dat_checksum']
- Country data tarball checksumnode['nginx']['geoip']['city_dat_url']
- City data tarball URLnode['nginx']['geoip']['city_dat_checksum']
- City data tarball checksumnode['nginx']['geoip']['lib_version']
- Version of the GeoIP library to installnode['nginx']['geoip']['lib_url']
- (Versioned) Tarball URL of the GeoIP librarynode['nginx']['geoip']['lib_checksum']
- Checksum of the GeoIP library tarball
From: http://nginx.org/en/docs/http/ngx_http_realip_module.html
node['nginx']['realip']['header']
- Header to use for the RealIp Module; only accepts "X-Forwarded-For" or "X-Real-IP"node['nginx']['realip']['addresses']
- Addresses to use for thehttp_realip
configuration.node['nginx']['realip']['real_ip_recursive']
- If recursive search is enabled, the original client address that matches one of the trusted addresses is replaced by the last non-trusted address sent in the request header field. Can be on "on" or "off" (default).
These attributes are used in the chef_nginx::passenger
recipe.
node['nginx']['passenger']['version']
- passenger gem versionnode['nginx']['passenger']['root']
- passenger gem root pathnode['nginx']['passenger']['install_rake']
- set to false if rake already present on systemnode['nginx']['passenger']['max_pool_size']
- maximum passenger pool size (default=10)node['nginx']['passenger']['ruby']
- Ruby path for Passenger to use (default=$(which ruby)
)node['nginx']['passenger']['spawn_method']
- passenger spawn method to use (default=smart-lv2
)node['nginx']['passenger']['buffer_response']
- turns on or off response buffering (default=on
)node['nginx']['passenger']['max_pool_size']
- passenger maximum pool size (default=6
)node['nginx']['passenger']['min_instances']
- minimum instances (default=1
)node['nginx']['passenger']['max_instances_per_app']
- maximum instances per app (default=0
)node['nginx']['passenger']['pool_idle_time']
- passenger pool idle time (default=300
)node['nginx']['passenger']['max_requests']
- maximum requests (default=0
)node['nginx']['passenger']['nodejs']
- Nodejs path for Passenger to use (default=nil)node['nginx']['passenger']['show_version_in_header']
- Show passenger version in HTTP headers (default=on
)
Basic configuration to use the official Phusion Passenger repositories:
node['nginx']['repo_source']
- 'passenger'node['nginx']['package_name']
- 'nginx-extras'node['nginx']['passenger']['install_method']
- 'package'
These attributes are used in the chef_nginx::openssl_source
recipe.
node['nginx']['openssl_source']['version']
- The version of OpenSSL you want to download and use (default: 1.0.1t)node['nginx']['openssl_source']['url']
- The url for the OpenSSL source
node['nginx']['enable_rate_limiting']
- set to true to enable rate limiting (limit_req_zone
in nginx.conf)node['nginx']['rate_limiting_zone_name']
- sets the zone inlimit_req_zone
.node['nginx']['rate_limiting_backoff']
- sets the backoff time forlimit_req_zone
.node['nginx']['rate_limit']
- set the rate limit amount forlimit_req_zone
.
These attributes are used in the chef_nginx::socketproxy
recipe.
node['nginx']['socketproxy']['root']
- The directory (on your server) where socketproxy apps are deployed.node['nginx']['socketproxy']['default_app']
- Static assets directory for requests to "/" that don't meet any proxy_pass filter requirements.node['nginx']['socketproxy']['apps']['app_name']['prepend_slash']
- Prepend a slash to requests to app "app_name" before sending them to the socketproxy socket.node['nginx']['socketproxy']['apps']['app_name']['context_name']
- URI (e.g. "app_name" in order to achieve "http://mydomain.com/app_name") at which to host the application "app_name"node['nginx']['socketproxy']['apps']['app_name']['subdir']
- Directory (undernode['nginx']['socketproxy']['root']
) in which to find the application.
These attributes are used in the chef_nginx::source
recipe. Some of them are dynamically modified during the run. See attributes/source.rb
for default values.
node['nginx']['source']['url']
- (versioned) URL for the nginx source code. By default this will use the version specified asnode['nginx']['version']
.node['nginx']['source']['prefix']
- (versioned) prefix for installing nginx from sourcenode['nginx']['source']['conf_path']
- location of the main config file, innode['nginx']['dir']
by default.node['nginx']['source']['modules']
- Array of modules that should be compiled into nginx by including their recipes inchef_nginx::source
.node['nginx']['source']['default_configure_flags']
- The default flags passed to the configure script when building nginx.node['nginx']['configure_flags']
- Preserved for compatibility and dynamically generated from thenode['nginx']['source']['default_configure_flags']
in thechef_nginx::source
recipe.node['nginx']['source']['use_existing_user']
- set totrue
if you do not wantchef_nginx::source
recipe to create system user with namenode['nginx']['user']
.
These attributes are used in the chef_nginx::http_stub_status_module
recipe.
node['nginx']['status']['port']
- The port on which nginx will serve the status info (default: 8090)
These attributes are used in the chef_nginx::syslog_module
recipe.
node['nginx']['syslog']['git_repo']
- The git repository url to use for the syslog patches.node['nginx']['syslog']['git_revision']
- The revision on the git repository to checkout.
These attributes are used in the chef_nginx::upload_progress_module
recipe.
node['nginx']['upload_progress']['url']
- URL for the tarball.node['nginx']['upload_progress']['checksum']
- Checksum of the tarball.node['nginx']['upload_progress']['javascript_output']
- Output in javascript. Default istrue
for backwards compatibility.node['nginx']['upload_progress']['zone_name']
- Zone name which will be used to store the per-connection tracking information. Default isproxied
.node['nginx']['upload_progress']['zone_size']
- Zone size in bytes. Default is1m
(1 megabyte).
This cookbook provides three main recipes for installing nginx.
default.rb
- Use this recipe to install nginx from either a distro package or a package provided by the repo recipe below. Note you'll need to include the repo recipe first if you plan to use the nginx.org repo.repo.rb
- Use this recipe if you want to use official nginx.org repositories for RHEL, Debian/Ubuntu, and Suse platforms.source.rb
- Use this recipe to compile nginx from source to avoid distro/nginx.org packages. This gives you the ultimate control over the version of nginx you use and the included modules, but it requires a number of compilation tools and time.
Several recipes are related to the source
recipe specifically. See that recipe's section below for a description.
The default recipe will install nginx as a native package for the system through the package manager and sets up the configuration according to the Debian site enable/disable style with sites-enabled
using the nxensite
and nxdissite
scripts. The nginx service will be managed with the normal init scripts that are presumably included in the native package.
Includes the ohai_plugin
recipe so the plugin is available.
This will add socketproxy support to your nginx proxy setup. Do not include this recipe directly. Instead, add it to the node['nginx']['default']['modules']
array (see below).
This recipe provides an Ohai plugin as a template. It is included by both the default
and source
recipes.
Sets up configuration for the authorized_ip
nginx module.
This recipe is responsible for building nginx from source. It ensures that the required packages to build nginx are installed (pcre, openssl, compile tools). The source will be downloaded from the node['nginx']['source']['url']
. The node['nginx']['user']
will be created as a system user. If you want to use existing user set node['nginx']['source']['use_existing_user']
to true
. The appropriate configuration and log directories and config files will be created as well according to the attributes node['nginx']['dir']
and node['nginx']['log_dir']
.
The recipe attempts to detect whether additional modules should be added to the configure command through recipe inclusion (see below), and whether the version or configuration flags have changed and should trigger a recompile.
The nginx service will be set up according to node['nginx']['init_style']
. Available options are:
- runit: uses runit cookbook and sets up
runit_service
. - anything else (e.g., "init") will use the nginx init script template.
RHEL/CentOS This recipe should work on RHEL/CentOS with "init" as the init style.
The following recipes are used to build module support into nginx. To use a module in the chef_nginx::source
recipe, add its recipe name to the attribute node['nginx']['source']['modules']
.
ipv6.rb
- enables IPv6 supporthttp_echo_module.rb
- downloads thehttp_echo_module
module and enables it as a module when compiling nginx.http_geoip_module.rb
- installs the GeoIP libraries and data files and enables the module for compilation.http_gzip_static_module.rb
- enables the module for compilation. Be sure to setnode['nginx']['gzip_static'] = 'yes'
.http_perl_module.rb
- enables embedded Perl for compilation.http_realip_module.rb
- enables the module for compilation and creates the configuration.http_ssl_module.rb
- enables SSL for compilation.http_stub_status_module.rb
- providesnginx_status
configuration and enables the module for compilation.naxsi_module
- enables the naxsi module for the web application firewall for nginx.passenger
- builds the passenger gem and configuration for "mod_passenger
".syslog
- enables syslog support for nginx. This only works with source builds. See https://github.com/yaoweibin/nginx_syslog_patchupload_progress_module.rb
- builds theupload_progress
module and enables it as a module when compiling nginx.openssl_source.rb
- downloads and uses custom OpenSSL source when compiling nginx
Enable or disable a Server Block in #{node['nginx']['dir']}/sites-available
by calling nxensite or nxdissite (introduced by this cookbook) to manage the symbolic link in #{node['nginx']['dir']}/sites-enabled
.
enable
- Enable the nginx site (default)disable
- Disable the nginx site
name
- (optional) Name of the site to enable. By default it's assumed that the name of the nginx_site resource is the site name, but this allows overriding that.template
- (optional) Path to the source for thetemplate
resource.cookbook
- (optional) The cookbook that contains the template source.variables
- (optional) Variables to be used with thetemplate
resource
To add a new module to be compiled into nginx in the source recipe, the node's run state is manipulated in a recipe, and the module as a recipe should be added to node['nginx']['source']['modules']
. For example:
node.run_state['nginx_configure_flags'] =
node.run_state['nginx_configure_flags'] | ['--with-http_stub_status_module']
The recipe will be included by recipe[chef_nginx::source]
automatically, adding the configure flags. Add any other configuration templates or other resources as required. See the recipes described above for examples.
The ohai_plugin
recipe includes an Ohai plugin. It will be automatically installed and activated, providing the following attributes via ohai, no matter how nginx is installed (source or package):
node['nginx']['version']
- version of nginxnode['nginx']['configure_arguments']
- options passed to./configure
when nginx was builtnode['nginx']['prefix']
- installation prefixnode['nginx']['conf_path']
- configuration file path
In the source recipe, it is used to determine whether control attributes for building nginx have changed.
Include the recipe on your node or role that fits how you wish to install nginx on your system per the recipes section above. Modify the attributes as required in your role to change how various configuration is applied per the attributes section above. In general, override attributes in the role should be used when changing attributes.
There's some redundancy in that the config handling hasn't been separated from the installation method (yet), so use only one of the recipes, default or source.
- Author:: Joshua Timberman ([email protected])
- Author:: Adam Jacob ([email protected])
- Author:: AJ Christensen ([email protected])
- Author:: Jamie Winsor ([email protected])
- Author:: Mike Fiedler ([email protected])
Copyright 2008-2016, Chef Software, Inc
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.