7.6 KiB
title, description
title | description |
---|---|
Installing Home Assistant | Instructions on how to install Home Assistant. |
The following will take you through the steps required to install Home Assistant.
-
Download the appropriate install option:
-
As an image for your device:
-
As a virtual appliance (x86_64/UEFI):
- VMDK (VMWare Workstation)
- VHDX
- VDI
- QCOW2 (beta)
- OVA (Beta)
-
Not recommended Hardware:
-
-
Install Home Assistant:
- Flash the downloaded image to an SD card using balenaEtcher. If using a Pi, we recommend at least a 32 GB SD card to avoid running out of space.
- Load the appliance image into your virtual machine software. Allow at least 32 GB of disk space for the virtual machine. Choose 64-bit Linux and UEFI boot. For a KVM-based setup with
virt-manager
, set Firmware toUEFI x86_64: /usr/share/ovmf/x64/OVMF_CODE.fd
.
-
Optional - set up the Wi-Fi or a static IP address. There are two possible places for that:
- on a blank USB stick with a FAT32 partition having partition label
CONFIG
, while in its root directory, create thenetwork/my-network
file, or - on the Home Assistant SD card's first, bootable partition (labeled
hassos-boot
, might not be auto mounted in Linux) create theCONFIG/network/my-network
file.
For the content of this file, follow the Home Assistant Operating System howto.
- on a blank USB stick with a FAT32 partition having partition label
-
For image-based installs insert the SD card (and optional USB stick) into the device.
-
Turn on your device or virtual appliance. On first boot, it downloads the latest version of Home Assistant which takes around 20 minutes (slower/faster depending on the platform and your Internet connection).
-
You will be able to reach your installation at
http://homeassistant.local:8123
(if your router supports mDNS, otherwise see below).
We used hassio.local
in the past, if you have a system that is installed before this naming change, you might need to use hassio.local
instead of homeassistant.local
.
If your router doesn't support mDNS, then you'll have to use the IP address of your Pi instead of homeassistant.local
. For example, http://192.168.0.9:8123
. You should be able to find the IP address of your Pi from the admin interface of your router.
If you are using a Raspberry Pi please remember to ensure you're using an appropriate power supply with your Pi. Mobile chargers may not be suitable since some were only designed to provide just enough power to the device it was designed for by the manufacturer. Do not try to power the Pi from the USB port on a TV, computer, or similar.
Now you can configure your install.
Updating a Home Assistant installation
Best practice for updating a Home Assistant installation:
- Backup your installation, using the snapshot functionality Home Assistant offers.
- Check the release notes for breaking changes on Home Assistant release notes. Be sure to check all release notes between the version you are running and the one you are upgrading to. Use the search function in your browser (
CTRL + f
) and search for Breaking Changes. - Check your configuration using the Check Home Assistant configuration add-on.
- If the check passes, you can safely update. If not, update your configuration accordingly.
- Select Dashboard from the Supervisor menu, and then select Update.
Run a specific version on Home Assistant
For this you would need to install the Terminal & SSH add-on or use the console that is available on your device by connecting a keyboard and screen.
To install the Terminal & SSH add-on, choose Supervisor, which is located in the sidebar and then the add-on store.
Use the web-based terminal or SSH to your Home Assistant system, or connect to the console, and run:
ha core update --version=0.XX.X
Run the beta version on Home Assistant
If you would like to test next release before anyone else, you can install the beta version released every three weeks:
- Backup your installation, using the snapshot functionality Home Assistant offers.
- Check the Home Assistant Beta release notes for breaking changes. Be sure to check all release notes between the version you are running and the one you are upgrading to. Use the search function in your browser (
CTRL + f
) and search for Breaking Changes. - Select System tab from the Supervisor menu, then select Join Beta Channel under Supervisor, then select Reload.
- Select Dashboard tab from the Supervisor menu, and then select Update.