InedoAgent Documentation

Installation Guide

  • Last Modified: 2019-09-16

Using the Installer

1. Pre-Installation Check List

There are no intense server requirements, and support all modern version of Windows (7+/2008+). Before installing, consider the following:

  • .NET Framework 4.5.2 – Requires .NET 4.5.2 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

2. Download Inedo Agent

Download the latest Inedo Agent from the Agent Versions & Release Notes page.

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.

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.

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.

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 messages, 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.

8. Installation

The actual installation is near instantaneous, and should take no more than a minute or two, even on the slowest of systems.

Once the installation is complete, just close the installer or click the Exit button.

Installing Multiple Agents on Same Machine

Sometimes, it may be desired to install multiple instances of the Inedo Agent on the same machine. The most common reason for this is privileges; one agent may run in a higher privilege mode than the other.

The agent installer (including silent installation) does not currently support installation or management of multiple instances. See KB#1146 for guidance on how to install more than one agent on the same server manually.

Silent Installation

The Inedo Agent installer may also be run without displaying a window, ideal for Infrastructure as Code or script-based installations. To perform a silent install, simply run the executable from the command line or PowerShell with the /S argument.

Argument Format:

Silent installation arguments follow the format:

InedoAgentSetup.{version}.exe /{argument-name}="{argument-value}"

Note: quotes are required if the argument-value contains whitespace.

Example:

.\InedoAgentSetup.42.exe /S /TargetPath="C:\Program Files\InedoAgent" /Port=46336 /TempPath="C:\ProgramData\InedoAgent" /ServiceName="INEDOAGENTSVC" /Security=AES /EncryptionKey="0123456789abcdef0123456789abcdef"

Available Arguments

NameDefault ValueNotes
S(not applicable)This argument instructs the installer not to display a window, and does not have an argument-value
TargetPath%ProgramFiles%\InedoAgentThe directory that will contain the service's executable and supporting files. If specified, argument-value must be an absolute path (i.e. %PROGRAMFILES will not expand)
Port46336
TempPath%ProgramData%\InedoAgentThe base directory for any ProductRootPath option not explicitly specified. If specified, argument-value must be an absolute path (i.e. %PROGRAMDATA will not expand)
OtterRootPathTempPath\Otter
BuildMasterRootPathTempPath\BuildMaster
HedgehogRootPathTempPath\Hedgehog
UserAccountLocalSystemThe user account to run the service under. For built-in accounts, use NetworkService or LocalSystem
PasswordThe password for UserAccount. Omit this field for built-in accounts.
ServiceNameINEDOAGENTSVC
SecurityAESAlso accepts SSL or None. It is recommended that this is left as AES as the other options do not have any way of validating the identity of the client.
CertificateNameUsed if Security is set to SSL. Represents the case-sensitive friendly name of a certificate in the Local Machine store.
EncryptionKeyUsed if Security is set to AES. Must be a 32-character hex string. If EncryptionKey is not specified, one will be randomly generated (which could overwrite an existing key on upgrade).

Is this documentation incorrect or incomplete? Help us by contributing!

This documentation is licensed under CC-BY-SA-4.0 and stored in GitHub.

Generated from commit 54a0ee92 on master