XperienceCommunity.ImageProcessing 2.0.1

Xperience Community: Image Processing

Description

This package provides a way to resize images and convert them to webp, jpg, and png formats. It supports images from Media libraries and Content hub items stored as Content item assets.

⚠️ Consider Kentico's Native Image Variants

Before using this package, consider Kentico's native Image Variants feature introduced in recent versions. The native solution:

• ✅ Officially supported by Kentico
• ✅ Integrated into the Content Hub UI
• ✅ Pre-generated variants for better performance
• ✅ No additional dependencies

This package is still useful if you need:

• On-the-fly image processing without pre-generation
• Media library image support (native variants are Content Hub only)
• Dynamic query parameter-based transformations
• Fit modes (cover, contain, fill) and crop positioning
• Legacy project compatibility

Future deprecation: As Kentico's native solution matures and adds more features, this package may be deprecated. For new projects, we recommend starting with the native Image Variants feature.

Library Version Matrix

Dependencies

• ASP.NET Core 8.0
• Xperience by Kentico

Package Installation

Add the package to your application using the .NET CLI

dotnet add package XperienceCommunity.ImageProcessing

Quick Start

1. Install NuGet package above.

2. Add the following configuration to your appsettings.json:

    {
      "ImageProcessing": {
        "ProcessMediaLibrary": true,
        "ProcessContentItemAssets": true,
        "MaxWidth": 5000,
        "MaxHeight": 5000,
        "MaxSideSize": 5000,
        "Quality": 80
      }
    }
   

   • ProcessMediaLibrary: Set to true to enable image processing for Media library images. Defaults to true.
   • ProcessContentItemAssets: Set to true to enable image processing for Content Hub assets. Defaults to true.
   • MaxWidth: Maximum allowed width in pixels. Requests exceeding this will be capped. Defaults to 5000.
   • MaxHeight: Maximum allowed height in pixels. Requests exceeding this will be capped. Defaults to 5000.
   • MaxSideSize: Maximum allowed value for the maxSideSize parameter. Requests exceeding this will be capped. Defaults to 5000.
   • Quality: JPEG/WebP encoding quality (1-100). Higher values produce better quality but larger file sizes. Defaults to 80.

3. Register the Image Processing middleware using app.UseXperienceCommunityImageProcessing():

    var builder = WebApplication.CreateBuilder(args);
   
    // ...
   
    builder.Services.Configure<ImageProcessingOptions>(builder.Configuration.GetSection("ImageProcessing"));
   
    var app = builder.Build();
   
    app.UseKentico();
   
    // ...
   
    app.UseXperienceCommunityImageProcessing();
   

4. You should be able to use the width, height, and maxSideSize query parameters on your image URLs to resize the image. Examples:

   1. Resize the Media library image to a width of 100px:

      https://yourdomain.com/getmedia/rest-of-your-asset-url?width=100
      

   2. Resize the Content item asset image to a height of 100px:

      https://yourdomain.com/getContentAsset/rest-of-your-asset-url?height=100
      

5. You can also use the format query parameter to convert the image to a different format. Allowed values are: webp, jpg and png. Example:

   1. Convert the Media library image to webp:

      https://yourdomain.com/getmedia/rest-of-your-asset-url?format=webp
      

   2. Convert the Content item asset image to png:

      https://yourdomain.com/getContentAsset/rest-of-your-asset-url?format=png
      

6. Use the fit parameter to control how images are resized. Available modes:

   • contain (default): Fit image inside dimensions, maintaining aspect ratio

     https://yourdomain.com/getmedia/rest-of-your-asset-url?width=500&height=500&fit=contain
     

   • cover: Fill dimensions exactly, cropping excess while maintaining aspect ratio

     https://yourdomain.com/getmedia/rest-of-your-asset-url?width=500&height=500&fit=cover
     

   • fill: Stretch image to exact dimensions, ignoring aspect ratio

     https://yourdomain.com/getmedia/rest-of-your-asset-url?width=500&height=500&fit=fill
     

7. Use the crop parameter with fit=cover to control crop positioning:

   • center (default): Crop from center

     https://yourdomain.com/getmedia/rest-of-your-asset-url?width=500&height=500&fit=cover&crop=center
     

   • north, south, east, west: Crop from edges

     https://yourdomain.com/getmedia/rest-of-your-asset-url?width=500&height=500&fit=cover&crop=north
     

   • northeast, northwest, southeast, southwest: Crop from corners

     https://yourdomain.com/getmedia/rest-of-your-asset-url?width=500&height=500&fit=cover&crop=southeast
     

Production Recommendations

Use a CDN

Strongly recommended: Place a CDN (like Cloudflare, Azure CDN, or CloudFront) in front of your website for production deployments.

• The middleware generates ETags for efficient browser/CDN caching
• First request processes the image, subsequent requests are served from CDN cache
• Dramatically reduces server load and improves performance
• Sets Cache-Control: public, max-age=31536000 (1 year) for optimal caching

Without a CDN, every unique image variant will be processed on your server, which can be memory and CPU intensive.

Parameter Validation

The middleware automatically validates and clamps dimension parameters:

• width, height, and maxSideSize values exceeding the configured maximums are automatically capped
• Default maximum values are 5000 pixels for all dimensions
• Adjust MaxWidth, MaxHeight, and MaxSideSize in configuration based on your needs
• Quality values outside the 1-100 range are automatically clamped

This prevents abuse while ensuring requests always succeed with reasonable values.

Contributing

Feel free to submit issues or pull requests to the repository, this is a community package and everyone is welcome to support.

License

Distributed under the MIT License. See LICENSE.md for more information.