I’ve been using the Portainer add-on from the Home Assistant add-on repository for quite a while now, and using it to manage several docker hosts. I recently went to add a few Kubernetes clusters as endpoints for Portainer only to realise that the add-on was Portainer 1.x instead of 2.x (which doesn’t support Kubernetes). It doesn’t appear that there’s going to be an update to 2.x on the existing Home Assistant add-on, so I’ve created a new one based on the Portainer-CE 2.1 code.
Installation requires an additional repository to be added to Home Assistant. The repository URL is: https://github.com/MikeJMcGuire/HASSAddons. From there, the installation is pretty much the same as the original add-on. You turn off protected mode (as it needs to manipulate the docker host on which it runs), and turn on the sidebar option.
The only real difference I’ve seen so far is that the 2.x version of Portainer doesn’t have a “no authentication” option. The original 1.x add-on used this as the interface to Portainer was protected by the Home Assistant ingress option. Therefore, the 2.x version requires you to login. The default credentials are admin/portainer and you can change that password as soon as you log in the first time. I’ve kept the add-on fairly basic, but if there’s any changes/features needed they’re quite straight forward to add.
If you’re looking for changes to the add-on, call it out here in a comment, or on the repository for the add-on code.
Backlog:
- Expose Portainer ports (8000/9000 TCP) outside of the container for those that wish to have an alternative to HA ingress – done.
Update (26 May): Upgraded to Portainer 2.5.
~ Mike
Hopefully Helpful Hints // Mike J McGuire 
Hi Mike,
Nice work.
I’m building a knowledge repository to help with FAQ/known issues around Portainer. Am going to create an entry around HA in 2.x.
Are you happy for us to link straight into the Git Repo you link above?
Yeah absolutely – hopefully I’ll start getting some more users testing the 2.x version in HA (seems great so far).
Hello Mike, I’m just looking at your post. The use case I’m looking for is the following. Not sure if your work will help. I have multiple docker instances running in my house, mostly on different RPIs which are doing different tasks. On each of these I’ve installed Docker/Docker Compose/Portainer. Ideally I would like to view all of them in Home Assistant. Do you think this is possible ? If so, please advice
Thank you so much,
Jens
Hi Jens – you’re best bet would be to use a single instance of Portainer (in HA) to manage other docker environments/endpoints. You should be able to find instructions on Portainer’s website about how to add other docker hosts (you basically need to configure your RPis to expose their docker port – or deploy a portainer agent to each of those hosts.
Hi Mike,
Maybe you could help me, I’m struggling with my Portainer setup.
I have a installed Home Assistant Supervised in Docker on a Debian machine.
And I would like to use Portainer to manage my Docker containers.
I have installed the latest Portainer:ce and when I login, local-ip-adderss:9000 I asked to create a user, password and so on. But I don’t get the choose to select “local server” during the setup.
Seems that the Portainer doesn’t find the local container or what is called…
Do know what the problem could be?
Br Fredrik
Howdy – when you say you installed portainer – do you mean my addon, or the provided home assistant addon? Or have you tried to run it separately as a standalone? I’d recommend running the addon version. If you’re not, then you need to ensure you map the docker.sock file into the container.
Hi Mike,
Hoping you can help. Running Home Assistant OS in a virtual machine. So I think I need the add-on method to use portainer. I’ve installed your add-on as above, but it won’t load and is erroring out with:
Logger: homeassistant.components.hassio
Source: components/hassio/__init__.py:557
Integration: Home Assistant Supervisor (documentation, issues)
First occurred: November 28, 2021, 11:01:30 PM (79 occurrences)
Last logged: 5:34:18 AM
Can’t read Supervisor data: Container addon_e4641267_portainer is not running
Howdy, not sure – it seems to be indicating the addon isn’t running. Is the addon running? Do the logs of the addon show anything? It might be starting and then failing due to not having protection mode disabled.
I have been installing Portainer following way
– Get the latest version of Portainer
docker pull portainer/portainer-ce:latest
– Create a new Docker volume for Portainer
docker volume create portainer_data
– Create the Portainer container
docker run -d -p 8000:8000 -p 9000:9000 -p 9443:9443 \
–name=portainer –restart=always \
-v /var/run/docker.sock:/var/run/docker.sock \
-v portainer_data:/data \
portainer/portainer-ce:latest
Howdy – yep, that’s how you run portainer standalone. The only advantage really of having it run as an addon in HA is the sidebar integration.
Hi,
Thanks for sharing this. I’m running into an issue of a read only files system when deploying a stack.
I’ll admin, I’m not a portainer expert, but can you help fill in what I should replace the below with from the volumes tag in my docker-compose file?
– ./output/:/output
Hi Mike, thanks for providing this since the “official” one has been abandoned. My HA still has the 1.5.2 version of the original Portainer plugin. Do you think a simple upgrade to your plugin will work and my existing portainer configured container will be present after the upgrade?
Hi Stefan – my pleasure. Unfortunately no, each add-on stores its data in a separate directory on the filesystem. Apparently you can export the portainer settings though and import on new deployment, although I’ve not tried it.
https://docs.portainer.io/v/ce-2.9/admin/settings#backup-to-local-disk
Been using this add on for a while (current version 2.13.1) but the 12 character password requirement is very annoying! Apparently 2.14.1 gives you configuration over that. When might we see it appear in HA?
Howdy, fairly shortly – I’d been waiting for the .1 before moving to 2.14.
Hello Mike, first of all thank you for all your great work. I’m running into an issue of a read only files system when deploying a stack. Do you have any idea why?
Hi Andre – not sure I’m sorry. Try some of the portainer forums. I’m assuming the readonly file systems arent volume mounts in a stack marked as readonly?
Hi, Mike,
First of all, I’d like to join others in thanking you for your work!
Like other commenters above, all I need is to run Portainer UI on Home Assistant to manage other Edge Agents running on different nodes. I got your plugin up and running in no time – it shows HA’s internal containers w/o problems.
But when I try creating an Edge Agent instance and connect it back to HA’s Portainer UI, all I get is a NOT associated Environment entry. I’ve been following all the standard steps – is there some special parameter I need to pass? Any hints?
Thanks for your help!
Howdy, I’ve used it to manage edge portainer agents. I don’t recall if you had to enable port 8000 on the add-on (add-on config), and expose that to the edge agents though, I think you might.
Thanks again for your help! Enabling port 8000 did the trick.
FWIW, it also required enabling port 9000 (which is rather not obvious based on description) plus using Docker Swarm instead of Docker Standalone…
Anyone any luck to start Portrainer on HA ? I was able to install it via the add-on store but when I want to start it nothing happens. Running Pi on the backend….
Hi,
the Addon won’t start anymore:
2023/07/19 08:05AM FTL github.com/portainer/portainer/api/cmd/portainer/main.go:65 > failed validating flags | error=”Unable to locate Unix socket or named pipe”
uninstall Portainer on your host system
Is there a way to recover or reset forgotten password?