Installation and Administration

Installing and Setting Up Related Software

The Nuxeo Platform modules use external software for some features. They need to be installed on the server in addition to Nuxeo application.

On a naked default Nuxeo Platform, you need the following software:

  • For web preview of office documents: LibreOffice and pdftohtml
    • LibreOffice: converts office file into PDF
    • pdftohtml: converts converted PDF into HTML preview
  • For thumbnail generation: ImageMagick and Ghostscript for most file formats. UFRaw for RAW files.
  • For metadata extraction: Exiftool
  • For picture preview and tilling: ImageMagick (already required for thumbnails)
  • For video conversion and storyboarding: FFmpeg (Nuxeo DAM add-on)
  • For processing WordPerfect documents: libwpd

Thumbnails and previews are created when documents are imported into Nuxeo, not on the fly when browsing documents. So in order to check if the third party software work properly on your Nuxeo instance, you must import new documents.

Linux

Under Debian or Ubuntu, all of this can be installed by the following command:

sudo apt-get install openjdk-8-jdk imagemagick ufraw poppler-utils libreoffice ffmpeg libwpd-tools ghostscript exiftool

OpenOffice / LibreOffice Configuration

If you'll be working with non-latin languages:

  1. Start OpenOffice/LibreOffice manually.
  2. Install  the additional fonts you may need for non-default languages.

For preview to work, the Nuxeo Platform should start OpenOffice / LibreOffice. You can see the places the Nuxeo Platform looks for OpenOffice / LibreOffice in the PlatformUtils.java definition.

If you haven't installed them at a traditional location, you may need to add the soffice program to your path: Edit the Path system variable and add ;OFFICE_INSTALL_DIRECTORY\program.

If not using default install path, you may have to add the path to the executable in your nuxeo.conf: jod.office.home=/path/to/libreoffice.

Controlling Threads Used by ImageMagick

By default ImageMagick is multi threaded and will use all the available CPUs. This creates burst of CPU usage, especially when thumbnail is generated concurrently.

Hopefully you can control the number of threads used by ImageMagick either by:

  • Editing /etc/ImageMagick/policy.xml and setting <policy domain="resource" name="thread" value="1"/>.

  • adding an environment variable export MAGICK_THREAD_LIMIT=1 in the nuxeo user .bash_profile.

libfaac Support

Common issue with libfaac encoder

Unknown encoder 'libfaac'

Ubuntu does not supply FFmpeg with libfaac support. So you must compile FFmpeg from sources with --enable-libfaac option.

Either follow the instructions from the FFmpeg Compilation Guide for Ubuntu adding the --enable-libfaac and --enable-nonfree compile options.

Or run the Nuxeo script for compiling FFmpeg. You should build the FFmpeg executable on a separate machine than your Nuxeo Platform server machine, and then install the result on the machine where you set up Nuxeo Platform. 

Running the FFmpeg build script on the same machine than where you installed Nuxeo Platform would result in uninstalling existing Nuxeo already installed with the Debian package along with its data.

You can do it manually as follow, but the recommended way is to use our "in-docker-build": https://github.com/nuxeo/nuxeo-tools-docker/tree/release-7.10/ffmpeg.

For a  manual build:

  1. Install the multiverse package repositories (required for the script to work).
  2. Issue the following commands:

    cd /tmp
    git clone https://github.com/nuxeo/ffmpeg-nuxeo
    cd ffmpeg-nuxeo
    sudo ./build-all.sh true
    

OS X

The OS X installation instructions provided use Homebrew.

OpenOffice/LibreOffice and pdftohtml for Office and PDF Preview

Installing OpenOffice / LibreOffice and pdftohtml on the server is only required if you need to use preview on PDF and office documents. pdftohtml is used for previewing PDF files. It is included in poppler.

pdftohtml

To install pdfttohtml using Homebrew:

brew install poppler

OpenOffice / LibreOffice

OpenOffice / LibreOffice are used for preview on office documents in association to pdftohtml.

Download and install them from:

If you'll be working with non-latin languages:

  1. Start OpenOffice/LibreOffice manually.
  2. Install  the additional fonts you may need for non-default languages.

For preview to work, the Nuxeo Platform should start OpenOffice / LibreOffice. You can see the places the Nuxeo Platform looks for OpenOffice / LibreOffice in the PlatformUtils.java definition.

If you haven't installed them at a traditional location, you may need to add the soffice program to your path: Edit the Path system variable and add ;OFFICE_INSTALL_DIRECTORY\program.

If not using default install path, you may have to add the path to the executable in your nuxeo.conf: jod.office.home=/path/to/libreoffice.

Ghostscript

Ghostscript is used in association with ImageMagick to generate the thumbnails of documents.

  • Using Homebrew: 

    brew install ghostscript
    

ImageMagick

ImageMagick is used in association with Ghostscript to generate the document thumbnails. It is also used by the Nuxeo DAM add-on for the preview and tiling of pictures.

  • Using Homebrew:

    brew install imagemagick
    

By default ImageMagick is multi threaded and will use all the available CPUs. This creates burst of CPU usage, especially when thumbnail is generated concurrently.

Hopefully you can control the number of threads used by ImageMagick either by:

  • Editing /etc/ImageMagick/policy.xml and setting <policy domain="resource" name="thread" value="1"/.

  • Adding an environment variable: add export MAGICK_THREAD_LIMIT=1 in the nuxeo user .bash_profile.

FFmpeg

FFmpeg is required by the Nuxeo DAM add-on. It is used to create the storyboard of videos and convert them to additional formats.

  • Using Homebrew: 

    brew install ffmpeg --with-fdk-aac --with-ffplay --with-freetype \
    --with-frei0r --with-libass --with-libbluray --with-libcaca \
    --with-libquvi --with-libvidstab --with-libvo-aacenc --with-libvorbis \
    --with-libvpx --with-opencore-amr --with-openjpeg --with-openssl \
    --with-opus --with-rtmpdump --with-schroedinger --with-speex \
    --with-theora --with-tools --with-x265 --with-faac
    

    This install most libraries. You can of course remove the libraries that are needed for the video files you will be managing. Use brew info ffmpeg for details about each library available.

UFRaw

UFRaw is used in association with ImageMagick and Ghostscript to generate RAW document thumbnails.

  • Using Homebrew:

    brew install ufraw  
    

libwpd

libwpd used to process WordPerfect documents.

 

Using Homebrew:

brew install libwpd

 

ExifTool

ExifTool is required by the Nuxeo Binary Metadata add-on. It is used to extract and override binaries metadata.

  • Using Homebrew: 

    brew install exiftool
    

Windows

The following software are already included when using the .exe installer:

  • FFmpeg
  • ImageMagick
  • pdftohtml
  • ghostscript
  • Exiftool (since 7.2).

The installer does not install them globally in Windows: they are available from the 3rdparty folder of the server tree and added to the PATH by the nuxeoctl.bat script.

If not already present on the system, you will have the option to automatically install LibreOffice and PostgreSQL.

Warning about ImageMagick: Some versions of Windows come with a System utility command named convert whose name conflicts with the ImageMagick's command of the same name. After installing Nuxeo, you can check if there will be a conflict:

  1. Open a terminal and use the where convert command. The output will tell you which command is in the PATH.
  2. If you don't see ImageMagick in the result (it must be the first ot the list, or the only one), then you must add the path to ImageMagick to the PATH System variable.

OpenOffice / LibreOffice and pdftohtml

Installing OpenOffice / LibreOffice and pdftohtml on the server is only required if you need to use preview on PDF and office documents. pdftohtml is used for previewing PDF files. It is included in poppler.

pdftohtml

  1. Install the poppler binary (available from this blogpost).
  2. Add a system variable POPPLER_INSTALL_DIRECTORY that points to the folder where you extracted poppler files (C:\Program Files (x86)\Poppler for example).
  3. Edit the Path system variable and add ;POPPLER_INSTALL_DIRECTORY\bin.

    Old pdftohtml binaries are available from http://sourceforge.net/projects/pdftohtml/files/, but they are obsolete. It is recommended to use poppler.

OpenOffice / LibreOffice

OpenOffice / LibreOffice are used for preview on office documents in association to pdftohtml.

Download and install them from:

If you'll be working with non-latin languages:

  1. Start OpenOffice/LibreOffice manually.
  2. Install  the additional fonts you may need for non-default languages.

For preview to work, the Nuxeo Platform should start OpenOffice / LibreOffice. You can see the places the Nuxeo Platform looks for OpenOffice / LibreOffice in the PlatformUtils.java definition.

If you haven't installed them at a traditional location, you may need to add the soffice program to your path: Edit the Path system variable and add ;OFFICE_INSTALL_DIRECTORY\program.

If not using default install path, you may have to add the path to the executable in your nuxeo.conf: jod.office.home=/path/to/libreoffice.

Ghostscript

Ghostscript is used in association with ImageMagick to generate the thumbnails of documents.

  1. Use the installer available from the Ghostscript download page.
  2. Edit the PATH system variable and add ;GHOSTSCRIPT_INSTALL_DIRECTORY\bin (C:\Program Files\gs\gs9.10\bin for example).

ImageMagick

ImageMagick is used in association with Ghostscript to generate the document thumbnails. It is also used by the Nuxeo DAM add-on for the preview and tiling of pictures.

  1. Download the ImageMagick installer from  http://www.imagemagick.org/
  2. Run the installer and make sure you check the option to add ImageMagick to the PATH.

     

    By default ImageMagick is multi threaded and will use all the available CPUs. This creates burst of CPU usage, especially when thumbnail is generated concurrently.

    Hopefully you can control the number of threads used by ImageMagick either by:

    • editing IMAGEMAGIK_DIRECTORY/policy.xml on Windows, and setting <policy domain="resource" name="thread" value="1"/>.
    • adding an environment variable MAGICK_THREAD_LIMIT  with value set to 1.

FFmpeg

FFmpeg is required by the Nuxeo DAM add-on. It is used to create the storyboard of videos and convert them to additional formats.

  1. Download FFmpeg from http://ffmpeg.zeranoe.com/builds/.
  2. Extract the FFmpeg archive into a new folder named C:\ffmpeg for instance.

    The archives provided by this website should be decompressed with: 7-Zip

  3. Add the FFmpeg environment variable:

    1. Right click on the "My Computer" icon and click on Properties.

    2. On the Advanced tab, edit the PATH system variable and add ;C:\ffmpeg\bin .

      Don't forget the semicolon at the end of existing values.

UFRaw

UFRaw is used in association with ImageMagick and Ghostscript to generate RAW document thumbnails.

  1. Download UFRaw from http://ufraw.sourceforge.net/Install.html#MS.
  2. Edit the PATH system variable and add ;UFRAW_INSTALL_DIRECTORY\bin (C:\Program Files (x86)\UFRaw\bin for example).

Exiftool

Here are some quick installation steps to install Exiftool. Full installation steps are available at http://www.sno.phy.queensu.ca/~phil/exiftool/install.html.

To install Exiftool:

  1. Download the standalone distribution.
  2. Unzip the distribution.
  3. Rename the .exe into exiftool.exe and move it to the C:\WINDOWS directory (or any other directory in your PATH).

 

4 months ago manonlumeau Relocated assets to fit new URL structure for 710 - fix
3 years ago Solen Guitter 101 | elated software installation by .exe detail
3 years ago Solen Guitter 100
3 years ago Solen Guitter 99
4 years ago Manon Lumeau 98 | Fix Homebrew
4 years ago Solen Guitter 97
4 years ago Solen Guitter 96 | Update Linux command with Java 8
4 years ago Solen Guitter 95
4 years ago Thierry Martins 94
4 years ago Solen Guitter 93 | Add --with-faac to FFmpeg install using Homebrew
4 years ago Thomas Roger 92
4 years ago Julien Carsique 91
4 years ago Alain Escaffre 90
4 years ago Guillaume Renard 89
4 years ago Manon Lumeau 88
4 years ago Solen Guitter 87
5 years ago Solen Guitter 86 | Add Exiftool installation on Linux and Windows.
5 years ago Solen Guitter 85 | Update ImageMagick installation steps
5 years ago Vladimir Pasquier 84 | add exiftool
5 years ago Florent Guillaume 83
5 years ago Solen Guitter 82
5 years ago Solen Guitter 81 | Add link
5 years ago Frédéric Vadon 80
5 years ago Solen Guitter 79
5 years ago Solen Guitter 78
5 years ago Solen Guitter 77 | Reorganize steps by OS
5 years ago Thomas Roger 76
5 years ago Thibaud Arguillere 75
5 years ago Julien Carsique 74 | NXBT-807
5 years ago Thibaud Arguillere 73 | Check yams before compiling ffmpeg
5 years ago Manon Lumeau 72
5 years ago Manon Lumeau 71
5 years ago Julien Carsique 70
5 years ago Thibaud Arguillere 69
5 years ago Solen Guitter 68
5 years ago Manon Lumeau 67
5 years ago Solen Guitter 66
5 years ago Julien Carsique 65
5 years ago Julien Carsique 64
6 years ago Solen Guitter 63 | Formatting
6 years ago Solen Guitter 61
6 years ago Solen Guitter 62 | Migration of unmigrated content due to installation of a new plugin
6 years ago Solen Guitter 60
6 years ago Michaël Vachette 59
6 years ago Michaël Vachette 58
6 years ago Solen Guitter 57 | Added Mac OS libwpd Homebrew installation commands
6 years ago Solen Guitter 56 | Added Windows installation and configuration information for ImageMagick and UFRaw
6 years ago Solen Guitter 55
6 years ago Solen Guitter 54
6 years ago Solen Guitter 53 | Added ghostscript to the requirements
6 years ago Solen Guitter 52
6 years ago Harlan Brown 51
6 years ago Solen Guitter 49 | Added link to the Windows poppler binary
6 years ago Solen Guitter 50 | Migration of unmigrated content due to installation of a new plugin
6 years ago Solen Guitter 48
6 years ago Solen Guitter 47
6 years ago Solen Guitter 46 | Removed duplicated content
6 years ago Benoit Delbosc 45
6 years ago Benoit Delbosc 44
6 years ago Solen Guitter 43 | Install poppler instead of pdftohtml
6 years ago Julien Carsique 42
6 years ago Julien Carsique 41
6 years ago Thibaud Arguillere 40
6 years ago Julien Carsique 39
6 years ago Solen Guitter 38 | Added title to non-latin fonts tip
6 years ago Florent Guillaume 37
7 years ago Laurent Doguin 35 | change ffmpeg build site adress
7 years ago Laurent Doguin 36 | Migration of unmigrated content due to installation of a new plugin
7 years ago Julien Carsique 34 | fix APT links
7 years ago Solen Guitter 33
7 years ago Antoine Taillefer 32
7 years ago Antoine Taillefer 31
7 years ago Solen Guitter 30
7 years ago Florent Guillaume 27
7 years ago Florent Guillaume 28 | Migrated to Confluence 4.0
7 years ago Florent Guillaume 29 | Migration of unmigrated content due to installation of a new plugin
7 years ago Solen Guitter 26
8 years ago Julien Carsique 25
8 years ago Mathieu Guillaume 24
8 years ago Solen Guitter 23 | Added tip about .exe installer
8 years ago Olivier Grisel 22 | apt link for ufraw
8 years ago Julien Carsique 20
8 years ago Julien Carsique 21
8 years ago Julien Carsique 19
8 years ago Julien Carsique 18
8 years ago Julien Carsique 17
8 years ago Julien Carsique 16
8 years ago Julien Carsique 15 | add brew install ffmpeg
8 years ago Solen Guitter 14
8 years ago Solen Guitter 13
8 years ago Florent Guillaume 12
8 years ago Wojciech Sulejman 11 | Update from the OOoDaemonService to OOoManagerService config starting with 5.4.0
8 years ago Julien Carsique 10 | info about libwpd thirdparty
8 years ago Julien Carsique 9
8 years ago Julien Carsique 8 | Add information about LibreOffice
8 years ago Julien Carsique 7
8 years ago Solen Guitter 6
8 years ago Solen Guitter 5
8 years ago Solen Guitter 4
8 years ago Solen Guitter 3
8 years ago Solen Guitter 2
8 years ago Solen Guitter 1
History: Created by Solen Guitter

We'd love to hear your thoughts!

All fields required