Bamboo EAR-WAR Installation Guide

The Bamboo EAR/WAR edition is intended for deployment into an existing J2EE application server. It is assumed that you already know how to deploy a webapp on the application server of choice. If not, it is recommended to install the Bamboo Standalone edition.

The following instructions are only indicative of the process and examples are based on installing the Bamboo WAR file on Apache Tomcat. Deployment and configuration will differ based on your webserver.

Step 1. Download and install Bamboo EAR-WAR

1. The Bamboo WAR file is available for download here. Click the 'Show all' link on the downloads page to display the WAR file.
2. Deploy onto your application server. In Tomcat there are two ways you can do this:
   1. Place the WAR file directly into the webapps folder of Tomcat. When Tomcat starts it will perform all the necessary extractions.
   2. Extract the WAR file to your chosen directory in the webapps folder.
      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.
   3. For Tomcat Application servers only : Extract the WAR file into a directory of your choice - this directory is referred to as <bamboo-install>.
      By default the WAR file will extract to a folder called Bamboo-<version>. Note: The name of the directory in the webapps folder will form the URL required to access Bamboo (eg. 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.

Step 2. Set Bamboo Home

You will need to set your Bamboo Home Directory. You can do this in one of three ways:

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

Step 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.

Step 4. Set Java OPTs

It is recommended that you 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 is 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 — For Unix systems. 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
  

Step 5. Edit 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 will 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.)
   Please note, for 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>
   

   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.

Step 6. Restart Server

1. Shut down, and then restart your application server.
2. Bamboo should now be accessible on http://host:port/bamboo.

Step 7. Configure Bamboo

See Running the Setup Wizard.