Configuring your system properties

Learn how to set Java system properties and startup options for Bamboo.

On this page:

Linux

To configure system properties in Linux installations:

  1. From <bamboo-install-dir>/bin, open setenv.sh.
  2. Find the section JVM_SUPPORT_RECOMMENDED_ARGS=.
  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 <bamboo-install-dir>\bin, open setenv.bat.
  2. Find the section set JVM_SUPPORT_RECOMMENDED_ARGS=
  3. Refer to the list of parameters below.

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

Docker

For Bamboo running in a Docker container, none of the system properties or startup options you set with setenv.sh will be persisted between container restarts. To persistently set system properties and startup options, recreate the container from the same image, passing the options as a space-separated list inside the JVM_SUPPORT_RECOMMENDED_ARGS="" environment variable directly in the docker run command using the -e, --env or -env-file flags.

For example:

docker run [...] --name="bamboo" -e=JVM_SUPPORT_RECOMMENDED_ARGS="[options]" atlassian/bamboo:<bamboo-version>

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

For more information, see Set environment variables (-e, --env, --env-file) in the Docker Docs.

Windows service

There are two ways to configure system properties when starting Bamboo as a service — either in the command prompt or in the Windows registry.

Setting properties for Windows services from the command line

  1. Identify the name of the service that Bamboo is installed as in Windows (Control panel > Administrative tools > Services):


  2. Open a command prompt by selecting StartRun.
  3. In the Run window, type cmd and press the Enter key.
  4. In the command prompt, navigate to the bin subdirectory of your Bamboo installation directory.
  5. Run the following command:

    bamboow.exe //ES//%SERVICENAME%

    Following the example above, the full command would be:

    bamboow.exe //ES//Bamboo
  6. Select the Java tab to see the list of current start-up options.
  7. 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.

    If you want to change the heap size configured for the JVM, use the Initial memory pool and Maximum memory pool fields instead of adding the -Xms and -Xmx parameters to the list of Java options.

Setting properties for Windows services using 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 using 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 >> Bamboo
    64-bit: HKEY_LOCAL_MACHINE >> SOFTWARE >> Wow6432Node >> Apache Software Foundation >> Procrun 2.0 >> Bamboo
  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.

Changing the Bamboo start port

  1. Stop Bamboo.
  2. Edit <Bamboo install directory>/conf/server.xml
  3. Update the following so that Connector port is set to the port value you require:

     <Service name="Catalina">
            <Connector port="8085"
                       maxThreads="150"
                       minSpareThreads="25"
                       connectionTimeout="20000"
                       enableLookups="false"
                       maxHttpHeaderSize="8192"
                       protocol="HTTP/1.1"
                       useBodyEncodingForURI="true"
                       redirectPort="8443"
                       acceptCount="100"
                       disableUploadTimeout="true"/>
  4. Restart Bamboo.


List of startup parameters

Memory Property

Notes

Related Pages

-Xmx 
-Xms 
XX:MaxPermSize

These properties are pre-existing. See related pages for instructions.

Tuning the Java heap

-XX:+PrintGCTimeStamps -verbose:gc -Xloggc:gc.log -XX:+HeapDumpOnOutOfMemoryError

Set these for Garbage Collection tuning.

Tuning Java VM garbage collection



Last modified on Feb 22, 2024

Was this helpful?

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