Install and configure ImageMagick to work with AEM Assets

Search
Experience Manager 6.3 Assets User Guide

On this page

Applies to: Experience Manager 6.3 Assets

某些 Creative Cloud 应用程序、服务和功能在中国不可用。

You're viewing help content for version:

ImageMagick is a software to create, edit, compose, or convert bitmap images. It can read and write images in a variety of formats (over 200) including PNG, JPEG, JPEG-2000, GIF, TIFF, DPX, EXR, WebP, Postscript, PDF, and SVG. Use ImageMagick to resize, flip, mirror, rotate, distort, shear, and transform images. You can also adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses, and curves using ImageMagick.

Use the Adobe Experience Manager (AEM) media handler from the command line to process images using ImageMagick. To work with various file formats using ImageMagick, see Assets file formats best practices. For a list of all the file formats that are supported by AEM Assets, see Assets supported formats.

To process large files using ImageMagick, consider higher than usual memory requirements, potential changes required to IM policies, and the overall impact on the performance. The memory requirements are dependent on various factors like resolution, bit depth, color profile, and file format. If you intend to process very large files using ImageMagick, properly benchmark the AEM server. Some helpful resources are provided at the end.

Note:

If you are using AEM on Adobe Managed Services (AMS), reach out to Adobe Support if you plan to process lots of large PSD or PSB files.

Install ImageMagick

Multiple versions of ImageMagic installation files are available for various operating systems. Use the appropriate version for your operating system.

  1. Download the appropriate ImageMagick installation files for your operating system.

  2. Run the installation file to install ImageMagick on the disk hosting the AEM server.

  3. Set the path Environment variable to the ImageMagic installation directory.  

  4. To check whether the installation was successful, run the identify -version command.

Set up the command line process step

You can set up the command line process steps for your particular use cases. Perform these steps to generate a flipped image and thumbnails (140x100, 48x48, 319x319, and 1280x1280) each time you add a JPEG image file to /content/dam on the AEM server:

  1. On the AEM server, go to the Workflow console (http://<AEM server>:<Port>/workflow) and open the DAM Update Asset workflow model.

  2. From the DAM Update Asset workflow model, open the EPS thumbnails (powered by ImageMagick) step.

  3. In the Arguments tab, add image/jpeg to the Mime Types list.

    mime_types_jpeg

  4. In the Commands box, enter the following command:

    convert ./${filename} -flip ./${basename}.flipped.jpg

  5. Select the Delete Generated Rendition and Generate Web Rendition flags.

    select_flags

  6. In the Web Enabled Image tab, specify the details for the rendition with dimentions 1280x1280 pixels. In addition, specify image/jpeg in the Mimetype box.

    web_enabled_image

  7. Tap/click OK to save the changes.

    Note:

    The convert command may not execute with certain Windows versions (for example Windows SE), because it conflicts with the native convert utility that is part of Windows installation. In this case, mention the complete path for the ImageMagick utility. For example, specify,

    "C:\Program Files\ImageMagick-6.8.9-Q16\convert.exe" -define jpeg:size=319x319 ./${filename} -thumbnail 319x319 cq5dam.thumbnail.319.319.png

  8. Open the Process Thumbnails step, and add the MIME type image/jpeg under Skip Mime Types.

    skip_mime_types

  9. In the Web Enabled Image tab, add the MIME type image/jpeg under the Skip List. Tap/click OK to save the changes.

    web_enabled

  10. Save the workflow.

  11. To check whether ImageMagic is able to process images properly, upload a .jpg image to AEM Assets. Verify whether a flipped image and the renditions are generated for it.

Mitigate security vulnerabilities

There are multiple security vulnerabilities associated with using ImageMagick to process images. For example, processing user-submitted images involves the risk of remote code execution (RCE).

In addition, a number of image processing plugins depend on the ImageMagick library, including but not limited to PHP’s imagick, Ruby’s rmagick and paperclip, and nodejs’s imagemagick. If you use ImageMagick or an affected library, Adobe recommends that you mitigate the known vulnerabilities by performing at least one of the following tasks (but preferably both):

  1. Verify that all image files begin with the expected "magic bytes" corresponding to the image file types you support before sending them to ImageMagick for processing.

  2. Use a policy file to disable the vulnerable ImageMagick coders. The global policy for ImageMagick is usually found in “/etc/ImageMagick”. 

More like this