This page describes how to install the Bamboo Remote Agent manually. Before you begin:
|
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' link. The following screen will be displayed:
Screenshot above: Installing a remote agent - 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:
The name of the jar file (e.g. atlassian-bamboo-agent-installer-2.2-SNAPSHOT.jar) will vary depending on the version of Bamboo you are running.
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.
![]() | If you are having issues bringing up the Agent, then take a look at our troubleshooting guide. |
Changing where the remote agent stores its data
By default, the remote agent will store its data in a USER_HOME/ where RemoteAgentHome is the path to the Bamboo agent home directory you created in step 1.1.
|
Changing the logging on the remote agent
By default, the remote agent will use the same logging level as the Bamboo server. However, you can control the level of logging of your remote agent independently of your Bamboo server by setting up a separate logging configuration file. Please see Logging in Bamboo for further details. |
Suppressing the self-signed certificate of the server
If your Bamboo server uses SSL (https) with a self-signed certificate, you will need to carry out one of the following two options:
|
Running Bamboo without the Remote Agent Supervisor
The remote agent supervisor is included in the remote agent JAR bundled with Bamboo. The appropriate remote agent supervisor for the operating system of your remote machine, will be automatically installed when you run the default remote agent start-up command line.
If you need to run the remote agent without running the remote agent supervisor, you can execute the 'classic' version of the remote agent JAR.
|
Running the remote agent with different start-up commands
The remote agent supervisor is executed by default when you run the default remote agent start-up command line. The remote agent supervisor is implemented via a Java Service wrapper. The wrapper allows you to execute a number of general start-up commands when the remote agent is run. These commands are appended to the end of the default remote agent start-up command line, where <wrapper_command> is one of the keywords described below:
|
(Windows only) Installing the remote agent as a Windows service
The remote agent supervisor is executed by default when you run the default remote agent start-up command line. The remote agent supervisor is implemented via a Java Service wrapper. The wrapper allows you to install or uninstall the remote agent as a service in Windows (i.e. start the Bamboo remote agent automatically when the machine boots). This is done by appending the appropriate wrapper commands to the end of the default remote agent start-up command line, where <wrapper_command> is one of the keywords described below:
If you have installed the NT service, you will be able to use the |
![]() | The remote agents connect to the Bamboo server on the normal http/https port and 54663. You need to ensure that, the network firewall isn't blocking these ports. If you're having issues connecting the Remote Agent with Server, please this Troubleshooting Guide |
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.