Documentation Center for Nuxeo Platform IDE

Running your Projects on the Server

Updated: January 2, 2020

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

Installing Nuxeo IDE adds a new perspective to Eclipse, called Nuxeo. This perspective is composed of three views:

The server view enables you to deploy your changes and control the runtime.

Configuring the Server Launcher

The server launcher can be configured from the Eclipse preferences.

  1. In the Eclipse preferences, click on Nuxeo > Run/Debug.
  2. Change the parameters you need (see below).
  3. Click on the Apply or OK button.

Run/Debug parameters

Field Description
VM Arguments System properties of the JVM
Debug port Port used to debug
Suspend server Indicate if you want the server to wait for the debugger to be attached to it before actually starting.

Deployment Profiles

As you develop new features, you want to be able to easily test them. To do so, you need to deploy them on the Nuxeo SDK. However, you often don't want to deploy all the features or projects you are working on. You may want to deploy only some of them. To make this easy, Nuxeo IDE includes a deployment profile configuration. A deployment profile is a set of Nuxeo IDE projects that will be deployed at the same time.

To create a new deployment profile:

  1.  Go into the Nuxeo Server view (on the bottom right).
  2. Click on the button  in the view toolbar. The button tooltip is "Select projects to deploy on server".
  3. Click on Add.
  4. Enter a name (in the right panel) for your deployment profile. Example: "My Projects".
  5. In the left panel click on the newly created profile.
  6. In the right panel, check the projects that will be deployed with this profile.
  7. If you want the new profile to be the default deployment profile, check it.
  8. Click on the OK button.

Launching the Server

The server can be started either in Run or Debug mode. In both cases, when launched the server will automatically deploy (at the end of the start process) all the projects and user libraries you configured in the current deployment profile.

You can see in the server console messages that are detailing which projects and user libraries were deployed.

Remote Debugging

If you need to check your developments or watch Nuxeo source code behavior this is possible throw the remote debugging.

With Eclipse and Nuxeo IDE

First configure the port the JVM will listen for remote debug:

  1. Go to Preferences > Nuxeo > Run/Debug
  2. Set a value for the debug port (choose one free 😄 Then start your Nuxeo Server from the Nuxeo perspective as debug and connect Eclipse to the JVM:
  3. Go to Run > Debug configurations... > Remote Java Application
  4. Create a new debug configurations
  5. Type the host name as localhost and the port as the one set below

You can set breakpoints and have fun.

With Other IDE or with a Server Not Local

First configure the port the JVM will listen for remote debug:

  1. Open the nuxeo.conf file, by default is here $TOMCAT_HOME/bin/nuxeo.conf or /etc/nuxeo.conf.

  2. Uncomment the following line:

    #JAVA_OPTS=$JAVA_OPTS -Xdebug -Xrunjdwp:transport=dt_socket,address=8787,server=y,suspend=n
  3. You can change the port number here.

  4. Start your server.
  5. Add source code you want to watch into your IDE.
  6. Create a remote debug connection with the port set.

You can set breakpoints and have fun.

Hot Reload

If you are modifying the sources of a project while the server is running, you may reload your changes on the server by simply clicking on the refresh button (in the Server View). A message will appear in the server console detailing the projects that were reloaded.

Be sure that the project you modify is selected in the current deployment profile, otherwise it will not be reloaded on the server.

You can modify the current deployment profile at any time by removing or adding projects. The next time you will click on the refresh button, the old profile will be uninstalled form the server and the new one will be installed. Projects that are common to both old and new deployment profiles will be reloaded.

For more information about Nuxeo hot reload support, see Supporting Hot Reload.

A bug affects hot reload when using Nuxeo 6.0 SDK (fixed in Nuxeo 6.0 HF01). Refer to the following JIRA ticket for a workaround if you have not installed any hotfix yet: fix dev bundles not taken in account

We'd love to hear your thoughts!

All fields required