# Agent Installation

## Overview

This page explains the steps required to set up an agent server for use in Highlight. It should be read in conjunction with the page [creating a new agent in Highlight](https://help.highlight.net/admin/agents#create_new_agent). There is no charge for the agent server software, which is installed on your own hardware.

***

## Installation Summary

There are four steps to install and make live a Highlight agent.

{% stepper %}
{% step %}
**Identify a suitable location for the server, and provision it** (server can be virtual).

Check the [system requirements](https://help.highlight.net/functionality/server-specs#server-specification) for a new server, which will depend on its role.

{% hint style="info" %}
**Notes:**

* .NET 4.8 is required to be installed.
* Time must be configured from an NTP server, to ensure the server keeps in sync with Highlight.
* Wireshark installation (the Tshark module as a minimum) is recommended for troubleshooting purposes.
  {% endhint %}
  {% endstep %}

{% step %}
**Make firewall changes** to allow appropriate access to and from the agent.

The changes required are summarised in the [network access requirements](https://help.highlight.net/functionality/server-specs#network-access-requirements) section.
{% endstep %}

{% step %}
**Follow the steps for** [**creating a new agent**](https://help.highlight.net/admin/agents#create_new_agent) in Highlight, which will require Highlight Admin access.
{% endstep %}

{% step %}
[**Download the latest copy**](https://support.highlight.net/downloads/HighlightAgentSetup.zip) of the Highlight Agent server software, install it on the server, and activate it.

The software is also available from the Admin Agents page, as shown below:

![Download option for Agent software](/files/c68de8451c5d8d133c46f1d69c0ab5c048648ec3)
{% endstep %}
{% endstepper %}

***

## Server Location and Provisioning

![Highlight architecture private network](/files/1e92a33f88a0f55ac812c1c05287fa68cd6acd33)

Highlight agents are used to collect data from a private network. Refer to the above section for an installation summary. Refer to the [architecture page](https://help.highlight.net/functionality/architecture) for infographics on public and hybrid networks.

![Highlight architecture VM agent](/files/1faaad83267dffa1e9eda710611c1420ae4b0d9b)

Highlight agents may also be used as a Flow Collector or for HTTPS testing.

### Using an Agent as a Flow Collector

When used for Flow, a Highlight agent collects information from devices on a private network, then encrypts it, compresses it and passes it out of the network to the main Highlight server, as shown in this example:

![Example of Flow Collector by customer](/files/e0117659eea2dacc73d31a81d65da3049916ddce)

Due to the volume of data generated by devices enabled for flow, ideally an agent used as a Flow Collector should be located as near as possible to the source.

A single Flow Collector is suited to handle flows from about 50 devices. If a greater number of flows are expected, a second collector should be installed, ideally in a solution incorporating a load balancer. Please [contact us](https://help.highlight.net/getting-started/contact-us) for more information on load balancing for flow.

Having identified a suitable location for the server and checked the [system requirements](https://help.highlight.net/functionality/server-specs#server-specification), provision it.

{% hint style="warning" %}
Highlight agent software requires .NET 4.8 to be pre-installed, and we strongly recommend that Highlight agents are configured to synchronise their clock with a reliable time source. Documentation for the Windows Time service is available from [Microsoft's website](https://docs.microsoft.com/en-us/windows-server/networking/windows-time-service/windows-time-service-top).
{% endhint %}

***

## Steps to Install the Agent Server Software

{% stepper %}
{% step %}
Obtain an activation code by [creating a new agent](https://help.highlight.net/admin/agents#create_new_agent) in the appropriate Highlight folder, which will require Highlight Admin access.
{% endstep %}

{% step %}
Download the latest copy of the [Highlight Agent server software](https://support.highlight.net/downloads/HighlightAgentSetup.zip), which is also available from the Admin Agents page:

![Download option for Agent software](/files/c68de8451c5d8d133c46f1d69c0ab5c048648ec3)
{% endstep %}

{% step %}
Extract the zip file to the required server, and run `Highlight.Agent.Bundle.Setup.exe`.

![Terms and conditions for Agent software](/files/586357a394d411fe5c37f9b89e876af6645161d3)
{% endstep %}

{% step %}
Agree to the licence terms and conditions.

![Agreed terms and conditions for Agent software](/files/61c324c986a51b5fe6be2c8732337005f400307f)
{% endstep %}

{% step %}
Click **Install**.

![Agent Authentication](/files/945c1fac1b4ca4edb1903e34ad2e6f5a7610d629)
{% endstep %}

{% step %}
Enter the activation code (obtained when setting up the agent in Highlight) and the URL you use to access Highlight.

{% hint style="info" %}
The URL must begin with `https://`
{% endhint %}
{% endstep %}

{% step %}
Click **Next**.

![Agent setup successful](/files/dfcbc3c40ca1271e2c22d4964a0bcfa6ab197720)
{% endstep %}

{% step %}
Click **Close**.
{% endstep %}

{% step %}
In Task Manager, ensure that all Highlight services are running. If they are not running, reboot the VM (restart the server).
{% endstep %}

{% step %}
We recommend that you also download and install Wireshark to improve supportability by Highlight.
{% endstep %}

{% step %}
Follow the steps to [assign the new agent](https://help.highlight.net/admin/agents#agent_selection) in the appropriate Highlight folders, which will require Highlight Admin access.
{% endstep %}
{% endstepper %}

***

## Steps to Confirm Agent Software is Operational

<img src="/files/faf5a82d62c0ece86e4edcfd0d7674d828650dc8" alt="Agent controller shortcut" width="188">

{% stepper %}
{% step %}
Open the **Agent Controller** shortcut on the server Desktop.

![Agent awaiting authorization](/files/b1cf2aad1cfa5dc7dd4f2f4d91276c9b7a266736)
{% endstep %}

{% step %}
Note the agent is **Running** and the connection status is **Awaiting Authorization**. Once the agent has been enabled in Highlight, the connection status will change to **Connected**, and an agent name will appear as configured in Highlight.

![Agent connected](/files/d027947186ea7b3374fbcf4113b313ff11cb2819)
{% endstep %}
{% endstepper %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://help.highlight.net/device-setup/agent-installation.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
