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
the $PATH inside a container. This makes it available to subsequent
buildpacks.
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 the NGINX Server that is installed.
When the value is set to nginx the buildpack will generate a default nginx.conf.
Defaults to 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 /workspace.
Set server’s location directive.
Enables push state routing functionality.
Allows you to enforce HTTPS for server connections by redirecting all requests to use the HTTPS protocol.
Gets NGINX basic status info via stub_status.
The NGINX buildpack can be configured using service bindings.
type |
Required Files | # Bindings of This Type Accepted |
|---|---|---|
htpasswd |
type, .htpasswd |
0 or 1 |
When the NGINX Buildpack participates in a build, it will contribute in one of two ways:
When an nginx.conf file is present in your app’s source code, the
buildpack will set up an NGINX server with that config.
When the 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.
When the BP_WEB_SERVER is set to nginx, the buildpack will set up an
NGINX server with a default configuration.
Last modified: April 3, 2024