# Home Assistant •

[Home Assistant](https://www.home-assistant.io/) is an open-source home automation and smart device dashboard. Protect your smart home with a focus on local-first security and user privacy.

# Overview

[![Screen Shot 2025-03-07 at 18.19.42.png](https://hub.subspace.services/uploads/images/gallery/2025-03/scaled-1680-/screen-shot-2025-03-07-at-18-19-42.png)](https://hub.subspace.services/uploads/images/gallery/2025-03/screen-shot-2025-03-07-at-18-19-42.png)

[Home Assistant](https://www.home-assistant.io/) is an open-source home automation and smart device dashboard. Protect your smart home with a focus on local-first security and user privacy.

<p class="callout success">Tryout a [Home Assistant demo](https://demo.home-assistant.io/#/lovelace/home).</p>

- An extensive open-source community dedicated to supporting over three thousand smart device and service integrations.
- Control your smart home from every device in your home.
- Integrated voice assistant support including the Home Assistant local-only voice service.

# Media

## Screenshots

<p class="callout info">Home Assistant v20250306.0</p>

<table border="1" id="bkmrk-" style="border-collapse: collapse; width: 100%; border-width: 1px; height: 59.6px; border-color: rgb(88, 110, 117);"><colgroup><col style="width: 33.3333%;"></col><col style="width: 33.3333%;"></col><col style="width: 33.3333%;"></col></colgroup><tbody><tr style="height: 29.8px;"><td style="border-width: 1px; height: 29.8px; border-color: rgb(88, 110, 117);">[![Screen Shot 2025-03-07 at 18.19.42.png](https://hub.subspace.services/uploads/images/gallery/2025-03/scaled-1680-/screen-shot-2025-03-07-at-18-19-42.png)](https://hub.subspace.services/uploads/images/gallery/2025-03/screen-shot-2025-03-07-at-18-19-42.png)</td><td style="border-width: 1px; height: 29.8px; border-color: rgb(88, 110, 117);">[![Screen Shot 2025-03-07 at 18.19.47.png](https://hub.subspace.services/uploads/images/gallery/2025-03/scaled-1680-/screen-shot-2025-03-07-at-18-19-47.png)](https://hub.subspace.services/uploads/images/gallery/2025-03/screen-shot-2025-03-07-at-18-19-47.png)</td><td style="border-width: 1px; height: 29.8px; border-color: rgb(88, 110, 117);">[![Screen Shot 2025-03-07 at 18.19.53.png](https://hub.subspace.services/uploads/images/gallery/2025-03/scaled-1680-/screen-shot-2025-03-07-at-18-19-53.png)](https://hub.subspace.services/uploads/images/gallery/2025-03/screen-shot-2025-03-07-at-18-19-53.png)</td></tr><tr style="height: 29.8px;"><td style="border-width: 1px; height: 29.8px; border-color: rgb(88, 110, 117);">[![Screen Shot 2025-03-07 at 18.20.08.png](https://hub.subspace.services/uploads/images/gallery/2025-03/scaled-1680-/screen-shot-2025-03-07-at-18-20-08.png)](https://hub.subspace.services/uploads/images/gallery/2025-03/screen-shot-2025-03-07-at-18-20-08.png)</td><td style="border-width: 1px; height: 29.8px; border-color: rgb(88, 110, 117);">[![Screen Shot 2025-03-07 at 18.20.21.png](https://hub.subspace.services/uploads/images/gallery/2025-03/scaled-1680-/screen-shot-2025-03-07-at-18-20-21.png)](https://hub.subspace.services/uploads/images/gallery/2025-03/screen-shot-2025-03-07-at-18-20-21.png)</td><td style="border-width: 1px; height: 29.8px; border-color: rgb(88, 110, 117);">[![Screen Shot 2025-03-07 at 18.20.39.png](https://hub.subspace.services/uploads/images/gallery/2025-03/scaled-1680-/screen-shot-2025-03-07-at-18-20-39.png)](https://hub.subspace.services/uploads/images/gallery/2025-03/screen-shot-2025-03-07-at-18-20-39.png)</td></tr><tr><td style="border-width: 1px; border-color: rgb(88, 110, 117);">[![Screen Shot 2025-03-07 at 18.21.09.png](https://hub.subspace.services/uploads/images/gallery/2025-03/scaled-1680-/screen-shot-2025-03-07-at-18-21-09.png)](https://hub.subspace.services/uploads/images/gallery/2025-03/screen-shot-2025-03-07-at-18-21-09.png)</td><td style="border-width: 1px; border-color: rgb(88, 110, 117);">[![Screen Shot 2025-03-07 at 18.21.16.png](https://hub.subspace.services/uploads/images/gallery/2025-03/scaled-1680-/screen-shot-2025-03-07-at-18-21-16.png)](https://hub.subspace.services/uploads/images/gallery/2025-03/screen-shot-2025-03-07-at-18-21-16.png)</td><td style="border-width: 1px; border-color: rgb(88, 110, 117);">[![Screen Shot 2025-03-07 at 18.21.22.png](https://hub.subspace.services/uploads/images/gallery/2025-03/scaled-1680-/screen-shot-2025-03-07-at-18-21-22.png)](https://hub.subspace.services/uploads/images/gallery/2025-03/screen-shot-2025-03-07-at-18-21-22.png)</td></tr><tr><td style="border-width: 1px; border-color: rgb(88, 110, 117);">[![Screen Shot 2025-03-07 at 18.21.42.png](https://hub.subspace.services/uploads/images/gallery/2025-03/scaled-1680-/screen-shot-2025-03-07-at-18-21-42.png)](https://hub.subspace.services/uploads/images/gallery/2025-03/screen-shot-2025-03-07-at-18-21-42.png)</td><td style="border-width: 1px; border-color: rgb(88, 110, 117);">  
</td><td style="border-width: 1px; border-color: rgb(88, 110, 117);">  
</td></tr></tbody></table>

# 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

<details id="bkmrk-media-folders-radarr"><summary>Persistent Data</summary>

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

<p class="callout warning">Ensure your user has permissions to access the folder.</p>

</details><details id="bkmrk-dbus-socket-this-ser"><summary>Dbus Socket</summary>

This service needs access to the Linux Dbus, or [Desktop Bus](https://en.wikipedia.org/wiki/D-Bus#:~:text=D%2DBus%20(short%20for%20%22,such%20as%20GNOME%20and%20KDE.), in order to access Bluetooth, audio and other hardware devices. We will only be providing "read-only" access meaning it cannot make changes.

<p class="callout warning">This is required and the service will fail to start without access.</p>

</details>## Environment

<details id="bkmrk-tz-this-is-the-curre"><summary>TZ</summary>

This is the current time zone formatted using the [tz database.](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)

<p class="callout info">*For example:* America/Vancouver</p>

</details>

# Installation

The service can be installed through the Portainer web interface.

<p class="callout info">Learn about [creating a new stack](https://hub.subspace.services/books/portainer/page/creating-a-new-stack "Creating a New Stack").</p>

## Docker Compose

Use the following code to install the service:

```yaml
---
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

<p class="callout warning">Backup and Re-Deploy the Stack</p>

Home Assistant has been optimized for running in Docker. This allows you to [re-deploy the stack through Portainer](https://hub.subspace.services/books/portainer/page/updating-a-stack "Updating a Stack") to download the latest updates.

Integrations within your Home Assistant, especially those from the [community store](https://www.hacs.xyz/), may encounter issues with newer updates. It is always a good idea to have a backup to downgrade your installation in case of errors.

# User Manual

# Development

<p class="callout info">This software is released under the [Apache License 2.0](https://opensource.org/license/apache-2-0). </p>

You can learn more about how to contribute to Home Assistant through their [documentation](https://github.com/home-assistant/core/blob/dev/CONTRIBUTING.md).

# Resources

## Official

- [Official Documentation](https://www.home-assistant.io/docs/)
- [Official Forum](https://community.home-assistant.io/)
- [Official GitHub Repository](https://github.com/home-assistant/)
- [Official Website](https://home-assistant.io)
- [Wikipedia Entry](https://en.m.wikipedia.org/wiki/Home_Assistant)
- [Installation Guide](https://www.home-assistant.io/installation/)
- [Frequently Asked Questions](https://www.home-assistant.io/faq/)
- [General Troubleshooting](https://www.home-assistant.io/docs/configuration/troubleshooting/)