Portuguese English Spanish
Portuguese English Spanish
Breadcrumbs

Install the DCA and Cloud Connector agent on Linux (other distributions)

To start monitoring your devices, it is essential to install the DCA and Cloud Connector agent.

If the gateway is used for communication between the agent and the portal, follow these steps before installing the DCA and Cloud Connector agent:

  1. Install the Gateway Connector on Windows

  2. Transfer the gateway certificate from Windows to Linux

Instructions

Information

Currently, the Linux agent only supports monitoring meters, supplies, and events for network printers (NDD - Printer Monitor service) and USB printers (NDD - Printer Monitor USB service).

For USB printers (NDD service - Printer Monitor USB), see the compatible models at Configure the DCA and Cloud Connector agent on Linux.

Note

This step-by-step has been approved for the Fedora distribution, but is compatible with other Linux distributions.

For installation on Ubuntu-based distributions, consult the specific documentation: Install the DCA and Cloud Connector agent on Linux (Ubuntu and Ubuntu-based distributions).

  1. Create the customers where the agents will be installed

  2. Check the installation prerequisites

  3. Check that the computer is connected to the internet

  4. Prepare the environment

  5. Open the terminal

Manual installation
Step 1: install the libusb1 library

Note

This installation is only necessary for USB printer monitoring.

  1. Run the command below in the terminal to install the library:

Bash
sudo dnf install libusb1-devel
Step 2: download the file ndd-package.sig

  1. Run the command below in the terminal to download the file:

sudo wget https://packages-orbix.ndd.tech/generic-linux/ndd-package.sig
Step 3: download and import the signing key

  1. Run the command below in the terminal to download the key:

sudo wget -O /usr/share/keyrings/ndd.public https://packages-orbix.ndd.tech/generic-linux/ndd.public

  1. Run the command below in the terminal to import the key:

sudo gpg --import /usr/share/keyrings/ndd.public

Once the import is complete, check that the ndd-package.sig file is owned by NDD by running the command below:

sudo gpg --output ndd-package.sh --decrypt ndd-package.sig

When you run the command, it should return the answer below among the other information:

Good signature from "NDD Print <print@ndd.tech>"

Step 4: grant the file execute permission

  1. Run the command below in the terminal to check that the files are in the installation folder:

ls -l

When you run the command, the files below should be listed:

ndd-package.sh
ndd-package.sig

  1. Run the command below in the terminal to grant execute permission:

sudo chmod +x ndd-package.sh
Step 5: install the agent

  1. Run the command below in the terminal to install the agent:

sudo ./ndd-package.sh install ndd-dca-and-cloud-connector

  1. Enter the Tenant (provider name) and press Enter

Tip

How to find information on the portal:

  • Provider name: in the upper right corner, below your name:

image-20250528-180550.png

  1. Enter the Organization ID (customer identification key) and press Enter

Tip

How to find information on the portal:

  • Customer identification key: in the customer properties:

  1. Go to the Administration > Customers menu

  2. Click on the name of the desired customer to open its properties

  3. In the Info tab, copy the Identification key

image-20250528-180703.png

The agent and service will be installed on the computer.

Step 6: configure agent communication

Direct communication

No action is required.


Proxy communication

To establish the type of communication between the agent and the portal by proxy:

  1. Run the command below in the terminal to configure the proxy:

sudo ndd-proxy-config

  1. In Insert proxy address, enter the IP address or hostname of the proxy and press Enter

  2. In Insert proxy port, enter the proxy port and press Enter

  3. In Use authentication?, type y if you want to use authentication or n if you don't, and press Enter

    1. If you want to use authentication:

      1. In Insert proxy user, enter the proxy's authentication user and press Enter

      2. In Insert proxy password, enter the proxy's authentication password and press Enter

    2. If you don't want to use authentication, just press Enter in both fields

  4. Run the command below in the terminal to enable the proxy:

sudo ndd-proxy-config --enable

  1. Run the command below in the terminal to restart the NDD - DCA and Cloud Connector service:

sudo systemctl restart NDDDCAandCloudConnector

  1. Run the command below in the terminal to restart the NDD - Printer Monitor service:

sudo systemctl restart NDDPrinterMonitor

  1. Run the command below in the terminal to restart the NDD - Printer Monitor USB service:

sudo systemctl restart NDDPrinterUsbMonitor


Gateway communication

To establish the type of communication between the agent and the portal by gateway:

  1. Run the command below in the terminal to configure the gateway:

sudo ndd-gateway-config

  1. In Insert Gateway Connector host, enter the IP address or hostname of the computer/server where the Gateway Connector was installed, and press Enter

  2. In Insert Gateway Connector port, enter the gateway port and press Enter
    The default gateway port is 9635, but you can enter another port if you wish.

  3. Run the command below in the terminal to enable the gateway:

sudo ndd-gateway-config --enable

  1. Run the command below in the terminal to restart the NDD - DCA and Cloud Connector service:

sudo systemctl restart NDDDCAandCloudConnector

  1. Run the command below in the terminal to restart the NDD - Printer Monitor service:

sudo systemctl restart NDDPrinterMonitor

  1. Run the command below in the terminal to restart the NDD - Printer Monitor USB service:

sudo systemctl restart NDDPrinterUsbMonitor
Silent installation

The ndd-package.sh script does not prompt for input in the terminal. However, during the initial installation, the postinst script for the ndd-dca-and-cloud-connector package prompts for the TENANT and ORGANIZATION_ID if the /etc/orbix/agent/appsettings.json file does not yet exist and this information has not been configured.

To keep the installation silent, specify TENANT and ORGANIZATION_ID in the command. Pass the variables along with sudo; an export command executed before sudo does not reach the installer.

Parameters for silent installation of DCA and Cloud Connector on Linux

Parameter

Description

Required

Default

Usage

TENANT

Provider name

Yes, on first installation

If not specified, it will be requested in the terminal

DCA and Cloud Connector and services

ORGANIZATION_ID

Customer identification key

Yes, on first installation

If not specified, it will be requested in the terminal

DCA and Cloud Connector and services

N.N.N

Version of the DCA and Cloud Connector agent to install

No

If not specified, the current version is installed

DCA and Cloud Connector

GATEWAY_HOST

IP address or hostname of the computer/server where the Gateway Connector is installed

No

127.0.0.1

DCA and Cloud Connector

GATEWAY_PORT

Gateway Connector port

No

9635

DCA and Cloud Connector

PACKAGE_SOURCE

Source address for packages

No

https://packages-orbix.ndd.tech/generic-linux

All generic packages

TENANT and ORGANIZATION_ID also apply to services if they are defined at the time of their installation. The terminal does not prompt for this information.

Choose one of the options below to install the DCA and Cloud Connector agent:

Install the DCA and Cloud Connector agent with direct communication

  1. Copy the command below:

    Bash
    sudo TENANT="tenant-name" \
     ORGANIZATION_ID="client-id" \
     ./ndd-package.sh install ndd-dca-and-cloud-connector 1.2.3

  2. Paste it into the terminal

  3. Replace tenant-name with the provider’s name

Tip

How to find information on the portal:

  • Provider name: in the upper right corner, below your name:

image-20250528-180550.png

  1. Replace client-id with the client identification key

Tip

How to find information on the portal:

  • Customer identification key: in the customer properties:

image-20250528-180703.png

  1. Go to the Administration > Customers menu

  2. Click on the name of the desired customer to open its properties

  3. In the Info tab, copy the Identification key

  1. Replace 1.2.3 with the specific version of the agent or remove 1.2.3 to install the latest version

  2. If you want to reinstall the same version, replace the command ./ndd-package.sh install ndd-dca-and-cloud-connector 1.2.3 with ./ndd-package.sh force-install ndd-dca-and-cloud-connector

  3. Run the adjusted command to install the agent

Install the DCA and Cloud Connector agent with gateway communication

  1. Copy the command below:

    Bash
    sudo TENANT="tenant-name" \
     ORGANIZATION_ID="client-id" \
     GATEWAY_HOST="127.0.0.1" \
     GATEWAY_PORT="9635" \
     ./ndd-package.sh install ndd-dca-and-cloud-connector 1.2.3

  2. Paste it into the terminal

  3. Replace tenant-name with the provider’s name

Tip

How to find information on the portal:

  • Provider name: in the upper right corner, below your name:

image-20250528-180550.png

  1. Replace client-id with the client identification key

Tip

How to find information on the portal:

  • Customer identification key: in the customer properties:

image-20250528-180703.png

  1. Go to the Administration > Customers menu

  2. Click on the name of the desired customer to open its properties

  3. In the Info tab, copy the Identification key

  1. If you want, replace 127.0.0.1 with the IP address or hostname of the computer/server where the Gateway Connector was installed

  2. If you want, replace 9635 with the Gateway Connector port

  3. Replace 1.2.3 with the specific version of the agent or remove 1.2.3 to install the latest version

  4. If you want to reinstall the same version, replace the command ./ndd-package.sh install ndd-dca-and-cloud-connector 1.2.3 with ./ndd-package.sh force-install ndd-dca-and-cloud-connector

  5. Run the adjusted command to install the agent

Remove the DCA and Cloud Connector agent

  1. Run the command below in the terminal to uninstall the agent:

    Bash
    sudo ./ndd-package.sh remove ndd-dca-and-cloud-connector

Install the network printer and/or USB printer monitoring service:

Install the network printer monitoring service

Follow the steps below to install the NDD - Printer Monitor service:

  1. Copy the command below:

    Bash
    sudo TENANT="tenant-name" \
     ORGANIZATION_ID="client-id" \
     ./ndd-package.sh install ndd-dca-printer-network-agent

  2. Paste it into the terminal

  3. Replace tenant-name with the provider’s name

Tip

How to find information on the portal:

  • Provider name: in the upper right corner, below your name:

image-20250528-180550.png

  1. Replace client-id with the client identification key

Tip

How to find information on the portal:

  • Customer identification key: in the customer properties:

image-20250528-180703.png

  1. Go to the Administration > Customers menu

  2. Click on the name of the desired customer to open its properties

  3. In the Info tab, copy the Identification key

  1. Run the adjusted command to install the service

Install the USB printer monitoring service

Follow the steps below to install the NDD - Printer Monitor USB service:

  1. Copy the command below:

    Bash
    sudo TENANT="tenant-name" \
     ORGANIZATION_ID="client-id" \
     ./ndd-package.sh install ndd-dca-printer-monitor-usb-agent

  2. Paste it into the terminal

  3. Replace tenant-name with the provider’s name

Tip

How to find information on the portal:

  • Provider name: in the upper right corner, below your name:

image-20250528-180550.png

  1. Replace client-id with the client identification key

Tip

How to find information on the portal:

  • Customer identification key: in the customer properties:

image-20250528-180703.png

  1. Go to the Administration > Customers menu

  2. Click on the name of the desired customer to open its properties

  3. In the Info tab, copy the Identification key

  1. Run the adjusted command to install the service

Last updated: