This page lists all the properties that impact Nuxeo's behavior. This is a work in progress.
There are two kinds of properties:
- Java System Properties, that can be specified using -Dproperty=value in the JVM startup command line,
- Nuxeo Runtime Properties, that can be specified in any *.properties file put in the nuxeo.ear/config directory.
 | Since Nuxeo 5.4.2, Nuxeo Runtime Properties can be set in nuxeo.conf: see Configuration parameters index (nuxeo.conf). |
Java System Properties for Nuxeo
org.nuxeo.runtime.redirectJUL
Control whether or not to redirect Java util logging (JUL) to Apache Commons Logging (JCL). Default is "true".
org.nuxeo.runtime.redirectJUL.threshold
Threshold level logging for JUL. Default is "INFO".
Java System Properties for Nuxeo Unit Tests
When running unit tests, some properties can influence the behaviour of Nuxeo.
nuxeo.test.vcs.db
Starting with Nuxeo 5.3, this can be set to an alternative database backend to run unit tests on. See http://jira.nuxeo.org/browse/NXP-3994 for details.
nuxeo.test.vcs.url
See above.
nuxeo.test.vcs.server
See above.
nuxeo.test.vcs.port
See above.
nuxeo.test.vcs.database
See above.
nuxeo.test.vcs.user
See above.
nuxeo.test.vcs.password
See above.
Java System Properties for the JVM
mail.mime.decodefilename
Needs to be set to true for correct decoding of non-ASCII filenames, for instance in email attachment names.
See http://java.sun.com/products/javamail/javadocs/javax/mail/internet/package-summary.html for more.
file.encoding
This should be set to UTF-8 for consistent behavior of Nuxeo.
com.sun.management.jmxremote
This has to be set (to any arbitrary value, even empty) to allow connection by a remote jmx management console. This is a prerequisite for remote access to the platform MBean server.
java.io.tmpdir
Java temporary directory (default on Linux is /tmp).
Java System Properties for JBoss
Please refer to JBoss documentation for details. The following lists important System Properties impacting JBoss behavior in Nuxeo.
...
jms.useTransactedConnection
true/false, not use by default from version 5.2.0
jms.isDeliveryPersistent
true/false, not use by default from version 5.2.0
jms.isDisableMessageID
true/false, not use by default from version 5.2.0
jms.isDisableMessageTimestamp
true/false, not use by default from version 5.2.0
org.nuxeo.ecm.platform.jbpm.deployProcessDefinition
true/false, default is true. if set to false, the process definition using the nuxeoProperties deployer do not deploy
org.nuxeo.ecm.platform.jbpm.startJobExecutor
true/false, default is false. If set to true the Jbpm JobExecutor will start when Nuxeo starts. JobExecutor is necessary for asynchronous and timer node.
org.nuxeo.ecm.webapp.search.csv.separator
This is the separator use for CSV export in the default webap. It can be set to \t for instance.
org.nuxeo.ecm.webapp.search.csv.quotechar
This is the quote character use for CSV export in the default webap. It can be set to " for instance.
org.nuxeo.ecm.webapp.search.csv.endofline
This is the end-of-line character use for CSV export in the default webap. It can be set to \n for instance.
org.nuxeo.ecm.webapp.readonly.mode
Whether the application will be started in "read-only" mode or not (default is false, set it to true to activate). This flag is used to define action filters used wherever necessary in the application.
org.nuxeo.ecm.sql.jena.databaseType
This is the Jena database type. It should be set to PostgreSQL for instance.
See http://jena.sourceforge.net/DB/ for details.
org.nuxeo.ecm.sql.jena.databaseTransactionEnabled
This is the Jena transaction mode. It should be set to false, except for Oracle where it needs to be true.
See http://jena.sourceforge.net/DB/ for details.
org.nuxeo.ecm.instance.name
The name of the Nuxeo instance, for display in the default webapp.
org.nuxeo.ecm.instance.description
The description of the Nuxeo instance, for display in the default webapp.
org.nuxeo.ecm.instance.host
The host where the Nuxeo instance is running, used as a property in other configuration files (especially platform-config.xml and nuxeo.properties), localhost for instance.
org.nuxeo.ecm.product.name
The name part of the Nuxeo server installed.
org.nuxeo.ecm.product.version
The version of the Nuxeo server installed.
org.nuxeo.runtime.server.enabled
Nuxeo Runtime Remoting: whether connections from remote servers are allowed. This needs to be true to use clients like the Nuxeo Shell.
org.nuxeo.runtime.server.host
Nuxeo Runtime Remoting: the host name to advertize to remote clients. Usually ${org.nuxeo.ecm.instance.host}
org.nuxeo.runtime.server.locator
Nuxeo Runtime Remoting: the server locator advertised to remote clients. This takes precedence over org.nuxeo.runtime.server.host.
Usually socket://0.0.0.0:62474/?datatype=nuxeo or with a specific host instead of 0.0.0.0.
org.nuxeo.runtime.streaming.isServer
Whether this is a streaming server. Only true for a "core" machine.
org.nuxeo.runtime.streaming.serverLocator
Server locator for streaming advertised to remote clients. Usually socket://${org.nuxeo.ecm.instance.host}:62474/?datatype=nuxeo
org.nuxeo.runtime.management.exist
Whether the JMX management of Nuxeo is activated.
org.nuxeo.runtime.management.serverRmiPort
What RMI port is used for JMX management of Nuxeo, if activated. Usually 2100.
org.nuxeo.ecm.platform.transform.ooo.host.name
Host name where the conversion service can contact an OpenOffice.org server.
org.nuxeo.ecm.platform.transform.ooo.host.port
Port where the conversion service can contact an OpenOffice.org server. Usually 8100.
org.nuxeo.ecm.platform.transform.ooo.version
The version of the OpenOffice.org used as a server. Versions above 2.3 allow the use of remote streaming.
org.nuxeo.ecm.webengine.skinPathPrefix
The prefix from which will be fetch the static resource of a webengine site. The default is "/nuxeo/site/skin" in JBoss or "/skin" in Jetty.
nuxeo-client-jndi.java.naming.provider.url
Needed for JNDI auto-configuration of clients. Usually jnp://%s:%s This must be changed to use JNDI through HTTP.
nuxeo-client-jndi.java.naming.factory.initial
JNDI initial context factory. Usually org.jnp.interfaces.NamingContextFactory
nuxeo-client-jndi.java.naming.factory.url.pkgs
JNDI configuration. Usually org.jboss.naming:org.jnp.interfaces
facelets.REFRESH_PERIOD
Refresh period, in seconds, of facelets XHTML pages from the filesystem. Usually 2 when debugging facelets.
org.nuxeo.dev
If this is set, Nuxeo will be started in development mode, which means that:
- WebEngine will refresh its files from the filesystem (every org.nuxeo.ecm.webengine.reloadInterval milliseconds),
- If it's set to ide then WebEngine will be more efficient in checking which files have changed.
- The following errors at startup will stop the server:
- Component XML parse error,
- Contribution to an unknown extension point,
- Component with an unknown implementation class (the implementation entry exists in the XML descriptor but cannot be resolved to a class),
- Uncaught exception on extension registration / unregistration (either in framework or user component code),
- Uncaught exception on component activation / deactivation (either in framework or user component code),
- Broken Nuxeo-Component MANIFEST entry. (i.e. the entry cannot be resolved to a resource).
org.nuxeo.ecm.platform.liveedit.config
Who does the LiveEdit configuration detection (client/server/both).
- client: let the client choose what is LiveEdit-able. The LiveEdit client does this by sending the content types it knows how to edit.
- server: let the server decide what is LiveEdit-able, using the MIME type registry.
- both: use client and server intersection. In order to be LiveEdit-able a type must be advertised by the client and allowed by the server.
For a client, the content types accepted are advertised through the Accept HTTP header, using the form Accept: application/x-nuxeo-liveedit;ext0="mimetype1";ext1="mimetype2";....
For the server, the content types allowed are specified in the MIME type registry using onlineEditable="true" (see the extension point documentation).
org.nuxeo.runtime.rest.management
Whether the REST API for Nuxeo Runtime management is activated. Usually true.
This management interface is accessible through an URL like http://localhost/nuxeo/site/server/html on JBoss.
org.nuxeo.ecm.core.strictlazyloading
When true, a DocumentModel that has been disconnected from its session isn't allowed to reconnect to a new CoreSession to lazily fetch new values. The default is false, but will become true in the future.
org.nuxeo.ecm.core.search.alwaysDetachResults
When true, the search service detaches from their session the documents it returns as results, which has the consequence of loading them completely in memory and is therefore slow. The default is false. (Nuxeo 5.2.1)