Quick Start DAM

Nuxeo DAM Quickstart

Nuxeo DAM is a Digital Asset Management application based on Nuxeo EP. This guide covers installation options and procedures, initial use of the application, and supported file formats. Be sure to review the most recent version of this guide.

Table of Contents

System Requirements

Nuxeo DAM runs in a large variety of technical environments. The following list delineates the currently supported systems for the installation and operation of Nuxeo DAM.

Supported Operating Systems

• Debian GNU/Linux 5.0 Lenny
• Linux Ubuntu 32 and 64 bits, Edgy (6.10), Feisty (7.04), Hardy (8.04), Intrepid (8.10), Jaunty (9.04), and Karmic (9.10)
• Linux Mandriva 2008.1, 2009.1, 2010.1 and MES5
• Mac OS X 10.4, 10.5
• Windows 2003 Server 32 and 64 bits, Windows XP

Supported Databases

• PostgreSQL 8.3
• PostgreSQL 8.4
• MySQL
• Oracle 10
• MS SQL 2005

Supported Browsers

• IE 7 and greater
• Firefox 3.5 and greater
• Google Chrome 3 and greater
• Safari 4 and greater

Install Nuxeo DAM

The following sections detail the Nuxeo DAM installation procedure for Windows, Linux, and Mac OS X.

For Windows

Requirements

Mandatory components

Download and install the following:

• Nuxeo DAM from http://www.nuxeo.com/en/downloads/download-dam-form
• Sun Java Development Kit (other JVM are not supported). Two versions are supported: 1.5.X or 1.6.X Java Development Kit (JDK). They are available from http://java.sun.com/javase/downloads/widget/jdk6.jsp
• Image Magick from http://www.imagemagick.org/script/binary-releases.php#windows (download Win32 dynamic at 16 bits-per-pixel if you don't know which one to choose)
• ffmpeg from http://ffmpeg.arrozcru.org/autobuilds/ (this is required for the upcoming 1.1 release of Nuxeo DAM, no for the current 1.0 release). The archives provided by this website should be decompressed with: http://www.7-zip.org/. Extract the ffmpeg archive into a new folder named C:\ffmpeg for instance.

System Properties

Right click on the "My Computer" icon to edit the system properties. On the "Advanced" tab, add the environment variables:

• JAVA_HOME set to the path of the JDK
• JAVA_OPTS set to -Xms128m -Xmx512m
• Path add ;C:\ffmpeg\bin including the semicolon at the end of existing values

Office Files Preview (optional)

This is only required if you need to use previews of Office files with annotations. Download and install the following optional components:

• PDFtoHTML from http://sourceforge.net/projects/pdftohtml/files/ (necessary for office documents preview)
• OpenOffice.org 3.x or greater. Available from http://www.openoffice.org/ (necessary for office documents preview)

soffice.exe -headless
            -nofirststartwizard
	    -accept="socket,host=localhost,port=8100;urp;StarOffice.Service"

Restart the server after launching OpenOffice server.

RAW format (optional)

Download and install the following optional components:

• Gimp (needed for UFRaw) 2.6.7 or greater from http://gimp-win.sourceforge.net/stable.html (necessary dependancy for RAW format)
• UFRaw from http://sourceforge.net/project/platformdownload.php?group_id=127649&sel_platform=3514 (necessary dependancy for RAW format)

Start Nuxeo DAM

• Decompress nuxeo-dam-latest-stable-tomcat.zip in a directory (let's call it $NUXEO_HOME)
• Run

$NUXEO_HOME/bin/startup.bat

or go to directory $NUXEO_HOME, then to directory bin, and double click on startup.bat.

For Linux

Requirements

Mandatory Components

Download and install the following (use the package manager of your distribution to download and install):

• Nuxeo DAM from http://www.nuxeo.com/en/downloads/download-dam-form
• Sun Java Development Kit (other JVM are not supported). It is required to use either 1.5.X or 1.6.X. Java Development Kit (JDK).
• ImageMagick 6.3.7 or later
• ffmpeg (latest stable release of your distribution)

sudo apt-get install sun-java6-jdk imagemagick ufraw poppler-utils openoffice.org ffmpeg

(Note that the sun-java6-jdk package is for Debian in the non-free apt repository, and for Ubuntu in the multiverse apt repository).

Office Files Preview (optional)

This is only required if you need to use previews of Office files with annotations. Download and install the following optional components :

• poppler-utils package (this installs the PDFtoHTML command tool, necessary for office document preview)
• OpenOffice.org 3.x or greater (including the headless version). Available from http://www.openoffice.org/ (necessary for office document preview)

/path/to/openoffice/program/soffice.bin -headless
	    -nofirststartwizard
	    -accept="socket,host=localhost,port=8100;urp;StarOffice.Service"

Restart server after launching OpenOffice server.

RAW format (optional)

Download and install the following optional components:

• Nuxeo DAM from http://www.nuxeo.com/en/downloads/download-dam-form
• UFRaw needed to manage RAW images
• Gimp (needed for UFRaw) 2.6.7 or greater from http://gimp-win.sourceforge.net/stable.html (necessary dependancy for RAW format)
• UFRaw from http://sourceforge.net/project/platformdownload.php?group_id=127649&sel_platform=3514 (necessary dependancy for RAW format)
• ffmpeg (you can extract it from the binary release of http://www.ffmpegx.com/ or build it from the source available at http://ffmpeg.org )

Start Nuxeo DAM

• Decompress nuxeo-dam-latest-stable-tomcat.zip in a directory (let's call it $NUXEO_HOME)
• Run

$NUXEO_HOME/bin/startup.sh

For Mac OS X

Nuxeo DAM runs on Mac OS version is 10.5 or greater (Leopard or Snow Leopard). Previous versions are not supported. Ensure that the Java version is the default one (1.5.x or greater). MacPorts is an easy-to-use installer for Mac OS; you can download it from http://www.macports.org/ and install it. To run it, you will have to install the Xcode Tools, which are provided as an Optional Install on your Mac OS X main installation disc.

Requirements

Mandatory Components

Use MacPorts to install the following component:

• ImageMagick 6.3.7 or later

sudo port install ImageMagick pdftohtml

Office Files Preview (optional)

This is only required if you need to use previews of Office files with annotations. Download and install the following optional components:

• OpenOffice.org version 3.x or greater from http://www.openoffice.org/ and install it in the default location (optional, only necessary for Office documents preview)
• PDFtoHTML command-line tool (optional, only necessary for Office documents preview)

/path/to/openoffice.app/Contents/MacOS/soffice.bin
            -headless -nofirststartwizard
	    -accept="socket,host=localhost,port=8100;urp;StarOffice.Service"

Restart server after launching OpenOffice server.

RAW format (optional)

Nuxeo DAM requires the UFRaw component if you need to manage RAW files. The UFRaw port exists but doesn't work, so we recommend installing install from http://ufraw.sourceforge.net/ Download and install the following optional components:

• Gimp (needed for UFRaw) 2.6.7 or greater from http://gimp-win.sourceforge.net/stable.html (necessary dependancy for RAW format)
• UFRaw from http://sourceforge.net/project/platformdownload.php?group_id=127649&sel_platform=3514 (necessary dependancy for RAW format)

Start Nuxeo DAM

• Decompress nuxeo-dam-latest-stable-tomcat.zip in a directory (let's call it $NUXEO_HOME)
• Run

$NUXEO_HOME/bin/startup.sh

Start Using Nuxeo DAM

• Prepare a zip file containing the files that you want to import (jpeg, gif, raw, avi, mov, doc, xls,...). The zip file size must be under 100Mo.
• Connect to Nuxeo DAM from your server: http://localhost:8080/nuxeo
• Login as user "Administrator" with password "Administrator"
• In the menu banner, click on "Import"
• Select your zip file (for testing, you can use one of these zip files: free to use photos under by David Blaikie or the following archive of Wikipedia articles converted to PDF files).
• Enter a title for the import set
• Wait for the upload to complete and click on "Create"
• You know have a repository of digital assets for use with Nuxeo DAM. For more detailed instructions on how to use the application, see the Nuxeo DAM User Guide.

Currently Supported File Formats

Nuxeo DAM supports a large number of file formats. This list is continuously updated as support for new file formats is available.

*Client browser must have the associated plugin installed
** with streaming service enabled

Known issues

• Watermarking on tiff and gif files can result of an unreadable tiff file
• Watermarking on RAW files does not work
• Tiling on RAW files can be slow the first time
• You can ignore the "SEVERE: Exception starting filter WSSROOTFilter" message in logs/localhost.log
• On Windows, concurrency issues on H2 database with Lucene ("Lock obtain timed out"). We recommend configuring Nuxeo DAM to use PostgreSQL (Refer to Nuxeo Book Documentation)
• When you annotate, some errors in logs appear ("UserTransaction not found in JNDI"). This does not disrupt the functioning of Nuxeo DAM.

Development with Nuxeo DAM

Nuxeo EP and Nuxeo DAM source files can be retrieved for development using Mercurial.

Nuxeo core developers should review Nuxeo's Mercurial usage.

We highly recommend the section "Using the Mercurial Forest Extension," which considerably eases the use of Nuxeo source files.

Contributors to Nuxeo source files should also review documentation about working both on 5.1 and 5.2

See workaround for client issue if you try to clone the HTTPS URL through a Proxy.

Download Nuxeo DAM source files

Use the following:

hg clone -r 1.0 http://hg.nuxeo.org/nuxeo-dam

For updating your source files, simply call:

hg pull -u

Resources

• To help us prioritize new features, please see JIRA. You can vote on your favorite features.
• To ask questions and give feedback, please see the DAM Forum.
• For more detailed information, see the User Guide.

Photos David Blaikie