Skip to content

v2.37.0

Choose a tag to compare

@github-actions github-actions released this 08 Aug 12:07
· 559 commits to main since this release

🔍 New: the access log now names the filter that blocked a request

A request refused by a filter subscription used to say only that a list had matched. Finding out which one meant turning subscriptions off one at a time until the block stopped. (#230)

Open the log entry and it now tells you:

Filter that blocked this request
  Emerging Threats   192.0.2.0/24
  Also present in disabled subscriptions: IPsum Level 3
  • The matched entry is shown, not just the list — the example above was caught by a CIDR range rather than the exact address.
  • Lists that are switched off are reported separately. They did not block anything, but when you are debugging one it matters that the address is in them too.
  • User-agent subscriptions are checked the same way.

This is worked out when you open the log entry rather than recorded on the request, so it costs nothing while traffic is flowing and it works on entries that were written before this release.

🛡 New: switch off a WAF rule for one path or one argument

Disabling a CRS rule from the UI wrote SecRuleRemoveById, which turned it off for every request to that host. Silencing one false positive therefore opened the attack that rule catches everywhere else on the site. (#231)

An exclusion now has a scope:

Scope What it does
The whole host Unchanged behaviour, still the default
Only this path The rule stops applying under a path prefix — every other path stays protected
Only this argument The rule keeps running but stops inspecting one form field or query parameter

When you disable a rule from a WAF log entry, Only this path is prefilled with the path from the request that produced the false positive, so the usual case is two clicks.

Scope values are validated before they can reach a config file — printable characters only, no quotes, semicolons or braces, a path must start with / and an argument must look like an argument name. NPG deliberately does not offer a free-form ModSecurity directive field: a typo there is one character away from switching the whole engine off or leaving nginx unable to start.

📖 The API documentation matches the API again

If you build against /api/docs, this is the important one. The spec had drifted badly: it declared version 1.3.7 against an app at 2.36.0, documented 89 of 292 endpoints, and listed 27 of a proxy host's 54 fields. A client generated from it dropped fields before sending them, which looked exactly like the API ignoring them. (#232)

  • All 292 endpoints are documented. Notifications, SSO, roles, DDNS, filter subscriptions, the global defaults and the per-host security sub-resources were all missing entirely.
  • Eight documented paths that do not exist were removed (/nginx/reload, /ip-ban-history, /proxy-hosts/{id}/cloud-blocking and others). Each had a correctly-named counterpart the spec never mentioned.
  • The inherit / override / disable fields are documented from the code that resolves them — what each value means, and that "inherit" is the absence of the other two rather than a field of its own. Each per-host sub-resource also states that it returns the host's stored row, not the effective value after global defaults are applied.
  • Public endpoints are marked public. /auth/login, the SSO start and callback, /health and /metrics inherited the document-wide bearer-token requirement, so a generated client demanded a token in order to log in.

🩹 Fixes

  • Settings → SSO now says that an existing account links itself. There is no button because none is needed: signing in with a provider that reports a matching verified email links the account in place, keeping its history and role. People were looking for a control that never existed. (#229)

⚠️ Upgrade note

This release adds two columns to waf_rule_exclusions and widens its uniqueness key so the same rule can be excluded on more than one path. The migration runs automatically on start, and existing exclusions are kept as whole-host exclusions — exactly what they were.

A backup taken before this release restores normally; its exclusions come back as whole-host ones.

Pull the api and ui images and recreate:

docker compose pull && docker compose up -d

Docker Images

docker pull svrforum/nginxproxyguard-api:2.37.0
docker pull svrforum/nginxproxyguard-ui:2.37.0
docker pull svrforum/nginxproxyguard-nginx:2.37.0

Architectures: linux/amd64, linux/arm64

Component Status
API Built
UI Built
Nginx Skipped (no changes)