Skip to main content

Installation

Installation (Linux via Docker containers)​

Linux Edgify agent installation consists of downloading the docker-compose-agent & config yml files so that the container images in the yml file are set to be pulled from Edgify's Docker Hub repository (Note: the default configuration uses the USB camera).

  1. Create the /edgify_agent/shared/ directory:

    sudo mkdir -p /edgify_agent/shared/

  2. Now that the new folder was created, place the account_token.txt file that you received from your Edgify account manager in the following folder:

    sudo cp account_token.txt /edgify_agent/shared/account_token.txt

  3. Download the relevant config.yaml file (per environment):

    3.1 For Edgify's Staging Environment (Development etc.): Download the config.yaml for staging.

    3.2 For Edgify's Production Environment (If you are installing in a real store): Download the config.yaml for production.

    3.3 For Edgify's Production USA Environment (If you are installing in a real store in the USA): Download the config.yaml for prod-us.

  4. Place the config.yaml file in the /edgify_agent/shared/ directory

    sudo cp config.yaml /edgify_agent/shared/config.yaml

  5. Download the docker-compose.yml. Edit the content of the file by changing 2.32.0 to represent the agent version you wish to install. The recent agent version is: 2.32.0

  6. Place the docker-compose.yml file in the /edgify_agent/shared/ directory

    sudo cp docker-compose.yml /edgify_agent/shared/docker-compose.yml

  7. Use the Linux terminal to authenticate with docker hub using the credentials you received from edgify (it will ask you for both a linux admin user/password and then the docker hub user/password) run:

    sudo docker login --username <username>

For example:

sudo docker login --username edgifyclients

  1. You will then be prompted to input the password (You will get the password credentials from Edgify).

  2. In order to pull all the relevant container images from the Edgify docker hub repository. Run the following command:

    sudo docker compose -f docker-compose.yml pull

  3. In order to run all the required containers from the previously pulled images and create the required folders on your device. Run the following command:

    sudo docker-compose up -d

It will run the docker and pull the account token from the account_token.txt file and delete it.

  1. Now, your edgify-agent container should be running (you can run sudo docker ps to validate).

Installation (Windows)​

Installing Edgify Agent exe on Windows.

Execute the following steps to install Edgify's Agent:

  1. Create the following folder: C:\edgify\agent\shared
  2. Now that the new folder was created, place the account_token file that you received from your Edgify account manager in the following folder:

C:\edgify\agent\shared

  1. Download Edgify's MSI Installation for Windows: Agent 2.32.0 64 bit

  2. Via Command line, CD (change directory) to the directory where you placed the MSI file

  3. Use the following command to run the Edgify Agent MSI.

    5.1 For connecting to Edgify's Staging Environment (Development etc):

    msiexec.exe /I EdgifyAgentMsi_2.32.0_x64.msi BASE_URL="https://dashboard.staging.edgify.ai/api/v2/edge/" WS_ENDPOINT="dashboard.staging.edgify.ai" /l*v EdgifyAgentInstallation.log

    5.2 For connecting to Edgify's EU Production Environment (If you are installing in a real store):

    msiexec.exe /I EdgifyAgentMsi_2.32.0_x64.msi BASE_URL="https://dashboard.production.edgify.ai/api/v2/edge/" WS_ENDPOINT="dashboard.production.edgify.ai" /l*v EdgifyAgentInstallation.log

    5.3 For connecting to Edgify's US Production Environment (If you are installing in a real store in the US):

    msiexec.exe /I EdgifyAgentMsi_2.32.0_x64.msi BASE_URL="https://dashboard.prod-us.edgify.ai/api/v2/edge/" WS_ENDPOINT="dashboard.prod-us.edgify.ai" /l*v EdgifyAgentInstallation.log

  4. Use the windows Management Console - Services Manager - to see that the agent is running

alt text