Nuxeo Server

Server Start and Stop

Updated: February 22, 2017 Page Information Edit on GitHub

On this page, you will see how to start and stop your Nuxeo application.

Nuxeo applications come with a Control Panel that allows you to start and stop the server easily, and to access more administration features.

The Control Panel gives you access to:

  • A summary of the server status: is it running, is stopped, etc...
  • The logs of the server: the console and server logs are information of the tasks the server is doing and messages on how it is processing these tasks.
  • The Nuxeo Shell: the administrators' Swiss Army knife.

Starting Your Nuxeo Application

Linux

Nuxeo applications are started using scripts.

  1.  Launch a terminal and go to your installation directory.
  2. Start the server using the nuxeoctl script (located in the bin directory):

    ./bin/nuxeoctl start --gui
    

    The command used to launch the Control Panel may not be executable by default. If it is the case, in the terminal go to the bin directory of Nuxeo and type the line below to be able to use it:

    chmod +x *.sh *ctl
    

    The Control Panel opens.

  3. Click on the Start button. Starting the Nuxeo server takes between 30 sec and several minutes, depending on your hardware. When the server is started, the Start button becomes a Stop button.

  4. Open a browser and type the URL http://localhost:8080/nuxeo/. If the server is started for the first time after the installation, the startup wizard is displayed so you can select what module you want to install on the platform and help you configure it. Otherwise, the login page is displayed so you can use the application.

Mac OS X

Using the Control Panel

  1. From the Finder, click on Start Nuxeo.command. You can also drag and drop the start script in the terminal and press Enter.

    The command may not be executable by default. If it is the case, in the terminal go to the bin directory of Nuxeo and type the line below:

    chmod +x *.command
    

    The Control Panel opens and the server starts. Starting the Nuxeo server takes between 30 sec and several minutes, depending on your hardware. When the server is started, the Start button becomes a Stop button.

  2. Open a browser and type the URL http://localhost:8080/nuxeo/. If the server is started for the first time after the installation, the startup wizard is displayed so you can select what module you want to install on the platform and help you configure it. Otherwise, the login page is displayed so you can use the application.

Using the nuxeoctl Script

  1. Open a terminal and go to the /bin directory of your Nuxeo application.

    cd $NUXEO_HOME/bin
    
  2. Execute the nuxeoctl script with the start command.

    ./nuxeoctl start --gui
    

    The Control Panel opens and the server starts. Check out the page nuxeoctl and Control Panel Usage for more commands and options of the nuxeoctl script, like the console command.

Windows

Using the Control Panel

  1. Open the Nuxeo Control Panel:

    • In the folder C:\Nuxeo application, double-click on Start Nuxeo.bat.
    • In the folder C:\Nuxeo application\bin\, double-click on nuxeoctl.bat.The Nuxeo Control Panel opens and the server starts. Starting the Nuxeo server takes between a few seconds and several minutes, depending on your hardware. When the server is started, the Start button becomes a Stop button.
  2. Open a browser and type the URL http://localhost:8080/nuxeo/. If the server is started for the first time after the installation, the startup wizard is displayed so you can select what module you want to install on the platform and help you configure it. Otherwise, the login page is displayed so you can use the application.

On Windows 7 (and higher versions), you need to run the nuxeoctl.bat and Start Nuxeo.bat commands as an administrator if you haven't installed your Nuxeo application at the root of C:\ (for instance in C:\Program Files). To run them as an administrator, right-click on the command and click on "Run as administrator".

On Windows, it is possible to start Nuxeo as a service. Please report the Installing the Nuxeo Platform as a Windows Service page for guidelines and examples.

Using the nuxeoctl Script

  1. Launch a command prompt and go to the /bin directory of your Nuxeo application.

    cd $NUXEO_HOME/bin
    
  2. Execute the nuxeoctl.bat script with the start command.

    nuxeoctl.bat start
    

    The Control Panel opens and the server starts. Check out the page nuxeoctl and Control Panel Usage for more commands and options of the nuxeoctl script, like the console command.

Stopping Your Nuxeo Application

The steps to stop your Nuxeo application are the same for all operating systems.

Using the Control Panel

  1. On the Control Panel, click on the Stop button. Stopping the server takes several seconds. When the server is stopped, the Stop button becomes a Start button.
  2. Close the Control Panel.

If you started the server using the nuxeoctl start command in the terminal, use the nuxeoctl stop command to stop it.

Using the nuxeoctl Script

If you started the server using the nuxeoctl start command, in a terminal execute the nuxeoctl script with the stop command:

  • Linux / Mac OS X

    ./nuxeoctl stop
    
  • Windows

    nuxeoctl.bat stop
    

If you started the server using the nuxeoctl console command, use Ctrl+C to stop the server.


Related Documentation
 
4 months ago Manon Lumeau fix image on quick overview page
a year ago Manon Lumeau 42
a year ago Alain Escaffre 41
2 years ago Solen Guitter 40
2 years ago Solen Guitter 39 | Add sections about using nuxeoctl
2 years ago Solen Guitter 38 | Fix formatting issues
4 years ago Solen Guitter 30
4 years ago Solen Guitter 31 | Migration of unmigrated content due to installation of a new plugin
4 years ago Solen Guitter 32 | Migration of unmigrated content due to installation of a new plugin
4 years ago Solen Guitter 33 | Migration of unmigrated content due to installation of a new plugin
4 years ago Solen Guitter 34 | Migration of unmigrated content due to installation of a new plugin
4 years ago Solen Guitter 35 | Migration of unmigrated content due to installation of a new plugin
4 years ago Solen Guitter 36 | Migration of unmigrated content due to installation of a new plugin
4 years ago Solen Guitter 37 | Migration of unmigrated content due to installation of a new plugin
4 years ago Solen Guitter 28
4 years ago Solen Guitter 29
5 years ago Florent Guillaume 23 | Removed 5.4 specific steps
5 years ago Florent Guillaume 24 | Migrated to Confluence 4.0
5 years ago Florent Guillaume 25 | Migration of unmigrated content due to installation of a new plugin
5 years ago Florent Guillaume 26 | Migration of unmigrated content due to installation of a new plugin
5 years ago Florent Guillaume 27 | Migration of unmigrated content due to installation of a new plugin
6 years ago Solen Guitter 22 | Removed 5.4 specific steps
6 years ago Solen Guitter 21 | Removed 5.4 specific steps
6 years ago Solen Guitter 20
6 years ago Solen Guitter 19
6 years ago Solen Guitter 18
6 years ago Solen Guitter 17 | added Windows 7 info
6 years ago Solen Guitter 16
6 years ago Solen Guitter 15
6 years ago Solen Guitter 14
6 years ago Solen Guitter 13 | fixed typo
6 years ago Solen Guitter 12
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 Solen Guitter 3
6 years ago Julien Carsique 2
6 years ago Solen Guitter 1
History: Created by Solen Guitter