Installing Onboard's Edge Software

Onboard's Edge Software is packaged into an OVA file and deployed as a VM in a virtualization environment (E.g. VMware).

Before proceeding, ensure all hardware, virtualization, and network requirements are met. Refer to the Steps to a Successful Installation guide.

‍

🏢 Step 1: Create Your Building & Deployment

Before installing the Edge Node, you need to set up your site in the Onboard App using the Building Launcher.

1. Navigate to the Building Launcher in the Onboard App.
2. Enter your building details and click Create Building.
   • This automatically creates an associated Deployment for your building in the system.
3. Once created, you will be directed to the Deployments page where you will see your new building's deployment.

You are now ready to create a Collector for your Deployment.

‍

⚙️ Step 2: Create a Collector & Download the ISO

A Collector must be created for your Deployment before the Edge Node can be installed. Creating a Collector generates the ISO file used to activate the Edge Node.

⚠️ Only one Collector can remain active per Deployment at a time.

‍

When should you create a new Collector?

Create a new Collector if:

• This is your first installation for the Deployment
• You need to run an updated version of the Collector
• You need to configure a static IP address
• You need to enable audit access (e.g., for IT security scans)
• You need to allow Onboard WireGuard® VPN access for troubleshooting

⚠️ Collector configurations cannot be edited after creation. If you need to modify static IP, audit access, or VPN settings, disable the existing Collector on the Management tab and provision a new one.

‍

How to create a Collector?

1. Navigate to the Deployments page in the Onboard App.
2. Click on the building Deployment where you want to install the Edge Node.
3. Open the Management tab.
4. Click Create Collector.
   • You will see configuration options for Static IP, Audit SSH Key, and Onboard WireGuard Access.
   • If none of these are required, leave the fields blank.
5. Click Submit. This will download filename.iso.gz.
   • You will also see a prompt to download the latest Onboard Edge Node OVA file. If you do not already have the latest version, download it using the link provided. The OVA contains the Edge Node software packaged as a virtual machine image, you will deploy this in your virtualization environment to run the Edge Node inside your building's network.
6. Extract the downloaded iso.gz file using 7-Zip or gunzip.
   • After extraction, you should have: filename.iso

⚠️ The ISO file is valid for 14 days from the date of creation and can be used up to 5 times.

‍

🖥️ Step 3: Import the OVA

1. Open your virtualization environment
2. Click File → Open
3. Select the provided .ova file
4. Click Import
5. Wait until the virtual machine appears in your library.

⚠️ Do not power on the VM yet.

‍

💿 Step 4: Attach the ISO as a Virtual CD/DVD

1. Select the imported VM
2. Click Edit virtual machine settings
3. Select CD/DVD (SATA)
4. Choose Use ISO image file
5. Browse and select filename.iso
6. Ensure "Connect at power on" is checked

▶️ Step 5: Boot the VM

1. Select the VM
2. Click Power on
3. The VM will boot with the ISO mounted as a virtual CD
4. Follow any on-screen prompts

✅ Step 6: Verify Connectivity

Return to the Deployments page in the Onboard App.

• The deployment status should change to Online.
• You can verify heartbeats under the Monitoring tab, check the Last Contact timestamp.

If the deployment shows Online and heartbeats are updating, the Edge Node is successfully connected and data collection will being shortly if the connectivity requirements are met.

‍

🔌 Bridged Network Connectivity Issues (Windows Host)

If the Edge Node VM fails to connect with Onboard in Bridged mode (e.g., DNS errors or no internet connectivity), verify your Windows network adapter configuration.

On your Windows host:

1. Open Network Connection Settings.
2. Identify the adapter currently providing internet access (Ethernet or Wi-Fi).
3. Ensure VMware Bridge Protocol is:
   • Enabled only on your active internet adapter.
   • Disabled on all other adapters (Bluetooth, VPN, unused, or virtual adapters).
4. Restart the VM.

‍

⚠️ Still not connecting? Capture a screenshot of your VM Network Settings and share it with support@onboarddata.io for further assistance