Setup & Configuration

We need to install the service through Portainer and configure any necessary settings.

Preparation

There are some things we need to do in preparation to install this service.

Volumes

Persistent Data

This is where the service will store its own application data and ensures we can quickly update the service image.

Ensure your user has permissions to access the folder.

Dbus Socket

This service needs access to the Linux Dbus, or Desktop Bus, in order to access Bluetooth, audio and other hardware devices.  We will only be providing "read-only" access meaning it cannot make changes.

This is required and the service will fail to start without access.

Environment

TZ

This is the current time zone formatted using the tz database.

For example: America/Vancouver

Installation

The service can be installed through the Portainer web interface. 

Learn about creating a new stack.

Docker Compose

Use the following code to install the service:

---
services:
  home-assistant:
    container_name: homeassistant
    image: "ghcr.io/home-assistant/home-assistant:stable"
    volumes:
      # Persistent Data
      - /srv/home-assistant/:/config

      # Hardware Access
      - /run/dbus:/run/dbus:ro
    restart: unless-stopped
    environment:
      - TZ=America/Vancouver
    privileged: true
    network_mode: host

Updating

Backup and Re-Deploy the Stack

Home Assistant has been optimized for running in Docker.  This allows you to re-deploy the stack through Portainer to download the latest updates. 

Integrations within your Home Assistant, especially those from the community store, may encounter issues with newer updates.  It is always a good idea to have a backup to downgrade your installation in case of errors.