WTH installing official addons alongside with HA docker installation could be a lot easier! Docker Compose examples

I think installing official addons alongside with HA docker installation could be a lot easier just by providing docker compose examples in documentation and project pages on github.

I have voice-related integrations (and docker containers) installed like piper, whisper, etc and sometimes it takes to much time to figure out what the proper docker compose file would look like.

TL;DR: we need Docker Compose examples for official HA addons that you can install alongside with HA docker installation :slightly_smiling_face:

Those examples aren’t “integrations”. Those are external apps being run in a docker container.

You should change your title and post to reflect that.

But I generally agree that developers should always provide thorough documentation for all images.

It’s not really a HA problem tho since Docker images are outside the control of HA itself.

1 Like

While I agree having compose example configs could be very helpful, it also carries with it a necessity of support and maintenance that might be too much.

People would need to maintain those examples to stay relevant and functional to the current version. In some cases, docker images are maintained by 3rd parties (for example, I believe piper doesn’t have it’s own container image) which can add further complexity with versions. If people don’t maintain the compose examples, that’s just additional support on the HA community when things don’t work.

Aren’t those official addons that you install from integrations page?

Aren’t those Docker images are the same that you install in HA OS? Like Piper or whisper.

I am mostly talking about (?) official addons like Piper or Wyoming Faster Whisper.

Here is gihub page of Wyoming Faster Whisper.

there is a Docker Image command:

docker run -it -p 10300:10300 -v /path/to/local/data:/data rhasspy/wyoming-whisper \ --model tiny-int8 --language en

A huge improvement would be to show a docker compose example as well.

No. Addons are not integrations.

Addons are external docker containers optimized to be maintained by the Supervisor.

integrations are either built in to HA core or added to HA core so they reside internally to HA itself.

Addons are external apps that provide additional services. They don’t even technically need to be used by HA. Once they exist then basically anything can use them.

Take for example the MQTT addon. yes it’s used by HA for the MQTT integration but any app that needs to use MQTT can use the broker provided by the addon.

but there is also a Mosquitto docker image (different than the addon) that can be frun to basically do the same thing. the addon is based on the source image.

But also not all addons have a source image. Some addons are created solely as an addon and no docker image exists for it.

An integration provides a way for HA to interact with things either internally like automations or with external services like the aforementioned MQTT broker created by the Mosquitto addon.

there could be both addons and integrations that work hand in hand. Like the zwavejs addon and zwavejs integration or the mosquitto addon and the mqtt integration. But addons and integrations are 100% different things.

no.

HAOS provides addons that are based on the source docker images but they are modified to allow for control by the HA Supervisor.

you can’t run addons in Docker directly.

You need to run the source image to create the equivalent docker container.

That’s why docker images are outside the control of HA.

1 Like

My mistake. I never used HAOS and I never saw addon page in my docker installation :smile:

Anyway my idea would be - docker compose examples for Official addons when it makes sense. Like in case of voice-related addons.

PS: edited title and 1st post.

But that’s the thing…it never makes sense.

because you can’t use addons in a HA Container (Docker based) install. Those are only ever available in a Supervisor based install.

and I would assume that there are sufficient documentation for installing addons.

But again that won’t help you because you can’t install addons without a Supervisor and the addons can’t be run using Docker Compose.

For the two examples you gave I just googled both of them and they seem to have a documented Docker Compose config available on at least Dockerhub.

Or maybe I’m missing what you are actually asking for…?

I think the idea here is to be able to run the equivalent of an addon (which are docker containers) alongside the HA container.

Basically, doing the equivalent of the supervisor manually.

While for most “global” piece of software, the addon is just a thin wrapper above an existing dockerfile, so docker compose examples are handily avaialble, the HA specific addons, e.g. wyoming stuff, sometimes (often?) lack documentation on how to use them as standalone containers.