11<p align =" center " >
22 <a href =" https://imgproxy.net " >
33 <picture>
4- <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/imgproxy/imgproxy/master/assets /logo-dark.svg?sanitize=true">
5- <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/imgproxy/imgproxy/master/assets /logo-light.svg?sanitize=true">
6- <img alt="imgproxy logo" src="https://raw.githubusercontent.com/imgproxy/imgproxy/master/assets /logo-light.svg?sanitize=true">
4+ <source media="(prefers-color-scheme: dark)" srcset="logo /logo-dark.svg?sanitize=true">
5+ <source media="(prefers-color-scheme: light)" srcset="logo /logo-light.svg?sanitize=true">
6+ <img alt="imgproxy logo" src="logo /logo-light.svg?sanitize=true">
77 </picture>
88 </a >
99</p >
@@ -25,10 +25,6 @@ imgproxy can be used to provide a fast and secure way to _get rid of all the ima
2525
2626** NOTE:** this readme shows documentation for 2.x version. For version 1.x see the [ v1.2.0] ( https://github.com/imgproxy/imgproxy.rb/tree/v1.2.0 ) tag. See [ 2.0-Upgrade.md] ( 2.0-Upgrade.md ) for the upgrade guide.
2727
28- <a href =" https://evilmartians.com/?utm_source=imgproxy.rb " >
29- <img src =" https://evilmartians.com/badges/sponsored-by-evil-martians.svg " alt =" Sponsored by Evil Martians " width =" 236 " height =" 54 " >
30- </a >
31-
3228## Installation
3329
3430Add this to your ` Gemfile ` :
106102- **salt** (`IMGPROXY_SALT`) - Hex-encoded signature salt. Default: `nil`.
107103- **raw_key** (`IMGPROXY_RAW_KEY`) - Raw (not hex-encoded) signature key. Default: `nil`.
108104- **raw_salt** (`IMGPROXY_RAW_SALT`) - Raw (not hex-encoded) signature salt. Default: `nil`.
109- - **signature_size** (`IMGPROXY_SIGNATURE_SIZE`) - Signature size. See [URL signature](https://docs.imgproxy.net/configuration?id= url-signature) section of imgproxy docs. Default: 32.
105+ - **signature_size** (`IMGPROXY_SIGNATURE_SIZE`) - Signature size. See [URL signature](https://docs.imgproxy.net/configuration/options# url-signature) section of imgproxy docs. Default: 32.
110106- **use_short_options** (`IMGPROXY_USE_SHORT_OPTIONS`) - Use short processing options names (`rs` for `resize`, `g` for `gravity`, etc). Default: true.
111107- **base64_encode_urls** (`IMGPROXY_BASE64_ENCODE_URLS`) - Encode source URLs to base64. Default: false.
112108- **always_escape_plain_urls** (`IMGPROXY_ALWAYS_ESCAPE_PLAIN_URLS`) - Always escape plain source URLs even when ones don't need to be escaped. Default: false.
@@ -209,52 +205,52 @@ builder.url_for("http://images.example.com/images/image2.jpg")
209205
210206# ## Supported imgproxy processing options
211207
212- - [resize](https://docs.imgproxy.net/generating_the_url?id= resize)
213- - [size](https://docs.imgproxy.net/generating_the_url?id= size)
214- - [resizing_type](https://docs.imgproxy.net/generating_the_url?id= resizing-type)
215- - [resizing_algorithm](https://docs.imgproxy.net/generating_the_url?id= resizing-algorithm) _(pro)_
216- - [width](https://docs.imgproxy.net/generating_the_url?id= width)
217- - [height](https://docs.imgproxy.net/generating_the_url?id= height)
218- - [dpr](https://docs.imgproxy.net/generating_the_url?id= dpr)
219- - [enlarge](https://docs.imgproxy.net/generating_the_url?id= enlarge)
220- - [extend](https://docs.imgproxy.net/generating_the_url?id= extend)
221- - [gravity](https://docs.imgproxy.net/generating_the_url?id= gravity)
222- - [crop](https://docs.imgproxy.net/generating_the_url?id= crop)
223- - [padding](https://docs.imgproxy.net/generating_the_url?id= padding)
224- - [trim](https://docs.imgproxy.net/generating_the_url?id= trim)
225- - [rotate](https://docs.imgproxy.net/generating_the_url?id= rotate)
226- - [quality](https://docs.imgproxy.net/generating_the_url?id= quality)
227- - [max_bytes](https://docs.imgproxy.net/generating_the_url?id= max-bytes)
228- - [background](https://docs.imgproxy.net/generating_the_url?id= background)
229- - [background_alpha](https://docs.imgproxy.net/generating_the_url?id= background-alpha) _(pro)_
230- - [adjust](https://docs.imgproxy.net/generating_the_url?id= adjust) _(pro)_
231- - [brightness](https://docs.imgproxy.net/generating_the_url?id= brightness) _(pro)_
232- - [contrast](https://docs.imgproxy.net/generating_the_url?id= contrast) _(pro)_
233- - [saturation](https://docs.imgproxy.net/generating_the_url?id= saturation) _(pro)_
234- - [blur](https://docs.imgproxy.net/generating_the_url?id= blur)
235- - [sharpen](https://docs.imgproxy.net/generating_the_url?id= sharpen)
236- - [pixelate](https://docs.imgproxy.net/generating_the_url?id= pixelate) _(pro)_
237- - [unsharpening](https://docs.imgproxy.net/generating_the_url?id= unsharpening) _(pro)_
238- - [watermark](https://docs.imgproxy.net/generating_the_url?id= watermark)
239- - [watermark_url](https://docs.imgproxy.net/generating_the_url?id= watermark-url) _(pro)_
240- - [watermark_text](https://docs.imgproxy.net/generating_the_url?id= watermark-text) _(pro)_
241- - [style](https://docs.imgproxy.net/generating_the_url?id= style) _(pro)_
242- - [jpeg_options](https://docs.imgproxy.net/generating_the_url?id= jpeg-options) _(pro)_
243- - [png_options](https://docs.imgproxy.net/generating_the_url?id= png-options) _(pro)_
244- - [gif_options](https://docs.imgproxy.net/generating_the_url?id= gif-options) _(pro)_
245- - [page](https://docs.imgproxy.net/generating_the_url?id= page) _(pro)_
246- - [video_thumbnail_second](https://docs.imgproxy.net/generating_the_url?id= video-thumbnail-second) _(pro)_
247- - [preset](https://docs.imgproxy.net/generating_the_url?id= preset)
248- - [cachebuster](https://docs.imgproxy.net/generating_the_url?id= cachebuster)
249- - [strip_metadata](https://docs.imgproxy.net/generating_the_url?id= strip-metadata)
250- - [strip_color_profile](https://docs.imgproxy.net/generating_the_url?id= strip-color-profile)
251- - [auto_rotate](https://docs.imgproxy.net/generating_the_url?id= auto-rotate)
252- - [filename](https://docs.imgproxy.net/generating_the_url?id= filename)
253- - [format](https://docs.imgproxy.net/generating_the_url?id= format)
254- - [return_attachment](https://docs.imgproxy.net/generating_the_url?id= return-attachment)
255- - [expires](https://docs.imgproxy.net/generating_the_url?id= expires)
256-
257- _See [imgproxy URL format guide](https://docs.imgproxy.net/generating_the_url?id= processing-options) for more info._
208+ - [resize](https://docs.imgproxy.net/usage/processing# resize)
209+ - [size](https://docs.imgproxy.net/usage/processing# size)
210+ - [resizing_type](https://docs.imgproxy.net/usage/processing# resizing-type)
211+ - [resizing_algorithm](https://docs.imgproxy.net/usage/processing# resizing-algorithm) _(pro)_
212+ - [width](https://docs.imgproxy.net/usage/processing# width)
213+ - [height](https://docs.imgproxy.net/usage/processing# height)
214+ - [dpr](https://docs.imgproxy.net/usage/processing# dpr)
215+ - [enlarge](https://docs.imgproxy.net/usage/processing# enlarge)
216+ - [extend](https://docs.imgproxy.net/usage/processing# extend)
217+ - [gravity](https://docs.imgproxy.net/usage/processing# gravity)
218+ - [crop](https://docs.imgproxy.net/usage/processing# crop)
219+ - [padding](https://docs.imgproxy.net/usage/processing# padding)
220+ - [trim](https://docs.imgproxy.net/usage/processing# trim)
221+ - [rotate](https://docs.imgproxy.net/usage/processing# rotate)
222+ - [quality](https://docs.imgproxy.net/usage/processing# quality)
223+ - [max_bytes](https://docs.imgproxy.net/usage/processing# max-bytes)
224+ - [background](https://docs.imgproxy.net/usage/processing# background)
225+ - [background_alpha](https://docs.imgproxy.net/usage/processing# background-alpha) _(pro)_
226+ - [adjust](https://docs.imgproxy.net/usage/processing# adjust) _(pro)_
227+ - [brightness](https://docs.imgproxy.net/usage/processing# brightness) _(pro)_
228+ - [contrast](https://docs.imgproxy.net/usage/processing# contrast) _(pro)_
229+ - [saturation](https://docs.imgproxy.net/usage/processing# saturation) _(pro)_
230+ - [blur](https://docs.imgproxy.net/usage/processing# blur)
231+ - [sharpen](https://docs.imgproxy.net/usage/processing# sharpen)
232+ - [pixelate](https://docs.imgproxy.net/usage/processing# pixelate) _(pro)_
233+ - [unsharpening](https://docs.imgproxy.net/usage/processing# unsharpening) _(pro)_
234+ - [watermark](https://docs.imgproxy.net/usage/processing# watermark)
235+ - [watermark_url](https://docs.imgproxy.net/usage/processing# watermark-url) _(pro)_
236+ - [watermark_text](https://docs.imgproxy.net/usage/processing# watermark-text) _(pro)_
237+ - [style](https://docs.imgproxy.net/usage/processing# style) _(pro)_
238+ - [jpeg_options](https://docs.imgproxy.net/usage/processing# jpeg-options) _(pro)_
239+ - [png_options](https://docs.imgproxy.net/usage/processing# png-options) _(pro)_
240+ - [gif_options](https://docs.imgproxy.net/usage/processing# gif-options) _(pro)_
241+ - [page](https://docs.imgproxy.net/usage/processing# page) _(pro)_
242+ - [video_thumbnail_second](https://docs.imgproxy.net/usage/processing# video-thumbnail-second) _(pro)_
243+ - [preset](https://docs.imgproxy.net/usage/processing# preset)
244+ - [cachebuster](https://docs.imgproxy.net/usage/processing# cachebuster)
245+ - [strip_metadata](https://docs.imgproxy.net/usage/processing# strip-metadata)
246+ - [strip_color_profile](https://docs.imgproxy.net/usage/processing# strip-color-profile)
247+ - [auto_rotate](https://docs.imgproxy.net/usage/processing# auto-rotate)
248+ - [filename](https://docs.imgproxy.net/usage/processing# filename)
249+ - [format](https://docs.imgproxy.net/usage/processing# format)
250+ - [return_attachment](https://docs.imgproxy.net/usage/processing# return-attachment)
251+ - [expires](https://docs.imgproxy.net/usage/processing# expires)
252+
253+ _See [imgproxy URL format guide](https://docs.imgproxy.net/usage/processing# processing-options) for more info._
258254
259255# ## Complex processing options
260256
@@ -280,7 +276,7 @@ Imgproxy.url_for(
280276# => .../c:500:600:nowe:10:5/...
281277` ` `
282278
283- All the arguments have the same names as in [imgproxy documentation](https://docs.imgproxy.net/generating_the_url?id= processing-options).
279+ All the arguments have the same names as in [imgproxy documentation](https://docs.imgproxy.net/usage/processing# processing-options).
284280
285281You can use named arguments even if the processing option is not supported by the gem. In this case the arguments won't be reordered nor formatted, so you should provide them in the same order and right the same way they should appear in the URL :
286282
@@ -349,7 +345,7 @@ Imgproxy.url_for(
349345
350346# # Getting the image info
351347
352- If you're a happy user of imgproxy Pro, you may find useful it's [Getting the image info](https://docs.imgproxy.net/getting_the_image_info ) feature. imgproxy.rb allows you to easily generate info URLs for your images :
348+ If you're a happy user of imgproxy Pro, you may find useful it's [Getting the image info](https://docs.imgproxy.net/usage/getting_info ) feature. imgproxy.rb allows you to easily generate info URLs for your images :
353349
354350` ` ` ruby
355351# Framework-agnositic way
0 commit comments