Virtual Box

Domotz Agent Installation on Virtual Box (VM)

This section contains a few tips and tricks on how to get started with the Domotz Agent on your Virtual Box.

Installing the Domotz Agent

Step 0 – Download the VM Image:

1.Download the VirtualBox image from here:

https://domotz-vm-images-temp.s3.eu-west-1.amazonaws.com/virtualbox/domotzpro-ubuntu-24.04-x64-3.3.3-6.0.7-b001-0213-virtualbox7_2024_jul.zip

2. Unzip it in a location of your choice.

Step 1. Import Appliance:

After the download has finished, open Oracle VM VirtualBox Manager (which you need to have previously installed on your system), and from the File menu select Import Appliance:

Search for the downloaded file:

Select the downloaded .ova file:

and import the Domotz Agent Virtual box image and click Next:

Step 2 – Edit the VM settings:

When the import process is finished, please edit the VM settings:

Select the Network settings:

Change the NAT network to Bridge and click OK:

In case you want to monitor Windows TAP L2VPN configured interfaces, please jump to the NAT setup paragraph.

Now you can start the VM:

Step 3 – Setting up the IP address:

After the VM has started login as

username: domotz

password: domotz

and issue the ifconfig command in order to see the IP address of your Domotz Agent:

We strongly recommend changing the password as soon as possible, and in general to not allow SSH to the VM.

Now you can connect to the Domotz Agent using your browser using the IP you got with the ifconfig command followed by the 3000 port.
In this case, we will use the address http://192.168.1.110:3000/

IMPORTANT SECURITY NOTES:
After setting up your VM you must update it with security patches. You can do it by performing these two commands when logged into the cli as domotz user:
sudo apt update
sudo apt upgrade

Ensure to keep a process to continuously update and upgrade the system. Only the Domotz Agent software is automatically upgraded via SNAPd process.

VPN on Demand

If the Domotz Agent on the Virtual Machine is supposed to be used for the VPN On Demand, the following commands should be executed from within the Virtual Machine itself (connect via SSH using the above-provided credentials):

sudo snap install domotzpro-agent-publicstore
sudo snap connect domotzpro-agent-publicstore:firewall-control
sudo snap connect domotzpro-agent-publicstore:network-observe
sudo snap connect domotzpro-agent-publicstore:raw-usb
sudo snap connect domotzpro-agent-publicstore:shutdown
sudo snap connect domotzpro-agent-publicstore:system-observe

sudo sh -c 'echo tun >> /etc/modules'
sudo modprobe tun
 
This will basically make the Domotz Agent able to control the network stack to create a VPN on Demand tunnel.

After doing that restart the Agent package:
 
sudo snap restart domotzpro-agent-publicstore

NAT setup: Configuration for Windows TAP L2VPN

In case you have windows based TAP Layer2 VPNs you should use the NAT network in order to have Domotz scan your connected VPNs.

Step 1:

To do this go to the Network settings of your virtual machine and please select Attached to NAT (1), then Advanced (2), then click on the Port Forwarding (3) button:

Then insert these values by clicking on the + button at your right:

Step 2:

Start the VM and you will be able to access the Domotz Agent at http://127.0.0.1:3000