refactor: rename whitelist_hosts config key to allowlist_hosts
All checks were successful
check / check (push) Successful in 4s
All checks were successful
check / check (push) Successful in 4s
This commit is contained in:
@@ -29,7 +29,7 @@ Image-heavy web applications need a fast, caching reverse proxy that
|
||||
can resize and transcode images on the fly. pixa fills that role as a
|
||||
single, self-contained binary with no external runtime dependencies
|
||||
beyond libvips. It supports HMAC-SHA256 signed URLs with expiration to
|
||||
prevent abuse, and whitelisted source hosts for open access.
|
||||
prevent abuse, and allowlisted source hosts for open access.
|
||||
|
||||
## Design
|
||||
|
||||
@@ -61,7 +61,7 @@ Images are only fetched from origins using TLS with valid certificates.
|
||||
|
||||
### Source Hosts
|
||||
|
||||
Source hosts may be whitelisted in the configuration. Non-whitelisted
|
||||
Source hosts may be allowlisted in the configuration. Non-allowlisted
|
||||
hosts require an HMAC-SHA256 signature.
|
||||
|
||||
#### Signature Specification
|
||||
@@ -99,7 +99,7 @@ expiration 1704067200:
|
||||
4. URL:
|
||||
`/v1/image/cdn.example.com/photos/cat.jpg/800x600.webp?sig=<base64url>&exp=1704067200`
|
||||
|
||||
**Whitelist patterns:**
|
||||
**Allowlist patterns:**
|
||||
|
||||
- **Exact match**: `cdn.example.com` — matches only that host
|
||||
- **Suffix match**: `.example.com` — matches `cdn.example.com`,
|
||||
@@ -110,7 +110,7 @@ expiration 1704067200:
|
||||
Configured via YAML file (`--config`). Key settings:
|
||||
|
||||
- `access_control_allow_origin` — CORS origin
|
||||
- `source_host_whitelist` — list of allowed upstream hosts
|
||||
- `allowlist_hosts` — list of allowed upstream hosts
|
||||
- `upstream_fetch_timeout` — timeout for origin requests
|
||||
- `upstream_max_response_size` — max origin response size
|
||||
- `downstream_timeout` — client response timeout
|
||||
|
||||
Reference in New Issue
Block a user