Merge branch 'docs/edits-overhaul' of https://github.com/imgproxy/imgproxy into docs/edits-overhaul

docs/README.md

@@ -1,6 +1,6 @@
 # imgproxy
 
-imgproxy is a fast and secure standalone server for resizing and converting remote images.  The guiding principles behind imgproxy are security, speed, and simplicity. 
+imgproxy is a fast and secure standalone server for resizing and converting remote images. The guiding principles behind imgproxy are security, speed, and simplicity.
 
 imgproxy is able to quickly and easily resize images on the fly, and it's well-equipped to handle a large amount of image resizing. imgproxy is a fast, secure replacement for all the image resizing code inside your web application (such as resizing libraries, or code that calls ImageMagick or GraphicsMagic). It's also an indispensable tool for processing images from a remote source. With imgproxy, you don’t need to repeatedly prepare images to fit your design every time it changes.
 
@@ -35,7 +35,7 @@ In terms of security, the massive processing of remote images is a potentially d
 
 * imgproxy checks the image type and its “real” dimensions when downloading. The image will not be fully downloaded if it has an unknown format or if the dimensions are too big (you can set the max allowed dimensions). This is how imgproxy protects from so called "image bombs”, like those described in [this doc](https://www.bamsoftware.com/hacks/deflate.html).
 
-* imgproxy protects image URLs with a signature, so an attacker cannot enacta denial-of-service attack by requesting multiple image resizes.
+* imgproxy protects image URLs with a signature, so an attacker cannot enact a denial-of-service attack by requesting multiple image resizes.
 
 * imgproxy supports authorization by HTTP header. This prevents imgproxy from being used directly by an attacker, but allows it to be used via a CDN or a caching server — simply by adding a header to a proxy or CDN config.
 

docs/configuration.md

@@ -10,7 +10,7 @@ imgproxy allows URLs to be signed with a key and a salt. This feature is disable
 * `IMGPROXY_SALT`: hex-encoded salt
 * `IMGPROXY_SIGNATURE_SIZE`: number of bytes to use for signature before encoding to Base64. Default: 32
 
-You can specify multiple key/salt pairs by dividing the keys and salts with a comma (,). imgproxy will check URL signatures with each pair. This is useful when you need to change key/salt pairs in your application while incurring zero downtime.
+You can specify multiple key/salt pairs by dividing the keys and salts with a comma (`,`). imgproxy will check URL signatures with each pair. This is useful when you need to change key/salt pairs in your application while incurring zero downtime.
 
 You can also specify file paths using the command line by referencing a separate file containing hex-coded keys and salts line by line:
 
@@ -61,7 +61,9 @@ imgproxy can process animated images (GIF, WebP), but since this operation is pr
 
 * `IMGPROXY_MAX_ANIMATION_FRAMES`: the maximum number of animated image frames that may be processed. Default: `1`
 
-**📝Note:**  imgproxy summarizes all frame resolutions while checking the source image resolution. To check if the source image is SVG, imgproxy reads some amount of bytes; by default it reads a maximum of 32KB. However, you can change this value using the following variable:
+**📝Note:** imgproxy summarizes all frame resolutions while checking the source image resolution.
+
+To check if the source image is SVG, imgproxy reads some amount of bytes; by default it reads a maximum of 32KB. However, you can change this value using the following variable:
 
 * `IMGPROXY_MAX_SVG_CHECK_BYTES`: the maximum number of bytes imgproxy will read to recognize SVG files. If imgproxy is unable to recognize your SVG, try increasing this number. Default: `32768` (32KB)
 
@@ -77,7 +79,7 @@ You can limit allowed source URLs with the following variable:
 
 * `IMGPROXY_ALLOWED_SOURCES`: a whitelist of source image URL prefixes divided by comma. Wildcards can be included with `*` to match all characters except `/`. When blank, imgproxy allows all source image URLs. Example: `s3://,https://*.example.com/,local://`. Default: blank
 
-**⚠️Warning:** Be careful when using this config to limit source URL hosts, and always add a trailing slash after the host. 
+**⚠️Warning:** Be careful when using this config to limit source URL hosts, and always add a trailing slash after the host.
 * Bad: `http://example.com`
 * Good: `http://example.com/`
 If the trailing slash is absent, `http://example.com@baddomain.com` would be a permissable URL, however, the request would be made to `baddomain.com`.
@@ -285,7 +287,7 @@ imgproxy can be switched into "presets-only mode". In this mode, imgproxy accept
 
 imgproxy can serve your local images, but this feature is disabled by default. To enable it, specify your local filesystem root:
 
-* `IMGPROXY_LOCAL_FILESYSTEM_ROOT`: the root of the local filesystem. Keep this empty to local file serving.
+* `IMGPROXY_LOCAL_FILESYSTEM_ROOT`: the root of the local filesystem. Keep this empty to disable local file serving.
 
 Check out the [Serving local files](serving_local_files.md) guide to learn more.
 

docs/image_formats_support.md

@@ -18,14 +18,6 @@ At the moment, imgproxy supports only the most popular image formats:
 | MP4 (h264)<i class='badge badge-pro'></i> | `mp4` | [See notes](#video-thumbnails) | Yes |
 | Other video formats<i class='badge badge-pro'></i> | | [See notes](#video-thumbnails) | No |
 
-## GIF support
-
-imgproxy supports GIF output only when using libvips 8.7.0+ compiled with ImageMagick support. The official imgproxy Docker image supports GIF output out of the box.
-
-## ICO support
-
-imgproxy supports ICO only when using libvips 8.7.0+ compiled with ImageMagick support. The official imgproxy Docker image supports ICO out of the box.
-
 ## SVG support
 
 imgproxy supports SVG sources without limitations, but SVG results are not supported when the source image is not SVG.
@@ -36,20 +28,6 @@ imgproxy reads some amount of bytes to check if the source image is SVG. By defa
 
 * `IMGPROXY_MAX_SVG_CHECK_BYTES`: the maximum number of bytes imgproxy will read to recognize SVG. If imgproxy can't recognize your SVG, try to increase this number. Default: `32768` (32KB)
 
-## HEIC support
-
-imgproxy supports HEIC only when using libvips 8.8.0+. The official imgproxy Docker image supports HEIC out of the box.
-
-## AVIF support
-
-imgproxy supports AVIF only when using libvips 8.9.0+ with compiled support for libheif and its supported encoder (rav1e, aom). The official imgproxy Docker image supports AVIF out of the box.
-
-## BMP support
-
-imgproxy supports BMP only when using libvips 8.7.0+ compiled with ImageMagick support. The official imgproxy Docker image supports ICO out of the box.
-
-By default, imgproxy saves BMP images as JPEG. You need to explicitly specify the `format` option to get BMP output.
-
 ## Animated images support
 
 Since the processing of animated images is a pretty heavy process, only one frame is processed by default. You can increase the maximum of animation frames to process with the following variable: