github.com/tiredofit/docker-homeassistant

About

This will build a Docker Image for Home Assistant, an automation platform.

This is a customized build with a very small amount of components and modules included to keep image size down and to be used specifically for my own installations. Of course you can use it for your own as well.

Maintainer

• Dave Conroy

Table of Contents

• About
• Maintainer
• Table of Contents
• Installation
  • Build from Source
  • Prebuilt Images
    • Multi Architecture
• Configuration
  • Quick Start
  • Persistent Storage
  • Environment Variables
    • Base Images used
    • Container Options
  • Soon
  • Networking
• Maintenance
  • Shell Access
• Support
  • Usage
  • Bugfixes
  • Feature Requests
  • Updates
• License
• References

Installation

Build from Source

Clone this repository and build the image with docker build -t (imagename) .

Prebuilt Images

Builds of the image are available on Docker Hub.

docker pull tiredofit/homeassistant:(imagetag)

Builds of the image are also available on the Github Container Registry

docker pull ghcr.io/tiredofit/docker-homeassistant:(imagetag)

The following image tags are available along with their tagged release based on what's written in the Changelog:

Container OS	Tag
Alpine	:latest

Multi Architecture

Images are built primarily for amd64 architecture, and may also include builds for arm/v7, arm64 and others. These variants are all unsupported. Consider sponsoring my work so that I can work with various hardware. To see if this image supports multiple architecures, type docker manifest (image):(tag)

Configuration

Quick Start

• The quickest way to get started is using docker-compose. See the examples folder for a working compose.yml that can be modified for development or production use.

• Set various environment variables to understand the capabilities of this image.

• Map persistent storage for access to configuration and data files for backup.

Persistent Storage

The following directories are used for configuration and can be mapped for persistent storage.

Directory	Description
/config/	Configuration folder
/logs	Logs

---

Environment Variables

Base Images used

This image relies on an Alpine Linux base image that relies on an init system for added capabilities. Outgoing SMTP capabilities are handlded via msmtp. Individual container performance monitoring is performed by zabbix-agent. Additional tools include: bash,curl,less,logrotate,nano,vim.

Be sure to view the following repositories to understand all the customizable options:

Image	Description
OS Base	Customized Image based on Alpine Linux
Nginx	Nginx webserver

Container Options

Variable	Value	Default	_FILE
CONFIG_PATH	Configuration directory	/config/
ENABLE_NGINX	Enable Nginx Frontend webserver	TRUE
ENABLE_BUILD_TOOLS	Install development tools if having problems installing modules	FALSE
ENABLE_JEMALLOC	Enable high performance memory allocator	TRUE
HOMEASSISTANT_MODE	Home Assistant Mode	NORMAL
HOMEASSISTANT_USER	Home Assistant User	homeassistant
HOMEASSISTANT_GROUP	Home Assistant Group	homeassistant
LISTEN_PORT	Listening Port	8123
LOG_PATH	Log Path	/logs/
LOG_FILE	Log File	homeassistant.log
SKIP_PIP	Skip using PIP on Home Assistant startup	FALSE

Soon

Variable	Value	Default	_FILE
LOG_TYPE	console file both none	FILE

Networking

Port	Protocol	Description
80	tcp	Nginx
8123	tcp	Home Assistant Web Interace

Maintenance

Shell Access

For debugging and maintenance purposes you may want access the containers shell.

docker exec -it (whatever your container name is) bash

Support

These images were built to serve a specific need in a production environment and gradually have had more functionality added based on requests from the community.

Usage

• The Discussions board is a great place for working with the community on tips and tricks of using this image.
• Sponsor me for personalized support.

Bugfixes

• Please, submit a Bug Report if something isn't working as expected. I'll do my best to issue a fix in short order.

Feature Requests

• Feel free to submit a feature request, however there is no guarantee that it will be added, or at what timeline.
• Sponsor me regarding development of features.

Updates

• Best effort to track upstream changes, More priority if I am actively using the image in a production environment.
• SponsorS me for up to date releases.

License

MIT. See LICENSE for more details.

References

• https://home-assistant.io