mirror of
https://github.com/imgproxy/imgproxy.git
synced 2025-02-07 11:36:25 +02:00
Remove v3 badges from docs
This commit is contained in:
DarthSim
parent
b01de24f4c
commit
fb5de53d38
@ -6,16 +6,16 @@
|
||||
* [Signing the URL](signing_the_url)
|
||||
* [Watermark](watermark)
|
||||
* [Presets](presets)
|
||||
* [Object detection<i class='badge badge-pro'></i><i class='badge badge-v3'></i>](object_detection)
|
||||
* [Autoquality<i class='badge badge-pro'></i><i class='badge badge-v3'></i>](autoquality)
|
||||
* [Chained pipelines<i class='badge badge-pro'></i><i class='badge badge-v3'></i>](chained_pipelines)
|
||||
* [Object detection<i class='badge badge-pro'></i>](object_detection)
|
||||
* [Autoquality<i class='badge badge-pro'></i>](autoquality)
|
||||
* [Chained pipelines<i class='badge badge-pro'></i>](chained_pipelines)
|
||||
* [Serving local files](serving_local_files)
|
||||
* [Serving files from Amazon S3](serving_files_from_s3)
|
||||
* [Serving files from Google Cloud Storage](serving_files_from_google_cloud_storage)
|
||||
* [Serving files from Azure Blob Storage](serving_files_from_azure_blob_storage)
|
||||
* [New Relic](new_relic)
|
||||
* [Prometheus](prometheus)
|
||||
* [Datadog<i class='badge badge-v3'></i>](datadog)
|
||||
* [Datadog](datadog)
|
||||
* [Image formats support](image_formats_support)
|
||||
* [About processing pipeline](about_processing_pipeline)
|
||||
* [Health check](healthcheck)
|
||||
|
||||
@ -109,12 +109,6 @@ i.badge-pro::before {
|
||||
text-transform: uppercase;
|
||||
}
|
||||
|
||||
i.badge-v3::before {
|
||||
content: "v3";
|
||||
color: #ff7401;
|
||||
border-color: #ff7401;
|
||||
}
|
||||
|
||||
h1 i.badge, h2 i.badge, h3 i.badge, h4 i.badge, .sidebar-nav i.badge {
|
||||
margin-left: .5ch;
|
||||
}
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
# Autoquality<i class='badge badge-pro'></i><i class='badge badge-v3'></i>
|
||||
# Autoquality<i class='badge badge-pro'></i>
|
||||
|
||||
imgproxy can calculate quality for your resultant images so they best fit the selected metric. The supported methods are [none](#none), [size](#autoquality-by-file-size), [dssim](#autoquality-by-dssim), and [ml](#autoquality-with-ml).
|
||||
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
# Chained pipelines<i class='badge badge-pro'></i><i class='badge badge-v3'></i>
|
||||
# Chained pipelines<i class='badge badge-pro'></i>
|
||||
|
||||
Though imgproxy's [processing pipeline](about_processing_pipeline.md) is suitable for most cases, sometimes it's handy to run multiple chained pipelines with different options.
|
||||
|
||||
|
||||
@ -154,17 +154,17 @@ imgproxy can calculate the quality of the resulting image based on selected metr
|
||||
|
||||
**⚠️Warning:** Autoquality requires the image to be saved several times. Use it only when you prefer the resulting size and quality over the speed.
|
||||
|
||||
* `IMGPROXY_AUTOQUALITY_METHOD`: <i class='badge badge-pro'></i> <i class='badge badge-v3'></i> the method of quality calculation. Default: `none`
|
||||
* `IMGPROXY_AUTOQUALITY_TARGET`: <i class='badge badge-pro'></i> <i class='badge badge-v3'></i> desired value of the autoquality method metric. Default: 0.02
|
||||
* `IMGPROXY_AUTOQUALITY_MIN`: <i class='badge badge-pro'></i> <i class='badge badge-v3'></i> minimal quality imgproxy can use. Default: 70
|
||||
* `IMGPROXY_AUTOQUALITY_FORMAT_MIN`: <i class='badge badge-pro'></i> <i class='badge badge-v3'></i> the minimal quality imgproxy can use per format, comma divided. Example: `jpeg=70,avif=40,webp=60`. When value for the resulting format is not set, `IMGPROXY_AUTOQUALITY_MIN` value is used. Default: `avif=40`
|
||||
* `IMGPROXY_AUTOQUALITY_MAX`: <i class='badge badge-pro'></i> <i class='badge badge-v3'></i> the maximum quality imgproxy can use. Default: 80
|
||||
* `IMGPROXY_AUTOQUALITY_FORMAT_MAX`: <i class='badge badge-pro'></i> <i class='badge badge-v3'></i> the maximum quality imgproxy can use per format, comma divided. Example: `jpeg=70,avif=40,webp=60`. When a value for the resulting format is not set, the `IMGPROXY_AUTOQUALITY_MAX` value is used. Default: `avif=50`
|
||||
* `IMGPROXY_AUTOQUALITY_ALLOWED_ERROR`: <i class='badge badge-pro'></i> <i class='badge badge-v3'></i> the allowed `IMGPROXY_AUTOQUALITY_TARGET` error. Applicable only to `dssim` and `ml` methods. Default: 0.001
|
||||
* `IMGPROXY_AUTOQUALITY_MAX_RESOLUTION`: <i class='badge badge-pro'></i> <i class='badge badge-v3'></i> when this value is greater then zero and the resultant resolution exceeds the value, autoquality won't be used. Default: 0
|
||||
* `IMGPROXY_AUTOQUALITY_JPEG_NET`: <i class='badge badge-pro'></i> <i class='badge badge-v3'></i> the path to the neural network for JPEG.
|
||||
* `IMGPROXY_AUTOQUALITY_WEBP_NET`: <i class='badge badge-pro'></i> <i class='badge badge-v3'></i> the path to the neural network for WebP.
|
||||
* `IMGPROXY_AUTOQUALITY_AVIF_NET`: <i class='badge badge-pro'></i> <i class='badge badge-v3'></i> the path to the neural network for AVIF.
|
||||
* `IMGPROXY_AUTOQUALITY_METHOD`: <i class='badge badge-pro'></i> the method of quality calculation. Default: `none`
|
||||
* `IMGPROXY_AUTOQUALITY_TARGET`: <i class='badge badge-pro'></i> desired value of the autoquality method metric. Default: 0.02
|
||||
* `IMGPROXY_AUTOQUALITY_MIN`: <i class='badge badge-pro'></i> minimal quality imgproxy can use. Default: 70
|
||||
* `IMGPROXY_AUTOQUALITY_FORMAT_MIN`: <i class='badge badge-pro'></i> the minimal quality imgproxy can use per format, comma divided. Example: `jpeg=70,avif=40,webp=60`. When value for the resulting format is not set, `IMGPROXY_AUTOQUALITY_MIN` value is used. Default: `avif=40`
|
||||
* `IMGPROXY_AUTOQUALITY_MAX`: <i class='badge badge-pro'></i> the maximum quality imgproxy can use. Default: 80
|
||||
* `IMGPROXY_AUTOQUALITY_FORMAT_MAX`: <i class='badge badge-pro'></i> the maximum quality imgproxy can use per format, comma divided. Example: `jpeg=70,avif=40,webp=60`. When a value for the resulting format is not set, the `IMGPROXY_AUTOQUALITY_MAX` value is used. Default: `avif=50`
|
||||
* `IMGPROXY_AUTOQUALITY_ALLOWED_ERROR`: <i class='badge badge-pro'></i> the allowed `IMGPROXY_AUTOQUALITY_TARGET` error. Applicable only to `dssim` and `ml` methods. Default: 0.001
|
||||
* `IMGPROXY_AUTOQUALITY_MAX_RESOLUTION`: <i class='badge badge-pro'></i> when this value is greater then zero and the resultant resolution exceeds the value, autoquality won't be used. Default: 0
|
||||
* `IMGPROXY_AUTOQUALITY_JPEG_NET`: <i class='badge badge-pro'></i> the path to the neural network for JPEG.
|
||||
* `IMGPROXY_AUTOQUALITY_WEBP_NET`: <i class='badge badge-pro'></i> the path to the neural network for WebP.
|
||||
* `IMGPROXY_AUTOQUALITY_AVIF_NET`: <i class='badge badge-pro'></i> the path to the neural network for AVIF.
|
||||
|
||||
## AVIF/WebP support detection
|
||||
|
||||
@ -227,12 +227,12 @@ imgproxy Pro can apply an unsharpening mask to your images.
|
||||
|
||||
imgproxy can detect objects on the image and use them to perform smart cropping, to blur the detections, or to draw the detections.
|
||||
|
||||
* `IMGPROXY_OBJECT_DETECTION_CONFIG`: <i class='badge badge-pro'></i> <i class='badge badge-v3'></i> the path to the neural network config. Default: blank
|
||||
* `IMGPROXY_OBJECT_DETECTION_WEIGHTS`: <i class='badge badge-pro'></i> <i class='badge badge-v3'></i> the path to the neural network weights. Default: blank
|
||||
* `IMGPROXY_OBJECT_DETECTION_CLASSES`: <i class='badge badge-pro'></i> <i class='badge badge-v3'></i> the path to the text file with the classes names, one per line. Default: blank
|
||||
* `IMGPROXY_OBJECT_DETECTION_NET_SIZE`: <i class='badge badge-pro'></i> <i class='badge badge-v3'></i> the size of the neural network input. The width and the heights of the inputs should be the same, so this config value should be a single number. Default: 416
|
||||
* `IMGPROXY_OBJECT_DETECTION_CONFIDENCE_THRESHOLD`: <i class='badge badge-pro'></i> <i class='badge badge-v3'></i> detections with confidences below this value will be discarded. Default: 0.2
|
||||
* `IMGPROXY_OBJECT_DETECTION_NMS_THRESHOLD`: <i class='badge badge-pro'></i> <i class='badge badge-v3'></i> non-max supression threshold. Don't change this if you don't know what you're doing. Default: 0.4
|
||||
* `IMGPROXY_OBJECT_DETECTION_CONFIG`: <i class='badge badge-pro'></i> the path to the neural network config. Default: blank
|
||||
* `IMGPROXY_OBJECT_DETECTION_WEIGHTS`: <i class='badge badge-pro'></i> the path to the neural network weights. Default: blank
|
||||
* `IMGPROXY_OBJECT_DETECTION_CLASSES`: <i class='badge badge-pro'></i> the path to the text file with the classes names, one per line. Default: blank
|
||||
* `IMGPROXY_OBJECT_DETECTION_NET_SIZE`: <i class='badge badge-pro'></i> the size of the neural network input. The width and the heights of the inputs should be the same, so this config value should be a single number. Default: 416
|
||||
* `IMGPROXY_OBJECT_DETECTION_CONFIDENCE_THRESHOLD`: <i class='badge badge-pro'></i> detections with confidences below this value will be discarded. Default: 0.2
|
||||
* `IMGPROXY_OBJECT_DETECTION_NMS_THRESHOLD`: <i class='badge badge-pro'></i> non-max supression threshold. Don't change this if you don't know what you're doing. Default: 0.4
|
||||
|
||||
## Fallback image
|
||||
|
||||
@ -241,8 +241,8 @@ You can set up a fallback image that will be used in case imgproxy is unable to
|
||||
* `IMGPROXY_FALLBACK_IMAGE_DATA`: Base64-encoded image data. You can easily calculate it with `base64 tmp/fallback.png | tr -d '\n'`.
|
||||
* `IMGPROXY_FALLBACK_IMAGE_PATH`: the path to the locally stored image
|
||||
* `IMGPROXY_FALLBACK_IMAGE_URL`: the fallback image URL
|
||||
* `IMGPROXY_FALLBACK_IMAGE_HTTP_CODE`: the <i class='badge badge-v3'></i> HTTP code for the fallback image response. When set to zero, imgproxy will respond with the usual HTTP code. Default: `200`
|
||||
* `IMGPROXY_FALLBACK_IMAGES_CACHE_SIZE`: <i class='badge badge-pro'></i> <i class='badge badge-v3'></i> the size of custom fallback images cache. When set to `0`, the fallback image cache is disabled. 256 fallback images are cached by default.
|
||||
* `IMGPROXY_FALLBACK_IMAGE_HTTP_CODE`: the HTTP code for the fallback image response. When set to zero, imgproxy will respond with the usual HTTP code. Default: `200`
|
||||
* `IMGPROXY_FALLBACK_IMAGES_CACHE_SIZE`: <i class='badge badge-pro'></i> the size of custom fallback images cache. When set to `0`, the fallback image cache is disabled. 256 fallback images are cached by default.
|
||||
|
||||
## Skip processing
|
||||
|
||||
@ -346,7 +346,7 @@ Check out the [Prometheus](prometheus.md) guide to learn more.
|
||||
|
||||
imgproxy can send its metrics to Datadog:
|
||||
|
||||
* `IMGPROXY_DATADOG_ENABLE`: <i class='badge badge-v3'></i> when `true`, enables sending metrics to Datadog. Default: false
|
||||
* `IMGPROXY_DATADOG_ENABLE`: when `true`, enables sending metrics to Datadog. Default: false
|
||||
|
||||
Check out the [Datadog](datadog.md) guide to learn more.
|
||||
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
# Datadog<i class='badge badge-v3'></i>
|
||||
# Datadog
|
||||
|
||||
imgproxy can send its metrics to Datadog. To use this feature, do the following:
|
||||
|
||||
|
||||
@ -56,7 +56,7 @@ Defines how imgproxy will resize the source image. Supported resizing types are:
|
||||
|
||||
* `fit`: resizes the image while keeping aspect ratio to fit a given size.
|
||||
* `fill`: resizes the image while keeping aspect ratio to fill a given size and crops projecting parts.
|
||||
* `fill-down`: <i class='badge badge-v3'></i> the same as `fill`, but if the resized image is smaller than the requested size, imgproxy will crop the result to keep the requested aspect ratio.
|
||||
* `fill-down`: the same as `fill`, but if the resized image is smaller than the requested size, imgproxy will crop the result to keep the requested aspect ratio.
|
||||
* `force`: resizes the image without keeping the aspect ratio.
|
||||
* `auto`: if both source and resulting dimensions have the same orientation (portrait or landscape), imgproxy will use `fill`. Otherwise, it will use `fit`.
|
||||
|
||||
@ -95,7 +95,7 @@ Defines the height of the resulting image. When set to `0`, imgproxy will calcul
|
||||
|
||||
Default: `0`
|
||||
|
||||
### Min width<i class='badge badge-v3'></i> :id=min-width
|
||||
### Min width
|
||||
|
||||
```
|
||||
min-width:%width
|
||||
@ -108,7 +108,7 @@ Defines the minimum width of the resulting image.
|
||||
|
||||
Default: `0`
|
||||
|
||||
### Min height<i class='badge badge-v3'></i> :id=min-height
|
||||
### Min height
|
||||
|
||||
```
|
||||
min-height:%height
|
||||
@ -200,7 +200,7 @@ Default: `ce:0:0`
|
||||
**Special gravities**:
|
||||
|
||||
* `gravity:sm`: smart gravity. `libvips` detects the most "interesting" section of the image and considers it as the center of the resulting image. Offsets are not applicable here.
|
||||
* `gravity:obj:%class_name1:%class_name2:...:%class_nameN`: <i class='badge badge-pro'></i> <i class='badge badge-v3'></i> object-oriented gravity. imgproxy [detects objects](object_detection.md) of provided classes on the image and calculates the resulting image center using their positions. If class names are omited, imgproxy will use all the detected objects.
|
||||
* `gravity:obj:%class_name1:%class_name2:...:%class_nameN`: <i class='badge badge-pro'></i> object-oriented gravity. imgproxy [detects objects](object_detection.md) of provided classes on the image and calculates the resulting image center using their positions. If class names are omited, imgproxy will use all the detected objects.
|
||||
* `gravity:fp:%x:%y`: the gravity focus point . `x` and `y` are floating point numbers between 0 and 1 that define the coordinates of the center of the resulting image. Treat 0 and 1 as right/left for `x` and top/bottom for `y`.
|
||||
|
||||
### Crop
|
||||
@ -393,7 +393,7 @@ ush:%mode:%weight:%dividor
|
||||
|
||||
Allows redefining unsharpening options. All arguments have the same meaning as [Unsharpening](configuration.md#unsharpening) configs. All arguments are optional and can be omitted.
|
||||
|
||||
### Blur detections<i class='badge badge-pro'></i><i class='badge badge-v3'></i> :id=blur-detections
|
||||
### Blur detections<i class='badge badge-pro'></i> :id=blur-detections
|
||||
|
||||
```
|
||||
blur_detections:%sigma:%class_name1:%class_name2:...:%class_nameN
|
||||
@ -404,7 +404,7 @@ imgproxy [detects objects](object_detection.md) of the provided classes and blur
|
||||
|
||||
The value of `sigma` defines the size of the mask imgproxy will use.
|
||||
|
||||
### Draw detections<i class='badge badge-pro'></i><i class='badge badge-v3'></i> :id=draw-detections
|
||||
### Draw detections<i class='badge badge-pro'></i> :id=draw-detections
|
||||
|
||||
```
|
||||
draw_detections:%draw:%class_name1:%class_name2:...:%class_nameN
|
||||
@ -505,7 +505,7 @@ Redefines quality of the resulting image, as a percentage. When set to `0`, qual
|
||||
|
||||
Default: 0.
|
||||
|
||||
### Format quality<i class='badge badge-v3'></i> :id=format-quality
|
||||
### Format quality
|
||||
|
||||
```
|
||||
format_quality:%format1:%quality1:%format2:%quality2:...:%formatN:%qualityN
|
||||
@ -514,7 +514,7 @@ fq:%format1:%quality1:%format2:%quality2:...:%formatN:%qualityN
|
||||
|
||||
Adds or redefines `IMGPROXY_FORMAT_QUALITY` values.
|
||||
|
||||
### Autoquality<i class='badge badge-pro'></i><i class='badge badge-v3'></i> :id=autoquality
|
||||
### Autoquality<i class='badge badge-pro'></i> :id=autoquality
|
||||
|
||||
```
|
||||
autoquality:%method:%target:%min_quality:%max_quality:%allowed_error
|
||||
@ -558,14 +558,14 @@ pngo:%interlaced:%quantize:%quantization_colors
|
||||
|
||||
Allows redefining PNG saving options. All arguments have the same meaning as with the [Advanced PNG compression](configuration.md#advanced-png-compression) configs. All arguments are optional and can be omitted.
|
||||
|
||||
<!-- ### GIF options<i class='badge badge-pro'></i> :id=gif-options
|
||||
### GIF options<i class='badge badge-pro'></i> :id=gif-options
|
||||
|
||||
```
|
||||
gif_options:%optimize_frames:%optimize_transparency
|
||||
gifo:%optimize_frames:%optimize_transparency
|
||||
```
|
||||
|
||||
Allows redefining GIF saving options. All arguments have the same meaning as with the [Advanced GIF compression](configuration.md#advanced-gif-compression) configs. All arguments are optional and can be omitted. -->
|
||||
Allows redefining GIF saving options. All arguments have the same meaning as with the [Advanced GIF compression](configuration.md#advanced-gif-compression) configs. All arguments are optional and can be omitted.
|
||||
|
||||
### Format
|
||||
|
||||
@ -599,7 +599,7 @@ vts:%second
|
||||
|
||||
Allows redefining `IMGPROXY_VIDEO_THUMBNAIL_SECOND` config.
|
||||
|
||||
### Fallback image URL<i class='badge badge-pro'></i><i class='badge badge-v3'></i> :id=fallback-image-url
|
||||
### Fallback image URL<i class='badge badge-pro'></i> :id=fallback-image-url
|
||||
|
||||
You can use a custom fallback image by specifying its URL with the `fallback_image_url` processing option:
|
||||
|
||||
@ -612,7 +612,7 @@ The value of `url` is the Base64-encoded URL of the custom fallback image.
|
||||
|
||||
Default: blank
|
||||
|
||||
### Skip processing<i class='badge badge-v3'></i> :id=skip-processing
|
||||
### Skip processing
|
||||
|
||||
```
|
||||
skip_processing:%extension1:%extension2:...:%extensionN
|
||||
@ -640,7 +640,7 @@ It's highly recommended to prefer the `cachebuster` option over a URL query stri
|
||||
|
||||
Default: empty
|
||||
|
||||
### Expires<i class='badge badge-v3'></i> :id=expires
|
||||
### Expires
|
||||
|
||||
```
|
||||
expires:%timestamp
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
# Object detection<i class='badge badge-pro'></i><i class='badge badge-v3'></i>
|
||||
# Object detection<i class='badge badge-pro'></i>
|
||||
|
||||
imgproxy can detect objects on the image and use them for smart cropping, bluring the detections, or drawing the detections.
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user