Install Home Assistant Using Docker Compose

This article is for those looking for a detailed and straightforward guide on installing Home Assistant using Docker Compose.

Home Assistant is an open-source home automation platform that prioritizes local control and privacy. It is powered by a worldwide community of tinkerers and DIY enthusiasts, making it ideal for running on a Raspberry Pi or a local server.

💾 You can find the repository used in this guide on GitHub.

NOTE

We’ll use Traefik as our reverse proxy. It’ll handle obtaining cryptographic certificates from Let’s Encrypt for your domain names and route requests to the corresponding services based on those domains.

CAUTION

Remember that without a secure connection, the services will not work.

CAUTION

To obtain cryptographic certificates, you will need A-type records in the external DNS zone, which point to the IP address of your server where Traefik is installed. If you have created these records recently, you should wait before starting the installation of the services. Full replication of these records between DNS servers can take from a few minutes to 48 hours or even longer in rare cases.

IMPORTANT

Docker Engine and Docker Compose must be installed on the server.

For a step-by-step guide on installing Docker Engine on Ubuntu Server, see Install Docker Engine and Docker Compose on Ubuntu Server

IMPORTANT

OpenSSH must be installed on the server, and port 22 must be open in order to be able to connect to the server using the SSH protocol.

To install OpenSSH on the server you can use the command:

1
sudo apt install openssh-server

NOTE

To connect to the server from a Windows system, you can use tools like PuTTY or MobaXterm.

NOTE

This guide walks you through connecting to a server with the iTerm2 terminal emulator on macOS.

CAUTION

You will need to open the following TCP ports for access to the services:

• TCP port 80 - to obtain a free cryptographic certificate through the Let’s Encrypt certification center.
• TCP port 443 - to access the Home Assistant web interface.

We connect to the server on which Home Assistant is planned to be installed.

Now it is necessary to create networks for your services.

We create a network for Traefik using the command:

1
docker network create traefik-network

We create a network for Home Assistant using the command:

1
docker network create homeassistant-network

Next, you need to clone the repository that contains the configuration files, which include all the necessary conditions for Home Assistant to work.

You can clone the repository using the command:

1
git clone https://github.com/heyvaldemar/homeassistant-traefik-letsencrypt-docker-compose.git

Navigate to the directory with the repository using the command:

1
cd homeassistant-traefik-letsencrypt-docker-compose

Next, you need to change the variables in the .env file according to your requirements.

NOTE

The .env and configuration.yaml files should be in the same directory as homeassistant-traefik-letsencrypt-docker-compose.yml.

Now let’s start Home Assistant with the command:

1
docker compose -f homeassistant-traefik-letsencrypt-docker-compose.yml -p homeassistant up -d

To access the Home Assistant management panel, go to https://homeassistant.heyvaldemar.net from your workstation, where homeassistant.heyvaldemar.net is the domain name of my service. Accordingly, you need to specify your domain name that points to the IP address of your server with the installed Traefik service, which will redirect the request to Home Assistant.

NOTE

You need to specify the domain name of the service, previously defined in the .env file.

Next, you need to register to start using the Home Assistant.

To access the Traefik control panel, go to https://traefik.homeassistant.heyvaldemar.net from your workstation, where traefik.homeassistant.heyvaldemar.net is the domain name of my service. Accordingly, you need to specify your domain name that points to the IP address of your server with the installed Traefik.

NOTE

You need to specify the domain name of the service, previously defined in the .env file.

Enter the username and password previously set in the .env file, and click the “OK” button.

Welcome to the Traefik control panel.