Install NetBeez Agents


NetBeez supported options for Agents

  • Linux Debian
  • Virtual appliance (OVA)
  • Docker container
  • Windows client

software-agent-icon-150x150.png Option 1 - Debian Linux package

1. Log in to the Linux host where you want to install the software Agent.
Fetch the installation script:

curl -L -O

3. Execute the script as a sudo user (replace <secret_key_received_via_email> in the following command with the actual secret key received upon registration of your dashboard or find it on the About page in your NetBeez Settings):

sudo bash --modify-interface --secret=<secret_key_received_via_email>

Please note: 32-bit versions of Linux are not supported.

4. To update an installed Debian Linux agent to a newer version run:

sudo apt-get update; sudo apt-get install netbeez-agent


virtual-agent-icon.png Option 2 - Virtual appliance

1. Download the NetBeez Agent virtual appliance at the following URL:


MD5SUM: 13d9fc60600a3e206e20920b023191aa

2. Import the appliance into your virtual environment (VMWare, vBox, etc.)

     Note: If you are using vBox manager, make sure to select Linux/Ubuntu as OS Type.

     Note: By default, the OVA is provisioned with 1 vCPU and 1 GB of RAM; these resources should be enough for most installations.

3. Log in to the virtual appliance using netbeez/netbeez as username/password.

4. Fetch the installation script:

curl -L -O

5. Execute the script as a sudo user (replace <secret_key_received_via_email> in the following command with the actual secret key received upon registration of your dashboard or find it on the About page in your NetBeez settings):

sudo bash --secret="<secret_key_received_via_email>"


docker_facebook_share.png Option 3 - Docker container

NetBeez has released the Docker Agent, an Agent that runs in a Docker container. To install a Docker Agent, run the following command:

docker volume create netbeez-config-vol
docker run -d --restart=always -e "NB_SECRET_KEY=xxx" -v netbeez-config-vol:/etc/netbeez/persistence/:rw netbeez/nb-agent

Replace the 'xxx' with your server's secret key, as well as the volume with a created docker volume.

To configure the Docker Agent, follow the setup guide on DockerHub

A video with information on installing a Docker Agent on Windows can be viewed HERE.


win-icon.png Option 4 - Windows installer

The Windows Remote Worker agent is an executable program that runs on Windows Desktops and Laptops. Currently, both Windows 7 and 10 versions are supported.

1) Download the latest version of the executable (in MSI format) here:

NetBeez Windows agent MSI installer

2) Once dowloaded, double click on the MSI and follow the instruction; the installation wizard will ask you for the dashboard's secret key which can be found on the NetBeez dashboard by going to Settings -> About page. 

If the installation is successful, your agent will connect to the dashboard, and you will be able to find an icon on the Windows System Tray in the lower right to control the agent service. The NetBeez agent will start on Windows boot automatically.

The installer support Windows 7 and 10 operating systems. For mass deployment of the Windows remote worker agent by NetBeez, please review this article.



Q: What should I do after I have loaded the Agents?

A: Log in to your dashboard instance, the URL of which was sent with the welcome email, and then create and review your monitoring Targets.

Q: The OVA file I downloaded has an .ovf extension.

A: This is a known issue with Chrome. Please see the reported issue here. You can still load and use the image.

Q: Why doesn't the virtual Agent seem to boot after I have imported it in vBox?

A: Make sure to select Linux/Ubuntu-64 as a machine type.

Q: Where is the Agent log?

A: The default agent log file location is /var/log/netbeez/nbagent_prod.log for virtual and Raspberry Pi images, while it's /var/log/netbeez/netbeez-agent.log for the software Agent.

Q: What happens if the Agent does not show up on the dashboard?

A: Check out this troubleshooting guide

Q: I get an error decompressing the Raspberry Pi image on Windows.

A: Use the 7-Zip program on Windows.

Have more questions? Submit a request


Please sign in to leave a comment.