All Nuxeo EP documentation versions

Nuxeo Platform 5.6
Nuxeo Platform 5.5
Nuxeo Enterprise Platform (EP) 5.4
Nuxeo Enterprise Platform (EP) 5.3

Nuxeo Enterprise Platform 5.4

This documentation relates to an old version of Nuxeo EP (5.4). You may want to check the latest version if you are using a more recent version.
Skip to end of metadata
Comment: Migration of unmigrated content due to installation of a new plugin
Go to start of metadata

Nuxeo provides you with easy access to the configuration of your Nuxeo server, thanks to the Admin Center and the Startup Wizard available for applications based on Nuxeo EP 5.4.1. For advanced configuration or a simple review, manual edition of Nuxeo's configuration file, called nuxeo.conf, and a template system is also available.

Initial setup of your application with the Startup Wizard

For applications based on Nuxeo EP 5.4.1 (such as Nuxeo DM 5.4.1), when you first start your Nuxeo server and go the URL http://localhost:8080/nuxeo, a Startup Wizard will guide you to the main configuration steps. 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 Center or by editing Nuxeo's configuration file manually.

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 Center or editing the nuxeo.conf file manually).

Server's 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 add-ons 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:

  • PostgreSQL,
  • Oracle,
  • MS SQL Server,
  • MySQL.

SMTP settings
Nuxeo applications include email alert features. By default, no SMTP configuration is enabled and so email alerts won't be sent to users. You can report 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 Connect 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 Connect, you will be sent an email confirming your subscription and your credentials to Nuxeo Connect and giving you the links to access the Nuxeo Connect Portal and Nuxeo Studio.

If you already have a Nuxeo Connect 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 Marketplace packages in your instance.

Summary
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 Nuxeo 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.

Update the application's configuration using the Admin Center

The Admin Center is the graphical interface that enables the application's administrators to edit the configuration of the application directly from the user interface, and prevents 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 Center:
  1. Log in with an administrator account.
    Default administrator credentials are:
    • login: Administrator
    • password: Administrator
  2. Click on the Nuxeo Admin Center link in the page header.
  3. Click on the Setup tab, edit the configuration you want to change and 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 for more information about the available parameters.

Manual edition of Nuxeo configuration file nuxeo.conf

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 DM\conf (check the corresponding Knowledge Base page 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 for the list of available paramaters.

Labels
  • None