Raspberry Pi - The first knowledge sharing application in Vietnam

/PATH_TO_YOUR_CONFIG points at the folder where you want to store your configuration and run it.

MY_TIME_ZONE is a tz database name, like TZ=America/Los_Angeles.

Install

docker run -d
 \
  --name
 homeassistant \
  --privileged
 \
  --restart
=
unless-stopped \
  -e
 TZ
=
MY_TIME_ZONE \
  -v
 /PATH_TO_YOUR_CONFIG:/config \
  --network
=
host \
  ghcr.io/home-assistant/home-assistant:stable

Once the Home Assistant Container is running Home Assistant should be accessible using http://<host>:8123 (replace with the hostname or IP of the system). You can continue with onboarding.

Onboarding

Mục lục bài viết

Restart Home Assistant

If you change the configuration, you have to restart the server. To do that you have 3 options.

In your Home Assistant UI, go to the Settings > System and click the Restart button.
You can go to the Developer Tools > Services, select the service homeassistant.restart and select Call Service.
Restart it from a terminal.

Docker CLI

Docker Compose

docker restart homeassistant

docker compose restart

Docker compose

docker compose should already be installed on your system. If not, you can manually install it.

As the Docker command becomes more complex, switching to docker compose can be preferable and support automatically restarting on failure or system restart. Create a compose.yml file:

  version
:
 '
3'
  services
:
    homeassistant
:
      container_name
:
 homeassistant
      image
:
 "
ghcr.io/home-assistant/home-assistant:stable"
      volumes
:
        -
 /PATH_TO_YOUR_CONFIG:/config
        -
 /etc/localtime:/etc/localtime:ro
      restart
:
 unless-stopped
      privileged
:
 true
      network_mode
:
 host

Start it by running:

docker compose up -d

Once the Home Assistant Container is running, Home Assistant should be accessible using http://<host>:8123 (replace with the hostname or IP of the system). You can continue with onboarding.

Onboarding

Exposing devices

In order to use Zigbee or other integrations that require access to devices, you need to map the appropriate device into the container. Ensure the user that is running the container has the correct privileges to access the /dev/tty* file, then add the device mapping to your container instructions:

Docker CLI

Docker Compose

docker run ... --device /dev/ttyUSB0:/dev/ttyUSB0 ...

version
:
 '
3'
services
:
  homeassistant
:
    ...
    devices
:
      -
 /dev/ttyUSB0:/dev/ttyUSB0

Optimizations

The Home Assistant Container is using an alternative memory allocation library jemalloc for better memory management and Python runtime speedup.

As jemalloc can cause issues on certain hardware, it can be disabled by passing the environment variable DISABLE_JEMALLOC with any value, for example:

Docker CLI

Docker Compose

docker run ... -e
 "DISABLE_JEMALLOC=true" ...

version
:
 '
3'
services
:
  homeassistant
:
  ...
  environment
:
    -
 DISABLE_JEMALLOC
:
 true

The error message <jemalloc>: Unsupported system page size is one known indicator.

Install Home Assistant Core

This is an advanced installation process, and some steps might differ on your system. Considering the nature of this installation type, we assume you can handle subtle differences between this document and the system configuration you are using. When in doubt, please consider one of the other installation methods, as they might be a better fit instead.

Prerequisites

This guide assumes that you already have an operating system setup and have installed Python 3.10 (including the package python3-dev) or newer.

Install dependencies

Before you start, make sure your system is fully updated, all packages in this guide are installed with apt, if your OS does not have that, look for alternatives.

sudo apt-get update
sudo 
apt-get upgrade -y

Install the dependencies:

sudo 
apt-get install
 -y python3 python3-dev python3-venv python3-pip bluez libffi-dev libssl-dev libjpeg-dev zlib1g-dev autoconf build-essential libopenjp2-7 libtiff5 libturbojpeg0-dev tzdata

The above-listed dependencies might differ or missing, depending on your system or personal use of Home Assistant.

Create an account

Add an account for Home Assistant Core called homeassistant.
Since this account is only for running Home Assistant Core the extra arguments of -rm is added to create a system account and create a home directory.
The arguments -G dialout,gpio,i2c adds the user to the dialout, gpio and the i2c group. The first is required for using Z-Wave and Zigbee controllers, while the second is required to communicate with GPIO.

sudo 
useradd -rm
 homeassistant -G dialout,gpio,i2c

Create the virtual environment

First we will create a directory for the installation of Home Assistant Core and change the owner to the homeassistant account.

sudo mkdir /srv/homeassistant
sudo chown homeassistant:homeassistant /srv/homeassistant

Next up is to create and change to a virtual environment for Home Assistant Core. This will be done as the homeassistant account.

sudo
 -u
 homeassistant -H
 -s
cd /srv/homeassistant
python3 -m
 venv .
source bin/activate

Once you have activated the virtual environment (notice the prompt change to (homeassistant) [email protected]:/srv/homeassistant $) you will need to run the following command to install a required Python package.

python3 -m
 pip install wheel

Once you have installed the required Python package, it is now time to install Home Assistant Core!

pip3 install 
homeassistant
==2023.4.6

Start Home Assistant Core for the first time. This will complete the installation for you, automatically creating the .homeassistant configuration directory in the /home/homeassistant directory, and installing any basic dependencies.

hass

You can now reach your installation via the web interface on http://homeassistant.local:8123.

If this address doesn’t work you may also try http://localhost:8123 or http://X.X.X.X:8123 (replace X.X.X.X with your machines’ IP address).

When you run the hass command for the first time, it will download, install and cache the necessary libraries/dependencies. This procedure may take anywhere between 5 to 10 minutes. During that time, you may get a site cannot be reached error when accessing the web interface. This will only happen the first time. Subsequent restarts will be much faster.

Writing the image with Balena Etcher

Use this procedure if Raspberry Pi Imager is not supported by your platform.

Insert the SD card into the computer. Note: the contents of the card will be overwritten.
Download and start Balena Etcher. You may need to run it with administrator privileges on Windows.
Select Flash from URL.
Copy the correct URL for the Raspberry Pi 3 or 4 (Note: there are 2 different links below!):

Raspberry Pi 4

Raspberry Pi 3

https://github.com/home-assistant/operating-system/releases/download/10.1/haos_rpi4-64-10.1.img.xz

https://github.com/home-assistant/operating-system/releases/download/10.1/haos_rpi3-64-10.1.img.xz

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

Paste the URL for the image into Balena Etcher and select OK.
When Balena Etcher has downloaded the image, select Select target.
Select the SD card you want to use for your installation.
Select Flash! to start writing the image.
Once Balena Etcher has finished writing the image, you will see a confirmation.

We get commissions for purchases made through links in this post.

Help us to improve our documentation

Suggest an edit to this page, or provide/view feedback for this page.