Relay server prerequisites

This feature is not supported in environments that use the Workspace Control Shield API. (scheduled to be resolved in a next release)

The following prerequisites need to be met before installing a Relay Server on a machine:

  • Microsoft .NET Framework 4.7.2 or higher.

  • The machine runs on Microsoft Windows Server 2012 R2 or higher.

  • At least 500 MB of available hard disk storage space, plus the current size of the Agent's cache.

    The size of the Configuration and state part of the primary Datastore provides an indication of the current Agent's cache size. The size is visible in the Console, in Setup > Datastore.


  • A Relay Server connected directly to the Datastore needs to have the database client installed for the type of database used for the Datastore. For Microsoft SQL this is not necessary when Windows Authentication and protocol encryption are not used. A child Relay Server connected to another Relay Server does not need a database client.

  • An environment password must be configured in the Console, under the Relay Servers node. Using the Change environment password option secures your Relay Servers from unauthorized access.