Server

Configuration Parameters Index (nuxeo.conf)

Updated: June 10, 2020

This page is scheduled for review and update. Check back soon for updated content!

The Nuxeo Platform reads configuration properties that you can set either:

  • In a nuxeo.conf file
  • By contributing to the Configuration Service
  • From the Setup tab in the Admin Center (if Nuxeo JSF UI is installed)

nuxeo.conf File

Nuxeo Platform reads configuration properties in nuxeo.conf file. Those parameters can be either environment parameters used by Nuxeo runtime or template parameters used for values replacement in configuration files. 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 lots of other text editors.

Existing configuration parameters are listed in the index section below.

Admin Center / Setup Tab

JSF UI Deprecation
This requires to have the JSF UI addon installed on your server that is deprecated since Nuxeo Platform LTS 2019.
Please refer to the Web UI documentation.

Administrators can also change the nuxeo.conf configuration parameters from the Admin 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 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 page for recommendations and examples.

Configuration Parameters Index

The properties that can be set in nuxeo.conf are below. Properties that can be contributed to the Configuration service are available from the Nuxeo Platform Explorer.

JAVA_HOME

Path to Java home directory.

Default Value

None.

If undefined nuxeoctl script will try to discover it.


JAVA_OPTS

Optional values passed to the JVM.
Nuxeo requires at least 1024 Mo in JVM heap size and 256Mo as maximum permanent size (512 recommended).
Decreasing garbage collector frequency avoid having too much CPU usage (Sun Java specific options, recommended by JBoss).

Default Value

-Xms512m -Xmx1024m -XX:MaxPermSize=512m
-Dsun.rmi.dgc.client.gcInterval=3600000
-Dsun.rmi.dgc.server.gcInterval=3600000
-Dfile.encoding=UTF-8


launcher.start.max.wait

In seconds. Maximum time to wait for effective Nuxeo server start before giving up (applies on commands "start" and "restart").

Default Value

300


launcher.stop.max.wait

In seconds. Maximum time to wait for effective Nuxeo server stop cleanly before using forced stop.

Default Value

60


launcher.override.java.tmpdir

Possible values: true or false .
If true, will set java.io.tmpdir = ${nuxeo.tmp.dir}.

Default Value

true


nuxeo.log.dir

Log directory (absolute or relative to NUXEO_HOME).
Linux recommended path: /var/log/nuxeo/...

Default Value

log


nuxeo.pid.dir

Directory where to store Nuxeo PID file.

Default Value

bin


nuxeo.data.dir

Data directory (absolute or relative to NUXEO_HOME). It involves all data not being stored in database.
Linux recommended path: /var/lib/nuxeo/...

Default Value

data


nuxeo.tmp.dir

Location of the temporary files.

Default Value

server/default/tmp (JBoss)
tmp (Tomcat)
tmp (Jetty)


nuxeo.mp.dir

Since Nuxeo 5.9.4

Since Nuxeo 5.9.4. Nuxeo Packages directory.

Default Value

packages


nuxeo.force.generation

If "true", will force generation of configuration files; otherwise they are only generated when not existing.
If "once", will force one time and switch to false after successful generation.
If "false", configuration changes are ignored.

Default Value

true | once


nuxeo.templates

Comma separated list of templates to include.
Templates paths are absolute or relative to $NUXEO_HOME/templates/.
Available templates: postgresql, mysql, mssql, oracle, custom, ...

Default Value

default


nuxeo.bind.address

Server binding address. "0.0.0.0" means "all available network interfaces".
WARNING: When changing nuxeo.bind.address, you must accordingly change nuxeo.loopback.url.

Default Value

0.0.0.0


nuxeo.server.http.port

Server HTTP listen port.

Default Value

8080


nuxeo.server.http.connectionUploadTimeout

Since 10.3

Since 10.3. Configure the Tomcat connectionUploadTimeout to specify the timeout, in milliseconds, to use while a data upload is in progress.

Default Value

60000


nuxeo.server.ajp.port

Server AJP listen port.
This is not available on Jetty.

Default Value

8009


nuxeo.server.jvmRoute

Server AJP route for load-balancing

Default Value

nuxeo


nuxeo.server.tomcat_admin.host

Since Nuxeo 7.3

Since Nuxeo 7.3. Tomcat server's "admin" host.
This is the address on which the server waits for a shutdown command.

Default Value

localhost


nuxeo.server.tomcat-admin.port

Deprecated since Nuxeo 5.6

Deprecated since Nuxeo 5.6 and replaced by nuxeo.server.tomcat_admin.port. Tomcat server's "admin" port.
This is only useful if you have another Tomcat server running and want to avoid port conflicts.

Default Value

8005


nuxeo.server.tomcat_admin.port

Since Nuxeo 5.6

Since Nuxeo 5.6. Tomcat server's "admin" port.
Replaces nuxeo.server.tomcat-admin.port. This is only useful if you have another Tomcat server running and want to avoid port conflicts.

Default Value

8005


nuxeo.server.tomcat_error.show_report

Since Nuxeo 9.3

Tomcat report displayed or not on Tomcat error page.

Default Value

false


nuxeo.server.tomcat_error.show_server_info

Since Nuxeo 9.3

Tomcat version info (as Tomcat server version) displayed or not on Tomcat error page.

Default Value

false


nuxeo.server.https.port

Server HTTPS listen port.
This is only useful if you have modified the application server to use HTTPS.

Default Value

8443


nuxeo.server.emptySessionPath

Since Nuxeo 5.5, until Nuxeo 5.7.1

(Tomcat only) Since Nuxeo 5.5, until 5.7.1. If set to true, all paths for session cookies will be set to /.
May be useful to enable authentication on proxyfied WebEngine applications (see HTTP and HTTPS Reverse-Proxy Configuration).
Removed since Nuxeo 5.7.2 (see http://tomcat.apache.org/migration-7.html#Session_cookie_configuration).

Default Value

false


nuxeo.server.signature

(Tomcat only) Since Nuxeo 6.0. If set, this will replace the default value of the "Server:" HTTP response header.

Default Value

None.


org.nuxeo.ecm.instance.name

Server name.

Default Value

Nuxeo 5.9.3-SNAPSHOT


org.nuxeo.ecm.instance.description

Server description.

Default Value

Nuxeo


org.nuxeo.ecm.product.name

Product name, displayed in the page title on your browser.

Default Value

Nuxeo Platform


org.nuxeo.ecm.product.version

Default Value

5.9.3-SNAPSHOT


org.nuxeo.dev

Since Nuxeo 5.6

Since Nuxeo 5.6, this property uses the "dev" mode when running the Nuxeo application. This parameter should not be set to true on a production server, as it disables some caches, and enables hot redeploy of some JARs (Studio JARs for instance). For more information about the dev mode, see How to do incremental deployment (hot reload) in the JSF-Seam layer.

Before 5.6, setting this property to true stopped the runtime when an error occured at deployment. This behaviour has been removed from the dev mode and is now controlled by the property org.nuxeo.runtime.strict.

Default Value

false


org.nuxeo.prod

Since Nuxeo 5.8

Since Nuxeo 5.8, setting this property to "true" will display a quite visible warning message in the Admin tab, stating that this is a production instance. This is useful for administrators who are sometimes confusing their Nuxeo production server with their test server (not to rat anyone out).

Default Value

false


org.nuxeo.rest.stack.enable

Since Nuxeo 6.0

Since Nuxeo 6.0, you can enable this mode if you'd like to display exception stacktraces in JSON response when error occurs after REST calls.

See Web Exceptions documentation to get modes description and examples.

Default Value

false


org.nuxeo.automation.trace

Enable this mode if you'd like to display automation traces during runtime:

  • You'll benefit from exhaustive logs to debug all automation chain and/or operation execution.
  • The automation trace mode is disabled by default (not suitable for production).
  • It can be activated through JMX via org.nuxeo:TracerFactory MBean during runtime.

Default Value

false


org.nuxeo.automation.trace.printable

By default, all automation executions are 'printable' (appear in logs) when automation trace mode is on.

  • You can filter chain and/or operation execution trace printing by setting this property to chain name and/or operation separated by comma.
  • Comment this property to get all automation chains/operations back in printing (by default set to * (star))

Default Value

*


templateName.target

Directory where templateName files will be deployed.

Default Value

server/default/deploy/nuxeo.ear


mailservice.user

(JBoss only) User for e-mail authentication.

Default Value

nobody


mailservice.password

(JBoss only) Password for e-mail authentication.

Default Value

password


mail.store.protocol

mail.transport.protocol

Server protocol parameters for e-mailing.

Default Value

pop3
smtp


mail.user

User who will receive e-mail (unused in Nuxeo).

Default Value

nobody


mail.store.host

e-Mail server.

Default Value

localhost


mail.store.user

Default Value

anonymous


mail.store.password

Default Value

password


mail.debug

Enable debugging output from the JavaMail classes.

Default Value

false


nuxeo.notification.eMailSubjectPrefix

Subject prefix in Nuxeo notification e-mails.

Default Value

[Nuxeo]


nuxeo.notification.eMailSigner

Signer of the sent e-mail.

Default Value

The Nuxeo team


mail.transport.host

SMTP gateway server.

Default Value

localhost


mail.transport.port

e-Mail server port.

Default Value

25 (without authentication)
587 (with authentication)
465 (SSL)


mail.transport.usetls

Use TLS for the SMTP connection.

Default Value

false


mail.transport.auth

Default Value

true


mail.transport.user

Default Value

anonymous


mail.transport.password

Default Value

password


mail.from

The e-mail address will be sent from.

Default Value

`[email protected]`


nuxeo.db.name

Database name.

Default Value

nuxeo | NUXEO


nuxeo.db.user

Database username.

Default Value

sa | nuxeo


nuxeo.db.password

Database password.

Default Value

(empty value) | password


nuxeo.db.host

Database host URL.

Default Value

localhost


nuxeo.db.port

Database host port.

Default Value

3700 (DB2)
5432 (PostgreSQL)
3306 (MySQL)
1521 (Oracle)
1433 (MSSQL)


nuxeo.db.jdbc.url

Database JDBC connection URL for Nuxeo datasources, for instance jdbc:postgresql://${nuxeo.db.host}:${nuxeo.db.port}/${nuxeo.db.name}.

Default Value

(database-dependent)


nuxeo.db.validationQuery

Database validation query, a SELECT statement used to check connections before using them, usually SELECT 1. Using this has a noticeable speed impact but makes connections resilient to network or sever problems.


nuxeo.db.min-pool-size

Database minimum pool size for Nuxeo datasources.

Default Value

5


nuxeo.db.max-pool-size

Database maximum pool size for Nuxeo datasources.

Default Value

20 (JBoss)
100 (Tomcat)


nuxeo.db.idle-timeout-minutes

Since Nuxeo 6.0

Since Nuxeo 6.0. Database timeout after which connections not in use are removed from the pool.

Default Value

5


nuxeo.db.xaMode

Enable XA mode (required if multiple datasources configured)

Default Value

false


nuxeo.vcs.min-pool-size

Database minimum pool size for Nuxeo repository (VCS).

Default Value

0


nuxeo.vcs.max-pool-size

Database maximum pool size for Nuxeo repository (VCS).

Default Value

20


nuxeo.vcs.blocking-timeout-millis

Since Nuxeo 5.8

Since Nuxeo 5.8. Database maximum wait time to get a connection from the pool when all connections are in use, for Nuxeo repository (VCS).

Default Value

100


nuxeo.vcs.idle-timeout-minutes

Since Nuxeo 5.8

Since Nuxeo 5.8. Database timeout after which connections not in use are removed from the pool, for Nuxeo repository (VCS).

Default Value

10


nuxeo.vcs.fulltext.disabled

Since Nuxeo 5.8

Since Nuxeo 5.8. Whether full text indexing and querying should be completely disabled in the repository. See VCS for details.

Default Value

false


nuxeo.vcs.fulltext.search.disabled

Since Nuxeo 6.0

Since Nuxeo 6.0. Full text querying from VCS (database backend) is disabled, full text extraction is done. See VCS for details.

Default Value

false


nuxeo.vcs.fulltext.analyzer.language

Since Nuxeo 7.3

Since Nuxeo 7.3. Full text analyzer language. Only applies to postgresql and mssql database types.

Default Value

english


nuxeo.vcs.noddl

Since Nuxeo 5.8

Since Nuxeo 5.8. Where DDL generation should be disabled in the repository. See VCS for details.

Default Value

false


nuxeo.vcs.ddlmode

Since Nuxeo 7.10-HF01 and Nuxeo 8.1

Since Nuxeo 7.10-HF01 and Nuxeo 8.1. What kind of DDL generation is done. See VCS for details.

Default Value

execute


nuxeo.vcs.idtype

Since Nuxeo 5.8

Since Nuxeo 5.8. The type of id column. See VCS for details.

Default Value

varchar


nuxeo.vcs.copy.findFreeName.disabled

Since Nuxeo 7.3

Since Nuxeo 7.3. Set to true to disable free-name detection and let the database raise a constraint error in case of collisions if the constraints have been added by hand.

Default Value

false


nuxeo.url

Application URL (without final slash), should be the public URL of your server (i.e.: http://www.yourdomain.com/....)
It is also used for emails sent out and to detect images in HTML documents when converting to PDF.

Default Value

http://localhost:8080/nuxeo


nuxeo.loopback.url

Nuxeo URL, for connections from Nuxeo to itself (theme banks default). The port should be the same as nuxeo.server.http.port.
If not explicitly configured, the loop back URL is generated from nuxeo.bind.address, nuxeo.server.http.port and org.nuxeo.ecm.contextPath values.

Default Value

http://localhost:8080/nuxeo


org.nuxeo.ecm.contextPath

Application context path.
Note: Changing this parameter is not enough. See HOWTO: Change Context Path

Default Value

/nuxeo


org.nuxeo.ecm.platform.transform.ooo.host.name

DEPRECATED.

Default Value

127.0.0.1


org.nuxeo.ecm.platform.transform.ooo.host.port

DEPRECATED.

Default Value

8100


org.nuxeo.ecm.platform.transform.ooo.version

DEPRECATED.

Default Value

2.2.1


org.nuxeo.ecm.platform.transform.ooo.enableDaemon

DEPRECATED.

Default Value

true


repository.clustering.enabled

Activate clustering mode.

Default Value

false


repository.clustering.id

Since Nuxeo 7.3

Since Nuxeo 7.3. The cluster node id for this Nuxeo instance. The id must be an integer for all databases, unless you are using Oracle which accepts a string (See NXP-17180).


repository.clustering.delay

When clustering is activated, defines the delay during which invalidations don't need to be processed (expressed in milliseconds).

Default Value

1000


repository.clustering.invalidation

Allows the configuration of VCS cluster invalidations. The value default uses VCS. Since Nuxeo 8.1 you can use redis to specify Redis-based invalidations.

Default Value

default


repository.binary.store

Defines the folder where binaries are stored. Useful when using clustering or to change the location of binaries to another location.


nuxeo.core.binarymanager

Custom class for the Binary Manager, to replace the default file-base storage.


nuxeo.core.binarymanager_key

Since Nuxeo 6.0

Since Nuxeo 6.0. Key configuration for the binary manager, if applicable.


nuxeo.templates.parsing.extensions

Deprecated since Nuxeo 5.6

Deprecated since Nuxeo 5.6. Files extensions being parsed for parameters replacement when copying templates.

Default Value

xml,properties


nuxeo.plaintext_parsing_extensions

Since Nuxeo 5.6

Since Nuxeo 5.6. Files extensions being parsed for parameters replacement when copying templates.

Default Value

xml,properties


org.nuxeo.ecm.jboss.configuration

JBoss configuration to use (default, minimal, all, ...)
Pay attention to the fact that this won't apply to templates defining their own _template_.target value (for instance, "default" template sets default.target=server/default/deploy without being aware of org.nuxeo.ecm.jboss.configuration value).

Default Value

default


zip.entry.encoding

Modified since Nuxeo 7.1

Choose how to encode filename when exporting documents to zip in the worklist.
Since Nuxeo 7.1, the ZIP entries names are encoded in UTF8 by default. If you want to get the old behavior back (having entry name encoded in ascii), use zip.entry.encoding=ascii.

org.nuxeo.ecm.platform.liveedit.autoversioning

Default Value

none, minor, major


nuxeo.wizard.done

If set to false, will start a setup wizard before starting Nuxeo.

Default Value

true| false (depending on the package)


nuxeo.http.proxy.host

HTTP proxy host.


nuxeo.http.proxy.port

HTTP proxy port.


nuxeo.http.proxy.login

HTTP proxy login.


nuxeo.http.proxy.password

HTTP proxy password.


nuxeo.http.proxy.ntlm.host

NT Lan Manager (NTLM) Proxy. Host name of the Windows machine running the Nuxeo server.


nuxeo.http.proxy.ntlm.domain

NT Lan Manager (NTLM) Proxy. Domain name to authenticate against.


nuxeo.http.proxy.pac.url

Since Nuxeo 5.9.3

Since Nuxeo 5.9.3. Proxy auto-config (PAC) file URL.


facelets.REFRESH_PERIOD

Indicates to the compiler the number of seconds to wait between subsequent checks for changes in modified JSF facelets in a running application. Useful for facelet debugging.
To disable this compiler check use a value of -1 which is a recommended value for production deployments as compiler checks have an impact on application performance.
Since Nuxeo 5.6, the parameter undefined should be used instead as it forces this parameter to value "2".

Default Value

-1


nuxeo.db.transactiontimeout

Database transaction timeout in seconds (available for Tomcat server only)

Default Value

300


server.status.key

Secure key for connecting to server status monitoring servlet. It is randomly generated if not set.
It is also used by default for sensitive configuration data encryption, see server.crypt.secretkey.


session.timeout

Session timeout (see web.xml session-timeout).

Default Value

60


session.config.tracking.mode.cookie

Since Nuxeo 10.2

Session tracking mode.
If true, prevents Tomcat from appending the jsessionid parameter to the URLs, for example a file download URL. Yet, cookies need to be enabled in the browser.
Otherwise, the jsessionid parameter might be appended to some URLs, for instance when sharing a document permalink to an anonymous user or when clearing the browser's cookies. Yet, cookies don't need to be enabled in the browser.

Default Value

true


nuxeo.updatecenter.disabled

Disables the Update Center feature.

Default Value

false (unset)


org.nuxeo.big.file.size.limit

Redirects onto the big file download URL if size exceeds limit.

Default Value

5Mi (unset)


org.nuxeo.ecm.platform.ui.web.auth

.NuxeoAuthenticationFilter.isLoginNotSynchronized

Disables login synchronization.

Default Value

false (unset)


nuxeo.wizard.packages.url

Defines the base URL used by the Setup Wizard to get the packages.xml file describing the available software packages options.


nuxeo.wizard.skippedpages

Comma separated list of pages that should be skipped inside the wizard.

Default Value

null


nuxeo.jsf. numberOfConversationsInSession

Since Nuxeo 5.7.2

Since Nuxeo 5.7.2, Parameter to control the number of conversation states that are saved in session. Each conversation holds a number of view states that is defined by nuxeo.jsf.numberOfViewsInSession

Default Value

4


nuxeo.jsf.numberOfViewsInSession

Since Nuxeo 5.7.2

Since Nuxeo 5.7.2 (5.6-HF20) Parameter to control the JSF init parameter com.sun.faces.numberOfViewsInSession

Default Value

4


nuxeo.jsf.numberOfLogicalViews

Since Nuxeo 5.7.2

Since Nuxeo 5.7.2 (5.6-HF20) Parameter to control the JSF init parameter com.sun.faces.numberOfLogicalViews

Default Value

4


nuxeo.jsf.tmp.dir

Since Nuxeo 6.0

Since Nuxeo 6.0. Faces Servlet multi-part config: an absolute path to a directory on the file system. The location attribute does not support a path relative to the application context. This location is used to store files temporarily while the parts are processed or when the size of the file exceeds the specified fileSizeThreshold setting. The default location is "".

Default Value

nuxeo.tmp.dir (unset)


nuxeo.jsf.maxFileSize

Since Nuxeo 6.0

Since Nuxeo 6.0. Faces Servlet multi-part config: the maximum size allowed for uploaded files, in bytes. The default size is unlimited.

Default Value

-1 (unlimited) (unset)


nuxeo.jsf.maxRequestSize

Since Nuxeo 6.0

Since Nuxeo 6.0. Faces Servlet multi-part config: the maximum size allowed for a multipart/form-data request, in bytes. The default size is unlimited.

Default Value

-1 (unlimited) (unset)


nuxeo.jsf.fileSizeThreshold

Since Nuxeo 6.0

Since Nuxeo 6.0. Faces Servlet multi-part config: The file size in bytes after which the file will be temporarily stored on disk. The default size is 0 bytes.

Default Value

0 (unset)


nuxeo.vcs.use-nulls-last-on-desc

Since Nuxeo 5.8

Since Nuxeo 5.8. Ask the database to use "NULLS LAST" when sorting DESC. True by default to get the same result order between different databases.
Also turning this option to false enable PostgreSQL and Oracle to use an index on the sorted column which can be huge performance improvement.

Default Value

true (unset)


org.nuxeo.connect.connector.cache.duration

Since Nuxeo 5.6

Since Nuxeo 5.6. Nuxeo Packages list cache (in minutes).

Default Value

60min (5min for Studio packages)


org.nuxeo.connect.server.reachable

Since Nuxeo 5.7

Since Nuxeo 5.7. Launcher online/offline mode for connections to Nuxeo Connect.

Default Value

true


org.nuxeo.connect.url

Nuxeo Connect URL.

Default Value

https://connect.nuxeo.com/nuxeo/site/


nuxeo.automation.properties.multiline.escape

Enable/Disable multi-line strings escaped with a trailing \ when using Document.Update or Workflow.SetWorkflowVariables Automation operations.

Default Value

false


org.nuxeo.cmis.joins

Since Nuxeo 6.0

Since Nuxeo 6.0. When true, CMISQL JOINs are allowed if VCS is used.

Default Value

false


org.nuxeo.cmis.proxies

Since Nuxeo 7.10-HF08 and Nuxeo 8.3

If false, proxies are not visible through CMIS. Cannot be true if org.nuxeo.cmis.joins is true.

Default Value

true


org.nuxeo.cmis.enableComplexProperties

Since Nuxeo 7.1

Since Nuxeo 7.1. When true, complex properties are exposed as JSON-encoded strings.

Default Value

false


nuxeo.security.allowNegativeACL

Since Nuxeo 6.0

Since Nuxeo 6.0. When true, enables adding negative ACL (deny permissions) in the UI, otherwise only grant permissions are available.

Default Value

false


audit.elasticsearch.enabled

Since Nuxeo 7.3

Since Nuxeo 7.3. See Disabling Elasticsearch for Audit Logs.
Defaults to false on server upgrade, true on new install.

Default Value

false | true


audit.elasticsearch.indexName

Since Nuxeo 7.10

Name of the Elasticsearch index for audit logs.

Default Value

${elasticsearch.indexName}-audit


seqgen.elasticsearch.indexName

Since Nuxeo 7.10

Name of the Elasticsearch index for the uid sequencer.

Default Value

${elasticsearch.indexName}-uidgen


audit.elasticsearch.migration

Since Nuxeo 7.3

Since Nuxeo 7.3. See Triggering SQL to Elasticsearch Audit Logs Migration

Default Value

false


audit.elasticsearch.migration.batchSize

Since Nuxeo 7.3

Since Nuxeo 7.3. See Triggering SQL to Elasticsearch Audit Logs Migration

Default Value

1000


elasticsearch.httpReadOnly.baseUrl

Since Nuxeo 7.10

Required when using a standalone Elasticsearch instance. See Elasticsearch Passthrough

Default Value

http://localhost:9200/


org.nuxeo.cmis.elasticsearch

Since Nuxeo 7.2

Since Nuxeo 7.2. To send the CMISQL queries to Elasticsearch, set to true.

Default Value

false


nuxeo.redis.enabled

Since Nuxeo 5.8

Set to true to activate Redis.

Default Value

false


nuxeo.redis.host

Since Nuxeo 5.8

Default Value

redishost


nuxeo.redis.port

Since Nuxeo 5.8

Default Value

6379


nuxeo.redis.password

Since Nuxeo 5.8


nuxeo.redis.database

Since Nuxeo 5.8

Default Value

0


nuxeo.redis.timeout

Since Nuxeo 5.8

Default Value

2000


nuxeo.redis.maxTotal

Since Nuxeo 8.2

The maximum size of the Redis connections pool.

Default Value

16


nuxeo.redis.maxIdle

Since Nuxeo 8.2

The maximum number of Redis idle connections in the pool.

Default Value

8


nuxeo.redis.prefix

Since Nuxeo 5.8

This allows you to use a single Redis server between several Nuxeo cluster installations by having a different prefix for each cluster. See the page Redis Configuration for more details.

Default Value

nuxeo:


server.crypt.secretkey

Since Nuxeo 7.4

Custom secret key used for sensitive configuration data encryption. It takes either a raw value or an URL (e.g. file:///path/to/secretkey or http://some.online.file.com).

Default Value

${server.status.key}


server.crypt.keystore.path

Since Nuxeo 7.4

Path to the keystore to use for sensitive configuration data encryption.

Default Value

${javax.net.ssl.keyStore}


server.crypt.keystore.pass

Since Nuxeo 7.4

The password used to protect the integrity of the keystore contents.

Default Value

${javax.net.ssl.keyStorePassword:="changeit"}


server.crypt.keyalias

Since Nuxeo 7.4

The alias prefix where to retrieve the secret key from the keystore. It is automatically suffixed with the algorithm ("AES" or "DES").


nuxeo.virtual.host

Since Nuxeo 7.4

This parameter can be used to replace the nuxeo-virtual-host request header (usually when using HTTPS) when it is not possible to set it at the reverse-proxy level.
The use of the header is still preferred as the parameter forces your Nuxeo instance to be accessible from one URL only.
Example: https://my.nuxeo.com/


elasticsearch.enabled

Since 6.0

Switch to enable/disable Elasticsearch usage

Default Value

true


elasticsearch.client

Since 9.3

Choose between TransportClient and RestClient protocols

Default Value

TransportClient


elasticsearch.indexName

Name of the Elasticsearch index for the default document repository

Default Value

nuxeo


elasticsearch.addressList

For TransportClient protocol a comma separated list of Elasticsearch node host:port. For RestClient protocol a comma separated list of URL. If empty an in JVM embedded Elasticsearch node is used, the embedded node is only for testing and it is not supported for production.

elasticsearch.clusterName

Name of the Elasticsearch cluster to join when using a TranportClient protocol

Default Value

nuxeoCluster


elasticsearch.indexNumberOfReplicas

Number of replicas (not for local node)

Default Value

1


elasticsearch.indexNumberOfShards

Number of shards (not for local node)

Default Value

5


elasticsearch.nodeName

Name of the local node

Default Value

nuxeoNode


elasticsearch.httpEnabled

Does the local node accept HTTP request on port 9200

Default Value

false


elasticsearch.override.pageproviders

Comma separated list of CorePageProvider names to supersede by Elasticsearch

Default Value

default_search,DEFAULT_DOCUMENT_SUGGESTION


elasticsearch.reindex.bucketReadSize

Reindexing option, number of documents to process per worker

Default Value

500


elasticsearch.reindex.bucketWriteSize

Reindexing option, number of documents to submit to Elasticsearch per bulk command

Default Value

50


elasticsearch.indexing.maxThreads

Maximum size of the indexing thread pool

Default Value

4


elasticsearch.indexing.clearCompletedAfterSeconds

Time to keep the completed indexing worker states

Default Value

90


elasticsearch.adminCenter.displayClusterInfo

Display Elasticsearch cluster and nodes information in the admin center @since 6.0-HF06, always true for embedded mode

Default Value

false


elasticsearch.reindex.onStartup

Reindex the repository content on startup if the index is empty

Default Value

false


elasticsearch.restClient.connectionTimeoutMs

Since 9.10

A timeout in milliseconds until a connection is established

Default Value

5000


elasticsearch.restClient.socketTimeoutMs

Since 9.10

A maximum period, in milliseconds, of inactivity between two consecutive data packets

Default Value

20000


elasticsearch.restClient.username

Since 9.10-HF01

A username for client basic authentication


elasticsearch.restClient.password

Since 9.10-HF01

A password for client basic authentication


elasticsearch.restClient.keystorePath

Since 9.10-HF01

A path to a valid keystore


elasticsearch.restClient.keystorePassword

Since 9.10-HF01

The keystore password


elasticsearch.restClient.keystoreType

Since 9.10-HF01

The type of keystore, e.g. jks

Default Value

Default Java system keystore type


elasticsearch.index.translog.durability

Since 10.3

The translog durability for Elasticsearch indexes. To reduce disk IO and increase performance this can be tuned to async.

Default Value

request


nuxeo.directory.type

Since 6.0

Type of directory, used for LDAP or multi-directory configuration. Possible values are default, ldap, multi.

Default Value

default


nuxeo.user.anonymous.enable

Since 6.0

When LDAP is enabled and this parameter is set to true, allows anonymous login with Guest user

Default Value

false


nuxeo.user.emergency.enable

Since 6.0

When LDAP is enabled and this parameter is set to true, declares an emergency user to connect to Nuxeo in case of LDAP issues

Default Value

false


nuxeo.user.emergency.username

Since 6.0

The username of emergency user when nuxeo.user.emergency.enable is set to true

Default Value

MyAdministrator


nuxeo.user.emergency.password

Since 6.0

The password of emergency user when nuxeo.user.emergency.enable is set to true

Default Value

secret


nuxeo.user.emergency.firstname

Since 6.0

The firstname of emergency user when nuxeo.user.emergency.enable is set to true


nuxeo.user.emergency.lastname

Since 6.0

The lastname of emergency user when nuxeo.user.emergency.enable is set to true


nuxeo.picture.migration.enabled

Since 8.10

When set to false allows to disable the picture migration that is run on startup and that can be slow on big volume.

Default Value

true


nuxeo.dbs.cache.enabled

Since 8.10-HF01

Whether or not the cache is enabled

Default Value

true


nuxeo.dbs.cache.concurrencyLevel

Since 8.10-HF01

Guava cache parameter: Guides the allowed concurrency among update operations. Used as a hint for internal sizing. The table is internally partitioned to try to permit the indicated number of concurrent updates without contention. Because assignment of entries to these partitions is not necessarily uniform, the actual concurrency observed may vary. Ideally, you should choose a value to accommodate as many threads as will ever concurrently modify the table. Using a significantly higher value than you need can waste space and time, and a significantly lower value can lead to thread contention. But overestimates and underestimates within an order of magnitude do not usually have much noticeable impact. A value of one permits only one thread to modify the cache at a time, but since read operations and cache loading computations can proceed concurrently, this still yields higher concurrency than full synchronization.

Default Value

10


nuxeo.dbs.cache.maxSize

Since 8.10-HF01

The maximum size of DBS cache

Default Value

1000


nuxeo.dbs.cache.ttl

Since 8.10-HF01

The expire after write value in minutes

Default Value

10


kafka.enabled

Since 9.3

Switch the default Stream configuration to Apache Kafka

Default Value

false


kafka.zkServers

Since 9.3

Deprecated since 10.2, 9.10-HF04, Nuxeo don't need Zookeeper access

Default Value

localhost:2181


kafka.bootstrap.servers

Since 9.3

host:port comma separated list of Kafka Brokers

Default Value

localhost:9092


kafka.default.replication.factor

Since 10.3

Default replication factor per partition when creating a new Topic

Default Value

1


kafka.topicPrefix

Since 9.3

The prefix applied to any Kafka Topic

Default Value

nuxeo-


kafka.request.timeout.ms

Since 9.3

Request timeout between Nuxeo and a Kafka broker

Default Value

30000


kafka.default.api.timeout.ms

Since 11.1, 10.10-HF22

Default timeout for consumer API related to position

Default Value

120000


kafka.max.poll.interval.ms

Since 9.3

Maximum delay between poll invocation

Default Value

7200000


kafka.max.poll.records

Since 9.3

Maximum number of records to read per poll

Default Value

2


kafka.session.timeout.ms

Since 9.3

Consumers that don't send heartbeat during this delay are removed from the group

Default Value

50000


kafka.heartbeat.interval.ms

Since 9.3

Heartbeat interval

Default Value

4000


kafka.delivery.timeout.ms

Since 11.1, 10.10-HF22

Timeout for a producer to get an acknowledgement

Default Value

120000


kafka.acks

Since 11.1, 10.10-HF22

The number of acknowledgments expected by a producer

Default Value

1


kafka.sasl.enabled

Since 10.3/9.10-HF22

Enable SASL authentication to communicate with Kafka brokers

Default Value

false


kafka.security.protocol

Since 10.3/9.10-HF22

When using SASL authentication, choose the protocol to communicate with brokers, valid values are: PLAINTEXT, SSL, SASL_PLAINTEXT, SASL_SSL

Default Value

SASL_PLAINTEXT


kafka.sasl.mechanism

Since 10.3/9.10-HF22

SASL mechanism used for client connections

Default Value

SCRAM-SHA-256


kafka.sasl.jaas.config

Since 10.3/9.10-HF22

JAAS login context parameters for SASL connections in the format used by JAAS configuration files. See Kafka documentation for more information.


kafka.ssl

Since 10.3/9.10-HF22

Use SSL to communicate with Kafka Broker

Default Value

false


kafka.truststore.path

Since 10.3/9.10-HF22

The location of the trust store file, empty path means no truststore.


kafka.truststore.type

Since 10.3/9.10-HF22

The file format of the trust store file

Default Value

JKS


kafka.truststore.password

Since 10.3/9.10-HF22

The password for the trust store file. If a password is not set access to the truststore is still available, but integrity checking is disabled.


kafka.keystore.path

Since 10.3/9.10-HF22

The location of the key store file used by the client for two-way authentication, empty value means no keystore.


kafka.keystore.type

Since 10.3/9.10-HF22

The file format of the key store file

Default Value

JKS


kafka.keystore.password

Since 10.3/9.10-HF22

The store password for the key store file


nuxeo.stream.chronicle.dir

Since 9.3

The directory where Chronicle Queue files are stored.

Default Value

${nuxeo.data.dir}/data/stream


nuxeo.stream.chronicle.retention.duration

Since 9.3

Default retention for Chronicle Queue Log, default to 4 days.

Default Value

4d


nuxeo.stream.audit.enabled

Since 9.3

Enable the Nuxeo Stream Audit Writer implementation

Default Value

true


nuxeo.stream.audit.log.config

Since 9.3

The Log configuration to use for the Stream Audit Writer

Default Value

audit


nuxeo.stream.audit.batch.size

Since 9.3

The entries batch size to submit the the audit backend

Default Value

25


nuxeo.stream.audit.batch.threshold.ms

Since 9.3

Do not wait more than this threshold if the batch is not full

Default Value

500


nuxeo.stream.work.enabled

Since 9.3

Supersed the default WorkManager with the Sream WorkManager

Default Value

false


nuxeo.stream.work.log.config

Since 9.3

The Log configuration to use for the Stream WorkManager

Default Value

work


nuxeo.stream.work.over.provisioning.factor

Since 9.3

The factor to use on the Work Thread pool size to get the number of Log partition.

Default Value

3


nuxeo.stream.work.computation.filter.enabled

Since 9.10

Filter work with a serialized size that exceed a threshold so they are stored outside of the stream.

Default Value

false


nuxeo.stream.work.computation.filter.thresholdSize

Since 9.10

Threshold in bytes that is used to store work outside of the stream.

Default Value

1000000


nuxeo.stream.work.computation.filter.class

Since 9.10

The class that implement the external storage of large work. Default is using a Transient store, there is also a KeyValue implementation org.nuxeo.ecm.core.work.KeyValueStoreOverflowRecordFilter.

Default Value

org.nuxeo.ecm.core.transientstore.computation.TransientStoreOverflowRecordFilter


nuxeo.stream.work.computation.filter.storeName

Since 9.10

The storage name to use.

Default Value

default


nuxeo.stream.work.computation.filter.storeKeyPrefix

Since 9.10

A key prefix to use on the external storage.

Default Value

bigRecord:


nuxeo.stream.work.computation.filter.storeTTL

Since 9.10

The time to live used the KeyValue storage implementation. This does not apply to the Transient store where the retention is fixed by its configuration.

Default Value

4d


org.nuxeo.runtime.reload_strategy

Since 9.2

The strategy to use when hot reloading Nuxeo Server.
There're two possible values, changing slightly the before/after reload logic:

  • standby: components are stopped, new/former components are deployed/undeployed, components are started
  • restart: components are stopped, then de-activated, new/former components are deployed/undeployed, components are activated, then started

Default Value

standby


We'd love to hear your thoughts!

All fields required