This page last changed on Dec 28, 2010 by jlargman.

This page describes how to set Java properties and options on startup for Confluence Stand-alone and EAR/WAR versions.

See Fix Out of Memory Errors by Increasing Available Memory for specific instructions for OutOfMemory Errors.

On this page:

Linux

To Configure System Properties in Linux Installations,
  1. From <confluence-install>/bin (Stand-alone) or <Tomcat-home>/bin (EAR-WAR installation), open setenv.sh.
  2. Find the section JAVA_OPTS=
  3. Refer to the list of parameters below.

Add all parameters in a space-separated list, inside the quotations.

Windows (starting from .bat file)

To Configure System Properties in Windows Installations When Starting from the .bat File,
  1. From <confluence-install>/bin (Stand-alone) or <Tomcat-home>/bin (EAR-WAR installation), open setenv.bat.
  2. Find the section set JAVA_OPTS=%JAVA_OPTS%
  3. Refer to the list of parameters below.

Add all parameters in a space-separated list. Make sure to keep the string %JAVA_OPTS% in place.

Windows Service

There are two ways to configure system properties when you Start Confluence Automatically on Windows as a Service, either via command line or in the Windows Registry

Setting Properties for Windows Services via Command Line

Setting Properties for Windows Services via Command Line
  1. Identify the name of the service that Confluence is installed as in Windows ( Control Panel > Administrative Tools > Services ):

    In the above example, the SERVICENAME is: JIRA030908110721. Find the Confluence equivalent.
  2. Open the command window from Start >> Run >> type in 'cmd' >> Enter
  3. cd to the bin directory of your Confluence Standalone instance, or the bin directory of your Tomcat installation if your are running Confluence EAR/WAR.
  4. Run:
    tomcat6w //ES//%SERVICENAME%
    .
    In the above example, it would be tomcat6w //ES//JIRA030908110721
  5. Click on the Java tab to see the list of current start-up options:
  6. Append any new option on its own new line by adding to the end of the existing Java Options. Refer to the list of parameters below.

Setting Properties for Windows Services via the Windows Registry

In some versions of Windows, there is no option to add Java variables to the service. In these cases, you must add the properties by viewing the option list in the registry.

To Set Properties for Windows Services via the Windows Registry,
  1. Go to {{Start >> Run, and run "regedit32.exe".
  2. Find the Services entry:
    32-bit: HKEY_LOCAL_MACHINE >> SOFTWARE >> Apache Software Foundation >> Procrun 2.0 >> Confluence
    64-bit: HKEY_LOCAL_MACHINE >> SOFTWARE >> Wow6432Node >> Apache Software Foundation >> Procrun 2.0 >> Confluence
  3. To change existing properties, especially increasing Xmx memory, double-click the appropriate value.
  4. To change additional properties, double-click options.
  5. Refer to the list of parameters below. Enter each on a separate line.

Verifying Your Settings

To see what Confluence is using, check Viewing System Properties.

Recognised System Properties

Property Since Default Value Module... Effect
atlassian.forceSchemaUpdate 1.0 true atlassian-config By default, Confluence will only run its database schema update when it detects that it has been upgraded. This flag will force Confluence to perform the schema update on system startup.
confluence.home 1.0 Any filesystem path Confluence and atlassian-config If this system property is set, Confluence will ignore the contents of the confluence-init.properties file, and use this property as the setting for the Confluence Home directory.
confluence.devmode 1.0 true Confluence Enables additional debugging options that may be of use to Confluence developers (additionally it changes spring bean creation to use lazy initialization by default to decrease startup time). Do not enable this flag on a production system.
confluence.disable.mailpolling 2.4 false Confluence If set to "true", will prevent Confluence from retrieving mail for archiving within spaces. Manually triggering "check for new mail" via the web UI will still work. This property has no effect on outgoing mail
confluence.i18n.reloadbundles 1.0 true Confluence Setting this property will cause Confluence to reload its i18n resource bundles every time an internationalised string is looked up. This can be useful when testing translations, but will make Confluence run insanely slowly.
confluence.ignore.debug.logging 1.0 true Confluence Confluence will normally log a severe error message if it detects that DEBUG level logging is enabled (as DEBUG logging generally causes a significant degradation in system performance). Setting this property will suppress the error message.
confluence.jmx.disabled 3.0 false Confluence If set to "true", will disable Confluence's JMX monitoring. This has the same effect as setting the "enabled" property to false in WEB-INF/classes/jmxContext.xml
confluence.optimize.index.modulo 2.2 20 Confluence Number of index queue flushes before the index is optimised.
confluence.plugins.bundled.disable 2.9 false Confluence Starts confluence without bundled plugins. May be useful in a development environment to make Confluence start quicker, but since bundled plugins are necessary for some of Confluence's core functionality, this property should not be set on a production system.
atlassian.mail.fetchdisabled 3.5 false Confluence Disables mail fetching services for IMAP and POP
atlassian.mail.senddisabled 3.5 false Confluence and atlassian-mail Disables sending of mail
atlassian.disable.caches 2.4 true atlassian-plugins, atlassian-cache-servlet Setting this property will disable conditional get and expires: headers on some web resources. This will significantly slow down the user experience, but is useful in devlopment if you are frequently changing static resources and don't want to continually flush your browser cache.
org.osgi.framework.bootdelegation 2.10 empty atlassian-plugins Comma-separated list of package names to provide from application for OSGi plugins. Typically required when profiling Confluence. For example: "com.jprofiler.,com.yourkit.".
confluence.diff.pool.size 3.1 20 Confluence Maximum number of concurrent diffs. When that number is exceeded, additional attempts by RSS feeds to create diffs are ignored and logged. (The RSS requests succeed, they are just missing diffs).
confluence.diff.timeout 3.1 1000 Confluence Number of milliseconds to wait for a diff operation (comparing two page versions) to complete before aborting with an error message.
atlassian.user.experimentalMapping 2.10 false Confluence Setting this property changes the relationship between local users and local groups to reduce performance degradation when adding a local user to a local group with a large number of users. Please note, setting this property can slow down other user management functions. We recommend that you set it only if you are experiencing performance problems when adding local users to large local groups. Please refer to CONF-12319, fixed in Confluence 3.1.1.
confluence.import.use-experimental-importer 3.2 false Confluence Setting this property changes Confluence to use the Experimental XML Importer. It is designed to be a more stable implementation but, at the time of the release of 3.2, the importer is largely untested and thus not supported.
atlassian.webresource.disable.minification 3.3 false
atlassian-plugins
Disables automatic minification of JavaScript and CSS resources served by Confluence.
index.queue.thread.count 3.3 See "Effect" Confluence Sets the number of threads to be used for the reindex job. The value has to be in the range of 1 to 10 (inclusive), i.e. at least one thread but no more than 10 threads will be used. There is no default value, i.e.
  • If you don't set index.queue.thread.count, the number of threads to be used are calculated based on the number of objects that need to be reindexed and the number of processors available (a maximum of 10 threads will be used).
  • If you set index.queue.thread.count=2, then two threads will be used to reindex the content (regardless of the number of objects to be reindexed or the number of processors available)
  • If you set index.queue.thread.count=200, then ten threads (the maximum allowed) will be used to reindex the content.
index.queue.batch.size 3.3
1500
Confluence
Size of batches used by the indexer. Reducing this value will reduce the load that the indexer puts on the system, but indexing takes longer. Increasing this value will cause indexing to be completed faster, but puts a higher load on the system. Normally this setting does not need tuning.
password.confirmation.disabled 3.4 false Confluence This property disables the password confirmation functionality that Confluence uses as an additional security measure. With this property set, Confluence will not require password confirmation for the following actions: administrative actions, change of email address and Captcha for failed logins. Disabling password confirmations is useful if you are using a custom authenticator.
confluence.browser.language.enabled 3.5 true Confluence Setting this property to "false" disables the detection of browser language headers, effectively restoring Confluence behaviour to that of earlier releases. Setting this property to "true" enables the detection of the language headers sent by the browser. Confluenc will change the UI language based on the browser headers. See documentation on how users can choose a language preference.

RELATED TOPICS

Recognised System Properties
Fix Out of Memory Errors by Increasing Available Memory


regedt32.png (image/png)
editoptions.png (image/png)
editxmx.png (image/png)
regeditor.png (image/png)
dosprompt.gif (image/gif)
jiraservice.gif (image/gif)
tomcat5w.gif (image/gif)
Document generated by Confluence on Mar 16, 2011 18:28