Skip to main content

Ubuntu

To get started with the UXM Endpoint agent on Ubuntu, please make sure you meet the prerequisites below.

Prerequisites​

OS requirements​

To install UXM Endpoint agent, you need the 64-bit version of one of these Ubuntu versions:

  • Ubuntu Noble 24.04 (LTS)
  • Ubuntu Jammy 22.04 (LTS)
  • Ubuntu Focal 20.04 (LTS)
  • Ubuntu Bionic 18.04 (LTS)

UXM Endpoint agent is compatible with x86_64 (or amd64) architectures.

Installation methods​

You can install the UXM Endpoint agent in different ways, depending on your needs:

  • Set up and install UXM Endpoint agent from UXM's aptrepository.
  • Install it manually and manage upgrades manually.

Install using the repository​

Before you install UXM Endpoint agent for the first time on a new host machine, you need to set up the UXM repository. Afterward, you can install and update UXM from the repository.

Set up the repository​

  1. Update the apt package index and install packages to allow apt to use a repository over HTTPS:
sudo apt-get update
sudo apt-get install \
    ca-certificates \
    curl \
    gnupg \
    lsb-release
  1. Add UXM’s official GPG key:
sudo mkdir -m 0755 -p /etc/apt/keyrings
curl -fsSL https://download.uxmapp.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /etc/apt/keyrings/uxm-endpoint-agent.gpg
  1. Use the following command to set up the repository:
echo \
"deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/uxm-endpoint-agent.gpg] https://download.uxmapp.com/linux/ubuntu \
$(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/uxm-endpoint-agent.list > /dev/null

Install UXM Endpoint Agent​

  1. Update the apt package index:
sudo apt-get update

Receiving a GPG error when runningapt-get update?

Your default umask may be incorrectly configured, preventing detection of the repository public key file. Try granting read permission for the UXM public key file before updating the package index:

sudo chmod a+r /etc/apt/keyrings/uxm-endpoint-agent.gpg
sudo apt-get update
  1. Install UXM Endpoint agent.

To install the latest version, run:

sudo apt-get install uxm-endpoint-agent

Update collector url that agent sends data to and agent key required to send the data.

export UXM_COLLECTOR=https://customername.uxmapp.com
export UXM_AGENT_KEY=${AgentKey}
sudo sed -i "s^{COLLECTOR}^$UXM_COLLECTOR^g" /opt/uxm-endpoint-agent/pcagent.config
sudo sed -i "s^{AGENT_KEY}^$UXM_AGENT_KEY^g" /opt/uxm-endpoint-agent/pcagent.config

Restart UXM Agent service

sudo systemctl restart uxm-endpoint-agent

Verify that the UXM Endpoint agent installation is successful by checking the log file or UXM after 5 minutes:

tail -n 50 -f /var/log/uxm-endpoint-agent.log | grep -E 'Error|error|Warn|warn'

You have now successfully installed and started UXM Endpoint agent.

Upgrade​

UXM Endpoint agent can be upgraded by apt upgrade if it's installed from repository:

sudo apt-get update
sudo apt-get upgrade

Install manually from a package​

If you can’t use UXM's apt repository, you can download the deb file for your release and install it manually. You need to download a new file each time you want to upgrade the UXM Endpoint Agent.

  1. Go to https://download.uxmapp.com/linux/ubuntu/dists/.

  2. Select your Ubuntu version in the list.

  3. Go to pool/stable/ and select the applicable architecture (amd64).

  4. Download the .deb file for the UXM Endpoint agent version you want to install:

    • uxm-endpoint-agent_<version>_<arch>.deb

  5. Install the .deb packages and set settings.
    Update the environments variables:

    • UXM_COLLECTOR needs to be set to UXM Collector that should receive the data
    • UXM_AGENT_KEY is the supplied key from UXM Admin page

    export UXM_COLLECTOR=https://customername.uxmapp.com
    export UXM_AGENT_KEY=AGENT_KEY_FROM_UXM
    sudo dpkg -i uxm-endpoint-agent_<version>_<arch>.deb
    sudo sed -i "s^{COLLECTOR}^$UXM_COLLECTOR^g" /opt/uxm-endpoint-agent/pcagent.config
    sudo sed -i "s^{AGENT\_KEY}^$UXM_AGENT_KEY^g" /opt/uxm-endpoint-agent/pcagent.config
    sudo systemctl start uxm-endpoint-agent.service

Uninstall​

UXM Endpoint agent can be uninstalled with the following commands

sudo apt-get remove -y --purge uxm-endpoint-agent

Delete keyring and apt source list

sudo rm --force /etc/apt/keyrings/uxm-endpoint-agent.gpg
sudo rm --force /etc/apt/sources.list.d/uxm-endpoint-agent.list