This reference documentation offers an in-depth description of the behavior and configuration options of the Paketo NGINX Buildpack. For explanations of how to use the buildpack for several common use-cases, see the Paketo NGINX Buildpack How To documentation.
The NGINX Paketo Buildpack supports the installation of the NGINX binary distribution onto
$PATH inside a container. This makes it available to subsequent
The NGINX Paketo Buildpack supports several versions of NGINX. For more details on the specific versions supported in a given buildpack version, see the release notes.
Enables reloadable processes.
Allows you to specify the version of Apache HTTP Server that is installed.
When the value is set to
httpd the buildpack will generate a default
public, setting this allows you to modify the location of the
static files served by the web server with either an absolute file path or a
file path relative to
Enables push state routing functionality.
Allows you to enforce HTTPS for server connections by redirecting all requests to use the HTTPS protocol.
The HTTPD buildpack can be configured using service bindings.
||Required Files||# Bindings of This Type Accepted|
||0 or 1|
When the NGINX Buildpack participates in a build, it will contribute in one of two ways:
nginx.conf file is present in your app’s source code, the
buildpack will set up an NGINX server with that config.
nginx.conf is not present in the app’s source code, the
buildpack simply provides the NGINX dependency to subsequent buildpacks
without actually setting up a server.
BP_WEB_SERVER is set to
nginx, the buildpack will set up an
NGINX server with a default configuration.
Last modified: March 16, 2023