How to Install Nuxeo as a Windows Service with AlwaysUp

The Nuxeo Content Services Platform is used by architects and developers to build, deploy, and run content-centric business applications.

To install Nuxeo as a Windows Service with AlwaysUp:

1. Download, install and configure Nuxeo if necessary.

   Please ensure that the Nuxeo content server starts and that the platform is accessible from your web browser:

   

2. Download and install AlwaysUp, if necessary.

3. Start AlwaysUp.

4. Select Application > Add to open the Add Application window:

   

5. On the General tab:

   • In the Application field, enter the full path to the batch file that starts Nuxeo server, nuxeoctl.bat. If you installed Nuxeo in the default location (C:\Nuxeo), this is:

     C:\Nuxeo\bin\nuxeoctl.bat

   • In the Arguments field, enter:

     --gui=false console

     The "gui" option tells Nuxeo to run headless and not show the control panel window. (You won't see the window when Nuxeo is running in the background in the isolated Session 0 anyway.)

     The "console" option instructs Nuxeo to keep important processes alive as it starts. Without that setting, AlwaysUp will notice those processes exiting, conclude that Nuxeo has failed and keep restarting the entire platform.

   • In the Name field, enter the name that you will call the application in AlwaysUp. We have specified Nuxeo but you can enter another name if you like.

   

6. Click over to the Logon tab and enter the user name and password of the account in which you installed and configured Nuxeo. Nuxeo must run in this account so that it can find its configuration & settings.

   

7. And if the content server will be accessing a network-based repository, move to the Startup tab and check both the Attempt to automatically reconnect all network drives and Ensure that the Windows networking components have started boxes.

   These will make certain that the network is primed and ready to go when Nuxeo launches.

   

8. We are now done installing Nuxeo as a service so click the Save >> button to record your settings. In a couple of seconds, an application called Nuxeo will appear in the AlwaysUp window. It is not yet running though.

   

9. To start Nuxeo, choose Application > Start "Nuxeo". In a few seconds, the state should transition to Running and Nuxeo will be running in the background.

   

   Confirm that content services are working properly by pointing your browser to http://127.0.0.1:8080/nuxeo/home.html:

   

10. That's it! Next time your computer boots, Nuxeo content server will start up immediately, before anyone logs on.

    We encourage you to edit Nuxeo in AlwaysUp and check out the many other settings available. You can send email if Nuxeo ends unexpectedly, reboot your server nightly to cure memory leaks, and much more.

Download & Import the Nuxeo Settings File

For your convenience, we have provided an AlwaysUp Settings File with all the settings recommended in this guide.

To use the file:

1. Download Nuxeo_alwaysup.xml to your computer. Please make a note of where you save it.

2. In AlwaysUp, select Application > Import from the menu.

3. Choose the file you downloaded in step 1.

4. Make the following adjustments in the Add Application window:

   • On the Logon tab, delete the placeholder values and enter the username and password of the Windows account where you installed and run Nuxeo.

5. Click Save to record your new Nuxeo service.

Nuxeo not working properly as a Windows Service?

• Perhaps the Nuxeo control panel (hidden when running as a service) is showing an error. To show the control panel:

  1. Stop Nuxeo in AlwaysUp
  2. Edit Nuxeo in AlwaysUp
  3. Remove the "--gui=false" option from the arguments field
  4. Save your changes
  5. Select Application > Start "Nuxeo" in this session

  The Nuxeo control panel should pop up on your desktop. Check for errors.

• Consult the AlwaysUp Troubleshooter — our online tool that can help you resolve the most common problems encountered when running an application as a Windows Service.

• From AlwaysUp, select Application > Report Activity > Today... to bring up a HTML report detailing the interaction between AlwaysUp and Nuxeo. The AlwaysUp Event Log Messages page explains the more obscure messages.

• Review the AlwaysUp FAQ for answers to commonly asked questions and troubleshooting tips.

• Contact us and we will be happy to help!