github
/
ha-operating-system
mirror of https://github.com/home-assistant/operating-system
1
Fork 0
Code Releases Activity
1,647 Commits 17 Branches 157 Tags 54 MiB
Python 71.6%
Shell 18.8%
Makefile 8%
HTML 0.8%
Groovy 0.4%
Other 0.4%
Go to file
Stefan Agner 8f07d16176
Improve HAOS builder Dockerfile (#2011) 		2022-07-08 22:36:02 +02:00
.github Set restrictive GitHub Action permissions (#1985) 2022-06-24 09:46:02 -07:00
Documentation Better detail on the wifi setup (#1990) 2022-07-08 13:57:23 +02:00
buildroot@e7a881ea75 Bump buildroot (#1986) 2022-06-24 09:57:01 -07:00
buildroot-external Increase Supervisor start rate limit (#2010) 2022-07-08 22:35:52 +02:00
scripts Use anonymous Docker volume as build output (#1825) 2022-03-31 23:43:37 +02:00
.dockerignore Improve HAOS builder Dockerfile (#2011) 2022-07-08 22:36:02 +02:00
.gitignore Ignore build output directory (#1453) 2021-07-09 16:16:34 +02:00
.gitmodules Use git submodule for buildroot (#1445) 2021-07-08 16:19:37 +02:00
.hadolint.yaml Create .hadolint.yaml 2019-05-09 10:10:53 +02:00
Dockerfile Improve HAOS builder Dockerfile (#2011) 2022-07-08 22:36:02 +02:00
LICENSE Update LICENSE 2018-04-15 10:27:33 +02:00
Makefile Recreate defconfigs using savedefconfig target (#1876) 2022-04-27 22:52:15 +02:00
README.md Devices description update (#1684) 2021-12-24 11:08:28 +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 Container engine. It by default 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

  • 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 os-builds.home-assistant.io.