Configuring System Properties

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

See How to fix out of memory errors by increasing available memory for specific instructions for OutOfMemory Errors.

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 CATALINA_OPTS=
  3. Refer to the list of parameters below.

(info) 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 CATALINA_OPTS=%CATALINA_OPTS%
  3. Refer to the list of parameters below.

(info) Add all parameters in a space-separated list. Make sure to keep the string %CATALINA_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

To set properties for Windows Services via a command line:

  1. Identify the name of the service that Confluence is installed as in Windows (Go to Control Panel > Administrative Tools > Services):

    (info) In the above example, the service name is Confluence121213135538
  2. Open the command window (Choose Start > cmd.exe
  3. cd to the bin directory of your Confluence instance (or the bin directory of your Tomcat installation if you are running Confluence EAR/WAR).
  4. Run the following command:

    tomcat7w //ES//<SERVICENAME>

    (info) In the above example, it would be tomcat7w //ES//Confluence121213135538
    The Tomcat version number may be different if you are using an earlier version of Confluence. 

  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.

  1. Go to the Registry Editor (Start > regedit.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 service name
  3. To change existing properties 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

Since

Default Value

Module...

Effect

atlassian.forceSchemaUpdate

1.0

false

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.dev.mode

1.0

false

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.indexing.contentbody.maxsize
3.0   atlassian Confluence stores the body of attachments in the index so the content of attachments are searchable. Set this property to set the maximum indexable size (in bytes).

Limiting the size of attachment indexing decreases the size of the index when large attachments are present and p revents excerpts of large attachments being displayed in search results. It does not limit the size of attachments that can be uploaded.

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.

confluence.html.encode.automatic

2.9

 

Confluence

Setting this property forces the antixss encoding on or off, overriding the behaviour dictated by settings. The default behaviour differs between Confluence versions.

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.

confluence.html.diff.timeout
4.0
10000
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 50 (inclusive), i.e. at least one thread but no more than 50 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 50 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.

Note: For Confluence versions from 3.3 to 5.6 the maximum threads is 10.

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.

upm.pac.disable

Universal Plugin Manager 1.5

false

Universal Plugin Manager (UPM)

When this property is set to true, then UPM will not try to access the The Atlassian Marketplace. This is useful for application servers that do not have access to the Internet. See the UPM documentation.

confluence.reindex.documents.to.pop

3.5.9

20

Confluence

Indicates how many objects each indexing thread should process at a time during a full re-index. Please note that this number does not include attachments

confluence.reindex.attachments.to .pop

3.5.9

10

Confluence

Indicates how many attachments each indexing thread should process at a time during a full re-index.

confluence.upgrade.active.directory

3.5.11

false

Confluence

Forces Confluence to treat any LDAP directories it migrates as Active Directory, rather than relying on looking for sAMAccountName in the username attribute. This is necessary if you are upgrading from before Confluence 3.5, and need to use an attribute other than sAMAccountName to identify your users and are seeing LDAP: error code 4 - Sizelimit Exceeded exceptions in your logs. For more details, see Unable to Log In with Confluence 3.5 or Later Due to 'LDAP error code 4 - Sizelimit Exceeded'

confluence.context.batching.disable
4.0
false
Confluence Disables batching for web resources in contexts (e.g. editor, main, admin). Useful for diagnosing the source of javascript or CSS errors.
com.atlassian.logout.disable.session.invalidation

4.0

false

Confluence

Disables the session invalidation on log out. As of 4.0 the default behaviour is to invalidate the JSession assigned to a client when they log out. If this is set to true the session is kept active (but the user logged out). This may be valuable when using external authentication systems, but should generally not be needed.

officeconnector.spreadsheet.xlsxmaxsize
4.0.5 2097152  Office Connector Indicates the maximum size in bytes of an Excel file that can be viewed using the viewxls macro. If empty, the maximum size defaults to 2Mb. See CONF-21043 for more details.
com.atlassian.confluence.extra.calendar3.display.events.calendar.maxpercalendar
  200 Team Calendars Specifies the maximum number of events per calendar. This property is effective only if the Team Calendars plugin is installed on your Confluence site.
com.atlassian.confluence.allow.downgrade
4.3.2, 5.0-OD-10 false Confluence Allows Confluence to start up against the home directory of a newer version of Confluence. Note that running Confluence like that is unsupported. You should only turn this on if you know what you are doing. See After Downgrading, Confluence Will No Longer Run for details.
confluence.mbox.directory
5.4.1   Confluence Setting this property defines the directory on your Confluence Server where mailboxes can be imported from (for use with the Confluence Mail Archiving add-on). Mailboxes are not able to be imported from any other location. We recommend administrators create a directory in the Confluence Home directory specifically for this purpose. Mail cannot be imported from the server until this system property is set.
confluence.search.max.results
5.5 1000 Confluence Setting this property changes the maximum number of items Confluence Search will return.
confluence.upgrade.recovery.file.enabled
5.5 true Confluence By default, Confluence creates an upgrade recovery file before and after an upgrade. The operation can take long time on large databases and can be safely turned off if there is a process to back up database and verify the backup before performing an upgrade. Setting this property to false will disable upgrade recovery file creation.
confluence.junit.report.directory
5.5   Confluence Setting this property defines the directory on your Confluence Server where JUnit Reports can be imported from (for use in the JUnit Report Macro). No other locations are permitted. We recommend administrators create a directory in the Confluence Home directory specifically for this purpose. JUnit Test result files cannot be imported from the server until this system property is set.
officeconnector.textextract.word. docxmaxsize
5.5.3 16777216 Confluence

This property defines the maximum amount of memory that can be allocated to extracting text from a DOCX file (for the purposes of search etc). The value refers to the amount of text inside the file (in bytes), ignoring any images.

cluster.login.rememberme.enabled
5.6

False

 

In a cluster, setting this property to True will enable the 'Remember Me' checkbox on the login page. This is not recommended in a cluster, and is disabled by default (i.e. 'Remember me' is always on and users can move seamlessly between nodes).

This system property has no effect in standalone Confluence.

confluence.cluster.hazelcast.listenPort
5.6 5801  

In a cluster, this property can be used to override the default port that Hazelcast will bind to, for example, if the port is unavailable, or you need to run more than one node on the same host (not recommended). It defaults to 5801.

Was this helpful?

Thanks for your feedback!

Why was this unhelpful?

Have a question about this article?

See questions about this article

Powered by Confluence and Scroll Viewport