Nuxeo Platform

About the Nuxeo Platform

The Nuxeo Platform is an open source customizable and extensible content management platform for building business applications. It provides the foundation for developing document management, digital asset management, case management application and knowledge management. You can easily add features using ready-to-use addons or by extending the platform using its extension point system.

The Nuxeo Platform is developed and supported by Nuxeo, with contributions from the community.

Installation

Please follow the Installation guide.

Running the Nuxeo Platform requires JDK 11, Oracle's JDK or OpenJDK.

Depending on the features you want to use, you may need some third-party software, such as LibreOffice and pdftohtml for document preview or ImageMagick for pictures. The list of third-party software is available in our Admin documentation: Installing and Setting Up Related Software.

Building

Building the Nuxeo Platform requires the following tools:

• Git (obviously)
• JDK 11 (Oracle's JDK or OpenJDK recommended)
• Apache Maven 3.1.1+ (3.2+ recommended)
• Apache Ant 1.7.1+

Get the source code:

# If you have access to the nuxeo/nuxeo-lts private repository (latest sources):
git clone git@github.com:nuxeo/nuxeo-lts.git
cd nuxeo-lts

# Else:
git clone git@github.com:nuxeo/nuxeo.git
cd nuxeo

Export the relevant options for the JVM running Maven:

export MAVEN_OPTS='-Xmx4g -Xms2g -XX:+TieredCompilation -XX:TieredStopAtLevel=1'

To build everything, including the packages, server ZIP and Docker image, run:

mvn install -Pdistrib,docker -DskipTests -Dnuxeo.skip.enforcer=true -T6

To take the shortest path for building the Docker image, run the following command. It starts by building the Docker image's dependencies (server modules and ZIP), then the Docker image itself.

mvn install -Pdistrib,docker -pl docker/nuxeo -am -DskipTests -Dnuxeo.skip.enforcer=true -T6

The Tomcat ZIP distribution is at server/nuxeo-server-tomcat/target. The Docker image, if you've built it, is in the local images repository (docker images).

See the docker directory for more information on how to build, run and configure the Nuxeo Docker Image.

See our Nuxeo Core Developer Guide for complete instructions and guidelines.

Resources

Documentation

The documentation for the Nuxeo Platform is available in our Documentation Center:

• Developer Documentation
• Server Documentation
• REST API Documentation
• User Documentation
• Nuxeo Core Developer Guide

Benchmarks

The Nuxeo Platform is benchmarked continuously to test its massive scalability on several databases.

Reporting Issues

You can follow the developments in the Nuxeo Platform project of our JIRA bug tracker.

You can report issues on answers.nuxeo.com.

Licensing

Most of the source code in the Nuxeo Platform is copyright Nuxeo and contributors, and licensed under the Apache License, Version 2.0.

See the LICENSE file and the documentation page Licenses for details.

About Nuxeo

Nuxeo dramatically improves how content-based applications are built, managed and deployed, making customers more agile, innovative and successful. Nuxeo provides a next generation, enterprise ready platform for building traditional and cutting-edge content oriented applications. Combining a powerful application development environment with SaaS-based tools and a modular architecture, the Nuxeo Platform and Products provide clear business value to some of the most recognizable brands including Verizon, Electronic Arts, Sharp, FICO, the U.S. Navy, and Boeing. Nuxeo is headquartered in New York and Paris. More information is available at www.nuxeo.com.