How to install Home Assistant via Docker and download the necessary components

How to install Home Assistant via Docker and download the necessary components

📖 Overview

This document provides a comprehensive guide on how to install Home Assistant using a Docker container on Robustel Edge Gateways (EG Series) running RobustOS Pro. Additionally, it covers the necessary steps to download and configure the Home Assistant Community Store (HACS) component.

Running Home Assistant on a Robustel Edge Gateway transforms your device into a powerful, locally-controlled hub for smart home and industrial IoT automation. Integrating HACS further extends its functionality by allowing you to easily install community-developed plugins, custom cards, and integrations.


🛠 What You'll Need

Hardware Requirements:

  • A Robustel Edge Gateway (e.g., EG5100, EG5120, EG5200).

Software/Firmware Requirements:

  • RobustOS Pro: v2.3.0 or newer.
  • SSH Client (e.g., PuTTY, macOS/Linux Terminal) to access the gateway's command line.

Other Requirements:

  • Internet Access: The gateway must have an active internet connection to pull the Docker image.

📝 Note: If your gateway is not yet connected to the internet, please refer to the relevant documentation on configuring cellular or Ethernet WAN connectivity.

  • Sudo User Account: A user with sudo privileges must be created in the device configuration page.

📝 Note: Refer to How to create a sudo user with SSH access on an EG series device to create a user if one does not exist.

  • Docker runtime environment: Installed and running on the gateway.

📝 Note: Refer to How to Install Docker on Robustel EG Series Gateways via Debian Package Manager to install Docker if it is not already installed.

  • A valid GitHub account: Required for the HACS configuration phase).

🚀 Step-by-Step Configuration Guide

1️⃣ Step 1: Install and Run Home Assistant

First, you will deploy the Home Assistant container using the command line.

  1. Open your SSH client and connect to the gateway.
  2. Run the following Docker command to pull the image, create the container, and start Home Assistant.
sudo docker run -d \
--name homeassistant \
--privileged \
--restart=unless-stopped \
-e TZ=Asia/Shanghai \
-v /usr/local/HAconfig:/config \
-v /run/dbus:/run/dbus:ro \
--network=host \
ghcr.io/home-assistant/home-assistant:stable

📝 Note: The system may prompt you to enter the password for your sudo user to authorize the installation. The -e TZ=Asia/Shanghai parameter sets the timezone. Please modify Asia/Shanghai to match your local timezone (e.g., America/New_York, Europe/London).

⚠️ Warning: The Home Assistant Docker image is quite large. Depending on your network speed, the download may take some time. Please be patient and do not interrupt the process.

2️⃣ Step 2: Download and Prepare HACS

Once the container is deployed, you need to manually download and extract the HACS component into the Home Assistant configuration directory.

  1. Navigate to the newly created Home Assistant configuration directory:
cd /usr/local/HAconfig
  1. Create a folder for custom components and navigate into it:
sudo mkdir custom_components
cd custom_components

  1. Download the HACS installation package:
sudo wget https://github.com/hacs/integration/releases/download/2.0.5/hacs.zip

📝 Note: If the wget command is not found on your system, you can install it by running sudo apt update && sudo apt install wget.

  1. Create a dedicated folder for HACS and extract the downloaded zip file into it:
sudo mkdir hacs
sudo unzip hacs.zip -d hacs

📝 Note: If unzip is not installed, you can install it using sudo apt install unzip


Verification & Testing

Test 1: Verify the Docker Container is Running

Run the following command in your SSH terminal to ensure the Home Assistant container is active:

sudo docker ps

Success: You should see homeassistant listed under the "NAMES" column with a status of "Up".

Test 2: Access the Home Assistant Web UI

  1. Open a web browser on a computer connected to the same local network as the gateway.
  2. Navigate to http://192.168.0.1:8123 (Replace 192.168.0.1 with the actual IP address of your gateway's LAN or WAN interface, depending on how you are accessing it).

📝 Note: If you need to access the WebUI via the WAN port, you must open port 8123 in the Firewall settings.

Success: You will be greeted by the Home Assistant onboarding screen. Follow the prompts to set up your administrator account and password.

Test 3: Verify and Install HACS via the UI

  1. Restart Home Assistant:  In the Home Assistant sidebar, click on Developer Tools.
    1. Under the YAML tab, click the RESTART button. This ensures Home Assistant detects the new custom_components folder.


  1. Add Integration: Navigate to Settings > Devices & Services.
    1. Click Add Integration in the bottom right and search for HACS.
  1. Authentication: Follow the prompts to link your GitHub account using the provided activation code.

Success: Once authentication is complete, a new "HACS" tab will appear in the left sidebar of the Home Assistant interface


Troubleshooting / FAQ

  • Q: What if the wget or unzip commands are not recognized in the terminal?
  • A: Your Debian environment may not have these basic utilities installed by default. You can install them by executing sudo apt update followed by sudo apt install wget unzip.

  • Q: I cannot access the Home Assistant Web UI at port 8123. What is wrong?
  • A: Verify the IP address of your gateway. If you are trying to access the UI from an external network, ensure that the gateway's Firewall rules allow inbound traffic on port 8123. Also, verify via sudo docker ps that the container is running.

  • Q: The HACS integration is not showing up when I search for it in "Add Integration".
  • A: This usually means the files were extracted into the wrong directory, or Home Assistant hasn't loaded them yet. Ensure the files are exactly in /usr/local/HAconfig/custom_components/hacs. After confirming the path, fully restart the Home Assistant Docker container by running sudo docker restart homeassistant.

📜 Revision History

Version

Date

Author

Notes

v1.0

2026-3-2

Jens Zhou

Initial document creation


    • Related Articles

    • How to Install Docker on Robustel EG Series Gateways via Debian Package Manager

      ? Overview This document outlines the procedures for installing the Docker Engine on Robustel EG series edge computing gateways (running RobustOS Pro). By leveraging the device's Debian-based architecture, users can configure official Docker ...
    • How to Install Node-RED on EG Series Devices via Docker?

      ? Overview This document outlines the procedure for deploying Node-RED on Robustel EG Series Edge Gateways. Node-RED is a flow-based programming tool, originally developed by IBM, which allows for visual programming to wire together hardware ...
    • How to Install KNX API Server on Robustel EG5120

      Overview The Robustel EG5120 is a high-performance industrial edge computing gateway. Robustel is proud to be the first manufacturer globally to achieve official KNX API Server certification, providing a standardized, secure, and modern interface for ...
    • How to Install Grafana on Debian 11

      To install Grafana on Debian 11, follow the steps below. Grafana provides its own APT repository for Debian-based distributions, which ensures you get the latest version. This guide will show you how to install Grafana from the official repository. ...
    • How to Deploy Zabbix and SNMP Data Simulation via MQTT on RobustOS Pro

      Overview When using Robustel's EG series gateways (such as the MG460) running RobustOS Pro, users may need to monitor end-device data using Zabbix via SNMP and MQTT protocols. This comprehensive deployment solution bridges end-devices to a Zabbix ...