BuildMaster Documentation

Agent Installation Guide

To facilitate communication between BuildMaster and the Windows servers you want to deploy to and orchestrate, BuidMaster uses a lightweight agent with a highly-optimized and resilient protocol. Installing agents is even easier than installing BuildMaster, and this guide will provide a step-by-step guide, as well provide some detail as to what's happening behind the scenes.

1. Pre-Installation Check List

BuildMaster agents don't have any intense server requirements, and support all modern version of Windows (7+/2008+). Before installing, consider the following:

  • .NET Framework 4.5 – BuildMaster requires .NET 4.5 or later; this is already installed on Windows Server 2012, and you can download it from Microsoft on earlier servers
  • Firewall (Inbound) – the agent will listen on the port of your choosing (defaults are 6846 for IIS and 6468 for self-hosted)

2. Download BuildMaster Agent

When you click the "Create Server" button on the Servers page in your BuildMaster installation, you'll be given a direct link to the file with the correct version. You can also find it on the all BuildMaster downloads page. Make sure to select the version that corresponds with your version of BuildMaster, which can be found in the bottom-right corner in your web browser.

3. Target Directory

Although you may install wherever you like, it is recommended to keep the temporary directory short to avoid potential issues with tools that have problems with long paths.

Agent Target Directory

4. User Account

By default, the agent service will run as LocalSystem, which is an administrative service account. While not required, administrator-level privileges are strongly recommended as it will eliminate any difficulty or confusion with moving files and running different operations.

Agent User Info

5. Network

We recommend using the default port (46336), as that's Inedo's officially designated port. Make sure that the selected port is not blocked by a firewall.

Agent Port

You can change this later by editing the configuration file in the installation directory, and restarting the service.

6. Encryption

Inedo's agents use a FIPS-compliant symmetric AES encryption scheme by default, and the installer will automatically generate a secure, 32-digit key for you. You can use that key, or another one of your choosing.

If you select SSL instead of built-in AES, then you will need to have a valid certificate installed on the server (see KB#1040).

No Encryption is also an option, but we don't recommend using it. The primary reason we have this is so that you can use a tool like Wireshark to inspect the individual packages, either as directed by our support engineers or because you really like studying binary TCP protocols.

You can change this later by editing the configuration file in the installation directory, and restarting the service.

7. Summary

Verify that the information here is correct and then click Install.

Agent Summary

Adding the Server to BuildMaster

Once the agent has been installed, the server must be added to BuildMaster. Click the Create Server button on the Servers page, and enter the host name of the server, the port you installed the agent on, and the encryption key if you chose one.