Running the Setup Wizard

When you launch Bamboo for the first time, the Bamboo setup wizard will display. The wizard will lead you through the Bamboo settings that you need to configure before you can start using it.

Before you begin

If you are currently using Atlassian's Crowd with Bamboo and wish to import existing data into Bamboo (see Step 5. Starting Data below), you will need to disable Crowd before starting the Setup Wizard. To do this, go to Administration > User Repositories (under 'Security') and choose Local users and groups.

You can then re-enable Crowd and restart Bamboo at the completion of the Setup Wizard.

Step 1. License Details and Setup Method

You must have a valid Bamboo license (evaluation or commercial) to use Bamboo. You can generate your own Bamboo evaluation license from your MyAtlassian self-service account here.

Once you have entered a valid license key, you can choose which setup method you prefer for your Bamboo installation:

  • Express Installation — use this method if you are evaluating or demonstrating Bamboo.
    • The 'Express Installation' method requires only a minimum of configuration information. It sets up Bamboo with default settings and an embedded database (H2). 
    • If you choose the 'Express Installation' method you can skip to Step 6. Set Up Administrator User below.

Custom Installation — use this method if you are setting up a production instance of Bamboo.

    • The 'Custom Installation' method takes longer, but allows you to configure Bamboo with an external database, customize the default settings, and/or initialize the server with your own data.
    • If you choose, the 'Custom Installation' method, proceed to Step 2. General Configuration below.

Screenshot: License Details and Setup Method

Step 2. General Configuration

(info) This step applies to the 'Custom Installation' method only.

On this page you specify a number of Bamboo server settings, such as the address of the server, where data is stored and the message broker used to communicate with remote agents.

(warning) You may find it simplest to keep the default settings for the three directory settings, in the table. For more information please see Locating important directories and files.

NameSee Specifying Bamboo's Title
Base URLSee Specifying Bamboo's URL
Configuration DirectoryThe location for Bamboo configuration files.
Build Data DirectoryThe location for Bamboo project data files.
Build Working DirectoryThe location of project files checked out from source control.
Broker URL

Only visible if you are permitted remote agents under your Bamboo license.

The URL of the embedded messaging broker that Bamboo sets up to communicate with its remote build agents. This URL will be written to bamboo.cfg.xml as a property. You can update this file if you want to change your Broker URL.

  • Replace localhost with the real host name or IP address of your Bamboo server. You should not use localhost as the host name in the Broker URL, as remote agents are provided with the Broker URL on startup and use it to communicate to the server.
  • If port number 54663 is already in use, specify a different port number.
Broker client URLThe URL used by agents to connect to the broker. This URL will be written to bamboo.cfg.xml as a property. You can update this file if you want to change your Broker URL. The default includes an actual IP of the Bamboo server. Specify if the default IP is not reachable from the agents.

Screenshot: General Configuration

Step 3. Choose a Database Configuration

(info) This step applies to the 'Custom Installation' method only.

Picking a database configuration is an important choice. If you pick the 'Embedded Database' configuration, you do not have to set up a database. However, the embedded H2 database is only suitable for evaluation purposes. You will need to move to an external database, if you decide to deploy Bamboo in production at a later stage (as described in Moving your Bamboo data to a different database).

Choose one of the following:

  • Embedded — Choose this for quick and easy first-time installation of Bamboo. This option is suitable for evaluation purposes only. Skip to Step 5. Starting Data.

Screenshot: Choose a Database Configuration

Step 4. Database Configuration

(info) This step applies to the 'Custom Installation' method only.

If you selected 'External Database' in Step 3, you will need to provide the configuration details for your database. Please see Connecting Bamboo to an external database for further instructions.

Screenshot: Database Configuration

Step 5. Starting Data

(info) This step applies to the 'Custom Installation' method only.

Screenshot: Starting Data

On this page you specify how Bamboo will populate the 'home directory' that you set up when you installed Bamboo.

Choose one of the following:

  • Create new Bamboo home — choose this if you are performing a normal installation or upgrade.
  • Import existing data — only choose this under exceptional circumstances, e.g. if you are connecting Bamboo to a different database, or moving your pre-existing Bamboo installation to a different server. Avoid importing backups from different versions of Bamboo.

Step 6. Set Up Administrator User

The final step of the setup wizard is to enter the details of the first registered user for the Bamboo system. This user will have global administrative privileges over the entire installation of Bamboo and should not be removed.

Once you have entered the details for your administrator user, click Finish. The Bamboo dashboard will be displayed.

Congratulations, you have successfully set up Bamboo!

Screenshot: Set Up Administrator User


Last modified on Nov 23, 2020

Was this helpful?

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