Nuxeo Server

Installation

Updated: September 22, 2017 Page Information Edit on GitHub

The Nuxeo Platform comes in different packages and can be installed on any operating system. You may have to install:

  • a zip archive (works on any operating system),
  • a Windows installer (.exe),
  • a virtual machine image (works on any operating system),
  • a .deb package (works on Linux Debian and Ubuntu).

General Installation Process

Installing the Nuxeo Platform requires a few steps:

  1. Have a look at our Hardware and Software Requirements in the section below, as well as our supported databases and application servers. You may also want to read our page regarding required storage space.
  2. Install and Set up the related software (unless you deploy on Amazon, the image already includes it).
  3. Install and start the Nuxeo Platform server. To understand how to start a Nuxeo Platform server on different environments, you can read and follow one of our recipes:
  4. Run the Configuration Wizard (not in the case of a standard static WAR).

Hardware and Software Requirements

The following table lists the current requirements for running the Nuxeo Platform.

If you have some constraints that do not fit this grid, do not hesitate to contact the Nuxeo team to evaluate the feasibility of running Nuxeo on any other environment, be it a different JVM, Database, Application server or OS.

Hardware Requirements Minimum requirement to start a Nuxeo server:
  • 2 CPU
  • 2 GB RAM
  • 300 MB of disk space
Note: a production-ready setup for the Nuxeo Platform may require several servers and different hardware sizing, depending on your SLA and planned usage. Contact Nuxeo for more information and for assistance with sizing your production architecture.
OS
  • Linux
  • macOS
  • Windows
Note: the only limitation on OS nature and version is the ability to install the correct version of the required JDK (see below). It means that while it is commonly reported to run on recent versions of Ubuntu, RHEL, Debian, CentOS, it can also run on any Linux distribution where it is possible to install the required JDK. You may have to adapt the provided startup shell scripts.
Java JDK 1.8.0_112 (Oracle's JDK or OpenJDK) and greater See the following documentation:
Application Server
  • Tomcat 7.0.69
Nuxeo is shipped with an embedded Tomcat server.
Database
  • MariaDB 10.1
  • MarkLogic 8.0
  • MongoDB 3.2
  • MySQL 5.7
  • Oracle 12c
  • PostgreSQL 9.6
  • SQL Server 2008
Nuxeo Platform will likely work with greater versions of the aforementioned databases. Do not hesitate to inform Nuxeo support of your attempts with different versions. More information can be found on the Database Configuration page.
Note that Nuxeo Server is shipped with an embedded H2 database, for quick evaluation purposes. One of the listed databases is required for a production set up or for a more thorough evaluation, like performance testing.
Authentication and User Management The Nuxeo Platform provides its own user and group directories and authentication solutions. It is also compatible with multiple cloud and enterprise solutions:
  • LDAP protocol (Open LDAP)
  • Active Directory
  • SAML Providers
  • OpenId
  • Kerberos
  • CAS
See Authentication and User Management section.
Optional Third-Party Software Some third party software may be required depending on the conversions capabilities you want to benefit from. The following list is not exhaustive:
  • LibreOffice
  • ImageMagick
  • FFmpeg
  • Docker
  • pdftohtml
  • Ghostscript
  • Exiftool
More information on installing third-party software.
Client-Side Requirements The Nuxeo Platform comes with several applications for business users, which have their own requirements:

Checking Your Java Version

To check that you have the right version of Java:

  1. Open a terminal:

    • On Linux or macOS: open a terminal.
    • On Windows: press the "Windows" key + r, type cmd (or command) in the Run window and press "OK" or open the Command Prompt from Start > Programs > Accessories.
  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 "1.8.0_66"
    Java(TM) SE Runtime Environment (build 1.8.0_66-b17)
    Java HotSpot(TM) 64-Bit Server VM (build 25.66-b17, mixed mode)
    

    If Java is not installed on you computer, it will fail to display the Java version. In this case, install Java (see below).

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

Installing Java

For Linux Users

sudo apt install openjdk-8-jdk

You can also download Java 8 from the Oracle website.

For macOS Users

Java packages and instructions for installation are available from the Oracle website:

For Windows Users

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

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

3 days ago manonlumeau NXDOC-1323: Update BDE doc
a year ago Solen Guitter 46
a year ago Solen Guitter 45
a year ago Solen Guitter 44 | Fix URL
2 years ago Alain Escaffre 43
2 years ago Alain Escaffre 42
2 years ago Alain Escaffre 40
2 years ago Alain Escaffre 41
2 years ago Alain Escaffre 39
2 years ago Alain Escaffre 38
2 years ago Alain Escaffre 37
2 years ago Manon Lumeau 36
6 years ago Solen Guitter 34
6 years ago Solen Guitter 35 | Migrated to Confluence 4.0
6 years ago Solen Guitter 33
6 years ago Solen Guitter 32
6 years ago Solen Guitter 31
6 years ago Solen Guitter 30 | updated debian package instructions
6 years ago Julien Carsique 29
6 years ago Julien Carsique 28
6 years ago Solen Guitter 27 | added Windows 7 info
6 years ago Mathieu Guillaume 26
6 years ago Mathieu Guillaume 25
6 years ago Mathieu Guillaume 24
6 years ago Mathieu Guillaume 23
6 years ago Julien Carsique 22
6 years ago Solen Guitter 21
6 years ago Solen Guitter 20
6 years ago Solen Guitter 19
6 years ago Solen Guitter 18 | updated link to configuration page
6 years ago Solen Guitter 17
6 years ago Solen Guitter 16
6 years ago Solen Guitter 15
6 years ago Solen Guitter 14
6 years ago Solen Guitter 13
6 years ago Julien Carsique 12
6 years ago Julien Carsique 11
6 years ago Julien Carsique 10 | Shell root access on VM
7 years ago Solen Guitter 9
7 years ago Solen Guitter 8
7 years ago Solen Guitter 7
7 years ago Solen Guitter 6
7 years ago Solen Guitter 5
7 years ago Solen Guitter 4
7 years ago Solen Guitter 3
7 years ago Solen Guitter 2
7 years ago Julien Carsique 1
History: Created by Julien Carsique