- 07 Jun 2021
- 2 Minutes to read
BuildMaster Installation Guide
- Updated on 07 Jun 2021
- 2 Minutes to read
BuildMaster is self-managed, which means you have the option to run BuildMaster on-premise or in your private/public cloud. Both Windows and Linux are supported.
Installing on Windows Servers
BuildMaster doesn't have any intense server requirements, and supports all modern version of Windows that Microsoft supports (see Windows Lifecycle Fact Sheet).
The recommended Windows server 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
There are three supported options; there is also Legacy (Traditional) Installer available for BuildMaster v6.2 and earlier.
Easiest: Inedo Hub
The easiest way to install BuildMaster on your Windows Servers is with Inedo Hub, which is a lightweight Windows application. The Inedo Hub is used to install, update, and otherwise service your BuildMaster installation, as well as other Inedo products installed on your server.
The Inedo Hub also supports Offline Installation for severs with limited or no Internet access.
Silent Installation for Automation
You can also perform a silent (non-interactive) installation of BuildMaster using the Inedo Hub. This won't display a user interface or ask any questions. This can be useful for scripts or other automations.
Fully Customizable: Manual Installation
If you prefer to install every component of BuildMaster yourself, that's also an option.
See: Manual installation
Installing on Linux Servers
BuildMaster can run on a Linux server through Docker. We may support additional installation options in the future if there's any interest.
The recommended Container resources are:
- Minimum - 2 vCPU, 2 GB RAM
- Recommended Average/Typical - 2 vCPU, 4 GB RAM
- Recommended Large - v4 CPU, 8 GB RAM
In addition, we recommend reserving a volume with at least 10GB to store your packages and container images.
In addition to Docker Engine, you can run BuildMaster through Docker Compose or Kubernetes.
Running in the Cloud
BuildMaster can be installed on a virtual machine or container in the cloud provider of your choosing.
The Installing ProGet on AWS Lightsail guide is a good starting point for using Lightsail to install an Inedo product.
Firewall & Network Access
On Windows, BuildMaster installs on port 8622 by default, and you should consider changing that after installation to the standard ports of HTTP (80) and/or HTTPS (443) after installation.
Whatever port you decide to access BuildMaster's web application on, you'll need to configure an Inbound Firewall rule to allow that access. No other inbound ports are required.
Server & Inedo Agent Network Access
BuildMaster is used to orchestrate and deploy files to servers, and will need the appropriate network access (inbound or outbound) to communicate with the servers. This is all configurable, and whatever access is needed depends on how you configured your servers, and BuildMaster to access those servers.
Maintaining your BuildMaster Installation
Once your BuildMaster instance is up and running, there isn't a whole lot that you will need to manage or maintain.
Update BuildMaster at least quarterly; we ship a maintenance release of BuildMaster at least twice a month with bugfixes and low-risk changes. However, lots of small, low-risk changes add up over time, so we recommend updating at least once per quarter to minimize the risk of a regression.
Routinely back-up your instance to mitigate the risk of sudden hardware/server problems, as well as to make rolling back to previous versions of BuildMaster easy.