Repository navigation
IMG-140: c2pa docs, source cache docs - #16
Open
gzigzigzeo wants to merge 5 commits into
Open
gzigzigzeo wants to merge 5 commits into
gzigzigzeo wants to merge 5 commits into
Conversation
gzigzigzeo
added this pull request to stack #17
September 14, 2026 14:15
✅ Deploy Preview for imgproxy-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
DarthSim
reviewed
Oct 12, 2026
|
|
||
| ### Source image caching | ||
|
|
||
| In addition to caching processed results, imgproxy can cache the raw bytes of downloaded source images. Set `IMGPROXY_CACHE_SOURCE_ENABLE` to `true` to enable it. This is useful when you request the same source image with many different processing options. Instead of re-downloading the source for every variant, imgproxy fetches it once and serves subsequent requests from the cache. |
Member
There was a problem hiding this comment.
I'd put it another way:
Suggested change
| In addition to caching processed results, imgproxy can cache the raw bytes of downloaded source images. Set `IMGPROXY_CACHE_SOURCE_ENABLE` to `true` to enable it. This is useful when you request the same source image with many different processing options. Instead of re-downloading the source for every variant, imgproxy fetches it once and serves subsequent requests from the cache. | |
| If you process remote images, like ones from third-party HTTP sources, you may want to cache source images in your storage to keep them close to imgproxy. You can enable source image caching by setting `IMGPROXY_CACHE_SOURCE_ENABLE` to `true`. This way, imgproxy will cache the source image on the first transformation and fetch it from the cache for subsequent ones. |
Collaborator
Author
There was a problem hiding this comment.
Done, including grammarly corrections
|
|
||
| Each tag can be up to 256 characters long and must consist of visible ASCII characters (character codes 33-126), excluding commas. We consider at most 50 tags per request; any beyond that are silently dropped. | ||
|
|
||
| The tags are also written to the response headers, so a CDN in front of imgproxy can use them for tag-based cache invalidation. Use the [`IMGPROXY_CACHE_TAGS_FORMAT`](../configuration/options.mdx#IMGPROXY_CACHE_TAGS_FORMAT) config to choose which format(s) the tags are written in — [CloudFront](https://aws.amazon.com/blogs/networking-and-content-delivery/manage-caches-with-precision-using-amazon-cloudfront-invalidation-by-cache-tag/), [Cloudflare](https://developers.cloudflare.com/cache/how-to/purge-cache/purge-by-tags/), both (the default), or neither. |
Member
There was a problem hiding this comment.
I'd either remove the formats list from here or copy the accepted values list from the configuration docs. As it is now, the reader will need to check the configuration docs anyway.
Collaborator
Author
There was a problem hiding this comment.
Ok, removed formats.
| imgproxy Pro can bypass the internal cache for a single request using the [bypass_cache](../usage/processing.mdx#bypass-cache) processing option: | ||
|
|
||
| ```imgproxy_url_option | ||
| bypass_cache:%bypass |
Member
There was a problem hiding this comment.
The second argument is missing. Also, we need to add it to the processing.info options docs.
DarthSim
reviewed
Oct 13, 2026
| ``` | ||
|
|
||
| When set to `1`, `t` or `true`, imgproxy will bypass the internal cache and do all the processing and fetching from the source image. | ||
| When set to `1`, `t`, or `true`, imgproxy bypasses the internal cache entirely. When set to `1:0`, only the processing cache is bypassed. When set to `0:1`, only the source cache is bypassed. |
Member
There was a problem hiding this comment.
Suggested change
| When set to `1`, `t`, or `true`, imgproxy bypasses the internal cache entirely. When set to `1:0`, only the processing cache is bypassed. When set to `0:1`, only the source cache is bypassed. | |
| Allows bypassing imgproxy's internal cache. | |
| * `bypass`: when set to `1`, `t`, or `true`, imgproxy bypasses the internal cache entirely. | |
| * `bypass_source`: _(optional)_ defines if imgproxy should bypass source image cache. When not set, its value is equal to `bypass`. When `bypass` is truthy, but `bypass_source` is not (e.g., `1:0`), imgproxy will bypass the results cache but not the source cache. When `bypass_source` is truthy, but `bypass` is not (e.g., `0:1`), imgproxy will bypass the source cache but not the results cache. | |
| Default: `0:0` |
Member
There was a problem hiding this comment.
We should also do the same for the getting info docs
Comment on lines
+95
to
+97
| Requires [`IMGPROXY_ALLOW_BYPASS_CACHE`](../configuration/options.mdx#IMGPROXY_ALLOW_BYPASS_CACHE) set to `true`. `bypass_source` is optional, and equals to `bypass` if not specified, hence, when only `bypass` is set, both processing and source cache are ignored. | ||
|
|
||
| Default: `0:0` |
Member
There was a problem hiding this comment.
I guess it's better to copy the arguments description from the processing options docs
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
2 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.