Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

nginx: add missing doc for env vars #765

Merged
merged 1 commit into from
Feb 9, 2024
Merged

nginx: add missing doc for env vars #765

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions content/docs/howto/web-servers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,6 +204,16 @@ files to `/workspace/my-build-directory`.
BP_WEB_SERVER_ROOT=htdocs
{{< /code/copyable >}}

#### Set Location Path for the Server
In auto-generated `nginx.conf`, the
[`server.location`](https://nginx.org/en/docs/http/ngx_http_core_module.html#location)
directive is set to the catch-all or default location block. You can override
this by setting the `BP_WEB_SERVER_LOCATION_PATH` variable.

{{< code/copyable >}}
BP_WEB_SERVER_LOCATION_PATH="/custom"
{{< /code/copyable >}}

#### Enable Push-State Routing
The `BP_WEB_SERVER_ENABLE_PUSH_STATE` variable enables push state routing
functionality. This is useful for single-page web applications.
Expand All @@ -221,6 +231,21 @@ endpoint.
BP_WEB_SERVER_FORCE_HTTPS=true
{{< /code/copyable >}}

#### Obtain real-time status info
The `BP_NGINX_STUB_STATUS_PORT` variable exposes a handful of NGINX Server
metrics via the
[`stub_status`](https://nginx.org/en/docs/http/ngx_http_stub_status_module.html#stub_status)
module which provides basic status information on provided port. This comes
handy for monitoring the server. For example using [NGINX Prometheus
Exporter](https://github.com/nginxinc/nginx-prometheus-exporter)

The info will be made available at the path `/stub_status` at the specified
port. Make sure that this port isn't used anywhere else in your application.

{{< code/copyable >}}
BP_NGINX_STUB_STATUS_PORT=8083
{{< /code/copyable >}}

#### Set Up Basic Authentication
You are able to provide basic authentication credentials via a [service
binding][service-binding] of type `htpasswd` that specifies the contents of a
Expand Down
6 changes: 6 additions & 0 deletions content/docs/reference/nginx-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,13 +36,19 @@ 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`.

### BP_WEB_SERVER_LOCATION_PATH
Set server's location directive.

### BP_WEB_SERVER_ENABLE_PUSH_STATE
Enables push state routing functionality.

### BP_WEB_SERVER_FORCE_HTTPS
Allows you to enforce HTTPS for server connections by redirecting all requests
to use the HTTPS protocol.

### BP_NGINX_STUB_STATUS_PORT
Gets NGINX basic status info via [`stub_status`](https://nginx.org/en/docs/http/ngx_http_stub_status_module.html#stub_status).

## Supported Service Bindings
The NGINX buildpack can be configured using [service bindings][service-binding].
####
Expand Down
Loading