Documentation Center for Nuxeo Platform IDE

Setting up a Nuxeo SDK

Updated: February 17, 2017 Page Information Edit on GitHub

Nuxeo IDE is being replaced by the Nuxeo Generator and won’t be maintained any longer. You can take a look at the page Start customizing the Nuxeo Platform to discover how to use the Nuxeo Generator.

Before starting to create your first project you must configure a Nuxeo SDK.

A Nuxeo SDK is a regular Tomcat distribution of the Nuxeo Platform that is used as the development server, where your projects will be deployed. The Nuxeo SDK is providing the classpath for your Nuxeo projects. All the JARs on the server will be visible in your project and you will be able to reference them from your code. Only Nuxeo Platform 5.5 versions and later are supported.

Do not use a Nuxeo SDK as a production server.

Installing a Nuxeo SDK

To install a Nuxeo distribution you can:

It is far simpler to download the SDK, and there is generally no need to build your own distribution. The Nuxeo Platform is designed to be customized without changing the SDK.

Installing a Downloaded Distribution

  1. UNzip the downloaded Nuxeo Platform distribution.
  2. In the Nuxeo SDK preference page (Eclipse Menu -> Window -> Preferences -> Nuxeo -> Nuxeo SDK), click on Add....
  3. Select the directory where you unzipped your Nuxeo distribution. Be sure to select the right directory: the one containing the bin and nxserver directories.
  4. Check the added Nuxeo SDK and click on the OK button to finish. Checking the box at the left of the SDK is required to mark it as the current Nuxeo SDK used in the Eclipse Workspace.

Using Multiple Nuxeo SDKs

You can install multiple Nuxeo SDKs (with different flavors and versions). But you cannot use them in parallel in the same workspace. Only one Nuxeo SDK can be used in an Eclipse workspace at a time: the one that you check in the SDK preferences view.

You can switch to another Nuxeo SDK at anytime, by checking the SDK of your choice in the preferences. This will recompile all of your Nuxeo projects against the new Nuxeo SDK.

You can for example use this method to check if your projects are compiling on different Nuxeo Platform versions.

If you need to work on projects that target different Nuxeo Platform versions, then you must use a different workspace for each Nuxeo Platform version you need. Checking a Nuxeo SDK - i.e. making an SDK the default one - is relative to an Eclipse workspace.

4 months ago Solen Guitter Fix heading not displayed in bold
a year ago Solen Guitter 54 | pdate link to SDK to use 8.
a year ago Solen Guitter 53 | Update FT SDK link to 8.2
a year ago Bertrand Chauvin 52 | fix yoda-esque sentence
a year ago Solen Guitter 51 | Add link to 8.1 SDK
2 years ago Vincent Dutat 50
2 years ago Vincent Dutat 49
2 years ago Gildas Lefevre 48
2 years ago Julien Carsique 47
2 years ago Bertrand Chauvin 46 | Updated SDK links
3 years ago Vladimir Pasquier 45
3 years ago Vladimir Pasquier 44 | update sdk link
3 years ago Solen Guitter 43 | Add Nuxeo Platform 6.0 SDK link
3 years ago Solen Guitter 42
3 years ago Solen Guitter 41
3 years ago Solen Guitter 40 | Terminology
3 years ago Solen Guitter 39 | Updated Fast Track and LTS links
3 years ago Todd Hivnor 38 | Recommend downloading the SD as opposed to building it. It is non-obvious to newcomers that the latter is difficult and not needed.
4 years ago Bertrand Chauvin 37 | Updated download link
4 years ago Solen Guitter 36
4 years ago Solen Guitter 35 | Updated links to SDKs (LTS and Fast Track)
4 years ago Solen Guitter 33
4 years ago Solen Guitter 34
4 years ago Solen Guitter 32
4 years ago Olivier Grisel 31
4 years ago Olivier Grisel 30
5 years ago stan 28
5 years ago stan 29 | Migration of unmigrated content due to installation of a new plugin
5 years ago Julien Carsique 25
5 years ago Julien Carsique 26 | Migrated to Confluence 4.0
5 years ago Julien Carsique 27 | Migration of unmigrated content due to installation of a new plugin
6 years ago Laurent Doguin 24
6 years ago Stéphane Lacoin 23
6 years ago Stéphane Lacoin 22
6 years ago Stéphane Lacoin 21 | Reverted from v. 18
6 years ago Solen Guitter 20 | Removed link to obsolete SDK
6 years ago Solen Guitter 19 | Reverted from v. 15
6 years ago Laurent Doguin 18
6 years ago Laurent Doguin 16 | update sdk version
6 years ago Laurent Doguin 17
6 years ago Stéphane Lacoin 15
6 years ago Julien Carsique 14
6 years ago Solen Guitter 13
6 years ago Solen Guitter 12 | added link to download SDK
6 years ago Solen Guitter 11
6 years ago Solen Guitter 10
6 years ago Solen Guitter 9
6 years ago Solen Guitter 8
6 years ago Solen Guitter 7
6 years ago Solen Guitter 6
6 years ago Solen Guitter 5
6 years ago Solen Guitter 4
6 years ago Bogdan Stefanescu 2
6 years ago Bogdan Stefanescu 3
6 years ago Solen Guitter 1
History: Created by Solen Guitter