> ## Documentation Index
> Fetch the complete documentation index at: https://docs.germainux.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Agent Installation

> Check the requirements and install GermainUX-Agent on the target Windows machine.

Service
`Management`

Availability
2014.1 or later

> [card] [System Requirements](#system-requirements)
>
> Check runtime and install prerequisites

> [card] [Select the Appropriate Installer](#select-the-appropriate-installer)
>
> Choose the right package

> [card] [Installed Files](#installed-files)
>
> Where agent components live

> [card] [Automatic Startup](#automatic-startup)
>
> Scheduled task runs agent

**Install GermainUX-Agent**

## System Requirements

Before installing GermainUX-Agent, confirm that the target machine meets these requirements:

* Supported 64-bit Windows operating system
* Administrator privileges for installation
* A local administrator account for running the Agent
* Microsoft Visual C++ 2015–2022 Redistributable
* Network access to your cloud or on-premise GermainUX Enterprise environment

> [!NOTE]
>
> The installer verifies that the required Microsoft Visual C++ Redistributable is present. If it is missing, installation stops and provides a link to the appropriate Microsoft package:

| Package | Link / Notes |
| - | - |
| 64-bit Visual C++ Redistributable | [https://aka.ms/vs/17/release/vc\_redist.x64.exe](https://aka.ms/vs/17/release/vc_redist.x64.exe) |
| 32-bit Visual C++ Redistributable |   |

The Agent requires elevated privileges to detect and monitor application processes. If it starts without sufficient privileges, it displays an error and exits instead of operating with limited functionality.

## Select the Appropriate Installer

Two installation packages are available. They serve different purposes and are not simply equivalent 32-bit and 64-bit versions.

| Installer | Installed product | Default location | Contents |
| - | - | - | - |
| **Setup64** | GermainUX-Agent | `C:\Program Files\Germain Software\GermainUX Agent\` | GermainUX-Agent, RUM Windows, 64-bit Code Profiler, and Agent Console |
| **Setup x86** | GermainUX-Code Profiler | `C:\Program Files (x86)\Germain Software\GermainUXCodeProfiler\` | 32-bit Code Profiler and Agent Console only |

### Setup64

Use `Setup64.msi` for almost every deployment.

It installs:

* The GermainUX-Agent system-tray application
* Application-process detection
* GermainUX-RUM Windows
* The 64-bit GermainUX-Code Profiler
* Diagnostic utilities

This is the primary package required for real-user monitoring and Session Replay of native Windows applications.

### Setup x86

Install the x86 package only when:

* CLR-level monitoring is required for a 32-bit .NET application
* The target machine runs both 32-bit and 64-bit applications that must be profiled
* GermainUX Support instructs you to install it

The x86 package does not include GermainUX-Agent or RUM Windows.

Both packages can be installed on the same machine. They use separate product identities, installation directories, and upgrade configurations.

## Install the Agent

**1. Launch `Setup64.msi` with administrator privileges**

**2. On the welcome screen, click Next**

**3. Enter the base URL of your GermainUX Enterprise environment**

**4. Click Next**

**5. Accept the default destination folder or choose another installation directory**

**6. Click Install**

**7. When installation is complete, click Finish**

**8. Sign out and sign back in using a local administrator account**

The GermainUX URL can point to either:

* GermainUX Cloud
* An on-premise GermainUX Enterprise installation
* A GermainUX Enterprise environment hosted in your private cloud

Enter only the base URL provided for your organization.

## After Installation

> [!NOTE]
>
> A Windows restart is not normally required.

The Agent does not start immediately when the installer finishes. It starts automatically the next time a local administrator signs in.

After signing in:

**1. Confirm that the GermainUX-Agent icon appears in the Windows system tray**

**2. Right-click the icon**

**3. Confirm that Monitoring Enabled is selected**

**4. Select Refresh Config to retrieve the latest configuration**

**5. Open Configurations and confirm that the expected monitored application is listed**

**6. Start or restart the monitored application**

**7. Verify that telemetry appears in GermainUX Workspace**

## Installed Files

The standard 64-bit package installs the following primary files:

| File | Purpose |
| - | - |
| `GermainUXAgent.exe` | Runs in the background, detects configured applications, retrieves monitoring rules, and manages the monitoring components. |
| `GermainUXRumWindows.exe` | Captures application windows, controls, user interactions, performance, and Session Replay. |
| `GermainUXCodeProfiler.dll` | Attaches to supported 64-bit .NET applications to collect runtime and code-level telemetry. |
| `AgentConsole.exe` | Command-line utility used for diagnostics and testing. |
| `cpprest_2_10.dll` | Runtime dependency. |
| `fmt.dll` | Runtime dependency. |

Do not independently move or rename these files. GermainUX-Agent locates RUM Windows and Code Profiler in the same directory as its own executable.

Moving one component without the others can prevent monitoring from starting correctly.

## Automatic Startup

GermainUX-Agent must:

* Run with elevated privileges
* Operate inside the interactive user session
* Access the Windows system tray
* Capture authorized mouse and keyboard activity

Because of these requirements, it does not run as a conventional Windows service.

The installer creates a machine-wide Windows Scheduled Task that:

* Runs when a user signs in
* Requests the highest available privileges
* Starts GermainUX-Agent in the interactive session
* Avoids displaying a User Account Control prompt at every sign-in for authorized administrators

### Administrator Account

When a local administrator signs in, the Agent starts automatically with the required privileges.

### Non-Administrator Account

When a non-administrator signs in, the Scheduled Task cannot provide the elevation required by the Agent. The Agent displays an insufficient-privileges error and exits.

For machines dedicated to monitoring, ensure that the account that remains signed in is a local administrator.

The Scheduled Task is created during installation and removed during uninstallation. It can be reviewed using Windows Task Scheduler.

## Install the 32-Bit Code Profiler

When CLR-level monitoring is required for a 32-bit .NET application:

**1. Install `Setup64.msi` to provide GermainUX-Agent and RUM Windows**

**2. Install the x86 package on the same machine**

**3. Enter the same GermainUX Enterprise URL when prompted**

**4. Complete the installation**

**5. Restart the monitored 32-bit application**

**6. Validate that Code Profiler telemetry appears in GermainUX Workspace**

The x86 package may also be installed by itself if only 32-bit .NET profiling is required and GermainUX-Agent or RUM Windows is not needed.

## Upgrade

To upgrade GermainUX-Agent:

**1. Obtain the newer installer**

**2. Run it with administrator privileges**

**3. Complete the installation using the existing installation location**

**4. Sign out and sign back in if the Agent does not restart automatically**

**5. Confirm the installed version from the system-tray menu**

**6. Validate monitoring and data transmission**

An in-place upgrade preserves the existing GermainUX URL and other Agent settings.

The installer prevents an older version from being installed over a newer version.

## Repair

Use the Windows repair option when installed files or installer-managed configuration may be damaged.

A repair:

* Restores missing or corrupted installed files
* Preserves the GermainUX Enterprise URL
* Preserves existing Agent settings
* Does not replace manually created local monitoring rules

After repairing the installation, sign out and sign back in before validating the Agent.

## Uninstall

To remove GermainUX-Agent:

**1. Open Windows Settings > Apps > Installed apps or Control Panel > Programs and Features**

**2. Select GermainUX-Agent**

**3. Click Uninstall**

**4. Complete the removal process**

Uninstallation removes:

* Installer-managed application files
* The GermainUX-Agent automatic-start Scheduled Task
* Installer-managed Agent Registry settings

Manually created monitoring rules under the following Registry location may remain:

```text theme={null}
HKLM\SOFTWARE\Germain Software\Germain Agent\Targets
```

Remove these rules manually if the machine will no longer be monitored.

If the optional 32-bit Code Profiler is installed, uninstall it separately.

## Validate the Installation

A successful installation should meet all of the following conditions:

* GermainUX-Agent appears in **Installed apps** or **Programs and Features**
* The Agent icon appears in the Windows system tray after an administrator signs in
* The Agent can connect to GermainUX Enterprise
* The expected monitoring rules appear under **Configurations**
* The configured application is detected when it starts
* RUM Windows or Code Profiler starts according to the monitoring rule
* Collected telemetry appears in GermainUX Workspace
* Session Replay is available when enabled

If any of these checks fail, see:

* [Agent Settings(Registry)](https://docs.germainux.com/main/agent-settings-registry.md)
* [Agent Troubleshooting](https://docs.germainux.com/main/germainux-agent-troubleshooting.md)

## Get Help

> [card] [Contact GermainUX Support](https://docs.germainux.com/main/support.md)
>
> The GermainUX team helps you get up and running faster, empower your team, turn data into actionable insights, and optimize performance to deliver measurable business outcomes.

> [card] Can't find what you need?
>
> Search all GermainUX docs with **Ctrl + K**, or use the feedback buttons at the bottom of this page to tell us what is missing.

The content of this document is proprietary to GERMAIN SOFTWARE.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.