imgproxy 2.1.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f30666a2a3a8a1097534749a93ca6d53492982f59f43e0fa91553f19957535d8
-  data.tar.gz: c0ac3bddc82a2e515b728107ad1bc58fedac3eb8edca76532a3f23d8b8def706
+  metadata.gz: '0186096d10a3cffb960421a5b8cd53a22525964be29aeed0794e8e2b42159f64'
+  data.tar.gz: a542c12c9f88f7e6caa264312009a686fd793ce3285a6938e0f6edb05fb395c1
 SHA512:
-  metadata.gz: 3c242a4e67d4e726ebae337e9264454ad223e2fbd31e8f5655cd8a47288e6ab8ee035bebbd0d99dbe17aa9de75ed3fc098cedae1acc7501ac5ea6e3dc43feea7
-  data.tar.gz: ccd34093cb91dbe50d1a59139db8c94da96fe0f6dba780ae1c1538ccb91646de982055aad509adceb6a3eb6af63f9a2f9af74450ce00aaa6bb0f00439b92acae
+  metadata.gz: '09a5bcee09b2931b148983b6ab385e7f0dc0725359f31c768a70f6011e7ae5bfe85dcf232bc98a5933ff616392addbfb0aeb65a0fe7220adba5b892689ee3c57'
+  data.tar.gz: b9ad733e0c6d8708009815e7dec8f019fede88454f1b544678a90fd14bacf1df3ed759ad9002a5e73d541b9a9b91cdc85f422047171f504f7f1bf78df1e9d84a

data/.yardopts

@@ -0,0 +1,8 @@
+--asset logo:logo
+--load docs/yard/fix_pictures.rb
+--load docs/yard/relative_markdown_links.rb
+--load docs/yard/github_alerts.rb
+-
+CHANGELOG.md
+UPGRADE.md
+docs/*.md

data/CHANGELOG.md

@@ -0,0 +1,74 @@
+<!--
+# @title Changelog
+-->
+# Changelog
+
+## [3.0.0] - 2023-12-28
+
+⚠️ This is a major release. See [the migration guide](https://github.com/imgproxy/imgproxy.rb/blob/master/UPGRADE.md). ⚠️
+
+### Added
+- Added info options support.
+- Added missing processing options.
+- Added ecrypted source URLs support.
+- Added extra services support.
+
+## [2.1.0] - 2022-06-14
+### Added
+- Add `ActiveStorage::Service::MirrorService` support.
+- Add `expires` and `return_attachment` options support.
+
+## [2.0.0] - 2021-03-02
+
+⚠️ This is a major release. See [the migration guide](https://github.com/imgproxy/imgproxy.rb/blob/master/UPGRADE.md). ⚠️
+
+### Added
+- Added missing processing options.
+
+### Changed
+- New processing options format.
+- Active Storage and Shrine extensions are enabled _automagially_.
+- Active Storage and Shrine extensions options are moved to the config.
+- The gem can be configured with environment variables or config files. Thanks to [anyway_config](https://github.com/palkan/anyway_config).
+- Unsupported processing options can be used with some limitations.
+- `hex_key` and `hex_salt` config options are renamed to `key` and `salt`. `key` and `salt` config options are renamed to `raw_key` and `raw_salt`.
+
+## [1.1.0] - 2019-10-14
+### Added
+- Add crop options;
+- Add adjustment options;
+- Add `pixelate` option;
+- Add `watermark_url` option.
+
+## [1.0.6] - 2019-09-24
+### Fixed
+- Escape spaces in source URLs;
+- Fix URL combination.
+
+## [1.0.5] - 2019-09-04
+### Fixed
+- Fix non-ascii URLs support
+
+## [1.0.4] - 2019-08-22
+### Fixed
+- Only set host to Shrine if it presents
+
+## [1.0.3] - 2019-08-21
+### Fixed
+- Don't modify builder options
+
+## [1.0.2] - 2019-04-08
+### Added
+- Add host option to Imgproxy.extend_shrine!
+
+### Changed
+- Check Active Storage attachment service instead of ::ActiveStorage::Blob.service
+- Better URL combination
+
+## [1.0.1] - 2019-04-03
+### Fixed
+- Fixed URL signing
+
+## [1.0.0] - 2019-04-03
+### Added
+- First production-ready release

data/README.md

@@ -1,21 +1,35 @@
-# imgproxy.rb
-
-<img align="right" width="200" height="200" title="imgproxy logo"
-     src="https://cdn.rawgit.com/DarthSim/imgproxy/master/logo.svg">
-
-[![GH Test](https://img.shields.io/github/workflow/status/imgproxy/imgproxy.rb/Test?label=Test&logo=github&style=for-the-badge)](https://github.com/imgproxy/imgproxy.rb/actions) [![GH Lint](https://img.shields.io/github/workflow/status/imgproxy/imgproxy.rb/Lint?label=Lint&logo=github&style=for-the-badge)](https://github.com/imgproxy/imgproxy.rb/actions) [![Gem](https://img.shields.io/gem/v/imgproxy.svg?style=for-the-badge)](https://rubygems.org/gems/imgproxy) [![rubydoc.org](https://img.shields.io/badge/rubydoc-reference-blue.svg?style=for-the-badge)](https://www.rubydoc.info/gems/imgproxy)
-
-**[imgproxy](https://github.com/imgproxy/imgproxy)** is a fast and secure standalone server for resizing and converting remote images. The main principles of imgproxy are simplicity, speed, and security. It is a Go application, ready to be installed and used in any Unix environment—also ready to be containerized using Docker.
+<p align="center">
+  <a href="https://imgproxy.net">
+    <picture>
+      <source media="(prefers-color-scheme: dark)" srcset="logo/logo-dark.svg?sanitize=true">
+      <source media="(prefers-color-scheme: light)" srcset="logo/logo-light.svg?sanitize=true">
+      <img alt="imgproxy logo" src="logo/logo-light.svg?sanitize=true">
+    </picture>
+  </a>
+</p>
+
+<p align="center">
+<a href="https://github.com/imgproxy/imgproxy.rb/actions"><img alt="GH Test" src="https://img.shields.io/github/actions/workflow/status/imgproxy/imgproxy.rb/test.yml?branch=master&label=Test&style=for-the-badge"/></a>
+<a href="https://github.com/imgproxy/imgproxy.rb/actions"><img alt="GH Lint" src="https://img.shields.io/github/actions/workflow/status/imgproxy/imgproxy.rb/lint.yml?branch=master&label=Lint&style=for-the-badge"/></a>
+<a href="https://rubygems.org/gems/imgproxy"><img alt="Gem" src="https://img.shields.io/gem/v/imgproxy.svg?style=for-the-badge"/></a>
+<a href="https://www.rubydoc.info/gems/imgproxy"><img alt="rubydoc.org" src="https://img.shields.io/badge/rubydoc-reference-blue.svg?style=for-the-badge"/></a>
+</p>
+
+---
+
+[imgproxy](https://imgproxy.net) is a fast and secure standalone server for resizing and converting remote images. The main principles of imgproxy are simplicity, speed, and security. It is a Go application, ready to be installed and used in any Unix environment—also ready to be containerized using Docker.
 
 imgproxy can be used to provide a fast and secure way to _get rid of all the image resizing code_ in your web application (like calling ImageMagick or GraphicsMagick, or using libraries), while also being able to resize everything on the fly on a separate server that only you control. imgproxy is fast, easy to use, and requires zero processing power or storage from the main application. imgproxy is indispensable when handling image resizing of epic proportions, especially when original images are coming from a remote source.
 
 [imgproxy.rb](https://github.com/imgproxy/imgproxy.rb) is a framework-agnostic Ruby Gem for imgproxy that includes proper support for Ruby on Rails' most popular image attachment options: [Active Storage](https://edgeguides.rubyonrails.org/active_storage_overview.html) and [Shrine](https://github.com/shrinerb/shrine).
 
-**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.
-
-<a href="https://evilmartians.com/?utm_source=imgproxy.rb">
-<img src="https://evilmartians.com/badges/sponsored-by-evil-martians.svg" alt="Sponsored by Evil Martians" width="236" height="54">
-</a>
+> [!IMPORTANT]
+> This readme shows documentation for version 3.x.
+>
+> * For version 2.x see the [v2.1.0](https://github.com/imgproxy/imgproxy.rb/tree/v2.1.0) tag
+> * For version 1.x see the [v1.2.0](https://github.com/imgproxy/imgproxy.rb/tree/v1.2.0) tag
+>
+> See [Upgrading imgproxy.rb](UPGRADE.md) for the upgrade guide.
 
 ## Installation
 
@@ -27,7 +41,7 @@ gem "imgproxy"
 
 or install system-wide:
 
-```
+```bash
 gem install imgproxy
 ```
 
@@ -35,7 +49,7 @@ gem install imgproxy
 
 imgproxy.rb uses [anyway_config](https://github.com/palkan/anyway_config) to load configuration, so you can configure it in different ways.
 
-- With a separate config file:
+With a separate config file:
 
 ```yaml
 # <Rails root>/config/imgproxy.yml
@@ -49,7 +63,7 @@ production: ...
 test: ...
 ```
 
-- With a `secrets.yml` entry for imgproxy:
+With a `secrets.yml` entry for imgproxy:
 
 ```yaml
 # secrets.yml
@@ -64,16 +78,16 @@ production:
 ...
 ```
 
-- With environment variables:
+With environment variables:
 
 ```bash
-IMGPROXY_ENDPOINT="http://imgproxy.example.com"\
-IMGPROXY_KEY="your_key"\
-IMGPROXY_SALT="your_salt"\
+IMGPROXY_ENDPOINT="http://imgproxy.example.com" \
+IMGPROXY_KEY="your_key" \
+IMGPROXY_SALT="your_salt" \
 rails s
 ```
 
-- ...or right in your application code:
+...or right in your application code:
 
 ```ruby
 # config/initializers/imgproxy.rb
@@ -87,21 +101,24 @@ Imgproxy.configure do |config|
 end
 ```
 
-#### Configuration options
-
-- **endpoint** (`IMGPROXY_ENDPOINT`) - Full URL to your imgproxy instance. Default: `nil`.
-- **key** (`IMGPROXY_KEY`) - Hex-encoded signature key. Default: `nil`.
-- **salt** (`IMGPROXY_SALT`) - Hex-encoded signature salt. Default: `nil`.
-- **raw_key** (`IMGPROXY_RAW_KEY`) - Raw (not hex-encoded) signature key. Default: `nil`.
-- **raw_salt** (`IMGPROXY_RAW_SALT`) - Raw (not hex-encoded) signature salt. Default: `nil`.
-- **signature_size** (`IMGPROXY_SIGNATURE_SIZE`) - Signature size. See [URL signature](https://docs.imgproxy.net/#/configuration?id=url-signature) section of imgproxy docs. Default: 32.
-- **use_short_options** (`IMGPROXY_USE_SHORT_OPTIONS`) - Use short processing options names (`rs` for `resize`, `g` for `gravity`, etc). Default: true.
-- **base64_encode_urls** (`IMGPROXY_BASE64_ENCODE_URLS`) - Encode source URLs to base64. Default: false.
-- **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.
-- **use_s3_urls** (`IMGPROXY_USE_S3_URLS`) - Use `s3://...` source URLs for Active Storage and Shrine attachments stored in Amazon S3. Default: false.
-- **use_gcs_urls** (`IMGPROXY_USE_GCS_URLS`) - Use `gs://...` source URLs for Active Storage and Shrine attachments stored in Google Cloud Storage. Default: false.
-- **gcs_bucket** (`IMGPROXY_GCS_BUCKET`) - Google Cloud Storage bucket name. Default: `nil`.
-- **shrine_host** (`IMGPROXY_SHRINE_HOST`) - Shrine host for locally stored files.
+### Configuration options
+
+* `endpoint` (`IMGPROXY_ENDPOINT`) - Full URL to your imgproxy instance. Default: `nil`.
+* `key` (`IMGPROXY_KEY`) - Hex-encoded signature key. Default: `nil`.
+* `salt` (`IMGPROXY_SALT`) - Hex-encoded signature salt. Default: `nil`.
+* `raw_key` (`IMGPROXY_RAW_KEY`) - Raw (not hex-encoded) signature key. Default: `nil`.
+* `raw_salt` (`IMGPROXY_RAW_SALT`) - Raw (not hex-encoded) signature salt. Default: `nil`.
+* `signature_size` (`IMGPROXY_SIGNATURE_SIZE`) - Signature size. See [URL signature](https://docs.imgproxy.net/configuration/options#url-signature) section of imgproxy docs. Default: 32.
+* `use_short_options` (`IMGPROXY_USE_SHORT_OPTIONS`) - Use short processing options names (`rs` for `resize`, `g` for `gravity`, etc). Default: true.
+* `base64_encode_urls` (`IMGPROXY_BASE64_ENCODE_URLS`) - Encode source URLs to base64. Default: false.
+* `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.
+* `source_url_encryption_key` (`IMGPROXY_SOURCE_URL_ENCRYPTION_KEY`) - Hex-encoded source URL encryption key. Default: `nil`.
+* `raw_source_url_encryption_key` (`IMGPROXY_RAW_SOURCE_URL_ENCRYPTION_KEY`) - Raw (not hex-encoded) source URL encryption key. Default: `nil`.
+* `always_encrypt_source_urls` (`IMGPROXY_ALWAYS_ENCRYPT_SOURCE_URLS`) - Always encrypt source URLs. Default: false.
+* `use_s3_urls` (`IMGPROXY_USE_S3_URLS`) - Use `s3://...` source URLs for Active Storage and Shrine attachments stored in Amazon S3. Default: false.
+* `use_gcs_urls` (`IMGPROXY_USE_GCS_URLS`) - Use `gs://...` source URLs for Active Storage and Shrine attachments stored in Google Cloud Storage. Default: false.
+* `gcs_bucket` (`IMGPROXY_GCS_BUCKET`) - Google Cloud Storage bucket name. Default: `nil`.
+* `shrine_host` (`IMGPROXY_SHRINE_HOST`) - Shrine host for locally stored files.
 
 ## Usage
 
@@ -118,10 +135,18 @@ Imgproxy.extend_active_storage!
 Now, to add imgproxy processing to your image attachments, just use the `imgproxy_url` method:
 
 ```ruby
-user.avatar.imgproxy_url(width: 250, height: 250)
+user.avatar.imgproxy_url(width: 500, height: 400, resizing_type: :fill)
 ```
 
-This method will return an URL to your user's avatar, resized to 250x250px on the fly.
+This method will return a URL to your user's avatar, resized to fill 500x400px on the fly.
+
+If you're a happy user of [imgproxy Pro](https://imgproxy.net#pro), you may find useful it's [Getting an image info](https://docs.imgproxy.net/usage/getting_info) feature. imgproxy.rb allows you to easily generate info URLs for your images:
+
+```ruby
+user.avatar.imgproxy_info_url(detect_objects: true, palette: 128)
+```
+
+This method will return a URL to the JSON with the requested info about your user's avatar.
 
 #### Amazon S3
 
@@ -131,7 +156,8 @@ If you have configured both your imgproxy server and Active Storage to work with
 
 You can also enable `gs://...` URLs usage for the files stored in Google Cloud Storage with `use_gcs_urls` and `gcs_bucket` config options (or `IMGPROXY_USE_GCS_URLS` and `IMGPROXY_GCS_BUCKET` env variables).
 
-**NOTE** that you need to explicitly provide GCS bucket name since Active Storage "hides" the GCS config.
+> [!IMPORTANT]
+> You need to explicitly provide GCS bucket name since Active Storage "hides" the GCS config.
 
 ### Using with Shrine
 
@@ -146,19 +172,28 @@ Imgproxy.extend_shrine!
 Now you can use `imgproxy_url` method of `Shrine::UploadedFile`:
 
 ```ruby
-user.avatar.imgproxy_url(width: 250, height: 250)
+user.avatar.imgproxy_url(width: 500, height: 400, resizing_type: :fill)
 ```
 
-This method will return an URL to your user's avatar, resized to 250x250px on the fly.
+This method will return a URL to your user's avatar, resized to fill 500x400px on the fly.
 
-**NOTE:** If you use `Shrine::Storage::FileSystem` as storage, uploaded file URLs won't include the hostname, so imgproxy server won't be able to access them. To fix this, use `shrine_host` config.
+If you're a happy user of [imgproxy Pro](https://imgproxy.net#pro), you may find useful it's [Getting an image info](https://docs.imgproxy.net/usage/getting_info) feature. imgproxy.rb allows you to easily generate info URLs for your images:
 
-Alternatively, you can launch your imgproxy server with the `IMGPROXY_BASE_URL` setting:
-
-```
-IMGPROXY_BASE_URL="http://your-host.test" imgproxy
+```ruby
+user.avatar.imgproxy_info_url(detect_objects: true, palette: 128)
 ```
 
+This method will return a URL to the JSON with the requested info about your user's avatar.
+
+> [!IMPORTANT]
+> If you use `Shrine::Storage::FileSystem` as storage, uploaded file URLs won't include the hostname, so imgproxy server won't be able to access them. To fix this, use `shrine_host` config.
+>
+> Alternatively, you can launch your imgproxy server with the `IMGPROXY_BASE_URL` setting:
+>
+> ```
+> IMGPROXY_BASE_URL="http://your-host.test" imgproxy
+> ```
+
 #### Amazon S3
 
 If you have configured both your imgproxy server and Shrine to work with Amazon S3, you can use `use_s3_urls` config option (or `IMGPROXY_USE_S3_URLS` env variable) to make imgproxy.rb use short `s3://...` source URLs instead of long ones generated by Shrine.
@@ -172,16 +207,28 @@ Imgproxy.url_for(
   "http://images.example.com/images/image.jpg",
   width: 500,
   height: 400,
-  resizing_type: :fill,
-  sharpen: 0.5
+  resizing_type: :fill
+)
+```
+
+This method will return a URL to the image, resized to fill 500x400px on the fly.
+
+If you're a happy user of [imgproxy Pro](https://imgproxy.net#pro), you may find useful it's [Getting an image info](https://docs.imgproxy.net/usage/getting_info) feature. imgproxy.rb allows you to easily generate info URLs for your images:
+
+```ruby
+Imgproxy.info_url_for(
+  "http://images.example.com/images/image.jpg",
+  detect_objects: true,
+  palette: 128
 )
-# => http://imgproxy.example.com/2tjGMpWqjO/rs:fill:500:400/sh:0.5/plain/http://images.example.com/images/image.jpg
 ```
 
+This method will return a URL to the JSON with the requested info about the image.
+
 You can reuse processing options by using `Imgproxy::Builder`:
 
 ```ruby
-builder = Imgproxy::Builder.new(
+builder = Imgproxy::UrlBuilders::Processing.new(
   width: 500,
   height: 400,
   resizing_type: :fill,
@@ -190,59 +237,37 @@ builder = Imgproxy::Builder.new(
 
 builder.url_for("http://images.example.com/images/image1.jpg")
 builder.url_for("http://images.example.com/images/image2.jpg")
+
+info_builder = Imgproxy::UrlBuilders::Info.new(
+  detect_objects: true,
+  palette: 128
+)
+
+info_builder.url_for("http://images.example.com/images/image1.jpg")
+info_builder.url_for("http://images.example.com/images/image2.jpg")
 ```
 
-### Supported imgproxy processing options
-
-- [resize](https://docs.imgproxy.net/#/generating_the_url_advanced?id=resize)
-- [size](https://docs.imgproxy.net/#/generating_the_url_advanced?id=size)
-- [resizing_type](https://docs.imgproxy.net/#/generating_the_url_advanced?id=resizing-type)
-- [resizing_algorithm](https://docs.imgproxy.net/#/generating_the_url_advanced?id=resizing-algorithm) _(pro)_
-- [width](https://docs.imgproxy.net/#/generating_the_url_advanced?id=width)
-- [height](https://docs.imgproxy.net/#/generating_the_url_advanced?id=height)
-- [dpr](https://docs.imgproxy.net/#/generating_the_url_advanced?id=dpr)
-- [enlarge](https://docs.imgproxy.net/#/generating_the_url_advanced?id=enlarge)
-- [extend](https://docs.imgproxy.net/#/generating_the_url_advanced?id=extend)
-- [gravity](https://docs.imgproxy.net/#/generating_the_url_advanced?id=gravity)
-- [crop](https://docs.imgproxy.net/#/generating_the_url_advanced?id=crop)
-- [padding](https://docs.imgproxy.net/#/generating_the_url_advanced?id=padding)
-- [trim](https://docs.imgproxy.net/#/generating_the_url_advanced?id=trim)
-- [rotate](https://docs.imgproxy.net/#/generating_the_url_advanced?id=rotate)
-- [quality](https://docs.imgproxy.net/#/generating_the_url_advanced?id=quality)
-- [max_bytes](https://docs.imgproxy.net/#/generating_the_url_advanced?id=max-bytes)
-- [background](https://docs.imgproxy.net/#/generating_the_url_advanced?id=background)
-- [background_alpha](https://docs.imgproxy.net/#/generating_the_url_advanced?id=background-alpha) _(pro)_
-- [adjust](https://docs.imgproxy.net/#/generating_the_url_advanced?id=adjust) _(pro)_
-- [brightness](https://docs.imgproxy.net/#/generating_the_url_advanced?id=brightness) _(pro)_
-- [contrast](https://docs.imgproxy.net/#/generating_the_url_advanced?id=contrast) _(pro)_
-- [saturation](https://docs.imgproxy.net/#/generating_the_url_advanced?id=saturation) _(pro)_
-- [blur](https://docs.imgproxy.net/#/generating_the_url_advanced?id=blur)
-- [sharpen](https://docs.imgproxy.net/#/generating_the_url_advanced?id=sharpen)
-- [pixelate](https://docs.imgproxy.net/#/generating_the_url_advanced?id=pixelate) _(pro)_
-- [unsharpening](https://docs.imgproxy.net/#/generating_the_url_advanced?id=unsharpening) _(pro)_
-- [watermark](https://docs.imgproxy.net/#/generating_the_url_advanced?id=watermark)
-- [watermark_url](https://docs.imgproxy.net/#/generating_the_url_advanced?id=watermark-url) _(pro)_
-- [style](https://docs.imgproxy.net/#/generating_the_url_advanced?id=style) _(pro)_
-- [jpeg_options](https://docs.imgproxy.net/#/generating_the_url_advanced?id=jpeg-options) _(pro)_
-- [png_options](https://docs.imgproxy.net/#/generating_the_url_advanced?id=png-options) _(pro)_
-- [gif_options](https://docs.imgproxy.net/#/generating_the_url_advanced?id=gif-options) _(pro)_
-- [page](https://docs.imgproxy.net/#/generating_the_url_advanced?id=page) _(pro)_
-- [video_thumbnail_second](https://docs.imgproxy.net/#/generating_the_url_advanced?id=video-thumbnail-second) _(pro)_
-- [preset](https://docs.imgproxy.net/#/generating_the_url_advanced?id=preset)
-- [cachebuster](https://docs.imgproxy.net/#/generating_the_url_advanced?id=cachebuster)
-- [strip_metadata](https://docs.imgproxy.net/#/generating_the_url_advanced?id=strip-metadata)
-- [strip_color_profile](https://docs.imgproxy.net/#/generating_the_url_advanced?id=strip-color-profile)
-- [auto_rotate](https://docs.imgproxy.net/#/generating_the_url_advanced?id=auto-rotate)
-- [filename](https://docs.imgproxy.net/#/generating_the_url_advanced?id=filename)
-- [format](https://docs.imgproxy.net/#/generating_the_url_advanced?id=format)
-- [return_attachment](https://docs.imgproxy.net/#/generating_the_url_advanced?id=return-attachment)
-- [expires](https://docs.imgproxy.net/#/generating_the_url?id=expires)
-
-_See [imgproxy URL format guide](https://docs.imgproxy.net/#/generating_the_url_advanced?id=processing-options) for more info._
+## Supported imgproxy options
+
+### Common options
+
+* `base64_encode_url` — per-call redefinition of `base64_encode_urls` config.
+* `escape_plain_url` — per-call redefinition of `always_escape_plain_urls` config.
+* `use_short_options` — per-call redefinition of `use_short_options` config.
+* `encrypt_source_url` - _(pro)_ per-call redefinition of `always_encrypt_source_urls` config.
+* `source_url_encryption_iv` - _(pro)_ an initialization vector (IV) to be used for the source URL encryption if encryption is needed. If not specified, a random IV is used.
+
+### Processing options
+
+See [Supported processing options](docs/processing_options.md) for the supported processing options list and their arguments.
+
+### Info options (pro)
+
+See [Supported info options](docs/info_options.md) for the supported info options list and their arguments.
 
 ### Complex processing options
 
-Some of the processing options like `crop` or `gravity` may have multiple arguments, and you can define these arguments multiple ways:
+Some of the processing and info options like `crop` or `gravity` may have multiple arguments, and you can define these arguments multiple ways:
 
 #### Named arguments
 
@@ -264,9 +289,11 @@ Imgproxy.url_for(
 # => .../c:500:600:nowe:10:5/...
 ```
 
-All the arguments have the same names as in [imgproxy documentation](https://docs.imgproxy.net/#/generating_the_url_advanced?id=processing-options).
+You can find argument names on the [Supported processing options](docs/processing_options.md) and [Supported info options](docs/info_options.md) pages.
+
+##### Using named arguments with usupported options
 
-You 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:
+You can use named arguments even if the 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:
 
 ```ruby
 Imgproxy.url_for(
@@ -286,20 +313,20 @@ Imgproxy.url_for(
 
 #### Unnamed arguments
 
-The arguments of the complex options can be provided as an array of formatted values or even as a colon-separated string:
+The arguments of the complex options can be provided as an array of formatted values:
 
 ```ruby
 Imgproxy.url_for(
   "http://images.example.com/images/image.jpg",
   crop: [500, 600, :nowe, 10, 5],
-  trim: "10:aabbcc:1:1"
+  trim: [10, "aabbcc", 1. 1]
 )
 # => .../c:500:600:nowe:10:5/t:10:aabbcc:1:1/...
 ```
 
 #### Single required argument
 
-If a complex option has a single required argument, and you don't want to use the optional ones, you can just use its value:
+If a complex option has a single required argument, and you don't want to use the optional ones, you can just use the required argument value:
 
 ```ruby
 Imgproxy.url_for(
@@ -312,7 +339,7 @@ Imgproxy.url_for(
 
 ### Base64 processing options arguments
 
-Some of the processing options like `watermark_url` or `style` require their arguments to be base64-encoded. Good news is that imgproxy gem will encode them for you:
+Some of the processing options like `watermark_url` or `style` require their arguments to be base64-encoded. Good news is that imgproxy.rb will encode them for you:
 
 ```ruby
 Imgproxy.url_for(
@@ -323,37 +350,13 @@ Imgproxy.url_for(
 # => .../wmu:aHR0cDovL2V4YW1wbGUuY29tL3dhdGVybWFyay5qcGc/st:Y29sb3I6IHJnYmEoMjU1LCAyNTUsIDI1NSwgLjUp/...
 ```
 
-### Special options:
-
-- `base64_encode_url` — per-call redefinition of `base64_encode_urls` config.
-- `escape_plain_url` — per-call redefinition of `always_escape_plain_urls` config.
-- `use_short_options` — per-call redefinition of `use_short_options` config.
-
-## Getting the image info
-
-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:
-
-```ruby
-# Framework-agnositic way
-Imgproxy.info_url_for("http://images.example.com/images/image.jpg")
-# Using Active Storage or Shrine
-user.avatar.imgproxy_info_url
-
-# You can also use base64_encode_url or escape_plain_url options
-Imgproxy.info_url_for(
-  "http://images.example.com/images/image.jpg",
-  base64_encode_url: true
-)
-Imgproxy.info_url_for(
-  "http://images.example.com/images/image.jpg",
-  escape_plain_url: true
-)
-```
-
 ## URL adapters
 
 By default, `Imgproxy.url_for` accepts only `String` and `URI` as the source URL, but you can extend that behavior by using URL adapters.
 
+> [!TIP]
+> imgproxy.rb provides built-in adapters for Active Storage and Shrine that are automatically added when Active Storage or Shrine support is enabled.
+
 URL adapter is a simple class that implements `applicable?` and `url` methods. See the example below:
 
 ```ruby
@@ -377,15 +380,53 @@ Imgproxy.configure do |config|
 end
 ```
 
-**NOTE:** `Imgproxy` will use the first applicable URL adapter. If you need to add your adapter to the beginning of the list, use the `prepend` method instead of `add`.
+> [!NOTE]
+> `Imgproxy` will use the first applicable URL adapter. If you need to add your adapter to the beginning of the list, use the `prepend` method instead of `add`.
+
+## Extra services
+
+If you use more than one instance of imgproxy and they have different endpoints and key/salt configurations you can specify them in `services` option.
+
+```ruby
+Imgproxy.configure do |config|
+  config.endpoint = "https://main.imgproxy.com/"
+  config.service(:pro) do |pro|
+    pro.endpoint = "https://pro.imgproxy.com/"
+    pro.key = ENV["IMGPROXY_PRO_KEY"]
+    pro.salt = ENV["IMGPROXY_PRO_SALT"]
+    pro.source_url_encryption_key = ENV["IMGPROXY_PRO_ENCRYPTION_KEY"]
+    pro.always_encrypt_source_urls = true
+  end
+end
+```
 
-**NOTE:** imgproxy.rb provides built-in adapters for Active Storage and Shrine that are automatically added when Active Storage or Shrine support is enabled.
+Or via YAML config:
+
+```yaml
+endpoint: "https://main.imgproxy.com/"
+services:
+  pro:
+    endpoint: "https://pro.imgproxy.com/"
+    key: <%= ENV["IMGPROXY_PRO_KEY"] %>
+    salt: <%= ENV["IMGPROXY_PRO_SALT"] %>
+    source_url_encryption_key: ENV["IMGPROXY_PRO_ENCRYPTION_KEY"]
+    always_encrypt_source_urls: true
+```
+
+If you don't specify `key`, `salt`, `endpoint`, `signature_size`, `source_url_encryption_key`, or `always_encrypt_source_urls`, they are inherited from the global configuration.
+
+Pass the `service` option to `url_for` and `info_url_for`:
+
+```ruby
+Imgproxy.url_for(image, service: :pro)
+Imgproxy.info_url_for(image, service: :pro)
+```
 
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/imgproxy/imgproxy.rb.
 
-If you are having any problems with image processing of imgproxy itself, be sure to visit https://github.com/imgproxy/imgproxy first and check out the docs at https://github.com/imgproxy/imgproxy/blob/master/docs/.
+If you are having any problems with image processing of imgproxy itself, be sure to visit https://github.com/imgproxy/imgproxy first and check out the docs at https://docs.imgproxy.net/.
 
 ## License
 
@@ -393,4 +434,4 @@ The gem is available as open source under the terms of the [MIT License](http://
 
 ## Security Contact
 
-To report a security vulnerability, please use the [Tidelift security contact](https://tidelift.com/security). Tidelift will coordinate the fix and disclosure.
+To report a security vulnerability, please contact us at security@imgproxy.net. We will coordinate the fix and disclosure.