BuildMaster Documentation

Windows Installation Guide

Getting BuildMaster up-and-running takes just a few minutes: just download and run the installer. 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 doesn't have any intense server requirements, and supports all modern version of Windows (7+/2008+). The recommended requirements are:

  • Minimum – 2 Core CPU, 2 GB RAM, 1 GB for storage
  • Recommended Average/Typical – 2 Core CPU, 4 GB RAM, 10 GB storage
  • Recommended Large – 4 Core CPU, 8 GB RAM, 16 GB Storage

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
  • Web Server – BuildMaster has its own web server, but can also be hosted in Microsoft IIS as well; if you want to use IIS, make sure it and ASP.NET 4.5 are installed first (see KB2736284 for instructions)
  • Database Server – BuildMaster does require Microsoft SQL Server, but the BuildMaster installer can install SQL Express 2005 for you
  • Firewall (Inbound) – BuildMaster is a web application and can be installed on the port of your choosing

2. Download BuildMaster

There are two different installation packages for BuildMaster that you can download on inedo.com , with the only difference being the inclusion or lack of the Microsoft SQL Express 2005 installer. If you already have your own instance of Microsoft SQL Server (any edition 2005 and later), then you can opt for the (significantly) smaller download that doesn't include SQL Express.

3. Verify the Installer

We always sign our installer packages. This signature can be seen when you run the installer and get a security warning, or right-click on the file for Properties and then look at Digital Signatures.

We've never had any issues with compromised installers (it's hosted on Amazon S3, which is quite reliable), but it doesn't hurt to make sure the signature is there.

4. Run the Installer

The installer requires administrative privileges to run and will attempt to escalate. It will then unpack the temporary files and begin installation verification.

5. License Agreement

Take a quick read of our BuildMaster license agreement. Really, it's quick!

BuildMaster License agreement

6.Edition/ License Key

After accepting the license agreement, select the edition of BuildMaster you'd like to use (free, trial, or enter a key).

BuildMaster Edition Key

7. License Registration

After selecting the edition, just enter your name and email. The installer will try to get this from the currently logged in user.

BuildMaster Registration

8. Target Directory

Deploy to your favorite location, or just stick with the default of Program Files.

BuildMaster Directory

9. Database Configuration

If you ran the installer with the embedded SQL Express, then you'll be able to select the option to install SQL Express.

BuildMaster Database Configuration

Otherwise, you'll need to point to an existing server using a standard SQL Connection string. Note that if no database is specified in the connection string (which is the default), a database named BuildMaster will be created.

10. Web Server Configuration

By default, the installer will configure BuildMaster to use its own web server.  This is the easiest to start with, and you can always switch to IIS hosting later.

BuildMaster Server Configuration

If IIS is installed on the server, you will have the option of installing BuildMaster in IIS. This will create an application pool and website in the local IIS configuration.

11. User Account

By default, the installer will use the NetworkService account to run the BuildMaster Service and Web Application. We recommend sticking with this, and changing the account later if you need to.

BuildMaster User account

12. Summary

Make sure everything here looks OK, and then click Install.

Installation summary

If any of the items indicate an error, you can click on it to go back to that page and fix it.

13. Patiently Wait

If you chose to have SQL Server Express installed, then the actual installation process will take a little while. On embarrassingly low-end servers (e.g. Intel Celeron processor and 256MB of RAM), we've seen this take as long as fifteen minutes.

Patiently wait

While you wait, you can always peruse Otters Who Look Like Benedict Cumberbatch.

Clicking cancel (especially during the SQL Express installation) is not advised, as you may have to manually remove some bits of SQL Server using Add/Remove programs. Once everything's done, you'll be ready to start using BuildMaster.

14. All Done

Click the absurdly large Launch BuildMaster button, and your web browser will start up with http://localhost:«port-you-chose»/.

Launch BuildMaster

Note that on slower systems, the services take a little bit to spin up, so if you see a blank page, just refresh the page until it loads.

Once BuildMaster loads, we suggest going through the Getting Started with BuildMaster tutorial.