Enabling ImageMagick

Introduction

FileRun can make use of ImageMagick utility for generating image thumbnails and previews for PDF, PSD and other advanced file formats. ImageMagick also enables support for large (high-res) pictures in FileRun.

GraphicsMagick (http://www.graphicsmagick.org) can also be used, and in some cases it can be faster and more efficient than ImageMagick

Note: FileRun does not use ImageMagick and does not do any processing on small image files. Those are used for thumbnails in their original form.

Installing ImageMagick

Please see http://www.imagemagick.org

Hewlett-Packard Graphics Language (HPGL) plotter files (.plt) can also be previewed with FileRun and ImageMagick by installing “Hp2xx” (http://www.gnu.org/software/hp2xx/hp2xx.html). Windows version available here: http://gnuwin32.sourceforge.net/packages/hp2xx.htm

If you are running a Windows server, we recommend you to install ImageMagick to a path without space characters (like “Program Files”). You can install it for example to a path like “C:/ImageMagick”.

PDF Support

For ImageMagick to be able to generate thumbnails for PDF documents you might also need to install Ghostscript (http://www.ghostscript.com/download/gsdnld.html).

Make sure the Ghostscript app also has permissions to write to the server's temporary folder.

Setting up FileRun

To enable ImageMagick please follow these steps:

  1. Login as superuser (default username “admin”).
  2. Open “Control Panel”.
  3. Go to “System configuration” » “Files” » “Image preview”.
  4. Click the “Enable ImageMagick support” checkbox.
  5. Set the path to the ImageMagick binary (convert on older versions, magick on newer).

Example of valid paths:

Windows servers: C:/ImageMagick/magick.exe
Windows servers: C:/"Program Files"/ImageMagick/magick.exe
Linux servers: /usr/bin/convert

Troubleshooting

If you see broken icons instead of thumbnails:

  1. Make sure ImageMagick is working, running the following command: convert logo: image.jpg
  2. Make sure the path to ImageMagick is correctly configured in FileRun's control panel.
  3. Make sure the folder the image files are in, are writable by PHP. FileRun needs to cache the generated thumbnails in a hidden folder next to the files. If the folder should be read-only, then configure FileRun with an external location for the thumbnail cache (see $config['path']['thumbnail_cache'] on this page)
  4. For PDF files: make sure that Ghostscript is working. Try converting a PDF document using the command line: convert example.pdf example.png
  5. On Windows servers: make sure PHP can run external application. You need to give the Internet Guest User (IURSR or IUSR_<your-computer-name> on older servers) “read & execute” permission on the file that PHP is trying to run ImageMagick trough. That would be “cmd.exe” (located usually inside the folder “C:/Windows/System32”), the file used for running programs trough the command line.
  6. On Windows servers: you might also need to adjust the permissions of the system temporary folder, to allow ImageMagick, Ghostscript and most importantly IUSR to write temporary data in there. Without the permissions, generating thumbnails from the command line might work, but it won't work for FileRun.
  7. If still having troubles: enable the Admin: Thumbnail troubleshooter plugin from the control panel, clear your browser's cache and reload FileRun, then right-click a file that is missing a thumbnail and choose Open withAdmin: Thumbnail troubleshooter. You will get to see what happens behind the scene and where the problem might be.