Documentation for Bamboo 4.0.x. Documentation for earlier versions of Bamboo is available too.

The Bamboo EAR-WAR distribution is intended for deployment into an existing J2EE application server. It is assumed that you already know how to deploy a web application on the application server of choice. If not, we recommend that you install the Bamboo distribution.

The following instructions are only indicative of the process and examples are based on installing the Bamboo WAR file on the Apache Tomcat application server. Deployment and configuration will differ from the procedure below if you choose to deploy the Bamboo EAR-WAR distribution on another (unsupported) application server.

Before you begin:
  • Please ensure that you have read the Requirements section of the Bamboo Installation Guide.
  • Deploying multiple Atlassian applications in a single Tomcat container is not supported. We do not test this configuration and upgrading any of the applications (even for point releases) is likely to break it. There are also a number of known issues with this configuration (see this FAQ for more information).

    We also do not support deploying multiple Atlassian applications to a single Tomcat container for a number of practical reasons. Firstly, you must shut down Tomcat to upgrade any application and secondly, if one application crashes, the other applications running in that Tomcat container will be inaccessible.

    Finally, we recommend not deploying any other applications to the same Tomcat container that runs Bamboo, especially if these other applications have large memory requirements or require additional libraries in Tomcat's lib subdirectory.

On this page:

Related pages:

1. Download and install Bamboo EAR-WAR

  1. Download Bamboo WAR for your operating system. Bamboo WAR files for Linux, Mac OS X and Windows are available for download from the Bamboo Download Center. Click the tab for your operating system, click the 'Show all' link to display the WAR file and select the Bamboo WAR file to download.
  2. Deploy onto your application server by using either of the following methods:
    • Place the WAR file directly into the webapps folder of Tomcat. Tomcat will perform all the necessary extractions when it starts.

    • Extract the WAR file to your chosen directory in the webapps folder. This directory is referred to as the installation directory (i.e. <bamboo-install>)

      Extracting the Bamboo WAR

      • Windows users must avoid Win XP's built-in unzip as it doesn't extract all the files. Use a third-party zip extractor like WinZip.
      • Solaris users will need to use GNU tar to handle the long filenames.

(info) By default, the WAR file will extract to a folder called Bamboo-<version>. The name of the directory in the webapps folder will form the URL required to access Bamboo (e.g. Tomcat/webapps/bamboo-1.0/ will become http://host:port/bamboo-1.0/). You may wish to change the directory name for a more concise access URL.

2. Set the Bamboo Home

Set your Bamboo Home Directory. You can do this in one of three ways:

  • Set the bamboo.home property in the file /WEB-INF/classes/bamboo-init.properties to your chosen Bamboo home directory.
  • Pass the Bamboo home directory to the application server as a java opt. (eg. -Dbamboo.home=C:/bamboo/bamboo-home).
  • Specify an environment variable 'BAMBOO_HOME' which specifies the absolute path to your {BAMBOO_HOME} directory.

3. Set jms.broker.uri

If you are going to use Bamboo remote agents, set the following in the /WEB-INF/classes/bamboo-init.properties file:

bamboo.jms.broker.uri=tcp://localhost:54663
  • Replace 'localhost' with the real host name or IP address of your Bamboo server.
  • If port number 54663 is already in use, specify a different port number.

4. Set Java OPTs

You have to set the following Java OPTs on your application server:

  • -server — Ensures that the jvm starts up in server mode. This will perform various optimisation tasks which are beneficial for long-running applications.
  • -Xmx512m — Sets the maximum memory recommended for Bamboo.
  • -XX:MaxPermSize=256m — Sets the maximum permgen memory recommended for Bamboo.
  • -Djava.awt.headless=true — (Unix systems only) This allows AWT to run in headless mode and is required if running Bamboo in non-graphical environments. For more details visit the Sun Developer Network.

In Tomcat, you can set the above Java OPTs as follows:

Windows:

  1. Find the setenv.bat file.

  2. Assign the desired properties to the JAVA_OPTS variable:

    set JAVA_OPTS=-server -XX:MaxPermSize=256m -Dbamboo.home=/opt/bamboo/bamboohome -Xmx512m -Djava.awt.headless=true %JAVA_OPTS%

Linux-based systems:

  1. Find the setenv.sh file

  2. Assign the desired properties to the JAVA_OPTS variable:

    JAVA_OPTS="-server -XX:MaxPermSize=256m -Dbamboo.home=/opt/bamboo/bamboohome -Xmx512m -Djava.awt.headless=true $JAVA_OPTS"
export JAVA_OPTS

5. Edit the Bamboo Context Descriptor (Tomcat)

If you have extracted the WAR file to a directory other than the default directory (e.g. for a Tomcat application server), you need to deploy <bamboo-install> by following the steps below:

  1. Create a file called bamboo.xml in your Tomcat installation's conf/Catalina/localhost directory. If you have set up a different hostname for your Tomcat instance, please use your specified hostname instead of localhost.
    (info)Please note, if you are using Tomcat 6 you must create the Catalina and localhost directories.

  2. Open your new bamboo.xml and add the following:

    <Context path="/bamboo" docBase="c:/applications/bamboo-war/" debug="0" reloadable="true">
</Context>

    (info)If you wish to change the context path to a different name, change both the context path and the name of the xml file.

     

  3. For docBase, specify the <bamboo-install> absolute path that you noted down earlier.

If you are installing Bamboo 3.4 or nerver versions

If installing Bamboo 3.4, or newer versions, please make sure that you apply the Tomcat configuration suggested in this KB Article.

6. Configure Bamboo

  1. Shut down and then restart your application server.
  2. Access your running Bamboo instance on http://host:port/bamboo.
  3. Configure Bamboo via the Setup Wizard which will display. Read Running the Setup Wizard for further instructions.

2 Comments

  1. Jason Huntley

    Sept 13, 2011

    Setting up java options for tomcat as an NT service

    Referencing step 4 "Set Java OPTs", the instructions will not be enough if you choose to run bamboo as a service. The jvm options are set separately for the nt service. You must modify your service.bat file before installing the nt service. This file resides in the tomcat/bin directory with the other startup.bat and shutdown scripts. Scroll down to the following section:

    "%EXECUTABLE%" //US//%SERVICE_NAME% ++JvmOptions "-Djava.io.tmpdir=%CATALINA_BASE%\temp;-Djava.util.logging.manager=org.apache.juli.ClassLoaderLogManager;-Djava.util.logging.config.file=%CATALINA_BASE%\conf\logging.properties" --JvmMs 128 --JvmMx 256

    Modify this line to match the following:

    "%EXECUTABLE%" //US//%SERVICE_NAME% ++JvmOptions "-Djava.io.tmpdir=%CATALINA_BASE%\temp;-Djava.util.logging.manager=org.apache.juli.ClassLoaderLogManager;-Djava.util.logging.config.file=%CATALINA_BASE%\conf\logging.properties" ++JvmOptions="-XX:MaxPermSize=256m" ++JvmOptions="-XX:+CMSClassUnloadingEnabled" ++JvmOptions="-XX:+CMSPermGenSweepingEnabled" --JvmMs 512 --JvmMx 1024 --JvmSs 1024

    The MaxPermSIze is required for resolving the java.lang.OutOfMemoryError: PermGen space exceptions. The initial memory, jvmMs, should definitely be set to 512Mb for bamboo and extended, JvmMx, to 1024Mb. The thread stack size, JvmSs, should also be set to 1024(value is read in Kb).

    Once those option updates are complete, you may proceed to install tomcat as a service by running: "service.bat install Bamboo".

  2. Seravy

    May 14, 2012

    If you installed tomcat via the windows service .exe installer (eg apache-tomcat-7.0.27.exe or apache-tomcat-6.0.35.exe) It will automatically create the service which will be too late to specify the service install options like Jason mentioned above. The folowing options can be used on tomcat6 and 7 installs.

    If you are using this installer to set the 3 options open the config menu (Run 'Moniter Tomcat' or run '"C:\Program Files\Apache Software Foundation\Tomcat 7.0\bin\Tomcat7w.exe" //ES//Tomcat7' updating your path and/or service name)

    On the 'Java' tab that opens, to set the '-server' option you need to specify the server jvm.dll for 'Java Virtual Machine'. Click browse and hunt for one of the bin\server\jvm.dll files. It should be installed with the JDK, for example 'C:\Program Files\Java\jdk1.7.0_04\jre\bin\server\jvm.dll' or 'C:\Program Files\Java\jre7\bin\server\jvm.dll'. It may have already found the server jvm.dll by default but check to make sure it doesn't say 'client\jvm.dll'

    The other two options:

    -Xmx512m
    -XX:MaxPermSize=256m

    Can be added to the bottom of the Java Options text box. Perhaps that is that the three memory related text boxes below that are for but setting the java options seem to work. (smile)

    Hit OK and then start the service. If it doesn't start check your logs for stderr and see what option wasn't supported or any related errors. Othewise it should start fine.



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.