Nuxeo Glossary

NXR

Updated: August 28, 2019 Page Information Edit on GitHub

NXR (NuXeo application aRchive)

Definition

The Nuxeo application archive is a structure built by a Nuxeo packaging process. That archive (a ZIP or an exploded directory) contains all the required Nuxeo bundles and third-party libraries assembled as an application. It may contain some configuration files even if those are usually stored either in the Nuxeo bundles, either outside the NXR in the configuration templates directory.

The NXR is aimed at being reorganized when being deployed in a server: it will then become an EAR, a WAR, a Nuxeo Runtime, ...

Historically, the NXR was called a "Nuxeo EAR" or "Nuxeo assembly".

Main Nuxeo NXR are:

Assembly

The NXR is built by Maven using ant-assembly-maven-plugin. See for instance nuxeo-distribution/nuxeo-distribution-cap.

Usage

The NXR is used in the build process. It is repackaged in a Marketplace Package for being later deployed in a server. Both NXR and Marketplace Package are multi-server compliant.

Standard NXR content

 nuxeo.nxr/
|-- artifacts.properties
|-- test-artifacts.properties
|-- bundles (Nuxeo bundles)
`-- lib (third-party libraries)

The following resources are usually not included in NXR. Thus, they can be included in the Marketplace Package for being installed as part of a specific configuration template.

Sample resources usually moved out from NXR to the configuration templates

|-- META-INF
|   `-- templates
|-- config
`-- plugins

23 days ago Manon Lumeau Fix screenshots on retention doc
5 years ago Julien Carsique 5
6 years ago Todd Hivnor 4 | grammer. 'is containing' changed to 'contains'
7 years ago Julien Carsique 2 | NXR
7 years ago Julien Carsique 3
7 years ago Julien Carsique 1
History: Created by Julien Carsique

We'd love to hear your thoughts!

All fields required