Installation and Administration


Updated: July 17, 2023

The Nuxeo Platform provides you with easy access to the configuration of your Nuxeo server, thanks to the Admin tab and the Startup Wizard. For advanced configuration or a simple review, manual edition of Nuxeo's configuration file, called nuxeo.conf, and a template system is also available.

Startup Wizard 

The first time you start the Nuxeo Platform and go the URL http://NUXEO_SERVER/nuxeo, a Startup Wizard will guide you to the main configuration steps and enable you to choose which add-ons you want to enable on the Platform. For each step, a default setting is proposed that enables you to test the application. You can change this default configuration to adapt it to specific environments.

The settings defined during the initial setup can be changed afterward using the Admin tab or by editing Nuxeo's configuration file manually. Addons can also be added or removed afterwards from the Admin tab.

The Startup wizard will be run only if the configuration sets nuxeo.wizard.done=false. You can edit the value in order to replay the wizard (using the Admin tab or editing the nuxeo.conf file manually), or simply run nuxeoctl wizard.

Server General Settings

This step enables you to change the default IP address of the server and where the logs and data are stored.

Proxy Settings

Some features of Nuxeo applications requires to access the Internet. That's the case of the Update Center from which you can access to the Marketplace addons and plugins, updates for your application, your Studio customizations.

Database Settings

Nuxeo applications embed a database by default, called H2/Derby. This database enables you to fully test and evaluate the application. However it is not recommended to use this embedded database for production and load testing. Select the database you want to use and provide the connection information to the database. Possible databases are:

Users & Groups

By default users and groups are stored in the embedded database. You can however set up the platform from the beginning to use your own users and groups directory.

Mail Settings

Nuxeo applications include email alert features. By default, no SMTP configuration is enabled and therefore no email alerts will be sent to users. You can refer to the email alerts section for more information about the SMTP configuration.

Connect Settings

From this step, you can subscribe to a free 30 days trial offer of Nuxeo Online Services which gives you the possibility to evaluate and fully leverage the Marketplace catalog and Nuxeo Studio, the online Nuxeo customization environment. If you subscribe to the trial offer of Nuxeo Online Services, you will be sent an email confirming your subscription and your credentials and giving you the links to access the Nuxeo Connect Portal and Studio.

If you already have a Nuxeo Online Services account, you can register your Nuxeo instance from this step to directly be able to apply your Nuxeo Studio customizations and the installation of Nuxeo Packages in your instance.

Module Installation

Select the additional features you want to install on the Platform. You can also just keep the naked Content Application Platform.

You can install or uninstall modules afterwards from the Admin tab.

And if needed, download the module packages. Packages may be already included in the Platform.


A final Summary step provides you with a screen on which you can see all the configuration parameters that you set in the previous steps so you can review them and possibly go back to a step to change them.

To validate your configuration, click on the Start button. The server will automatically restart and your configuration will be applied. Once the server is restarted, you are displayed the login page. Log in to your application the Administrator user name and the Administrator password.

Admin Tab

The Admin tab is where administrators can edit the configuration of the application directly from the user interface, preventing them from editing .xml and .conf files. They can edit the configuration of the application, monitor it, display messages to the users, and easily customize the application thanks to the Update Center.

To edit the configuration of the application using the Admin tab:

  1. Log in with an administrator account. Default administrator credentials are:
    • login: Administrator
    • password: Administrator
  2. Click on the Admin tab in the page header.
  3. Click on the Setup tab, edit the configuration you want to change and click on Save.
  4. If indicated as needed on top of the page, restart the server.

You can also take a look at the following pages for recommendations and examples:

You can report to the Configuration Parameters Index (nuxeo.conf) for more information about the available parameters.


By default, the nuxeo.conf file is located in $NUXEO_HOME/bin. If you installed your application using the Windows installer, the configuration is located in %APPDATA%\Nuxeo\conf (check the page Where Are the Log and Configuration Files in Windows? for more information).

If you plan to use the application in production, you should move the configuration file outside the Nuxeo home directory, to make upgrades easier and more secured: your data and configuration won't risk to be overridden or lost.

For Windows users
Do not use Office writers, nor Notepad.

Wordpad is fine, Notepad++ and SciTE are good text editors, there are a lot of other text editors.

You can report to the Configuration Parameters Index (nuxeo.conf) for the list of available paramaters.