Windows

Create the virtual machine

The following steps use VirtualBox Basic Mode, which provides a simplified wizard for creating and configuring a virtual machine.

1. Open VirtualBox, and select New on the toolbar.
2. In the Virtual machine name and operating system step, specify the following settings:
   • Name: Enter Home Assistant.
   • VM Folder: Select a location to store the virtual machine files.
   • ISO Image: Leave blank.
   • OS: Select Linux.
   • OS Distribution: Select Oracle Linux (64-bit). If you use a Mac with Apple silicon (M1, M2, or M3), select ARM 64-bit instead.
3. Select Next.
4. In the Specify virtual hardware step, specify the following settings:
   • Base Memory: Set to at least 2048 MB, which is 2 GB.
   • Number of CPUs: Set to at least 2.
   • Use EFI: Select the checkbox to use UEFI instead of legacy BIOS. Home Assistant requires UEFI to boot.
5. Select Next.
6. In the Summary step, review the settings and select Finish.

Attach the Home Assistant disk (VDI)

Configure the virtual machine to use the Home Assistant disk (VDI) that you downloaded and extracted earlier.

1. Select your new Home Assistant VM in the list, and then select Settings on the toolbar.
2. Go to the Storage section.
3. In the Storage Devices list, under Controller: SATA, right-click the empty placeholder disk and select Remove attachment.
4. Next to Controller: SATA, select the Add hard disk icon (the blue disk with a plus sign).
5. In the dialog that appears, select the Add button.
6. Find and select the downloaded .vdi file.
7. Select Choose to confirm the file.

Configure network

1. While still in the Settings window, go to the Network section.
2. In Attached to, change the setting to Bridged Adapter.
3. In Name, select the network adapter you use for internet access. Home Assistant uses this adapter to communicate with other devices on your network. If your computer uses Wi-Fi, select your Wi-Fi adapter. If it uses a wired connection, select your Ethernet adapter.
4. Select OK.

Enable automatic disk space reclamation (optional)

By default, VirtualBox does not reclaim unused disk space from virtual disks. To enable automatic disk shrinking for the Home Assistant VDI, run the following command on the host machine:

VBoxManage storageattach <VM name> --storagectl "SATA" --port 0 --device 0 --nonrotational on --discard on

For more information about the command, see VBoxManage storageattach command.

1. Download the .qcow2 image above and decompress it. (Extract all in Windows)
2. Store the image in the isos share on your server.
3. Make sure under Settings > VM manager, Enable VMs is enabled.
4. Create a new virtual machine: VMS > Add VM.
5. Select type Linux and give the VM a name and a description.
6. Select the CPU cores you want to let the VM use and give it some memory.
7. Under Primary vDisk Location, select Manual and then select the qcow2 image.
8. Select your keyboard language under VM Console Keyboard.
9. Select br0 under Network Source.
10. Select virtio under Network model.
11. Select any USB-devices that you want to pass through to Home Assistant, such as Zigbee- or Z-Wave controllers.
12. Deselect Start VM after creation.
13. Select Create.
14. Select the name of your new VM and select the capacity number for your disk. Here, you can expand the disk to whatever your needs are. The default is 32 GB.
15. Select the icon of your new VM and select start with console (VNC).

1. Create a new virtual machine in virt-manager.
2. Select Import existing disk image, provide the path to the QCOW2 image above.
3. Choose Generic Default for the operating system.
4. Check the box for Customize configuration before install.
5. Under Network Selection, select your bridge.
6. Under customization select Overview > Firmware > UEFI x86_64: …. Make sure to select a non-secureboot version of OVMF (does not contain words such as secure or secboot), for example /usr/share/edk2/ovmf/OVMF_CODE.fd.
7. Select Add Hardware (bottom left), and select Channel.
8. Select device type: unix.
9. Select name: org.qemu.guest_agent.0.
10. Finally, select Begin Installation (upper left corner).

virt-install --name haos --description "Home Assistant OS" --os-variant=generic --ram=4096 --vcpus=2 --disk <PATH TO QCOW2 FILE>,bus=scsi --controller type=scsi,model=virtio-scsi --import --graphics none --boot uefi

If you have a USB dongle to attach, you need to add the option --hostdev busID.deviceId. You can discover these IDs via the lsusb command. As example, if lsusb output is:

   Bus 004 Device 001: ID 1d6b:0003 Linux Foundation 3.0 root hub
   Bus 003 Device 004: ID 30c9:0052 Luxvisions Innotech Limited Integrated RGB Camera
   Bus 003 Device 003: ID 1a86:55d4 QinHeng Electronics SONOFF Zigbee 3.0 USB Dongle Plus V2
   Bus 003 Device 002: ID 06cb:00fc Synaptics, Inc. 
   Bus 003 Device 005: ID 8087:0033 Intel Corp. 
   Bus 003 Device 001: ID 1d6b:0002 Linux Foundation 2.0 root hub
   Bus 002 Device 001: ID 1d6b:0003 Linux Foundation 3.0 root hub
   Bus 001 Device 001: ID 1d6b:0002 Linux Foundation 2.0 root hub

You can recognize the Sonoff dongle at Bus 003 Device 003. So the command to install the VM will become:

virt-install --name haos --description "Home Assistant OS" --os-variant=generic --ram=4096 --vcpus=2 --disk <PATH TO QCOW2 FILE>,bus=scsi --controller type=scsi,model=virtio-scsi --import --graphics none --boot uefi --hostdev 003.003

Note that this configuration (bus 003, device 003) is just an example, your dongle could be on another bus and/or with another device ID. Please check the correct IDs of your USB dongle with lsusb.

1. Start VMware Workstation and select Create a New Virtual Machine.
   • Note: the exact name and location of the settings below depend on the VMware version. This procedure is based on version 17.
2. Select I will install the operating system later, then select Linux > Other Linux 5.x kernel 64-bit.
3. Give the VM a name, home-assistant, and define an easy to reach storage location, such as C:\home-assistant.
4. Specify the disk size and select Store virtual disk as a single file.
5. Select Customize Hardware.
6. Define the amount of memory and the number of cores the VM is allowed to use.
7. Remove the New CD/DVD entry. It will not be used.
8. Connect an Ethernet cable and make sure it is connected to your network.
9. Under Network adapter, select Bridged: Connected directly to the physical network.
   • Make sure Replicate physical network connection state is not selected.
   • Select Configure Adapters.
   • Make sure all virtual adapters and Bluetooth devices are deselected.
   • Select your host network adapter. Most likely, this is one of the first 2 checkboxes in the list:
     • Select the one for Ethernet.
     • The exact names of these adapters depend on your hardware.
10. At the end of the wizard, select Finish.

Edit the VM settings

11. In Windows Explorer, go to the storage location of your newly created VM, for example under C:\home-assistant.
12. Delete the home-assistant.vmdk file.
13. In the Downloads folder, find the haos_ova_xx.x.vmdk file. - If you haven’t unzipped the archive, unzip it. - Within the folder, find the .vmdk file and rename it to home-assistant.vmdk. - Paste the file (not the unzipped folder) into the C:\home-assistant folder.
14. Right-click the .vmx file and select Open with > Notepad.
15. Under .encoding, add a line. Enter firmware = "efi".
16. Now continue with the next step to start your VM. - If you see a message about side channel mitigations, select OK. - If you see a message stating that the .vmdk file could not be found, in step 13, you likely pasted the folder, not the file. Repeat step 13.

⚠️ Hyper-V does not have USB support.

1. Create a new virtual machine.
2. Select Generation 2.
3. Select Connection > Your Virtual Switch that is bridged.
4. Select Use an existing virtual hard disk and select the VHDX file from above.

After creation, go to Settings > Security and deselect Enable Secure Boot.