Go to file
Jan Čermák 5c1a505322
Bump OS to development version 12.3.dev0
2024-03-28 11:30:21 +01:00
.github Bump docker/setup-buildx-action from 3.1.0 to 3.2.0 (#3257) 2024-03-18 15:35:15 +01:00
.os-artifacts Maintain and upload artifacts index (#2839) 2023-10-26 20:24:04 +02:00
Documentation Linux: Update kernel to 6.6.23 (#3270) 2024-03-27 10:20:35 +01:00
buildroot@15dc3b6e0c Bump OS to development version 12.3.dev0 2024-03-28 11:30:21 +01:00
buildroot-external Bump OS to development version 12.3.dev0 2024-03-28 11:30:21 +01:00
scripts Include links to kernel changelogs on kernel bump (#3133) 2024-02-01 11:27:52 +01:00
tests Fix test_restore_ssl_directory with HA CLI in interactive PTY (#3239) 2024-03-12 14:55:10 +01:00
.dockerignore Improve HAOS builder Dockerfile (#2011) 2022-07-08 22:36:02 +02:00
.gitignore Create foundation for Labgrid-based OS tests (#2812) 2023-10-17 18:23:29 +02:00
.gitmodules Fix remote tracking branch for Buildroot submodule (#2288) 2022-12-27 09:05:39 +01:00
.hadolint.yaml Create .hadolint.yaml 2019-05-09 10:10:53 +02:00
Dockerfile Dockerfile: migrate to trusted.gpg.d for docker repo keys (#3090) 2024-01-19 11:02:34 +01:00
LICENSE Update LICENSE 2018-04-15 10:27:33 +02:00
Makefile Adjust Home Assistant OS versioning to prepare for new release strategy (#2767) 2023-09-25 13:41:50 +02:00
README.md List Nabu Casa appliances under boards README.md (#3260) 2024-03-20 09:35:58 +01:00

README.md

Home Assistant Operating System

Home Assistant Operating System (formerly HassOS) is a Linux based operating system optimized to host Home Assistant and its Add-ons.

Home Assistant Operating System uses Docker as its container engine. By default it deploys the Home Assistant Supervisor as a container. Home Assistant Supervisor in turn uses the Docker container engine to control Home Assistant Core and Add-Ons in separate containers. Home Assistant Operating System is not based on a regular Linux distribution like Ubuntu. It is built using Buildroot and it is optimized to run Home Assistant. It targets single board compute (SBC) devices like the Raspberry Pi or ODROID but also supports x86-64 systems with UEFI.

Features

  • Lightweight and memory-efficient
  • Minimized I/O
  • Over The Air (OTA) updates
  • Offline updates
  • Modular using Docker container engine

Supported hardware

  • Nabu Casa
  • Raspberry Pi
  • Hardkernel ODROID
  • Asus Tinker Board
  • Generic x86-64 (e.g. Intel NUC)
  • Virtual appliances

See the full list and specific models here

Getting Started

If you just want to use Home Assistant the official getting started guide and installation instructions take you through how to download Home Assistant Operating System and get it running on your machine.

If you're interested in finding out more about Home Assistant Operating System and how it works read on...

Development

If you don't have experience with embedded systems, Buildroot or the build process for Linux distributions it is recommended to read up on these topics first (e.g. Bootlin has excellent resources).

The Home Assistant Operating System documentation can be found on the Home Assistant Developer Docs website.

Components

  • Bootloader:
    • Barebox for devices that support UEFI
    • U-Boot for devices that don't support UEFI
  • Operating System:
  • File Systems:
    • SquashFS for read-only file systems (using LZ4 compression)
    • ZRAM for /tmp, /var and swap (using LZ4 compression)
  • Container Platform:
    • Docker Engine for running Home Assistant components in containers
  • Updates:
    • RAUC for Over The Air (OTA) and USB updates
  • Security:

Development builds

The Development build GitHub Action Workflow is a manually triggered workflow which creates Home Assistant OS development builds. The development builds are available at https://os-artifacts.home-assistant.io/index.html.