Photos.sh

Image effects for Drupal image styles, powered by the Photos.sh API. Each effect sends the image to the API and uses the answer as the derivative, so a style can remove a background, upscale a small photo or make a product photo fit a marketplace's rules.

Features

Thirteen effects, added to an image style like any other:

• Remove background: transparent or onto a colour, optionally cropped to the subject.
• Upscale: 2x, 3x or 4x.
• Remove text: watermarks, captions and prices. Text printed on the product can stay.
• Fix for a marketplace: the size and background that Amazon, eBay, Etsy, Shopify, Google, Allegro or Zalando ask for.
• Run a preset: marketplace, studio, social, cutout or web.
• Fix light and colour, Remove noise and Colourise.
• Restore faces and Hide faces (blur, pixelate or cover).
• Crop to a shape around the subject or the faces, and Expand to a shape.
• Watermark with text.

How it behaves:

• Originals are never changed. Only derivatives are written.
• Each effect declares the file extension and, where it can, the size it will produce, so image style URLs and width and height attributes are right before anything is processed.
• A derivative is made when it is first requested, and that request waits for the API. Every derivative made uses credits from your Photos.sh account, also after a style is flushed.
• If the API fails or is busy, no derivative is written, the reason is logged (never the key), and the next request tries again.
• Works with the GD toolkit and with the ImageMagick module's toolkit.
• Other modules can use the API client as a service, photos_sh.client.

Post-Installation

1. Go to Configuration > Media > Photos.sh (/admin/config/media/photos-sh) and give the API key. The page shows the account and the credits left once the key works.
2. Go to Configuration > Media > Image styles and add the effects you want to a style.

The key can come from the PHOTOS_API_KEY environment variable, from a key of the Key module, or from configuration. Prefer the first two: configuration is exported with the rest of the site's config.

Additional Requirements

• A Photos.sh account and an API key, created on your organisation's API keys page in the Photos.sh console.
• The PHP library photos-sh/photos, which Composer installs with the module.
• Drupal 10.3 or 11, and PHP 8.3 or later.

Recommended modules/libraries

• Key: keeps the API key out of configuration.
• ImageMagick: runs the effects with the ImageMagick toolkit instead of GD.