linuxserver/homeassistant ¶

Home Assistant Core - 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¶

We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.

Simply pulling lscr.io/linuxserver/homeassistant:latest 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	Available	Tag
x86-64	✅	amd64-<version tag>
arm64	✅	arm64v8-<version tag>
armhf	❌

Application Setup¶

This image is based on Home Assistant Core.

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

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.

Accessing Bluetooth Device¶

In order to provide HA with access to the host's Bluetooth device, one needs to install BlueZ on the host, add the capabilities NET_ADMIN and NET_RAW to the container, and map dbus as a volume as shown in the below examples.

Docker Cli:¶

--cap-add=NET_ADMIN --cap-add=NET_RAW -v /var/run/dbus:/var/run/dbus:ro

Docker Compose:¶

    cap_add:
      - NET_ADMIN
      - NET_RAW
    volumes:
      - /var/run/dbus:/var/run/dbus:ro

Using the Ping integration¶

For the Ping integration to work, the capability NET_RAW must be added to the container. See above for instructions.

Usage¶

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

docker-compose (recommended, click here for more info)¶

---
services:
  homeassistant:
    image: lscr.io/linuxserver/homeassistant:latest
    container_name: homeassistant
    network_mode: host
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Etc/UTC
    volumes:
      - /path/to/data:/config
    ports:
      - 8123:8123 #optional
    devices:
      - /path/to/device:/path/to/device #optional
    restart: unless-stopped

docker cli (click here for more info)¶

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

Parameters¶

Containers 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=Etc/UTC`	specify a timezone to use, see this list.

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.

Miscellaneous Options¶

Parameter	Function

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__MYVAR=/run/secrets/mysecretvariable

Will set the environment variable MYVAR based on the contents of the /run/secrets/mysecretvariable 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 your_user as below:

id your_user

Example output:

uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)

Docker 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" }}' lscr.io/linuxserver/homeassistant:latest

Updating Info¶

Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (noted in the relevant readme.md), we do not recommend or support updating apps inside the container. Please consult the Application Setup section above to see if it is recommended for the image.

Below are the instructions for updating containers:

Via Docker Compose¶

Update images:

All images:
```
docker-compose pull
```
Single image:
```
docker-compose pull homeassistant
```

Update containers:

All containers:
```
docker-compose up -d
```
Single container:
```
docker-compose up -d homeassistant
```

You can also remove the old dangling images:
```
docker image prune
```

Via Docker Run¶

Update the image:

docker pull lscr.io/linuxserver/homeassistant:latest

Stop the running container:
```
docker stop homeassistant
```
Delete the container:
```
docker rm homeassistant
```
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
```

Image Update Notifications - Diun (Docker Image Update Notifier)¶

Tip

We recommend Diun for update notifications. Other tools that automatically update containers unattended are not recommended or supported.

Building locally¶

If you want to make local modifications to these images for development purposes or just to customize the logic:

git clone https://github.com/linuxserver/docker-homeassistant.git
cd docker-homeassistant
docker build \
  --no-cache \
  --pull \
  -t lscr.io/linuxserver/homeassistant:latest .

The ARM variants can be built on x86_64 hardware using multiarch/qemu-user-static

docker run --rm --privileged multiarch/qemu-user-static:register --reset

Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.

Versions¶

05.03.24: - Add mime.types to help with detection of certain media files.
13.02.24: - Rebase to alpine 3.19, upgrade to python 3.12. Restructure python packages so all packages are internal (no more venv in /config). Use upstream project's wheels. Due to an upstream issue, on first start of the newly updated container, some custom integrations may be disabled in HA due to missing dependencies. A subsequent container restart should fix that and the integrations should be re-enabled.
18.12.23: - Add Bluetooth instructions to readme.
05.07.23: - Deprecate armhf. As announced here
21.06.23: - Pin pycups version.
14.06.23: - Create secondary venv in /config for pip installs.
07.06.23: - Rebase to alpine 3.18, switch to cp311 wheels.
03.05.23: - Deprecate arm32v7. Latest HA version with an arm32v7 build is 2023.4.6.
16.11.22: - Fix the dep conflict for google calendar.
23.09.22: - Migrate to s6v3.
29.07.22: - Improve usb device permission fix.
07.07.22: - Rebase to alpine 3.16, switch to cp310 wheels.
07.05.22: - Build matplotlib with the same Numpy version as HA req.
31.03.22: - Install pycups.
07.03.22: - Install PySwitchbot.
02.03.22: - Update pip and use legacy resolver, clean up temp python files, reduce image size.
04.02.22: - Always compile grpcio on arm32v7 due to pypi pushing a glibc only wheel.
12.12.21: - Use the new build.yaml to determine HA base version.
25.09.21: - Use the new lsio homeassistant wheel repo, instead of the HA wheels.
13.09.21: - Build psycopg locally as the HA provided wheel does not seem to work properly.
13.09.21: - Fix setcap in service. Build CISO8601 locally as the HA provided wheel does not seem to work properly.
12.09.21: - Rebase to alpine 3.14. Build on native armhf.
09.08.21: - Fixed broken build caused by missing dependency.
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.

linuxserver/homeassistant¶