ImageMagick integration in Studio Server – Home

Info: Performing the steps described in this article requires direct server access. Depending upon how your system is hosted and the level of access you have to that system, coordination may be required with your Partner or WoodWing Support team. For a full overview of the steps that need to be done by WoodWing and how to request them, see WoodWing Cloud - Change management.

Integrating ImageMagick in Studio Server is a 4-step process:

Step 1. Checking the compatibility of ImageMagick with Studio Server

Step 2. Installing ImageMagick

Step 3. Configuring Studio Server

Step 4. Testing the integration

Step 5. (Optional) Integrating Ghostscript.

1. Checking compatibility

For details about which version of ImageMagick is compatible with which version of Studio Server, please check the Compatibility Matrix.

2. ImageMagick installation on Windows

Installation

Download and install ImageMagick for example from the following location:

https://www.imagemagick.org/script/download.php#windows

Setting environment variables

The installation process will update the PATH setting. Once the installation is completed, reboot the system to use the modified PATH setting.

On Linux

Use one of the following methods:

Download and install ImageMagick for example from the following location:

https://www.imagemagick.org/script/download.php#unix

Download the ImageMagick source file from the following location and then compile and install it yourself:

https://www.imagemagick.org/download/

3. Studio Server configuration

Step 1. Define the path where ImageMagick is installed:

File: configserver.php (recommended: config_overrule.php file)
Name of option: IMAGE_MAGICK_APP_PATH
Values: The full path to the folder of the ImageMagick application.

Note: Use forward slashes and do NOT end with a slash.

Example:
For Linux:

define( 'IMAGE_MAGICK_APP_PATH', '/usr/local/bin' );

For Windows:

define( 'IMAGE_MAGICK_APP_PATH', 'C:/Program Files/ImageMagick-6.6.3-Q16' );

Step 2. Configure the preview and thumbnail quality:

File: configserver.php file (recommended: config_overrule.php file)
Name of option: IMAGE_MAGICK_OPTIONS
Possible values: Any value mentioned on the ImageMagick Help page Command Line Options.

Note: The size (-size) is set by Studio Server and must not be set here.

Default values used:
-colorspace Sets the colorspace of the image. See ImageMagick Help.
-quality Sets the compression level for the images. See ImageMagick Help.
-sharpen Sharpens the image. See ImageMagick Help.
-layers Handles multiple image as a set of image layers or animation frames. See ImageMagick Help.
-depth Sets the number of bits in a color sample within a pixel. See ImageMagick Help.
-strip Strips the image of any profiles or comments. See ImageMagick Help.
-density Sets the horizontal and vertical resolution of an image for rendering to devices. See ImageMagick Help.
Default setting: -colorspace sRGB -quality 100 -sharpen 5 -layers merge -depth 8 -strip -density
Example:

define ('IMAGE_MAGICK_OPTIONS', '-colorspace sRGB -quality 92 -sharpen 5 -layers merge -depth 8 -strip -density 72x72');

Step 3. Configure for which file formats previews should be generated:

Info: This feature requires Studio Server 10.27.0 or higher.

File: configserver.php file (recommended: config_overrule.php file)
Name of option: IMAGEMAGICK_FORMATS
Possible values: Any mimetype => format combination.

Notes:

The mimetype that is referenced should also be listed in the EXTENSIONMAP option of the configserver.php file or config_overrule.php file.

The image format that is added to this option should be able to be handed by ImageMagick too

The Health Check test (see below) will check and raise an error if ImageMagick cannot handle any of the listed image format in this option.

Example:

if( !defined('IMAGEMAGICK_FORMATS') ) {
	define( 'IMAGEMAGICK_FORMATS', [
		// mimetype => format
		'image/jpeg' => 'JPEG',
		'image/png' => 'PNG',
		'image/gif' => 'GIF',
		'image/tiff' => 'TIFF',
		'image/x-photoshop' => 'PSD',
		'application/postscript' => 'EPS',
		'application/pdf' => 'PDF',
		'application/illustrator' => 'AI',
		'image/webp' => 'WEBP',
		//'image/heic' => 'HEIC',
		//'image/heif' => 'HEIF',
	] );
}

4. Testing the integration

To test ImageMagick from the command line:

Add /usr/local/bin to the PATH setting one of the following locations:
For the current user: ~/.profile
For all users: /etc/profile

Example:

export PATH=”$PATH:/usr/local/bin”

export MAGICK_HOME=”/usr/local”

export LD_LIBRARY_PATH=”/usr/local/lib”

Access the Health Check page in Studio Server and run the ImageMagick test. Resolve any issues that are reported.

5. (Optional) Integrating Ghostscript

When Postscript based file types such as PDF and EPS need to be rendered, Ghostscript also needs to be integrated.

For details, see Ghostscript integration in Studio Server.