highperfocused/imgproxy
1
0
Fork 0
mirror of https://github.com/imgproxy/imgproxy.git synced 2025-10-04 18:33:36 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update docs and changelog

Browse Source
This commit is contained in:
DarthSim
2023-08-17 22:42:44 +03:00
parent ee25c32ba0
commit f87ce66519
2 changed files with 18 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
CHANGELOG.md
View File

@@ -5,6 +5,7 @@
- Add [multi-region mode](https://docs.imgproxy.net/latest/serving_files_from_s3?id=multi-region-mode) to S3 integration. - Add [multi-region mode](https://docs.imgproxy.net/latest/serving_files_from_s3?id=multi-region-mode) to S3 integration.
- Add the ability to [load environment variables](https://docs.imgproxy.net/latest/loading_environment_variables) from a file or a cloud secret. - Add the ability to [load environment variables](https://docs.imgproxy.net/latest/loading_environment_variables) from a file or a cloud secret.
- Add `IMGPROXY_WORKERS` alias for the `IMGPROXY_CONCURRENCY` config. - Add `IMGPROXY_WORKERS` alias for the `IMGPROXY_CONCURRENCY` config.
- (pro) Add [pages](https://docs.imgproxy.net/latest/generating_the_url?id=pages) processing option.
### Change ### Change
- Don't report `The image request is cancelled` errors. - Don't report `The image request is cancelled` errors.

19
docs/generating_the_url.md
View File

@@ -683,10 +683,25 @@ page:%page
pg:%page pg:%page
``` ```
When a source image supports pagination (PDF, TIFF) or animation (GIF, WebP), this option allows specifying the page to use it on. Page numeration starts from zero. When a source image supports pagination (PDF, TIFF) or animation (GIF, WebP), this option allows specifying the page to use. Page numeration starts from zero.
**📝 Note:** If both the source and the resulting image formats supoprt animation, imgproxy will ignore this option and use all the source image pages. Use the [disable_animation](#disable-animation) option to make imgproxy treat all images as not animated.
Default: 0 Default: 0
### Pages![pro](./assets/pro.svg) :id=pages
```
pages:%pages
pgs:%pages
```
When a source image supports pagination (PDF, TIFF) or animation (GIF, WebP), this option allows specifying the number of pages to use. The pages will be stacked vertically and left-aligned.
**📝 Note:** If both the source and the resulting image formats supoprt animation, imgproxy will ignore this option and use all the source image pages. Use the [disable_animation](#disable-animation) option to make imgproxy treat all images as not animated.
Default: 1
### Disable animation![pro](./assets/pro.svg) :id=disable-animation ### Disable animation![pro](./assets/pro.svg) :id=disable-animation
``` ```
@@ -694,7 +709,7 @@ disable_animation:%disable
da:%disable da:%disable
``` ```
When set to `1`, `t` or `true`, imgproxy will use a single frame of animated images. Use the [page](#page) option to specify which frame imgproxy should use. When set to `1`, `t` or `true`, imgproxy will treat all images as not animated. Use the [page](#page) and the [pages](#pages) options to specify which frames imgproxy should use.
Default: `false` Default: `false`