Portainer Templates logo

Portainer Templates

Homeassistant Homeassistant

Container

Home Automation

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

Image details

Pulls: 4.8M
Architecture: amd64, arm64
Image size: 698 MB
Latest: 2026.8.0
User: linuxserverci
Created: Jan 25, 2021
Updated: 20 hours ago
Status: active

Configuration

Type
Container
Platform
linux
Image
linuxserver/homeassistant:latest
Ports
8123:8123/tcp
Volumes
/config : /srv/lsio/homeassistant/config
Env vars
PUID=1000PGID=1000TZ=Etc/UTC
Restart
unless-stopped

Template by technorabilia

Notes

Portainer App Templates by Technorabilia, based on data provided by LinuxServer.io.

Ensure to create the following volume directories on the host file system, or modify the paths in the volume mapping section under the advanced options below, as needed.

mkdir -p /srv/lsio/homeassistant/config

Standalone Install

Select an install method, to see config/commands for deploying Homeassistant

Installation method

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select Homeassistant, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo

More install options in our documentation.

linuxserver.io
Blog Discord Discourse GitHub Open Collective
The LinuxServer.io team brings you another container release featuring:
  • regular and timely application updates
  • easy user mappings (PGID, PUID)
  • custom base image with s6 overlay
  • weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
  • regular security updates

Find us at:
  • Blog - all the things you can do with our containers including How-To guides, opinions and much more!
  • Discord - realtime support / chat with the community and the team.
  • Discourse - post on our community forum.
  • GitHub - view the source for all of our repositories.
  • Open Collective - please consider helping us by either donating or contributing to our budget

linuxserver/homeassistant

Scarf.io pulls GitHub Stars GitHub Release GitHub Package Repository GitLab Container Registry Quay.io Docker Pulls Docker Stars Jenkins Build LSIO CI
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
homeassistant

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:
ArchitectureAvailableTag
x86-64✅amd64-\
arm64✅arm64v8-\

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 discoverhb0 and automatically configure zeroconfhb1/mDNShb2 and UPnPhb3 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 /run/dbus:/run/dbus:ro

Docker Compose:

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

If the dbus path on host differs, such as /var/run/dbus, then you can map it as /var/run/dbus:/run/dbus:ro.

Using the Ping integration

For the Pingping0 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.
>!NOTE >Unless a parameter is flagged as 'optional', it is mandatory and a value must be provided.

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/homeassistant/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/homeassistant/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.
ParameterFunction
--net=hostShares host networking with container. Required for some devices to be discovered by Home Assistant.
-p 8123Application WebUI, only use this if you are not using host mode.
-e PUID=1000for UserID - see below for explanation
-e PGID=1000for GroupID - see below for explanation
-e TZ=Etc/UTCspecify a timezone to use, see this list.
-v /configHome Assistant config storage path.
--device /path/to/deviceFor 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__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

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:
```bash
docker exec -it homeassistant /bin/bash
```
  • To monitor the logs of the container in realtime:
```bash
docker logs -f homeassistant
```
  • Container version number:
```bash
docker inspect -f '{{ index .Config.Labels "build_version" }}' homeassistant
```
  • Image version number:
```bash
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:

    ```bash
    docker-compose pull
    ```

* Single image:

    ```bash
    docker-compose pull homeassistant
    ```
  • Update containers:
* All containers:

    ```bash
    docker-compose up -d
    ```

* Single container:

    ```bash
    docker-compose up -d homeassistant
    ```
  • You can also remove the old dangling images:
```bash
docker image prune
```

Via Docker Run

  • Update the image:
```bash
docker pull lscr.io/linuxserver/homeassistant:latest
```
  • Stop the running container:
```bash
docker stop homeassistant
```
  • Delete the container:
```bash
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:
```bash
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 x8664 hardware and vice versa using lscr.io/linuxserver/qemu-static
docker run --rm --privileged lscr.io/linuxserver/qemu-static --reset

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

Versions

  • 02.07.26: - Rebase to alpine 3.24.
  • 05.03.26: - Remove pycups as there are no python 3.14 wheels for it.
  • 02.10.25: - Rebase to alpine 3.22, rely on baseimage service for usb device permission fixing.
  • 19.09.25: - Add the necessary capabilities in the container to allow the unprivileged user access to bluetooth stack.
  • 03.01.25: - Rebase to alpine 3.21.
  • 04.12.24: - Make setcap target dynamic.
  • 07.11.24: - Add go2rtc binary.
  • 12.10.24: - Allow uv to modify system python packages.
  • 07.10.24: - Switch to uv instead of pip.
  • 03.07.24: - Rebase to alpine 3.20.
  • 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.

Serve Homeassistant on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxying homeassistant.example.com to http://localhost:8123

Add this to your Caddyfile

homeassistant.example.com {
	reverse_proxy http://localhost:8123
}

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs Homeassistant
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Runs on the host network

This container shares your server's network directly, so port mappings are ignored and every port the app opens binds straight to the host.

  • If a port won't bind, find the clash with sudo ss -tlnp and stop the other service, or change the port in Homeassistant's own settings.

Running but the page won't load

The container is up but nothing appears in your browser.

  • Use your server's real IP: http://your-server-ip:8123. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, Homeassistant can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 8123

Permission denied on volumes

If the logs show "permission denied", the app can't write to its data folder on the host.

  • Fix the ownership: sudo chown -R 1000:1000 /srv/lsio/homeassistant/config
  • Or set the PUID and PGID variables (defaults 1000:1000) to match your own user, found with id $USER

Image won't pull

Test the pull directly on the host: docker pull linuxserver/homeassistant:latest

  • "manifest unknown" means the tag no longer exists. This template uses latest, so try pinning a specific version instead.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • This image supports: amd64, arm64
  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Container keeps restarting

The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.

  • Check the logs right after a restart, the last few lines before it died are the useful ones.
  • Get the exit code with docker inspect Homeassistant --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A single container

Homeassistant runs as one container, the simplest kind of app here. Just the one image to pull and nothing else wired up alongside it.

The app image

An image is the app packed up ready to go, everything Homeassistant needs bundled into one download. This template pulls linuxserver/homeassistant:latest, which Docker fetches once (about 698 MB) and then starts your own copy from.

Where the image comes from

Docker pulls its images from registries, public libraries of ready-built apps. Homeassistant's comes from Docker Hub, published by linuxserver.

Version tags

The bit after the colon in the image name is the version tag. Here it's latest, which always points at the newest build, so a redeploy can bump you to a newer release without you asking. Newest right now is 2026.8.0. Pin a specific tag if you would rather stay on one version.

Which machines it runs on

Every image is built for particular CPU types. This one ships for amd64, arm64, so it runs on both regular x86 servers and ARM boards like a Raspberry Pi.

Ports

A port is the door the app answers on. A mapping like 8123:8123 means it's reachable on port 8123 of your server, where the left number is yours to change and the right one belongs to the app. Once it's running, open http://your-server-ip:8123 in a browser. It opens:

  • 8123:8123, likely the web interface

Volumes

A volume is where Homeassistant keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

  • /config from /srv/lsio/homeassistant/config on the host

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Homeassistant takes 3 of them, all with defaults you can leave alone or tweak:

  • PUID, defaults to 1000. Run 'id [USER]' for the owner of the host volume directories to get the UID to use here.
  • PGID, defaults to 1000. Run 'id [USER]' for the owner of the host volume directories to get the GID to use here.
  • TZ, defaults to Etc/UTC. Specify a timezone to use, see this list.

Restart policy

The restart policy here is unless-stopped, so Docker restarts Homeassistant after a crash or reboot, but leaves it off when you stop it on purpose. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).

Users and permissions

The PUID and PGID settings tell it which user and group to act as on your host. Point them at your own account (find yours with id $USER) so the files it writes into your mounted folders come out owned by you rather than root.

Networking

Homeassistant runs on the host network, so it shares your server's networking directly instead of getting a private one of its own. Its ports open straight on the server with no mapping in between.

Container name

Once it's deployed, Portainer names the container Homeassistant. That's what you'll spot in the containers list and use in commands like docker logs Homeassistant.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Homeassistant up. Add the template list to Portainer once, then deploying Homeassistant is a click rather than a wall of config.