Here is a list of available parameters for nuxeo.conf. This list may not be exhaustive but it will be often updated.
Those parameters can be either environment parameters used by Nuxeo runtime or template parameters used for values replacement in configuration files.
| Parameter | Default value ("|" separates possible values) |
Description | |
|---|---|---|---|
| JAVA_HOME | None. If undefined nuxeoctl script will try to discover it. |
Path to Java home directory. | |
| JAVA_OPTS | -Xms512m -Xmx1024m -XX:MaxPermSize=512m -Dsun.rmi.dgc.client.gcInterval=3600000 -Dsun.rmi.dgc.server.gcInterval=3600000 -Dfile.encoding=UTF-8 |
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). |
|
| launcher.start.max.wait | 300 | Since 5.4.1. Maximum time to wait for effective Nuxeo server start before giving up (applies on commands "start" and "restart"). | |
| launcher.stop.max.wait | 60 | Since 5.5. Maximum time to wait for effective Nuxeo server stop cleanly before using forced stop. | |
| launcher.override.java.tmpdir | true | Since 5.4.1. Possible values: true or false If true, will set java.io.tmpdir = nuxeo.tmp.dir. |
|
| nuxeo.log.dir | log | Log directory (absolute or relative to NUXEO_HOME). Linux recommended path: /var/log/nuxeo/... |
|
| nuxeo.pid.dir | bin | Directory where to store Nuxeo PID file. | |
| nuxeo.data.dir | data | Data directory (absolute or relative to NUXEO_HOME). It involves all data not being stored in database. Linux recommended path: /var/lib/nuxeo/... |
|
| nuxeo.tmp.dir | server/default/tmp (JBoss) temp (Tomcat) tmp (Jetty) |
Location of the temporary files. | |
| nuxeo.force.generation | true | once |
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. |
|
| nuxeo.templates | default |
Comma separated list of templates to include. Templates paths are absolute or relative to $NUXEO_HOME/templates/. Available templates: postgresql, mysql, mssql, oracle, custom, ... |
|
| nuxeo.bind.address | 0.0.0.0 | 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". |
|
| nuxeo.server.http.port | 8080 | Server HTTP listen port. | |
| nuxeo.server.ajp.port | 8009 | Server AJP listen port. This is not available on Jetty. |
|
| nuxeo.server.jvmRoute | nuxeo | Server AJP route for load-balancing (since 5.4.2) | |
| nuxeo.server.tomcat-admin.port | 8005 | Deprecated since 5.6. Tomcat server's "admin" port. This is only useful if you have another tomcat server running and want to avoid port conflicts. |
|
| nuxeo.server.tomcat_admin.port | 8005 | Since 5.6. Tomcat server's "admin" port. This is only useful if you have another tomcat server running and want to avoid port conflicts. |
|
| nuxeo.server.https.port | 8443 | Server HTTPS listen port. This is only useful if you have modified the application server to use HTTPS. |
|
| nuxeo.server.emptySessionPath | false |
(Tomcat only) Since 5.5. 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). |
|
| org.nuxeo.ecm.instance.name | Nuxeo 5.4 | Server name. | |
| org.nuxeo.ecm.instance.description | Nuxeo ECM server | Server description. | |
| org.nuxeo.ecm.product.name | Nuxeo Platform | Product name, displayed in the page title on your browser. | |
| org.nuxeo.ecm.product.version | 5.5 | ||
| org.nuxeo.ecm.webapp.dashboard.mode | auto |
Defines the dashboard mode. There are 3 modes:
|
|
| templateName.target | server/default/deploy/nuxeo.ear | Directory where templateName files will be deployed. | |
| mailservice.user | nobody | (JBoss only) User for mail authentication. | |
| mailservice.password | password | (JBoss only) Password for mail authentication. | |
| mail.store.protocol mail.transport.protocol |
pop3 smtp |
Server protocol parameters for mailing. | |
| mail.user | nobody | User who will receive mail (unused in Nuxeo). | |
| mail.store.host | localhost | Mail server. | |
| mail.store.user | anonymous | ||
| mail.store.password | password | ||
| mail.debug | false | Enable debugging output from the javamail classes. | |
| nuxeo.notification.eMailSubjectPrefix | [Nuxeo] | Subject prefix in Nuxeo notification mails. | |
| mail.transport.host | localhost | SMTP gateway server. | |
| mail.transport.port | 25 | Mail server port. | |
| mail.transport.usetls | false | Use TLS for the SMTP connection. | |
| mail.transport.auth | true | ||
| mail.transport.user | anonymous | ||
| mail.transport.password | password | ||
| mail.from | noreply@nuxeo.com | The address mails will be sent from. | |
| nuxeo.db.name | nuxeo | NUXEO | Database name. | |
| nuxeo.db.user | sa | nuxeo | Database username. | |
| nuxeo.db.password | (empty value) | password | Database password. | |
| nuxeo.db.host | localhost | Database host URL. | |
| nuxeo.db.port | 3306 | 1521 | 5432 | Database host port. | |
| nuxeo.db.jdbc.url | (database-dependent) | Database JDBC connection URL for Nuxeo datasources, for instance jdbc:postgresql://${nuxeo.db.host}:${nuxeo.db.port}/${nuxeo.db.name}. | |
| 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 | 5 | Database minimum pool size for Nuxeo datasources. | |
| nuxeo.db.max-pool-size | 20 (JBoss) 100 (Tomcat) |
Database maximum pool size for Nuxeo datasources. | |
| nuxeo.vcs.min-pool-size | 0 | Database minimum pool size for Nuxeo repository (VCS). | |
| nuxeo.vcs.max-pool-size | 20 | Database maximum pool size for Nuxeo repository (VCS). | |
| nuxeo.url | http://localhost:8080/nuxeo | Application URL (without final slash) | |
| nuxeo.loopback.url | http://localhost:8080/nuxeo | Since 5.4.1. Nuxeo URL, for connections from Nuxeo to itself (theme banks default). The port should be the same as nuxeo.server.http.port Since 5.5, if not explicitly configured, the loop back URL is generated from nuxeo.bind.address, nuxeo.server.http.port and org.nuxeo.ecm.contextPath values. |
|
| org.nuxeo.ecm.contextPath | /nuxeo | Application context path. Before 5.6, you also have to accordingly rename all occurrences of nuxeo.xml (for Tomcat) |
|
| org.nuxeo.ecm.platform.transform.ooo.host.name | 127.0.0.1 | DEPRECATED. | |
| org.nuxeo.ecm.platform.transform.ooo.host.port | 8100 | DEPRECATED. | |
| org.nuxeo.ecm.platform.transform.ooo.version | 2.2.1 | DEPRECATED. | |
| org.nuxeo.ecm.platform.transform.ooo.enableDaemon | true | DEPRECATED. | |
| jod.connection.protocol | SOCKET | OpenOffice Connection protocol, either PIPE or SOCKET. | |
| jod.max.tasks.per.process | 200 | Maximum task per Office instance before restarting it | |
| jod.task.execution.timeout | 120000 | Will stop the task if it s not completed after timeout. | |
| jod.task.queue.timeout | 30000 | Will stop looking for the next task in the queue after timeout. | |
| jod.office.home | Home directory of OpenOffice or LibreOffice. |
||
| jod.office.ports | 2003 | Since 5.5. When running in SOCKET mode, comma-separated list of ports used for the office connection. | |
| jod.office.pipes | Since 5.5. When running in PIPE mode, comma-separated list of pipe names used for the office connection. | ||
| jod.jpipe.lib.path | Path to Jpipe library. Only used when connecting to OO through PIPE. | ||
| jod.template.profile.dir | Path to custom OO template directory. | ||
| opensocial.gadgets.host | localhost | ||
| opensocial.gadgets.port | 8080 | ||
| opensocial.proxy.proxySet | false | DEPRECATED since 5.6 | |
| opensocial.proxy.proxyHost | DEPRECATED since 5.6 (use default nuxeo.http.proxy.host) | ||
| opensocial.proxy.proxyPort | DEPRECATED since 5.6 (use default nuxeo.http.proxy.port) | ||
| opensocial.proxy.user | DEPRECATED since 5.6 (use default nuxeo.http.proxy.login) | ||
| opensocial.proxy.password | DEPRECATED since 5.6 (use default nuxeo.http.proxy.password) | ||
| repository.clustering.enabled | false | Activate clustering mode. | |
| repository.clustering.delay | 1000 | When clustering is activated, defines the delay during which invalidations don't need to be processed (expressed in milliseconds). | |
| 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.templates.parsing.extensions | xml,properties | Deprecated since 5.6. Files extensions being parsed for parameters replacement when copying templates. | |
| nuxeo.plaintext_parsing_extensions | xml,properties | Since 5.6. Files extensions being parsed for parameters replacement when copying templates. | |
| org.nuxeo.ecm.jboss.configuration | default | 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). |
|
| zip.entry.encoding | ascii | Choose how to encode filename when exporting documents to zip in the worklist. | |
| org.nuxeo.ecm.platform.liveedit.autoversioning | none,minor,major | see Configuration examples | |
| nuxeo.wizard.done |
true or false depending on the package |
If set to false, will start a setup wizard before starting Nuxeo. |
|
| 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. |
||
| facelets.REFRESH_PERIOD |
-1 |
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. |
|
| nuxeo.db.transactiontimeout |
300 | Database transaction timeout in seconds (available for server tomcat only - Since 5.5) |
|
| server.status.key | Since 5.5. Secure key for connecting to server status monitoring servlet. It is randomly generated if not set. | ||
| session.timeout | 60 | Since 5.5. Session timeout (see web.xml session-timeout). | |
| nuxeo.updatecenter.disabled | false (unset) | Since 5.5, Disable the Update Center feature. | |
| theme.useOldLocalConfiguration | false (unset) | Since 5.5, Use the old local configuration for theme, selecting a theme page instead of a flavor. | |
| org.nuxeo.big.file.size.limit | 5Mi (unset) | Since 5.4.1, redirect onto the big file download url if size exceed limit | |
| org.nuxeo.ecm.platform.ui.web.auth .NuxeoAuthenticationFilter.isLoginNotSynchronized |
false (unset) | Since 5.5, disable login synchronization | |
| nuxeo.wizard.packages.url | Since 5.5, defines the base url used by the Setup Wizard to get the packages.xml file describing the available software packages options | ||
| nuxeo.wizard.skippedpages | null | Since 5.5, comma separated list of pages that should be skipped inside the wizard | |
| nuxeo.pageprovider.default-max-page-size | 100 |
Since 5.6 (5.5-HF06 and 5.4.2-HF20), defines the default maxPageSize to use in pageProvider when no value is defined in the pageProvider contribution. Value '0' means no limit. |
| Related content |
|---|
| Page: Configuration examples |
| Page: Configuration templates |
| Page: Recommended configurations |
Labels: