Configuring System Properties

This page describes how to set Java properties and options on startup for Confluence.

tip/resting Created with Sketch.

See Fix java.lang.OutOfMemoryError in Confluence for specific instructions for OutOfMemory Errors.

Linux

To configure System Properties in Linux installations:

  1. Edit the <installation-directory>/bin/setenv.sh file. 
  2. Find the section CATALINA_OPTS=
    (this is JAVA_OPTS= in Confluence 5.5 and earlier) 
  3. Refer to the list of parameters in Recognized System Properties.

(info) Add all parameters in a space-separated list, inside the quotations. Make sure to keep the string ${CATALINA_OPTS}" in place.

Windows (starting from .bat file)

To Configure System Properties in Windows Installations When Starting from the .bat File:

  1. Edit the <installation-directory>/bin/setenv.bat file. 
  2. Find the section set CATALINA_OPTS=%CATALINA_OPTS%
    (this is JAVA_OPTS=%JAVA_OPTS% in Confluence 5.5 and earlier) 
  3. Refer to the list of parameters in Recognized System Properties.

(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 Confluence260919000053
  2. Open the command window (Choose Start > cmd.exe
  3. cd to the bin directory of your Confluence instance and run the following command:

    tomcat9w //ES//<SERVICENAME>

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

  4. Click on the Java tab to see the list of current start-up options:
  5. 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 in Recognized System Properties.

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:
    64bit: HKEY_LOCAL_MACHINE >> SOFTWARE >> WOW6432Node >> Apache Software Foundation >> Procrun 2.0 >> Confluence service name
    32bit: HKEY_LOCAL_MACHINE >> SOFTWARE >> 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 in Recognized System Properties. Enter each on a separate line.

Confluence Data Center deployed in AWS

If you've used the Quick Start or CloudFormation template to deploy Confluence Data Center in AWS, you will pass system properties via the Cloud Formation Template, and not using the methods described above. 

  1. In the AWS Console, choose Update Stack
  2. Under Advanced, enter system properties in the Catalina Properties field as follows: 

    -Xms1024m -Xmx1024m -Dsystemproperty=value
  3. Changes are applied when a new nodes are provisioned. 

Verifying your settings

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

Recognized system properties

See Recognized System Properties for the full list of system properties available to your Confluence version. 

Last modified on Nov 29, 2022

Was this helpful?

Yes
No
Provide feedback about this article
Powered by Confluence and Scroll Viewport.