Home Assistant

Common tasks - Container

Update

Best practice for updating Home Assistant Core:

  1. Backup your installation.
  2. Check the release notes for backward-incompatible 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 / CMD + f) and search for Backward-incompatible changes.

First start with pulling the new container.

docker pull ghcr.io/home-assistant/home-assistant:stable

You then need to recreate the container with the new image.

docker compose pull homeassistant
docker compose up -d

Run a specific version

In the event that a Home Assistant Core version doesn’t play well with your hardware setup, you can downgrade to a previous release. In this example 2024.4.3 is used as the target version but you can choose the version you desire to run.

docker pull ghcr.io/home-assistant/home-assistant:2024.4.3

You then need to recreate the container with the new image.

Run a beta version

If you would like to test next release before anyone else, you can install the beta version.

docker pull ghcr.io/home-assistant/home-assistant:beta

You then need to recreate the container with the new image.

Run a development version

If you want to stay on the bleeding-edge Home Assistant Core development branch, you can upgrade to dev.

The dev branch is likely to be unstable. Potential consequences include loss of data and instance corruption.

docker pull ghcr.io/home-assistant/home-assistant:dev

You then need to recreate the container with the new image.

Configuration check

After changing configuration files, check if the configuration is valid before restarting Home Assistant Core.

If your container name is something other than homeassistant, change that part in the examples below.

Run the full check:

docker exec homeassistant python -m homeassistant --script check_config --config /config

Listing all loaded files:

docker exec homeassistant python -m homeassistant --script check_config --files

Viewing an integration’s configuration (light in this example):

docker exec homeassistant python -m homeassistant --script check_config --info light

Or all integrations’ configuration

docker exec homeassistant python -m homeassistant --script check_config --info all

You can get help from the command line using:

docker exec homeassistant python -m homeassistant --script check_config --help