Skip to content

Installation

Edge Xpert supports ARM (32 and 64 bit) and x86 (64 bit) architectures on Linux-based operating systems and is available in the following formats:

  • Debian Software Package (DEB) format for Debian Linux-based operating systems including Ubuntu
  • RPM Package Manager (RPM) format for Red Hat, CentOS, and similar Linux-based operating systems

Note

To run Edge Xpert in Windows systems, users can install Edge Xpert Debian Software Package (DEB) on the Windows Subsystem for Linux (WSL 2). For more details about WSL 2 installation and setup on a Windows system, please refer to Microsoft documentation. Once the WSL 2 environment is ready on your Windows system, you can apply the remaining steps as described in this documentation to install Docker, Docker Compose, and Edge Xpert Debian Software Package inside the WSL 2 environment.

Prerequisites

Edge Xpert requires the following installation prerequisites:

  • Docker version 18.06.0 or later, available from the Get Docker topic in the Docker documentation
  • Docker Compose version 1.22.0 or later, available from the Docker Compose topic in the Docker documentation

The documentation for Docker details how to download and install these prerequisites.

Once you have installed Docker and Docker Compose, you must add your account to the docker group, using the following command:

 sudo usermod -aG docker <user_account>
After this command has successfully been completed, you must reboot your system to apply the permissions.

Download Edge Xpert

After ensuring the above prerequisites are met, download and install Edge Xpert.

Edge Xpert users with valid and active support contracts can download the Edge Xpert installation packages from the Support Portal on the IOTech website. After logging in, navigate to Downloads where you can select the version and type of package that are required.

Users wishing to evaluate Edge Xpert can download the installation packages from the IOTech website here.

Info

You must also have a license file that defines which microservices can be run. See Edge Xpert Licensing for more details

Install Edge Xpert

  • To install the Edge Xpert Debian package as root, enter:
    sudo dpkg -i edgexpert-<version_number>_amd64.deb
    
  • To install the Edge Xpert RPM package as root, enter:

    sudo rpm -ivh edgexpert-<version_number>.aarch64.rpm
    

    Info

    Before installing the Edge Xpert packages, ensure that Docker is running. If Docker is not running, the installation will fail with an error message similar to the following:

    Cannot connect to the Docker daemon at unix:///var/run/docker.sock. Is the docker daemon running?
    dpkg: error processing package edgexpert (--configure): installed edgexpert package post-installation script subprocess returned error exit status 1
    

Verify Installation

You can verify that the installation was successful by entering the following command:

edgexpert -v

The output will be similar to the following:

edgexpert version 2.0.3
services version: 2.0 - repository: releases
git-sha: 7118e42c42c248622403da4aefa18248f499b0c4

Uninstall Edge Xpert

Edge Xpert can be uninstalled using the following commands:

sudo apt remove edgexpert
sudo apt update

Upgrade Edge Xpert

To upgrade Edge Xpert, download the latest package following the steps detailed above.

Remove the existing version of Edge Xpert with the uninstall commands.

Finally, install Edge Xpert again and verify the installation.

Back to top