https://github.com/imagegenius/docker-esphome
Minimal ESPHome Alpine Docker Container
https://github.com/imagegenius/docker-esphome
Last synced: 3 months ago
JSON representation
Minimal ESPHome Alpine Docker Container
- Host: GitHub
- URL: https://github.com/imagegenius/docker-esphome
- Owner: imagegenius
- License: gpl-3.0
- Created: 2021-04-22T05:37:41.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2026-04-01T20:45:36.000Z (4 months ago)
- Last Synced: 2026-04-03T04:19:11.650Z (4 months ago)
- Language: Dockerfile
- Homepage:
- Size: 473 KB
- Stars: 16
- Watchers: 0
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# [imagegenius/esphome](https://github.com/imagegenius/docker-esphome)
[](https://github.com/imagegenius/docker-esphome/releases)
[](https://github.com/imagegenius/docker-esphome/packages)
[](https://ci.imagegenius.io/job/Docker-Pipeline-Builders/job/docker-esphome/job/main/)
[](https://ci-tests.imagegenius.io/esphome/latest-main/index.html)
ESPHome is a system to control your ESP8266/ESP32 by simple yet powerful configuration files and control them remotely through Home Automation systems.
[](https://esphome.io/)
## Supported Architectures
We use Docker manifest for cross-platform compatibility. More details can be found on [Docker's website](https://distribution.github.io/distribution/spec/manifest-v2-2/#manifest-list).
To obtain the appropriate image for your architecture, simply pull `ghcr.io/imagegenius/esphome:latest`. Alternatively, you can also obtain specific architecture images by using tags.
This image supports the following architectures:
| Architecture | Available | Tag |
| :----: | :----: | ---- |
| x86-64 | ✅ | amd64-\ |
| arm64 | ✅ | arm64v8-\ |
| armhf | ❌ | |
## Version Tags
This image offers different versions via tags. Be cautious when using unstable or development tags, and read their descriptions carefully.
| Tag | Available | Description |
| :----: | :----: |--- |
| latest | ✅ | Latest ESPHome release with an Alpine Base. |
| ubuntu | ✅ | Latest ESPHome release with an Ubuntu base. |
## Application Setup
Access the webui at `:6052`, for more information check out [ESPHome](https://esphome.io/).
## Usage
Example snippets to start creating a container:
### Docker Compose
```yaml
---
services:
esphome:
image: ghcr.io/imagegenius/esphome:latest
container_name: esphome
environment:
- PUID=1000
- PGID=1000
- TZ=Etc/UTC
- ESPHOME_DASHBOARD_USE_PING=false #optional
volumes:
- path_to_appdata:/config
ports:
- 6052:6052
restart: unless-stopped
```
### Docker CLI ([Click here for more info](https://docs.docker.com/engine/reference/commandline/cli/))
```bash
docker run -d \
--name=esphome \
-e PUID=1000 \
-e PGID=1000 \
-e TZ=Etc/UTC \
-e ESPHOME_DASHBOARD_USE_PING=false `#optional` \
-p 6052:6052 \
-v path_to_appdata:/config \
--restart unless-stopped \
ghcr.io/imagegenius/esphome:latest
```
## Parameters
To configure the container, pass variables at runtime using the format `:`. For instance, `-p 8080:80` exposes port `80` inside the container, making it accessible outside the container via the host's IP on port `8080`.
| Parameter | Function |
| :----: | --- |
| `-p 6052` | WebUI Port |
| `-e PUID=1000` | UID for permissions - see below for explanation |
| `-e PGID=1000` | GID for permissions - see below for explanation |
| `-e TZ=Etc/UTC` | Specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). |
| `-e ESPHOME_DASHBOARD_USE_PING=false` | Use ping rather than mDNS to get device status, set to true if devices are appearing offline |
| `-v /config` | Appdata Path |
## Umask for running applications
All of our images allow overriding the default umask setting for services started within the containers using the optional -e UMASK=022 option. Note that umask works differently than chmod and subtracts permissions based on its value, not adding. For more information, please refer to the Wikipedia article on umask [here](https://en.wikipedia.org/wiki/Umask).
## User / Group Identifiers
To avoid permissions issues when using volumes (`-v` flags) between the host OS and the container, you can specify the user (`PUID`) and group (`PGID`). Make sure that the volume directories on the host are owned by the same user you specify, and the issues will disappear.
Example: `PUID=1000` and `PGID=1000`. To find your PUID and PGID, run `id user`.
```bash
$ id username
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
```
## Updating the Container
Most of our images are static, versioned, and require an image update and container recreation to update the app. We do not recommend or support updating apps inside the container. Check the [Application Setup](#application-setup) section for recommendations for the specific image.
Instructions for updating containers:
### Via Docker Compose
* Update all images: `docker-compose pull`
* or update a single image: `docker-compose pull esphome`
* Let compose update all containers as necessary: `docker-compose up -d`
* or update a single container: `docker-compose up -d esphome`
* You can also remove the old dangling images: `docker image prune`
### Via Docker Run
* Update the image: `docker pull ghcr.io/imagegenius/esphome:latest`
* Stop the running container: `docker stop esphome`
* Delete the container: `docker rm esphome`
* Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your `/config` folder and settings will be preserved)
* You can also remove the old dangling images: `docker image prune`
## Versions
* **14.04.23:** - switch to gcompat
* **21.03.23:** - Add service checks
* **20.01.23:** - Add aarch64 support.
* **02.01.23:** - Initial Release.