This documentation relates to an earlier version of Bamboo.
View

Unknown macro: {spacejump}

or visit the current documentation home.

The default settings on a number of Bamboo functions can be configured by setting the appropriate system properties. This page provides general instructions on how to set a system property in Bamboo.

Please ensure that Bamboo is shut down before modifying any of its system properties. Once you have modified one or more system properties, they will come into effect when Bamboo is restarted.

Running Elastic Agents?

If you have any elastic agents running, ensure that they are shut down before you restart the Bamboo server. If you do not shut down your elastic instances before restarting, they will continue to run and become orphaned from your Bamboo server.

Bamboo on UNIX-based operating systems (such as Solaris, Linux or Mac OS X) can be started by either executing the bamboo.sh script or using the Java Service Wrapper packaged with Bamboo.

Bamboo on Windows-based operating systems can be started by running the startup.bat file from the command line (which is the same as running the 'Start in Console' option from the Windows Start menu) or as a Windows Service. Both approaches start Bamboo using the Java Service Wrapper.

You can configure a Bamboo system property using either of the following approaches:

Configuring a Bamboo system property via the bamboo.sh file (UNIX-based operating systems only)

To configure a system property via the bamboo.sh file,

  1. Open the Bamboo start-up script bamboo.sh in a text editor. (This is usually located at the root of your Bamboo installation directory.)

  2. Locate the variable RUN_CMD in bamboo.sh and add the system property as a parameter to the java command string value of RUN_CMD, by adding the '-D' prefix to the system property.

    For example, if you wanted to set the bamboo.agent.heartbeatInterval system property to 10 (seconds), you would add the parameter -Dbamboo.agent.heartbeatInterval=10 to the java command string value of RUN_CMD such that the RUN_CMD variable assignment in bamboo.sh might look like: 

    RUN_CMD="java -server -Xms256m -Xmx512m -XX:MaxPermSize=256m -Dbamboo.agent.heartbeatInterval=10 -Djava.awt.headless=true -classpath $CLASSPATH -Dorg.mortbay.xml.XmlParser.NotValidating=true -Djetty.port=8085 com.atlassian.bamboo.server.Server 8085 ./webapp /"
  3. Save your changes to the bamboo.sh file and (re-)start Bamboo.

Configuring a Bamboo system property via the Java Service Wrapper wrapper.conf configuration file

To configure a system property via the Java Service Wrapper wrapper.conf configuration file,

  1. Open the Bamboo Wrapper configuration file wrapper.conf in a text editor. (This is usually located in the conf subdirectory of your Bamboo installation directory.)

  2. Locate the set of variables beginning wrapper.java.additional.X, where X is a series of consecutive numbers starting from '1'. After the final wrapper.java.additional.X variable in this set, add a new variable wrapper.java.additional.Y, where Y is the next consecutive number in this set of variables.

  3. Add the entire system property with the Java '-D' prefix and assign it to the value of wrapper.java.additional.Y.

    For example, if you wanted to set the bamboo.agent.heartbeatInterval system property to 10 (seconds), you would add a new variable wrapper.java.additional.4 to wrapper.conf and assign it the value -Dbamboo.agent.heartbeatInterval=10, such that this section of the wrapper.conf file might look like: 

    wrapper.java.additional.1=-Dorg.mortbay.xml.XmlParser.NotValidating=true
wrapper.java.additional.2=-XX:MaxPermSize=256m
wrapper.java.additional.3=-Djava.awt.headless=true
# And now for the new variable:
wrapper.java.additional.4=-Dbamboo.agent.heartbeatInterval=10
  4. Save your changes to the wrapper.conf file and (re-)start Bamboo.

For general information on configuring Bamboo parameters on start up, please refer to Configuring Bamboo on start-up.

  • No labels



Log a request with our support team.



Raise an issue for our developers.



See answers from the community.



Blog and update our documentation.

Except where otherwise noted, content in this space is licensed under a Creative Commons Attribution 2.5 Australia License.