From fb5de53d38e017d504d846afc0f89303f0096128 Mon Sep 17 00:00:00 2001 From: DarthSim Date: Mon, 21 Feb 2022 14:39:09 +0600 Subject: [PATCH] Remove v3 badges from docs --- docs/_sidebar.md | 8 ++++---- docs/assets/style.css | 6 ------ docs/autoquality.md | 2 +- docs/chained_pipelines.md | 2 +- docs/configuration.md | 40 +++++++++++++++++++------------------- docs/datadog.md | 2 +- docs/generating_the_url.md | 26 ++++++++++++------------- docs/object_detection.md | 2 +- 8 files changed, 41 insertions(+), 47 deletions(-) diff --git a/docs/_sidebar.md b/docs/_sidebar.md index b0d5b341..68da946d 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -6,16 +6,16 @@ * [Signing the URL](signing_the_url) * [Watermark](watermark) * [Presets](presets) -* [Object detection](object_detection) -* [Autoquality](autoquality) -* [Chained pipelines](chained_pipelines) +* [Object detection](object_detection) +* [Autoquality](autoquality) +* [Chained pipelines](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](datadog) +* [Datadog](datadog) * [Image formats support](image_formats_support) * [About processing pipeline](about_processing_pipeline) * [Health check](healthcheck) diff --git a/docs/assets/style.css b/docs/assets/style.css index 5b19b614..b15ce2dd 100644 --- a/docs/assets/style.css +++ b/docs/assets/style.css @@ -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; } diff --git a/docs/autoquality.md b/docs/autoquality.md index a0cdb7b3..59cb23a9 100644 --- a/docs/autoquality.md +++ b/docs/autoquality.md @@ -1,4 +1,4 @@ -# Autoquality +# Autoquality 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). diff --git a/docs/chained_pipelines.md b/docs/chained_pipelines.md index 761fbffc..357908bc 100644 --- a/docs/chained_pipelines.md +++ b/docs/chained_pipelines.md @@ -1,4 +1,4 @@ -# Chained pipelines +# Chained pipelines 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. diff --git a/docs/configuration.md b/docs/configuration.md index 3d7417bf..ebed243b 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -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`: the method of quality calculation. Default: `none` -* `IMGPROXY_AUTOQUALITY_TARGET`: desired value of the autoquality method metric. Default: 0.02 -* `IMGPROXY_AUTOQUALITY_MIN`: minimal quality imgproxy can use. Default: 70 -* `IMGPROXY_AUTOQUALITY_FORMAT_MIN`: 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`: the maximum quality imgproxy can use. Default: 80 -* `IMGPROXY_AUTOQUALITY_FORMAT_MAX`: 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`: the allowed `IMGPROXY_AUTOQUALITY_TARGET` error. Applicable only to `dssim` and `ml` methods. Default: 0.001 -* `IMGPROXY_AUTOQUALITY_MAX_RESOLUTION`: 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`: the path to the neural network for JPEG. -* `IMGPROXY_AUTOQUALITY_WEBP_NET`: the path to the neural network for WebP. -* `IMGPROXY_AUTOQUALITY_AVIF_NET`: the path to the neural network for AVIF. +* `IMGPROXY_AUTOQUALITY_METHOD`: the method of quality calculation. Default: `none` +* `IMGPROXY_AUTOQUALITY_TARGET`: desired value of the autoquality method metric. Default: 0.02 +* `IMGPROXY_AUTOQUALITY_MIN`: minimal quality imgproxy can use. Default: 70 +* `IMGPROXY_AUTOQUALITY_FORMAT_MIN`: 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`: the maximum quality imgproxy can use. Default: 80 +* `IMGPROXY_AUTOQUALITY_FORMAT_MAX`: 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`: the allowed `IMGPROXY_AUTOQUALITY_TARGET` error. Applicable only to `dssim` and `ml` methods. Default: 0.001 +* `IMGPROXY_AUTOQUALITY_MAX_RESOLUTION`: 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`: the path to the neural network for JPEG. +* `IMGPROXY_AUTOQUALITY_WEBP_NET`: the path to the neural network for WebP. +* `IMGPROXY_AUTOQUALITY_AVIF_NET`: 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`: the path to the neural network config. Default: blank -* `IMGPROXY_OBJECT_DETECTION_WEIGHTS`: the path to the neural network weights. Default: blank -* `IMGPROXY_OBJECT_DETECTION_CLASSES`: the path to the text file with the classes names, one per line. Default: blank -* `IMGPROXY_OBJECT_DETECTION_NET_SIZE`: 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`: detections with confidences below this value will be discarded. Default: 0.2 -* `IMGPROXY_OBJECT_DETECTION_NMS_THRESHOLD`: non-max supression threshold. Don't change this if you don't know what you're doing. Default: 0.4 +* `IMGPROXY_OBJECT_DETECTION_CONFIG`: the path to the neural network config. Default: blank +* `IMGPROXY_OBJECT_DETECTION_WEIGHTS`: the path to the neural network weights. Default: blank +* `IMGPROXY_OBJECT_DETECTION_CLASSES`: the path to the text file with the classes names, one per line. Default: blank +* `IMGPROXY_OBJECT_DETECTION_NET_SIZE`: 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`: detections with confidences below this value will be discarded. Default: 0.2 +* `IMGPROXY_OBJECT_DETECTION_NMS_THRESHOLD`: 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 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`: 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`: 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`: 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. diff --git a/docs/datadog.md b/docs/datadog.md index 717abab8..a48eb97e 100644 --- a/docs/datadog.md +++ b/docs/datadog.md @@ -1,4 +1,4 @@ -# Datadog +# Datadog imgproxy can send its metrics to Datadog. To use this feature, do the following: diff --git a/docs/generating_the_url.md b/docs/generating_the_url.md index 333be0e9..793529ca 100644 --- a/docs/generating_the_url.md +++ b/docs/generating_the_url.md @@ -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`: 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 :id=min-width +### Min width ``` min-width:%width @@ -108,7 +108,7 @@ Defines the minimum width of the resulting image. Default: `0` -### Min height :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`: 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`: 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 :id=blur-detections +### Blur detections :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 :id=draw-detections +### Draw detections :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 :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 :id=autoquality +### Autoquality :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. - +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 :id=fallback-image-url +### Fallback image URL :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 :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 :id=expires +### Expires ``` expires:%timestamp diff --git a/docs/object_detection.md b/docs/object_detection.md index a939f6bd..9bee8ecb 100644 --- a/docs/object_detection.md +++ b/docs/object_detection.md @@ -1,4 +1,4 @@ -# Object detection +# Object detection imgproxy can detect objects on the image and use them for smart cropping, bluring the detections, or drawing the detections.