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:
|
1. Download and install Bamboo EAR-WAR
- 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.
- 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.
- Place the WAR file directly into the
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:
- Find the setenv.bat file.
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:
- Find the setenv.sh file
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:
- Create a file called
bamboo.xml
in your Tomcat installation'sconf/Catalina/localhost
directory. If you have set up a different hostname for your Tomcat instance, please use your specified hostname instead oflocalhost
.Please note, if you are using Tomcat 6 you must create the Catalina and localhost directories.
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.
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
- Shut down and then restart your application server.
- Access your running Bamboo instance on
http://host:port/bamboo
. - Configure Bamboo via the Setup Wizard which will display. Read Running the Setup Wizard for further instructions.