This documentation refers to the unreleased development version of the Nuxeo Platform. For the current production version, refer to the 5.6 documentation.
Skip to end of metadata
Go to start of metadata

This section presents information about the running environment for a Nuxeo server. Listing all required software, giving a recommended configuration and listing some others, known as operational, this sections aims at helping you to validate or define your production environment. However the list is not exhaustive and needs to be completed with the users' experience.

Requirements

The Nuxeo Platform can run on Linux, Mac OS X and Windows operating systems.

 All you need for a quick start is a Java Development Kit (JDK)* (a JRE is not enough). Java 7 (also called Java 1.7) is required.

We currently support Oracle's JDK and OpenJDK. Don't hesitate to contact us if you need us to support a JDK from another vendor.

Checking your Java version

 To check that you have the right version of Java:

  1. Open a terminal:
    • on Linux or Mac OS X: open a terminal.
    • on Windows: press "windows" key + r, type cmd (or command) in the Run window and press "OK" or open the "Prompt command" from "Start > Programs > Accessories" menu.

  2. Type java -version and press Enter.
    If Java is correctly installed on your computer, the name and version of your Java virtual machine is displayed:

    java -version result on Mac OS
    java -version result on Ubuntu

    If Java is not installed on you computer, it fails to display the Java version. Then, you need to install Java (see below).

    If Java is installed but not included in the PATH, it fails to find the Java command. Then, you need to add $JAVA_HOME/bin/ in your PATH (see How do I set or change the PATH system variable?).

On this page

Installing Java

For Windows users

 If the required version of Java is not installed on your computer:

  1. Download it from the Oracle website and choose the appropriate platform for your hardware and Windows version.
  2. Run the downloaded .exe file and follow the instructions displayed.

For Linux users

For Ubuntu, the openjdk-7-jdk package is available from version 12.04 LTS on.

For Debian, it is not available in the current stable release (6.0.x aka "squeeze"), but it will be in the next one ("wheezy"). You can still download it from the Oracle website, but in that case you can not use the nuxeo .deb package (the zip distribution still works fine).

For Mac OS X users

Java 7 requires at least Lion (Mac OS 10.7.3). The Java 7 package for Mac OS is available on the Oracle website and instructions for installation on the Java website.

Recommendations

Hardware configuration

The Nuxeo Platform is designed to be scalable and can thus to be deployed on many servers. It can be installed on only one server for a start, and can also easily be installed on many servers. The constant is that there is the need to have one modern server with good performances. Then the other servers can be more lower-end.

The numbers below are given for the one needed high-end server.

  • RAM: 2 GB is the minimum requirement for using Nuxeo,
  • CPU: Intel Core 2 or equivalent and better.
    You might want to avoid machines from the Intel Pentium 4 Xeon series since some models have a too small amount of cache. This impairs performance greatly compared to other CPU architecture of the same generation. (Intel Pentium 4 servers are quite widespread because of an attractive price policy.)
  • Storage (disk) space: the minimum Nuxeo installation, along with the needed server and libs, takes something between 200 MB and 280 MB on a filesystem. Then, the final size will of course depend on the amount of data that will be stored in Nuxeo. A safe bet (until we provide better numbers) is to consider data space ratio of 1.5 to 2.

Default configuration

The default persistence configuration is lightweight and easy to use, but it is not made for performance.

The Nuxeo Platform uses:

  • H2 for SQL Data (directories, JBPM, Relations ...),
  • Filesystem persistence with VCS for the Document repository.

For optimal performances

  • Linux 64 bits,
  • PostgreSQL 8.4 or 9.0, Use PostgreSQL for document repository and all other services.
  • Have plenty of RAM (>= 4 GB).

Known working configurations

OS

  • Debian GNU/Linux 5.0 Lenny or more recent
  • Linux Ubuntu 32 and 64 bits: 10.10 or more recent
  • Linux Mandriva 2008.1
  • Red Hat Linux RHEL 5 and 6
  • CentOS 5
  • OpenSUSE
  • Mac OS X Lion (10.7), Mac OS X Mountain Lion (10.8)
  • Microsoft Windows 2000, Windows 2003 server 32 and 64 bits, Windows XP, Windows 7

Other Unix variants (such as Solaris) should work as long as there is an implementation of Java 7, but some adjustments may be needed to have :

  • process management running 100% ok (monitor, restart ...) 
  • all external converters available (OpenOffice/LibreOffice, pdf2html, ffmpeg ...)

 

JVM

Sun JDK 7, 64 bits recommended especially on Windows environment.

Storage backends

Different backends may be set as well for Nuxeo Core repository as for all other Nuxeo services that persist data. Please see the list of supported databases for each version of Nuxeo.

LDAP

  • OpenLDAP
  • OpenDS
  • Microsoft Active Directory

Browsers

Nuxeo applications can be used with the browsers below.

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

Browser extensions for Drag & Drop and Live Edit are available for Internet Explorer and Firefox only.

 

 

Labels