Overview

This instruction manual will guide you through the installation process of the various Linux distributions deployable instances of the Footprint Agent.

Table of contents

General Prerequisites

Ubuntu distributions

• Minimum OS: Ubuntu 18.04 or newer

• Disk Space Required: 200 MB

Debian distributions

• Minimum OS: Debian 11 or newer

• Disk Space Required: 200 MB

SUSE distributions

• Minimum OS: OpenSUSE Leap 42 or SUSE SLES 12 SP5

• Disk Space Required: 200 MB

Installing the agent

From the Footprint console, go to SCAN SURFACE in the main menu:

Once here, go to the AGENT-BASED SURFACE menu option, then go to the SETUP AGENTS submenu :

Once here, you will then be presented with a brief overview of what an agent is

To install the agent, click on the GET button under the Linux icon. This will prompt the display of the installation script and the following relevant information:

• 🌐 Footprint Management URL: This is the URL of your Footprint instance

• 🔑 Footprint Agent Token: This is the token you will use to authorize the agent on your instance.

You can copy and paste the script into your terminal for a clean and silent install, or you can tailor it to fit your installation needs. The following parameters are permitted:

Examples:

# Standard install 
wget -O footprint-agent-installer.sh https://dev.codacloud.net/agent/linux/update/agent_installer.sh && sudo bash footprint-agent-installer.sh --token 4cc706dfanehmlml1pa5a2n0 --server_url https://url.com

# Custom install with provided path to package
sudo bash footprint-agent-installer.sh --token 4cc706dfanehmlml1pa5a2n0 --server_url https://url.com --pkg /path/to/deb/footprint-agent.deb

Uninstall

Uninstalling the agent can be done in several ways such as:

1. From the Footprint Platform (Recommended)

Scan Surface-> Agent-based Surface ->Deployed agents

2. Local uninstall using the database manager

If you opt for the local uninstall, first you need to call the uninstall command:

sudo dpkg -P footprint-agent

Afterwards, the process associated with the Footprint Agent needs to be stopped:

sudo systemctl stop footprint-agent-daemon.service

And, finally, reload the systemd manager configuration:

sudo systemctl daemon-reload