---
title: ESAM Installation Guide
slug: market-switching/esam-installation-guide
docTags: 
createdAt: 2025-05-21T19:19:32.945Z
---

## Installation

To install the Zixi ESAM Agent, follow the steps below.

:::::WorkflowBlock
:::WorkflowBlockItem
Login to the [Customer Portal](https://portal.zixi.com).
:::

:::WorkflowBlockItem
Go to the **Software** section > **BY TYPE/PRODUCT** tab.
:::

:::WorkflowBlockItem
Select **Zixi ESAM Agent:**

![](https://api.archbee.com/api/optimize/amUtKWPrNQCS-26DKyGuI-S9eiKWsedW7MkseX0eHtQ-20250521-192831.png)
:::

:::WorkflowBlockItem
Download the tar file for your processor (ARM or X86) and untar the files in the same `/zixi` directory where you installed Zixi Broadcaster.
:::

:::WorkflowBlockItem
Run the installer `./esam.service.install.sh` from within the same directory.
:::

::::WorkflowBlockItem
Open `/zixi/esam-linux-x64/config.json` or `/zixi/esam-linux-arm64/config.json` and configure for desired operations (see [Agent Configuration](docId\:kmh8XYPqthZ9gVMGAik1G)).

:::hint{type="warning"}
Note: if you do not do this **before** starting the service (the next step), you will need to restart the service for the configuration changes to take effect.
:::
::::

:::WorkflowBlockItem
Once you have updated the `config.json` file, start the ESAM service using the command `esam-agent-service.service`
:::
:::::

## Updating the ESAM Agent

When a new version of the Zixix ESAM Agent is released on the [Customer Portal](https://portal.zixi.com/dashboard), you can update your installation by following the steps below.

:::::WorkflowBlock
:::WorkflowBlockItem
First, verify that you need the update by checking your installed version: `curl http://localhost:5555/version`
:::

:::WorkflowBlockItem
If the version on the portal is newer, download it and untar the file in the same`  /zixi  `directory where you installed Zixi Broadcaster.
:::

::::WorkflowBlockItem
***DO NOT*** run `./esam.service.install.sh` during update process.

:::hint{type="warning"}
Running the install script is ***NOT*** necessary to update the agent, and will overwrite the current `config.json` file. We strongly recommend that you keep a separate copy of the `config.json` file anyway, in case the install script is rerun by mistake.
:::
::::

:::WorkflowBlockItem
To restart the ESAM service, run the command `esam-agent-service.service`
:::

:::WorkflowBlockItem
Verify that the agent is updated by checking the version again: `curl http://localhost:5555/version`
:::
:::::