https://github.com/tomaae/homeassistant-portainer
Portainer integration for Home Assistant
https://github.com/tomaae/homeassistant-portainer
docker hacs homeassistant homeassistant-components homeassistant-custom-component homeassistant-integration portainer
Last synced: 19 days ago
JSON representation
Portainer integration for Home Assistant
- Host: GitHub
- URL: https://github.com/tomaae/homeassistant-portainer
- Owner: tomaae
- License: apache-2.0
- Created: 2023-05-06T03:28:40.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2025-02-22T01:43:31.000Z (2 months ago)
- Last Synced: 2025-04-07T00:42:28.254Z (19 days ago)
- Topics: docker, hacs, homeassistant, homeassistant-components, homeassistant-custom-component, homeassistant-integration, portainer
- Language: Python
- Homepage:
- Size: 521 KB
- Stars: 118
- Watchers: 7
- Forks: 10
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Portainer integration for Home Assistant
[](https://github.com/hacs/integration)
[](https://app.lokalise.com/public/892665226456f113e0a814.16864793/)
Monitor and control Portainer from Home Assistant.
Features:
* List Endpoints
* List Containers
# Features
## Endpoints
List of portainer endpoint.
## Containers
List of containers.
# Install integration
This integration is distributed using [HACS](https://hacs.xyz/).
You can find it under "Integrations", named "Portainer"
## Get portainer access token
1. Login into your portainer instance
2. Click you username at top right and select "My Account"
3. Under "Access tokens", click "Add access token"
4. Enter name for your access token (can be anything, for example "homeassistant")
5. Copy displayed access token for use in integration setup
## Setup integration
Setup this integration for your Portainer in Home Assistant via `Configuration -> Integrations -> Add -> Portainer`.
You can add this integration several times for different portainer instances.
* "Name of the integration" - Friendly name for this Portainer instance
* "Host" - Use hostname or IP and port (example: portainer.domain.tld or 192.168.0.2:9000)
* "Access token" - Use access token from previous step
* "Use SSL" - Connect to portainer using SSL
* "Verify SSL certificate" - Validate SSL certificate (must be trusted certificate)
## Configuration
When setup is done, it is possilbe to cunfigure custom attibutes for each entry via `Configuration -> Integrations -> Portainer -> Configure`.
List of supported custom attibutes:
* "Health check" - Checks if the container is running correctly by executing a defined command.
* "Restart policy" - Defines how and when the container restarts after stopping.
# Development
## Translation
To help out with the translation you need an account on Lokalise, the easiest way to get one is to [click here](https://lokalise.com/login/) then select "Log in with GitHub".
After you have created your account [click here to join Portainer project on Lokalise](https://app.lokalise.com/public/892665226456f113e0a814.16864793/).
If you want to add translations for a language that is not listed please [open a Feature request](https://github.com/tomaae/homeassistant-portainer/issues/new?labels=enhancement&title=%5BLokalise%5D%20Add%20new%20translations%20language).
## Enabling debug
To enable debug for Portainer integration, add following to your configuration.yaml:
```
logger:
default: info
logs:
custom_components.portainer: debug
```