Using homekit component inside Docker

sk229 · December 18, 2020, 11:39pm

Any solutions available for MacOS? I’m about to throw Docker out the window for this, but I really like the idea of having everything containerized.

pamidur · January 13, 2021, 10:31am

To everyone who has HASS running in docker on Synology DSM
The Avahi Reflector doesn’t want to join docker mutlicast group for some reason. I suspect synology has modified it this way. I spent way to much time on it.
The only thing that helped me was

mdns-repeater:
    image: angelnu/mdns_repeater
    network_mode: host
    environment:
    - hostNIC=enp4s0
    - dockerNIC=br-de87821a94e9

irvinlim · January 2, 2022, 7:12pm

@TonyB Amazing tips on running HA without host network! I just have one more thing to add.

I am also running Home Assistant in a Docker bridge network (without wanting to use network: host). The mdns-repeater sidecar container works amazingly well to forward mDNS packets in and out of a Docker bridge network.

However, I realise that in my setup, I had to also install avahi-daemon WITHIN the homeassistant container so that discovery would work. I don’t understand too much about the Avahi/Bonjour/SSDP protocols to explain why this is required.

I found out that this was required when following this guide on how to resolve mDNS queries from within a Docker container: mDNS, avahi and docker non-root containers. Basically, with the mdns-repeater container in the same bridge network, I was able to discover other devices using avahi-browse -alr with the above method.

My setup is thus as follows, after taking everything into account:

Create a dedicated Docker bridge network homeassistant with docker network create homeassistant.
The network interface of the newly created network is given by br-$(docker network ls | grep homeassistant | cut -d' ' -f1). You can use this to automatically substitute the value of the bridge network into the docker-compose file.
In the HA Dockerfile, install avahi-daemon like as follows. This assumes we are using the Alpine-based images, which are default:

FROM homeassistant/home-assistant:2021.12.7

# Install avahi-daemon in container
# https://gnanesh.me/avahi-docker-non-root.html
RUN set -ex \
  && apk --no-cache --no-progress add avahi avahi-tools dbus \
  # Disable default Avahi services
  && rm /etc/avahi/services/* \
  && rm -rf /var/cache/apk/*

# Add our custom entrypoint
COPY docker-entrypoint.sh /usr/local/sbin/
ENTRYPOINT ["/usr/local/sbin/docker-entrypoint.sh"]

# Rest of your dockerfile here...

Create a custom entrypoint entrypoint.sh:

#!/bin/bash
set -euxo pipefail

# Start dbus and avahi-daemon
dbus-uuidgen > /var/lib/dbus/machine-id
dbus-daemon --config-file=/usr/share/dbus-1/system.conf --print-address
avahi-daemon --daemonize

# Run anything else you want to run before HA starts...

# Run original entrypoint
exec /init

And voila, you should now be able to see integrations like HomeKit and Google Cast appearing in the integrations page automatically

You can also verify this by running avahi-browse -alr in the HA container now, since avahi-tools is installed above.

thi_baut · June 8, 2022, 1:37am

Wow this works for me, many thanks, it’s a simple solution. Do you know if the docker NIC (Iface) can change? I set a static IP to my HA container.

Saturnus · June 16, 2022, 6:15pm

Trying to get Homekit working while running HA without --net=host. Tried all the solutions from above and Homekit not working with docker · Issue #15692 · home-assistant/core · GitHub but could not get it working. Pairing does not succeed: Accessory Not Found.

Should these methods still work?

Saturnus · June 16, 2022, 6:55pm

Could not edit previous post.

The mdsn repeater container solution still works. Not a fan because of the --net=host that it needs.

At this moment the Avahi reflector mode started working out of nowhere. Will test more.

Penryn · December 20, 2022, 2:14pm

I try my luck and hope somebody can help:

iam running HA in a bride network and have the mens repeater as container running in host network.

the HomeKit App does show the new bridge I can start the setup process but than it timed out and I can’t find where the problem is any idea ?

yochien · January 29, 2023, 10:00pm

I also stuck at the same issue. Here’s what I found by far:

After I added mDNS repeater to my docker-compose.yml, the error message when adding HA Bridge to was changed from

Accessory Not Found
Make sure your accessory is powered on and connected to your router with an Ethernet cable, then ty again.

to

Unable to Add Accessory 
Accessory is not reachable.

And I check the network packets with Wireshark. Looks like the mDNS packets did be forwarded from cotnainer bridge network to host network. However, since HA Homekit Controller was listening on bridge network:

2023-01-30 05:09:36 INFO (MainThread) [pyhap.accessory_driver] Starting accessory HASS Bridge on address 172.27.0.2, port 21063.

The forwarded mDNS record was also advertising the IP in bridge network:

5cb632a6036f4874bfdcd61455d9c48d-hap.local: type A, class IN, cache flush, addr 172.27.0.2
HASS Bridge Bedroom EF3D24._hap._tcp.local: type SRV, class IN, cache flush, priority 0, weight 0, port 21063, target 5cb632a6036f4874bfdcd61455d9c48d-hap.local

So when adding HA Bridge to Homekit, the IP address that Homekit got from mDNS record was the IP in docker network (172.27.0.2), which is not reached able outside the bridge network, rather than the host IP.

I think forwarding mDNS traffic between docker bridge network to host network only allowed HA to discover devices on local network. If the goal is to add HA Bridge to Homekit, we might need to find a way to change the advertised IP in mDNS to Host IP or use another solution in this thread that manually advertise mDNS with avahi, however it’s kind of hack in my opinion.

Looks like HAP-python does have the option to specify advertised_address, but I haven’t look into how to configure this in HA.

github.com

ikalchev/HAP-python/blob/8b62c1965b8d88d79b26d1d857408659ab9b84ba/pyhap/accessory_driver.py#L196-L212

    
      
          def __init__(
              self,
              *,
              address=None,
              port=51234,
              persist_file="accessory.state",
              pincode=None,
              encoder=None,
              loader=None,
              loop=None,
              mac=None,
              listen_address=None,
              advertised_address=None,
              interface_choice=None,
              async_zeroconf_instance=None,
              zeroconf_server=None
          ):

Update:

Just noticed that HA Homekit Controller also has the advertised_address config.
https://github.com/home-assistant/core/blob/cb13418babd21a1e9584978b0c523f1b1e4e1cb0/homeassistant/components/homekit/init.py#L304

I added this line to my configureation.yaml and it started to work.

homekit:
  - name: HASS Bridge
    advertise_ip: YOUR_HOST_IP # <---- Add this line to configuration.yaml

I can see the advertised IP address in mDNS is now my host IP:

5cb632a6036f4874bfdcd61455d9c48d-hap.local: type A, class IN, cache flush, addr 192.168.50.101
HASS Bridge Bedroom EF3D24._hap._tcp.local: type SRV, class IN, cache flush, priority 0, weight 0, port 21063, target 5cb632a6036f4874bfdcd61455d9c48d-hap.local

I hope this helps!

Concrete5799 · March 23, 2023, 1:52pm

This had been working for months for me. Now, after I updated HA docker I seem to get stuck on ‘dbus-daemon --config-file=/usr/share/dbus-1/system.conf --print-address’ which has no output and never ends

crsantos · April 4, 2023, 12:54pm

It helped a lot

Thank you so much.

DominikR · June 1, 2023, 2:02pm

Can anyone help me figure out what the correct environment entries for hostNIC and dockerNIC are? I’m stumped…
Running docker on macOS.

DominikR · June 8, 2023, 10:03pm

I’ve given up on docker
Tried UTM but that one is not able to idle the CPU cores that are reserved for the VM (but Homekit integration worked great).
So settled on VMWare Fusion which can idle the CPU cores and I already had a license. All works great now.

Terratoss · July 2, 2023, 9:27am

Did you find any workaround for it?
Having my home assistant run on docker in mac os, but cant install now homekit on iPhone as the mDNS traffic wont go out from the container.

dieu · February 19, 2024, 10:06pm

I was able to configure by using combination of two methods above:

Link on gists Home Assistant Docker on Mac OS · GitHub
You need to use custom docker image with installed avahi to automation of mdns redirect (see docker-entrypoint.sh)
Then you need to register homekit bridge in mac os mDns responser by using dns-sd (see dns-sd.sh)
And finally you need to configure Home Assistant to advertise real IP address of host machine (see configure.yml)

DominikR · March 14, 2024, 7:35am

Oh great! Months, too late
But seriously thank you, I’m going to give it a try. As I have other docker images running, I’d very much still like to run that than having to run a VM for HA as well (as I’m doing now).

Questions:

Running dns-sd.sh ← that will run as a daemon in macOS, it’s not just a one time registering?
Updates to HA will mean having to build a new image via the dockerfile, right? (that’s one thing I like about the VM - it just updates the image, restarts and done)

Thanks again!

dieu · March 15, 2024, 4:54am

Running dns-sd.sh ← that will run as a daemon in macOS, it’s not just a one time registering?

yes, dns-sd script trying to prepare right parameters to run dns-sd -R to announce HA as homekit device in your network. it basically mDns retranslator.

Updates to HA will mean having to build a new image via the dockerfile, right?

right, homeassistant/home-assistant:stable it will always rebuild from latest stable version, but I don’t know how migration will happens.

DominikR · March 15, 2024, 11:38am

Thank you!