Server

Installation

Updated: April 12, 2021

Nuxeo Docker Image

The Nuxeo Platform can be installed on many operating systems by running the Nuxeo Docker image.

Using a Docker image has several advantages:

  • It is OS-independent, can be run in any container runtime.
  • It provides an abstraction layer that eases installation and administration. For instance, the Docker image embeds most of the external software needed by the Nuxeo Platform.
  • It's what we're using internally at Nuxeo, especially in Nuxeo Cloud.
  • Docker and the container ecosystem are widely maintained by the open source community.

Before installing the nuxeo Platform, make sure you have a look at the Hardware and Software Requirements in the section below. You may also want to read our page regarding required storage space.

Tomcat server ZIP
Though it is not the recommended way, you can also install the Nuxeo Platform with the Tomcat server ZIP archive, which works on any operating system that supports a Java Development Kit.

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.

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.
Database
  • Recommended, validated by continuous integration:
    • MongoDB 4.4
    • PostgreSQL 13
  • Supported, not validated by continuous integration:
    • MongoDB 4.0 and 4.2
    • PostgreSQL 11 and 12
    • MariaDB 10.3
    • MySQL 8.0
    • Oracle 18c
    • SQL Server 2017
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.
Client-Side Requirements The Nuxeo Platform comes with several applications for business users, which have their own requirements:

We'd love to hear your thoughts!

All fields required