Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
499 lines (442 sloc) 17.1 KB
title review labels toc notes confluence tree_item_index version_override history
Installation
comment date status
2017-12-14
ok
lts2016-ok
multiexcerpt
multiexcerpt-include
lts2017-ok
pabgrall
true
Documentation page used by the Marketing team. Check with Marketing before deleting or moving.
ajs-parent-page-id ajs-parent-page-title ajs-space-key ajs-space-name canonical canonical_source page_id shortlink shortlink_source source_link
31033314
Nuxeo Server
NXDOC
Nuxeo Platform Developer Documentation
Installation
3866685
PQA7
/display/NXDOC/Installation
100
LTS 2015 6.0 5.8
710/admindoc/installation
60/admindoc/installation
58/admindoc/installation
author date message version
Solen Guitter
2016-09-06 14:06
46
author date message version
Solen Guitter
2016-05-13 15:04
45
author date message version
Solen Guitter
2016-03-29 16:04
Fix URL
44
author date message version
Alain Escaffre
2016-03-23 16:02
43
author date message version
Alain Escaffre
2016-03-23 11:01
42
author date message version
Alain Escaffre
2016-03-23 10:58
41
author date message version
Alain Escaffre
2016-03-23 10:58
40
author date message version
Alain Escaffre
2016-03-23 10:53
39
author date message version
Alain Escaffre
2016-03-23 10:52
38
author date message version
Alain Escaffre
2016-03-23 10:41
37
author date message version
Manon Lumeau
2016-03-23 10:22
36
author date message version
Solen Guitter
2011-12-12 23:54
Migrated to Confluence 4.0
35
author date message version
Solen Guitter
2011-12-12 23:54
34
author date message version
Solen Guitter
2011-12-12 23:48
33
author date message version
Solen Guitter
2011-10-25 15:03
32
author date message version
Solen Guitter
2011-07-22 15:21
31
author date message version
Solen Guitter
2011-07-22 15:20
updated debian package instructions
30
author date message version
Julien Carsique
2011-07-07 18:53
29
author date message version
Julien Carsique
2011-06-21 16:00
28
author date message version
Solen Guitter
2011-06-09 10:36
added Windows 7 info
27
author date message version
Mathieu Guillaume
2011-06-03 12:37
26
author date message version
Mathieu Guillaume
2011-05-17 12:01
25
author date message version
Mathieu Guillaume
2011-05-17 11:55
24
author date message version
Mathieu Guillaume
2011-05-17 11:12
23
author date message version
Julien Carsique
2011-05-02 12:46
22
author date message version
Solen Guitter
2011-04-22 15:50
21
author date message version
Solen Guitter
2011-04-22 11:50
20
author date message version
Solen Guitter
2011-04-21 15:06
19
author date message version
Solen Guitter
2011-04-21 15:05
updated link to configuration page
18
author date message version
Solen Guitter
2011-04-21 11:06
17
author date message version
Solen Guitter
2011-04-18 15:27
16
author date message version
Solen Guitter
2011-04-12 10:18
15
author date message version
Solen Guitter
2011-04-12 09:37
14
author date message version
Solen Guitter
2011-04-12 09:33
13
author date message version
Julien Carsique
2011-04-06 17:09
12
author date message version
Julien Carsique
2011-04-06 17:00
11
author date message version
Julien Carsique
2011-04-06 16:55
Shell root access on VM
10
author date message version
Solen Guitter
2011-03-24 14:56
9
author date message version
Solen Guitter
2011-03-11 16:55
8
author date message version
Solen Guitter
2011-03-11 16:54
7
author date message version
Solen Guitter
2011-03-11 10:09
6
author date message version
Solen Guitter
2011-03-04 17:30
5
author date message version
Solen Guitter
2011-03-04 12:19
4
author date message version
Solen Guitter
2011-03-02 18:07
3
author date message version
Solen Guitter
2011-03-02 18:06
2
author date message version
Julien Carsique
2010-08-02 17:14
1

{{#> callout type='info' heading='Nuxeo University'}} Watch the related courses on Nuxeo University

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

  • a zip archive (works on any operating system that supports a Java Development Kit),
  • a Docker image,
  • a Windows installer (.exe),
  • a virtual machine image (works on any operating system that supports running VMware or VirtualBox),
  • a .deb package (works on Linux Debian and Ubuntu).
![]({{file page='userdoc/icons-index' name='download-document-web-ui.png'}})
[Linux]({{page version='' space='nxdoc' page='installing-the-nuxeo-platform-on-linux'}})

![]({{file page='userdoc/icons-index' name='download-document-web-ui.png'}})
[macOS]({{page version='' space='nxdoc' page='installing-the-nuxeo-platform-on-mac-os'}})

![]({{file page='userdoc/icons-index' name='download-document-web-ui.png'}})
[Windows]({{page version='' space='nxdoc' page='installing-the-nuxeo-platform-on-windows'}})

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]({{page page='compatibility-matrix'}}#databases) and [application servers]({{page page='compatibility-matrix'}}#application-servers). You may also want to read our page regarding [required storage space]({{page page='how-to-estimate-volume-usage'}}).
  2. [Install and Set up the related software]({{page page='installing-and-setting-up-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:
    • [Installing the Nuxeo Platform on Linux]({{page page='installing-the-nuxeo-platform-on-linux'}})
    • [Installing the Nuxeo Platform on Windows]({{page page='installing-the-nuxeo-platform-on-windows'}})
    • [Installing the Nuxeo Platform on macOS]({{page page='installing-the-nuxeo-platform-on-mac-os'}})
    • [Deploying Nuxeo on Amazon AWS]({{page page='deploying-nuxeo-on-amazon-aws'}})
    • [Deploying as a Standard Static WAR]({{page page='deploying-as-a-standard-static-war'}})
  4. Run the [Configuration Wizard]({{page page='configuration-wizard'}}) (not in the case of a standard static WAR).

Available Installers

By default, the Nuxeo distributions are packaged as ZIP files and are multi-OS compliant.

Some Nuxeo distributions are also packaged with automated installers, in order to ease installation and follow the targeted OS standards, by respecting the usual directory organization for instance, creating desktop shortcuts and menu items, tweaking environment properties, helping installing optional third-parties...

The available installers can be:

  • Multi-platform packages (ZIP, executable JAR, JNLP, ...),
  • Docker,
  • Windows installers (EXE, MSI),
  • Linux packages (DEB, RPM, ...),
  • macOS packages (DMP, APP, PKG),
  • VMWare images
  • VirtualBox images
  • Specific installers (Homebrew, ...).

Nuxeo currently maintains a Linux Debian and a Windows installer. They are available for download here.

Nuxeo aims at gathering and documenting all contributed installation solutions from the user community. Any help about OS-specific cases, recommendations, contributions or feedbacks is very welcome. To contribute, you can:

Hardware and Software Requirements

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

If you have requirements and/or constraints are not reflected below, 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
  • 1 GB 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 {{{multiexcerpt 'java_requirement' page='Compatibility Matrix'}}} See the following documentation:
  • [Checking your Java Version]({{page page='installation'}}#java-check)
  • [How to Install Java]({{page page='installation'}}#java-install)
Application Server {{{multiexcerpt 'supported-app-servers-versions' page='Compatibility Matrix'}}} {{{multiexcerpt 'supported-app-servers-static-war' page='Compatibility Matrix'}}}
Database {{{multiexcerpt 'all-supported-databases' page='Compatibility Matrix'}}} {{{multiexcerpt 'supported-databases-notes' page='Compatibility Matrix'}}}
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]({{page page='authentication-and-user-management'}}).
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]({{page page='installing-and-setting-up-related-software'}}).
Client-Side Requirements The Nuxeo Platform comes with several applications for business users, which have their own requirements:
  • [JSF UI]({{page page='nuxeo-jsf-ui'}})
  • [Web UI]({{page page='web-ui'}})
  • [Nuxeo Drive]({{page space='client-apps' page='nuxeo-drive'}})

Checking Your Java Version {{> anchor 'java-check'}}

{{! multiexcerpt name='check-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 in Windows 7 or entering Command Prompt in Cortana in Windows 10)
  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_202"
    Java(TM) SE Runtime Environment (build 1.8.0_202-b08)
    Java HotSpot(TM) 64-Bit Server VM (build 25.202-b08, mixed mode)
    
    

    Check in the output that the JDK version is 64 bits.

    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?).

    To ensure you installed a Java Development Kit environment, type javac -version and press Enter.

    If you installed a JDK, the javac version is displayed:

    javac 1.8.0_202
    

    If you installed a Java Runtime Environment instead of a Java Development Kit, it will fail to find javac and to display the javac version. In this case, install a Java Development Kit (see below).

{{! /multiexcerpt}}

Installing Java Development Kit {{> anchor 'java-install'}}

For Linux Users

{{! multiexcerpt name='java-install-linux'}}

sudo apt install openjdk-8-jdk

You can also download Java 8 from the Oracle website.

{{! /multiexcerpt}}

For macOS Users

{{! multiexcerpt name='java-install-macos'}}

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

{{! /multiexcerpt}}

For Windows Users

{{! multiexcerpt name='java-install-windows'}}

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.

{{! /multiexcerpt}}

You can’t perform that action at this time.