View Source

Not sure whether to install a Remote Agent? See About Agents to understand how Remote Agents interact with your Bamboo server.
Ensure that you have specified the Broker URL, as described in the Bamboo Setup Wizard and the Bamboo 2.0 Upgrade Guide.
Do you have sufficient Agent licenses? See Bamboo licensing for details.
Have you enabled the creation of Remote Agents, as described in Disabling Remote Agents Support.

Ensure that you have Java Runtime Environment 5.0 or later installed on the agent machine.
Have you installed your own remote agent service wrapper or have problems with the service wrapper used by the remote agent supervisor in Bamboo? You may wish to install the Legacy Remote Agent instead.

To install the Bamboo Remote Agent manually,

Step 1. Download and Install the Remote Agent

Create a directory on the agent machine (e.g. bamboo-agent-home), to serve as the "Bamboo agent home" for the remote agent.
On your Bamboo server, click the 'Administration' link in the top navigation bar.
Click the 'Agents' link in the left navigation column.
This will display the 'Agents' screen, showing lists of all Local Agents and all Remote Agents that currently exist in your Bamboo system.
Click the 'Install Remote Agent' button.
The following screen will be displayed:
Click the 'DOWNLOAD Remote Agent JAR' button and save the JAR file to the directory you created in step 1.1.
Note the command under the heading 'Running a Remote Agent' for use in step 2 below.

Step 2. Launch the Remote Agent

Once installed, you can run the remote agent by executing the command line obtained in the previous step. This command will look something like the following:

java -jar bamboo-agent-2.0-SNAPSHOT.jar http://bamboo-host-server:8085/agentServer/

You may wish to configure the remote agent machine to start the Bamboo remote agent automatically when the machine boots. Please consult your operating system documentation for instructions on how to do this.

You can also choose to run the remote agent with different command line parameters, to change where the remote agent stores its data or suppress the self-signed certificate of the server.

Changing where the remote agent stores its data
By default, the remote agent will store its data in a directory called bamboo-agent-home. If you wish to specify a different directory, add the following command line parameter:
-Dbamboo.home=RemoteAgentHome
where RemoteAgentHome is the path to the Bamboo agent home directory you created in step 1.1.
Your command line will look something like this:
java -Dbamboo.home=RemoteAgentHome -jar bamboo-agent-2.0-SNAPSHOT.jar http://bamboo-host-server:8085/agentServer/
Suppressing the self-signed certificate of the server
If your Bamboo server uses SSL, the following instructions will also appear in the 'Running a Remote Agent' section:

You will need to carry out either one of the two options listed above.
The first option of suppressing the self-signed certificate is simple to execute, but will reduce the security of your configuration (as described in the instructions). To suppress the self-signed certificate, add the following command line parameter:
-Dbamboo.agent.ignoreServerCertName=true
Your command line will look something like this:
java -Dbamboo.agent.ignoreServerCertName=true -jar bamboo-agent-2.0-SNAPSHOT.jar http://bamboo-host-server:8085/agentServer/
The second option of adding the self-signed certificate to the trusted certificates in your keystore is the more secure option, but is complex to set up. For detailed instructions of how to do this, please refer to the relevant Sun documentation.

Step 3. Configure the Remote Agent's Capabilities

Please see Configuring Capabilities.

Step 4. (Optional) Rename the Remote Agent

Your new remote agent has been automatically given a default name (e.g. 'Remote Agent on mymachine'). If you wish to rename your new remote agent, please see Editing an Agent's Details.