Configuring the Inedo Agent
  • 06 Mar 2023
  • 1 Minute to read
  • Dark
    Light
  • PDF

Configuring the Inedo Agent

  • Dark
    Light
  • PDF

Article summary

As of v49, the Inedo Agent stores its configuration in the InedoAgent.config file. Earlier versions stored configuration in the InedoAgentService.exe.config file, located in the agent's installation directory.

Configuration File Location

Normally, the Inedo Agent looks for its configuration file at: %PROGRAMDATA%\Inedo\SharedConfig\InedoAgent.config. On most systems, this will resolve to C:\ProgramData\Inedo\SharedConfig\InedoAgent.config. However, to accomodate upgrades and other scenarios it can load from other locations:

  1. InedoAgent.config in install directory
  2. Legacy InedoAgentService.exe.config in install directory
  3. InedoAgent.config in %PROGRAMDATA%\Inedo\SharedConfig

If no configuration file is found in any of those locations, the Inedo Agent will not run.

Configuration File Format

The Inedo Agent configuration file is a simple XML format:

<InedoAgentConfig>
  <LogFile></LogFile>
  <ExtensionCachePath></ExtensionCachePath>
  <BuildMasterRootPath></BuildMasterRootPath>
  <OtterRootPath></OtterRootPath>
  <Listener Enabled="true/false">
    <Encryption Mode="none/ssl/aes">
      <CertificateName></CertificateName>
      <Key></Key>
    </Encryption>
    <Address></Address>
    <Port></Port>
    <MaxConcurrentHandshakes></MaxConcurrentHandshakes>
    <HandshakeTimeout></HandshakeTimeout>
    <AllowedAddresses></AllowedAddresses>
  </Listener>
  <Connections Enabled="true/false">
    <Server Host="" Key="" />
  </Connections>
</InedoAgentConfig>
NameDefault ValueNotes
LogFilenoneWhen a path to a file is specified, diagnostic information is written to this file. Do not specify a log file unless directed to do so by Inedo support.
ExtensionCachePath%TEMP%\Inedo\ExtensionCacheDirectory where Inedo extensions are unpacked and loaded from when necessary.
BuildMasterRootPath%TEMP%\InedoAgent\BuildMasterActs as the root temporary directory for BuildMaster deployments that target this server
OtterRootPath%TEMP%\InedoAgent\OtterActs as the root temporary directory for Otter orchestrations that target this server
Listener->EnabledtrueWhen true, the agent will listen for incoming connections.
Listener->Encryption->ModenoneSpecifies the type of encryption used for incoming connections. May be none, ssl, or aes.
Listener->Encryption->CertificateNamenoneWhen Encryption Mode is ssl, specifies the name of the certificate used for incoming connections.
Listener->Encryption->KeynoneWhen Encryption Mode is aes, specifies the 128 or 256-bit key in 64 hexadecimal digits used to encrypt data from incoming connections.
Listener->AddressAnyThe IP address to listen for incoming connections on.
Listener->Port46336The TCP port to listen for incoming connections on.
Listener->MaxConcurrentHandshakes100Maximum number of simultaneous incoming handshakes to process.
Listener->HandshakeTimeout30Maximum amount of time in seconds to allow an incoming handshake to take.
Listener->AllowedAddressesany;-separated list of IP addresses that are allowed to connect to this agent.
Connections->EnabledtrueWhen true, connections will be issued to the servers specified in this element.
Connections->Server->HostnoneRemote host name/address and optionally port if not using 46336 of product to connect to.
Connections->Server->KeynoneSecret key defined by the remote product to identify this agent instance.

Was this article helpful?