How to install the Fing Agent on Linux Docker

This guide will walk you through the process of installing the Fing-Agent image on a device supporting  Docker containers.  Follow these step-by-step instructions to successfully install the docker image and set up the Fing-Agent container.

Prerequisites

• Ensure that Docker is installed and running. For instructions, refer to the Docker installation guide.
• An active internet connection.

At this time, the Fing Agent image is compatible with ARM-64 and AMD-64 with a single, multi-architecture image. Additional architectures may be added in the future, as the product improves and evolves.

Before you begin

Please note the following restrictions before proceeding with the installation:

• Unsupported Operating Systems: Docker installations of Fing Agent are not supported on Windows or macOS.
• Single Agent per Device: Only one instance of the Fing Agent can run per device. If you already have the Fing Agent installed via Snap on the same device, it must be uninstalled before running the Docker version.
• Snap Migration Limitations: Currently, migration from the Snap version of Fing Agent to Docker is not supported. If you are running a Fing Agent on the same device using snap, you must deactivate, uninstall the Snap version, and install the Docker version from scratch.

Install and run the Docker image using Docker Compose

The Fing Agent can be downloaded and automatically setup using instructions defined in a Docker Compose file. 

• Verify you can execute Docker Compose definitions by running the following command. 

docker compose (for recent versions of Docker)
docker-compose (for older versions of Docker)

• Open a shell on your device - or access through a remote shell - and run the following command to install the Fing Agent Docker container:

curl https://get.fing.com/fing-docker/compose.yaml -o compose.yaml
docker compose up -d (for recent versions of Docker)
docker-compose up -d (for older versions of Docker)

This command will:

• • Download the docker compose file: the file defines everything needed to run the service 
  • Launch the new container: a new container will be spawn after downloading the latest image of the Fing-agent and executed as a background service.

Install the Docker image manually

• Open a shell on your device - or access through a remote shell - and run the following command to install the Fing Agent Docker container:

sudo docker run --network=host --cap-add NET_ADMIN --publish 44444:44444 \
  -d --restart=always --name FingAgent \
  -v fing-data-volume:/app/fingdata fing/fing-agent:latest

This command will:

• • Download the latest image: the image from the official Fing account is securely download from DockerHub 
  • Network Mode: Run the container in host network mode for optimal networking capabilities. It will grant access to the underlying networking system, which is required for the agent to work correctly.
  • Capabilities: Add the necessary NET_ADMIN capability for network administration.
  • Port Mapping: Publish port 44444 to publish their status via UPnP.
  • Volume Persistence: Use the fing-data-volume to persist data across container restarts, such as configuration and log files.

After installation, the Fing Agent will automatically start and be available to be activated.

Uninstalling the Snap Version

If you are migrating from a previous Snap installation, follow these steps:

• Deactivate the existing Snap-based Fing Agent on your account. Using the mobile app, open the list of networks and long-tap or swipe to display the actions on that network. Select "Deactivate" to deactivate the snap image.
• Uninstall the Snap version:

sudo snap remove fing-agent

• Proceed with Docker Installation using the instructions provided above.

How to activate your Fing Agent

You have now successfully started the container running the Fing Agent image on your device. To activate the agent you will need:

• The Fing App running on your mobile
• An active subscription

Open the Fing App on your mobile, select the "Account" tab, tap on "Add monitoring unit" and follow the on-screen instructions to start the activation procedure.

Keeping your Fing Agent up-to-date

Docker containers are created using Docker images, which are essentially filesystem snapshots that include the operating system along with the pre-installed packages for the Fing Agent. These base images are regularly updated to incorporate security patches, bug fixes, and feature improvements.

However, once a Docker container is built, it doesn’t automatically inherit updates from its base image. As a result, containers can become outdated and potentially vulnerable to security threats unless they are manually updated. Automating the update process helps ensure containers stay secure and efficient without requiring constant manual intervention. 

We strongly recommend to install a solution for automating Docker container base image updates, such as Watchtower.