Images

linuxserver/homeassistant

GitHub Stars GitHub Release GitHub Package Repository GitLab Container Registry Docker Pulls Docker Stars Jenkins Build LSIO CI

Homeassistant is open source home automation that puts local control and privacy first. Powered by a worldwide community of tinkerers and DIY enthusiasts. Perfect to run on a Raspberry Pi or a local server.

Supported Architectures

Our images support multiple architectures such as x86-64, arm64 and armhf. We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.

Simply pulling ghcr.io/linuxserver/homeassistant should retrieve the correct image for your arch, but you can also pull specific arch images via tags.

The architectures supported by this image are:

Architecture

Tag

x86-64

amd64-latest

arm64

arm64v8-latest

armhf

arm32v7-latest

Application Setup

The Webui can be found at http://your-ip:8123. Follow the wizard to set up Home Assistant.

Usage

To help you get started creating a container from this image you can either use docker-compose or the docker cli.

---
version: "2.1"
services:
homeassistant:
image: ghcr.io/linuxserver/homeassistant
container_name: homeassistant
network_mode: host
environment:
- PUID=1000
- PGID=1000
- TZ=Europe/London
volumes:
- /path/to/data:/config
ports:
- 8123:8123 #optional
devices:
- /path/to/device:/path/to/device
restart: unless-stopped

docker run -d \
--name=homeassistant \
--net=host \
-e PUID=1000 \
-e PGID=1000 \
-e TZ=Europe/London \
-p 8123:8123 `#optional` \
-v /path/to/data:/config \
--device /path/to/device:/path/to/device \
--restart unless-stopped \
ghcr.io/linuxserver/homeassistant

Host vs. Bridge

Home Assistant can discover and automatically configure zeroconf/mDNS and UPnP devices on your network. In order for this to work you must create the container with --net=host.

Parameters

Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <external>:<internal> respectively. For example, -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 outside the container.

Ports (-p)

Parameter

Function

8123

Application WebUI, only use this if you are not using host mode.

Networking (--net)

Parameter

Function

--net=host

Shares host networking with container. Required for some devices to be discovered by Home Assistant.

Environment Variables (-e)

Env

Function

PUID=1000

for UserID - see below for explanation

PGID=1000

for GroupID - see below for explanation

TZ=Europe/London

Specify your TimeZone e.g. Europe/London.

Volume Mappings (-v)

Volume

Function

/config

Home Assistant config storage path.

Device Mappings (--device)

Parameter

Function

/path/to/device

For passing through USB, serial or gpio devices.

Environment variables from files (Docker secrets)

You can set any environment variable from a file by using a special prepend FILE__.

As an example:

-e FILE__PASSWORD=/run/secrets/mysecretpassword

Will set the environment variable PASSWORD based on the contents of the /run/secrets/mysecretpassword file.

Umask for running applications

For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional -e UMASK=022 setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up here before asking for support.

User / Group Identifiers

When using volumes (-v flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user PUID and group PGID.

Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.

In this instance PUID=1000 and PGID=1000, to find yours use id user as below:

$ id username
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)

Docker Mods

Docker Mods Docker Universal Mods

We publish various Docker Mods to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.

Support Info

  • Shell access whilst the container is running:

    • docker exec -it homeassistant /bin/bash

  • To monitor the logs of the container in realtime:

    • docker logs -f homeassistant

  • Container version number

    • docker inspect -f '{{ index .Config.Labels "build_version" }}' homeassistant

  • Image version number

    • docker inspect -f '{{ index .Config.Labels "build_version" }}' ghcr.io/linuxserver/homeassistant

Versions

  • 01.07.21: - Remove HACS dependencies as it caused a crash in Home-assistant.

  • 25.02.21: - Add python dependencies from homeassistant base image.

  • 07.02.21: - Fix building from the wrong requirement file. Add ssh client & external DB libs.

  • 06.02.21: - Add iputils so ping works as non root user.

  • 30.01.21: - Initial Release.