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.

Step 1. License Details and Setup Method

Screenshot: License Details and Setup Method (click to view larger image)

You must have a valid Bamboo license (evaluation or commercial) to use Bamboo. You can generate your own Bamboo evaluation license from your Atlassian self-service account here. If you have any problems with this, please email sales.

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

• 'Express Installation' — the 'Express Installation' method only requires you to enter the bare minimum of configuration information, as it sets up Bamboo with default settings and an embedded database (HSQL). We recommend that you choose this method if you are evaluating or demonstrating Bamboo.
  • If you choose, the 'Express Installation' method you can skip to 'Step 6. Set Up Administrator User'.
• 'Custom Installation' — the 'Custom Installation' method is much longer, but allows you to configure Bamboo with an external database, customise the default settings, and/or initialise the server with your own data. We recommend that you choose this method if you are setting up a production instance of Bamboo.
  • If you choose, the 'Custom Installation' method, proceed to 'Step 2. General Configuration' below.

Step 2. General Configuration

This step applies to the 'Custom Installation' method only.

Screenshot: General Configuration (click to view larger image)

On this page, you need to 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.

• 'Name' — for more details please see Specifying Bamboo's Title.
• 'Base URL' — for more details please see Specifying Bamboo's URL.
• 'Configuration Directory' — This is where Bamboo will store its configuration files.
• 'Build Data Directory' — This is where Bamboo will store its project data files.
• 'Build Working Directory' — This is where Bamboo will check out project files from source control.
  You may find it simplest to keep the default settings for the above three directories. For more information please see Locating Important Directories and Files.
• 'Broker URL' — This field will only display if you are permitted remote agents under your Bamboo license. The Broker URL is 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.

Step 3. Choose a Database Configuration

This step applies to the 'Custom Installation' method only.

Screenshot: Choose Database Configuration (click to view larger image)

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 HSQL database is only suitable for evaluation purposes. You will need to move to an external database, if you decided to deploy Bamboo in production at a later stage (as described in Moving your Bamboo Data to a different Database).

• 'Embedded Database' — Choose this for quick and easy first-time installation of Bamboo. This option is suitable for evaluation purposes only.
  • If you choose, the 'Embedded Database' method you can skip to 'Step 5. Starting Data'.
    OR:
• 'External Database' — Choose this if you wish to use an external database.
  • If you choose, the 'External Database' method, proceed to 'Step 4. Database Configuration' below.

Step 4. Database Configuration

This step applies to the 'Custom Installation' method only.

Screenshot: Database Configuration (click to view larger image)

If you selected 'External Database' in the previous 'Choose a Database Configuration' screen, you will need to provide the configuration details for your database. Please see Connecting Bamboo to an external database for further instructions.

Step 5. Starting Data

This step applies to the 'Custom Installation' method only.

Screenshot: Starting Data (click to view larger image)

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

• 'Create new Bamboo home' — choose this if you are performing a normal installation or upgrade.
  OR:
• '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.

Step 6. Set Up Administrator User

Screenshot: Set Up Administrator User (click to view larger image)

The final step of the setup wizard is to enter the details of the first registered user to 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 of your administrator user, click the 'Finish' button. The Bamboo dashboard will display.

Congratulations, you have successfully set up Bamboo!

Next Steps

If you are new to Bamboo, we recommend that you read the Bamboo 101 guide. The Bamboo 101 guide will walk you through the key features of Bamboo and how to set up and use them.