home-assistant.io/source/_includes/installation/operating_system.md

Install Home Assistant Operating System

{% assign release_url = "https://github.com/home-assistant/operating-system/releases/download" %}

Follow this guide if you want to get started with Home Assistant easily or if you have little to no Linux experience

{% if site.installation.types[page.installation_type].board %} {% if page.installation_type == 'raspberrypi' %}

Suggested Hardware

We will need a few things to get started with installing Home Assistant. Links below lead to Amazon US. If you’re not in the US, you should be able to find these items in web stores in your country.

• Power Supply (at least 3A)
• Micro SD Card. Ideally get one that is Application Class 2 as they handle small I/O much more consistently than cards not optimized to host applications. A 32 GB or bigger card is recommended.
• SD Card reader. This is already part of most laptops, but you can purchase a standalone USB adapter if you don't have one. The brand doesn't matter, just pick the cheapest.
• Ethernet cable. Home Assistant can work with Wi-Fi, but an Ethernet connection would be more reliable.

{% endif %}

Write the image to your installation media

1. Attach the installation media ({{site.installation.types[page.installation_type].installation_media}}) to your computer

2. Download and start Balena Etcher

3. Select "Flash from URL"

4. Get the URL for your {{site.installation.types[page.installation_type].board}}: {% if site.installation.types[page.installation_type].variants.size > 1 %} {% tabbed_block %} {% for variant in site.installation.types[page.installation_type].variants %}

• title: {{ variant.name }} content: |

  {{release_url}}/{{site.installation.versions.os}}/hassos_{{ variant.key }}-{{site.installation.versions.os}}.img.xz
  

  {% if variant.key == "odroid-n2" %} Guide: Flashing Odroid-N2 using OTG-USB {% elsif variant.key == "rpi4" %} (On the 8GB model 64-bit is recommended) {% endif %}

{% endfor %} {% endtabbed_block %} {% else %}

{{release_url}}/{{site.installation.versions.os}}/hassos_{{ site.installation.types[page.installation_type].variants[0].key }}-{{site.installation.versions.os}}.img.xz

{% endif %}

Select and copy the URL or use the "copy" button that appear when you hover it.

1. Paste the URL for your {{site.installation.types[page.installation_type].board}} into Balena Etcher and click "OK"
2. Balena Etcher will now download the image, when that is done click "Select target"
3. Select the {{site.installation.types[page.installation_type].installation_media}} you want to use for your {{site.installation.types[page.installation_type].board}}
4. Click on "Flash!" to start writing the image
5. When Balena Etcher is finished writing the image you will get this confirmation

Start up your {{site.installation.types[page.installation_type].board}}

1. Insert the installation media ({{site.installation.types[page.installation_type].installation_media}}) you just created
2. Attach a ethernet cable for network.
3. Attach a cable for power
4. Within a few minutes you will be able to reach Home Assistant on homeassistant.local:8123. If you are running an older Windows version or have a stricter network configuration, you might need to access Home Assistant at homeassistant:8123 or http://X.X.X.X:8123 (replace X.X.X.X with your {{site.installation.types[page.installation_type].board}}’s IP address).

{% else %}

Download the appropriate image

{% if page.installation_type == 'nuc' %}

• Intel NUC {% else %}
• VirtualBox (.vdi) {% if page.installation_type == 'macos' %}
• KVM (.qcow2) {% endif %} {% if page.installation_type == 'windows' or page.installation_type == 'linux' %}
• KVM (.qcow2)
• Vmware Workstation (.vmdk) {% elsif page.installation_type == 'alternative' %}
• KVM/Proxmox (.qcow2)
• VMware ESXi/vSphere (.ova) {% elsif page.installation_type == 'windows' %}
• Hyper-V (.vhdx) {% endif %} {% endif %} {% if page.installation_type == "nuc" %}

1. Put the SD card in your card reader.
2. Open balenaEtcher, select the Home Assistant image and flash it to the SD card.
3. Unmount the SD card and remove it from your card reader. {% else %}

Create the Virtual Machine

Load the appliance image into your virtual machine software. (Note: You are free to assign as much resources as you wish to the VM, please assign enough based on your add-on needs)

Minimum recommended assignments:

• 2GB RAM
• 32GB Storage
• 2vCPU

All these can be extended if your usage calls for more resources.

Hypervisor specific configuration

{% tabbed_block %}

• title: VirtualBox content: |

  1. Create a new virtual machine
  2. Select “Other Linux (64Bit)
  3. Select “Use an existing virtual hard disk file”, select the VDI file from above
  4. Edit the “Settings” of the VM and go “System” then Motherboard and Enable EFI
  5. Then “Network” “Adapter 1” Bridged and your adapter.

• title: KVM content: |

  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. Select your bridge under “Network Selection”
  6. Under customization select “Overview” -> “Firmware” -> “UEFI x86_64: …”.****

{% if page.installation_type == 'windows' or page.installation_type == 'linux' %}

• title: Vmware Workstation content: |

  1. Create a new virtual machine
  2. Select “Custom”, make it compatible with the default of Workstation and ESX
  3. Choose “I will install the operating system later”, select “Linux” -> “Other Linux 5.x or later kernel 64-bit”
  4. Select “Use Bridged Networking”
  5. Select “Use an existing virtual disk” and select the VMDK file above,

  After creation of VM go to “Settings” and “Options” then “Advanced” and select “Firmware type” to “UEFI”.

{% elsif page.installation_type == 'alternative' %}

• title: VMware ESXi/vSphere content: | Use the “E1001” or “E1001E” virtual network adapater. There are confirmed mDNS/Multicast discovery issues when using VMware’s “VMXnet3” virtual network adapter.

{% elsif page.installation_type == 'windows' %}

• title: Hyper-V content: |

  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”. {% endif %}

{% endtabbed_block %}

Start up your Virtual Machine

1. Start the Virtual Machine
2. Observe the boot process of Home Assistant Operating System
3. Once completed you will be able to reach Home Assistant on homeassistant.local:8123. If you are running an older Windows version or have a stricter network configuration, you might need to access Home Assistant at homeassistant:8123 or http://X.X.X.X:8123 (replace X.X.X.X with your {{site.installation.types[page.installation_type].board}}’s IP address).

{% endif %}

{% endif %}

With the Home Assistant Operating System installed and accessible you can continue with onboarding.

{% include getting-started/next_step.html step="Onboarding" link="/getting-started/onboarding/" %}