ImageMagick Engine - Linux Installation

Please note: this article is only applicable to on-premise installations. If you are a SaaS customer, ImageMagick is automatically installed and configured.

ImageMagick is a software suite to create, edit, and compose bitmap images. NetX uses ImageMagick to generate image proxies such as thumbnails, previews, and zoom views.

Installation

ImageMagick must be installed on the NetX application server.

Ubuntu and other Debian-based distributions

  1. Verifying that all software is up to date is highly recommended before beginning the installation process. To do so, run sudo apt-get update

    user@server:~$ sudo apt-get update
  2. Run apt-get install imagemagick. The server will then determine any relevant software that needs to be installed to use ImageMagick. 

    user@server:~$ sudo apt-get install imagemagick
  3. Test that ImageMagick has been installed correctly. ImageMagick is installed under the folder /usr/bin; running /usr/bin/convert -version from the sub directory convert will return information regarding your newly installed ImageMagick software. 

    user@server:~$ /usr/bin/convert -version
    Version: ImageMagick 6.5.7-8 2009-11-26 Q16 http://www.imagemagick.org
    Copyright: Copyright (C) 1999-2009 ImageMagick Studio LLC
    Features: OpenMP

Red Hat Enterprise Linux

  1. Verifying that all software is up to date is highly recommended before beginning the installation process. To do so, run sudo yum update

    [user@server ~]$ sudo yum update
  2. Run sudo yum install ImageMagick.x86_64. The server will then determine any relevant software that needs to be installed to use ImageMagick.  

    [user@server ~]$ sudo yum install ImageMagick.x86_64
  3. Test that ImageMagick has been installed correctly. ImageMagick is installed under the folder /usr/bin; running /usr/bin/convert -version from the sub directory convert will return information regarding your newly installed ImageMagick software. 

    user@server:~$ /usr/bin/convert -version
    Version: ImageMagick 6.5.7-8 2009-11-26 Q16 http://www.imagemagick.org
    Copyright: Copyright (C) 1999-2009 ImageMagick Studio LLC
    Features: OpenMP

Configuration properties

Once ImageMagick is installed on your server, you'll need to configure NetX to use it via the properties below. The first two properties are used to enable ImageMagick support in NetX, the rest are optional. The first two properties are used to enable ImageMagick support in NetX, the rest are optional.

For more information regarding ImageMagick command options, see the official ImageMagick documentation.

Property Description
imagemagick.limitMemory

This property limits the amount of memory allocated to ImageMagick while processing an image. This property's value should be a number, in megabytes. For more information regarding ImageMagick and memory limits, see their documentation.

Value options: Number, in MB

imagemagick.limitArea

This property limits the image area processed by ImageMagick. This property's value should be a number, in megabytesFor more information regarding ImageMagick and area limits, see their documentation.

Value options: Number, in MB

imagemagick.limitMap

This property limits the map processed by ImageMagick. This property's value should be a number, in megabytes. This property For more information regarding ImageMagick and area limits, see their documentation.

Value options: Number, in MB

imagemagick.limitThread

This property limits the number of threads processed by ImageMagick. This property's value should be a number, in megabytes. This property For more information regarding ImageMagick and area limits, see their documentation.

Value options: Number

imagemagick.scanAndRemoveBadXmp

This property allows you to specify an XMP field that will be ignored as the image is processed through ImageMagick. This is useful to cut down on resources and processing time if there is a large XMP field. This property's value should be formatted with the name of a file format (such as PSD), followed by the name of an XMP field, e.g. photoshop:DateCreated. These values should be delimited with a comma, as in this example: PSD,photoshop:DateCreated. Only one XMP field may be specified as a value for this property.

Value options: format, XMP tag name

imagemagick.jpgQuality

This property determines the quality of the output image. The value of this property should be a number between 1-100, representing a percentage of image quality. The default value is 70. 

Value options: 1-100

imagemagick.processTimeout

This property determines the length of time ImageMagick will spend before timing out. This value is in seconds. The default limit is 2700, or 45 minutes.

Value options: Number, in seconds

imagemagick.tifEndian

This property determines the byte order ImageMagick will use to process tiff images. The value options are msb (most significant bye) or lsb (least significant byte). The default value for this property is msb; if there is an issue processing an image using this setting, the system will fall back on lsb

Value options: msb or lsb

imagemagick.optimizedProxyGeneration

If the value of this property is true, proxy generation (previews, thumbnails, zoom views) will be performed using the ImageMagick engine. If the value of this property is false, this proxy generation will be disabled. The default value for this property is true.

Value options: true / false

imagemagick.optimizedProxyRetainColorProfiles

If the value of this property is true, some XMP data will be stripped from any generated proxies, but their color profile will be maintained. If the value of this property is falseall XMP data will be removed from any generated proxies, including color profiles. This property is false by default. 

Value options: true / false

imagemagick.postProcessing

If the value of this property is true, any embedded ICC color profiles will be stripped from the output file. If the value of this property is false, the embedded color profile will be maintained. This property is false by default. 

Value options: true / false

image.colorspaceIdentification

If the value of this property is true, ImageMagick will identify the color space of the input image and use the color space in the output file in NetX. If the value of this property is false, this check will not take place.

Value options: true / false

xmp.packetMaxThreshold

This property limits the size of the XMP packet associated with an asset. If the asset meets this threshold, the XMP is scanned for any large values; these larger values are then stripped from the temporary input file. Note that the original asset will be maintained. The value of this property should be a number, in megabytes. It is not set by default.

Value options: Number, in MB

engine.proxy.strictSRGB

When this property is true, asset previews and thumbnails will convert to sRGB colorspace. When this property is false, previews and thumbnails will not be converted.

Value options: true / false

engine.repurpose.strictSRGB

When this property is trueall repurposed assets will convert to sRGB colorspace unless otherwise specified during the repurpose process. When this property is false, repurposed assets will not automatically convert to sRGB colorspace. 

Value options: true / false

engine.zoom.strictSRGB

When this property is true, zoom tiles will be converted to sRGB colorspace when generated. When this property is false, zoom tiles will not be converted. 

Value options: true / false

imagemagick.enabled

When the value of this property is true, the ImageMagick engine is enabled. By default it will be enabled, if the ImageMagick init code finds the binary in the default location, else it is disabled. This property is required.

Value options: true / false

imagemagick.homeFolder
The value of this property must be an absolute path to the folder that contains your ImageMagick binaries. If this property's value is not set the system will first use /usr/local/bin by default; if no binaries are found, the system will then look in /usr/bin. If no binaries are found in either folder, ImageMagick will fail.
Value options: Absolute path
imagemagick.stripMetadata

If the value of this property is trueall metadata will be stripped from the output file including all XMP, EXIP, or color profile data. If the value of this property is false, the output file's metadata will be preserved.

Value options: true / false

 

 

Was this article helpful?
0 out of 0 found this helpful