Skip to content

Commit 0e93687

Browse files
committed
Add IMGPROXY_BASE64_URL_INCLUDES_FILENAME docs
1 parent dc03920 commit 0e93687

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

docs/configuration/options.mdx

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -508,6 +508,18 @@ Check out the [Serving files from OpenStack Object Storage](../image_sources/ope
508508
Replacements defined in `IMGPROXY_URL_REPLACEMENTS` are applied before `IMGPROXY_BASE_URL` is added.
509509
:::
510510

511+
* [`IMGPROXY_BASE64_URL_INCLUDES_FILENAME`]: when `true` and the source image URL is Base64-encoded or encrypted, imgproxy will treat the part after the last slash (`/`) as an SEO-friendly filename and will discard it when decoding the URL. Default: `false`
512+
513+
:::tip
514+
For example, if you have `IMGPROXY_BASE64_URL_INCLUDES_FILENAME` enabled and want to add a `puppy.jpg` filename to your imgproxy URL for SEO reasons, the URL will look like this:
515+
516+
```
517+
https://my-imgproxy.dev/.../aHR0cDovL2V4YW1wbGUuY29tL3B1cHB5LmpwZw/puppy.jpg
518+
```
519+
520+
imgproxy will treat `puppy.jpg` as an SEO-friendly filename and will use `aHR0cDovL2V4YW1wbGUuY29tL3B1cHB5LmpwZw` as a Base64-encoded source URL.
521+
:::
522+
511523
## Metrics
512524

513525
### New Relic {#new-relic-metrics}

0 commit comments

Comments
 (0)