Open
Conversation
✅ Deploy Preview for imgproxy-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
yaroslav
reviewed
Apr 4, 2026
docs/configuration/options.mdx
Outdated
|
|
||
| imgproxy can cache processed images in various storage backends to improve performance and reduce processing overhead. | ||
|
|
||
| * [`IMGPROXY_CACHE_USE`]: ((pro)) the cache storage adapter to use. Can be `filesystem`, `s3`, `gcs`, `abs` (Azure Blob Storage), or `swift`. When blank, the cache is disabled. Default: blank |
There was a problem hiding this comment.
Not obvious swift stands for OpenStack, IMO
Collaborator
Author
There was a problem hiding this comment.
Thank you, fixed
DarthSim
reviewed
Apr 6, 2026
DarthSim
reviewed
Apr 6, 2026
|
|
||
| 1. Set the `IMGPROXY_CACHE_USE` environment variable to `s3`. | ||
| 2. [Set up the necessary credentials](#set-up-credentials) to grant access to your cache bucket. | ||
| 3. _(optional)_ Specify the AWS region with `IMGPROXY_CACHE_S3_REGION`. Default: `us-west-1` |
| 1. Set the `IMGPROXY_CACHE_USE` environment variable to `s3`. | ||
| 2. [Set up the necessary credentials](#set-up-credentials) to grant access to your cache bucket. | ||
| 3. _(optional)_ Specify the AWS region with `IMGPROXY_CACHE_S3_REGION`. Default: `us-west-1` | ||
| 4. _(optional)_ Specify the cache bucket name with `IMGPROXY_CACHE_BUCKET`. |
| 1. Set the `IMGPROXY_CACHE_USE` environment variable to `abs`. | ||
| 2. Set `IMGPROXY_CACHE_ABS_NAME` to your Azure account name. | ||
| 3. [Set up the necessary credentials](#set-up-credentials). | ||
| 4. _(optional)_ Specify the cache container name with `IMGPROXY_CACHE_BUCKET`. |
|
|
||
| 1. Set the `IMGPROXY_CACHE_USE` environment variable to `gcs`. | ||
| 2. [Set up credentials](#setup-credentials) to grant access to your cache bucket. | ||
| 3. _(optional)_ Specify the cache bucket name with `IMGPROXY_CACHE_BUCKET`. |
|
|
||
| imgproxy can store cached images on the local filesystem. To use filesystem cache, do the following: | ||
|
|
||
| 1. Set the `IMGPROXY_CACHE_USE` environment variable to the filesystem. |
| * `scale_factor`: a float value that defines how much the crop area should be scaled relative to the detected objects. For example, `1.0` crops exactly to the detected objects, while `1.2` adds 20% padding around them. | ||
| * `class_name1`, `class_name2`, ..., `class_nameN`: _(optional)_ names of the object classes to detect. If class names are omitted, imgproxy crops to all detected objects. | ||
|
|
||
| This option is useful when you want to automatically extract the area containing specific objects from an image, such as all faces in a group photo or products in a catalog image. |
Member
There was a problem hiding this comment.
Add a description of what happens when the fill or fill-down resizing types are used.
Add a note that IMGPROXY_OBJECT_DETECTION_GRAVITY_MODE and objects_position are respected (see the blog post).
Comment on lines
+599
to
+601
| :::info | ||
| When no objects are detected, imgproxy will not crop the image and will process it as usual. | ||
| ::: |
Member
There was a problem hiding this comment.
Add a note that this option overwrites crop
|
|
||
| **When `IMGPROXY_PRESERVE_HDR` is enabled:** | ||
|
|
||
| * High bit images remain high bit in the output (eg, GRAYSCALE16 remains GRAYSCALE16, scRGB remains scRGB) |
Member
There was a problem hiding this comment.
scRGB becomes RGB16, RGB16 remains RGB16. We don't preserve linear colorspace
|
|
||
| **When `IMGPROXY_PRESERVE_HDR` is disabled (default):** | ||
|
|
||
| * High bit images are converted to 8-bit (eg, GRAYSCALE16 becomes GRAYSCALE8, RGB and scRGB become sRGB) |
| @@ -1,5 +1,5 @@ | |||
| .badge, | |||
| .menu__list-item--badge a::after { | |||
| .menu__list-item--badge .menu__link::after { | |||
Member
There was a problem hiding this comment.
There are a couple of places with a::after below. It's better to fix this there too
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.