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

Jump to bottom

Document BP_WEB_SERVER_ENABLE_PUSH_STATE #575

Merged
merged 2 commits into from
Sep 1, 2023
Merged

Document BP_WEB_SERVER_ENABLE_PUSH_STATE #575

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1d6d868
Update README.md
mucsi96 Aug 31, 2023
8b1393b
Update README.md
mucsi96 Aug 31, 2023
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
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,10 @@ nginx:
# any valid semver constraints (e.g. 1.* and 1.21.*) are also acceptable
version: "1.21.0"
```
### `BP_WEB_SERVER_ENABLE_PUSH_STATE`
The `BP_WEB_SERVER_ENABLE_PUSH_STATE` variable enables push state based routing for Single-page applications relying on browser history API.
NGINX Server will send the content at / in response to *any* requested endpoint.
Usefull for React, Angular, Vue and other SPAs.

### `BP_NGINX_STUB_STATUS_PORT`
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.
Expand Down