-
-
Notifications
You must be signed in to change notification settings - Fork 7.8k
Add Portainer docs #39268
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
erwindouna
wants to merge
9
commits into
home-assistant:next
Choose a base branch
from
erwindouna:portainer-new-integration
base: next
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Add Portainer docs #39268
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
ea29b19
Add Portainer docs
erwindouna 28a5513
Moving elements around a bit
c0ffeeca7 26e2775
move prereqs and config sections further up
c0ffeeca7 9e3a25a
change title to Prereqs
c0ffeeca7 725ad6f
Apply suggestions from code review
c0ffeeca7 28375c7
update release version
c0ffeeca7 0a2237b
Merge branch 'next' into portainer-new-integration
erwindouna 756e444
Update source/_integrations/portainer.markdown
erwindouna 49be20a
Update source/_integrations/portainer.markdown
erwindouna File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
--- | ||
title: Portainer | ||
description: Instructions on how to integrate Portainer with Home Assistant. | ||
ha_category: | ||
- Binary sensor | ||
ha_release: 2025.7 | ||
ha_iot_class: Cloud Polling | ||
ha_codeowners: | ||
- '@erwindouna' | ||
ha_domain: portainer | ||
ha_config_flow: true | ||
ha_platforms: | ||
- binary_sensor | ||
ha_integration_type: integration | ||
--- | ||
|
||
The Portainer {% term integration %} is used as an interface to the [Portainer API](https://docs.portainer.io/api). | ||
Portainer is a lightweight management UI that allows you to easily manage your Docker containers, images, networks, and volumes. It works on every Docker host or Swarm cluster. | ||
|
||
The Portainer API provides a way to manage Docker containers, images, networks, and volumes. It allows you to interact programmatically with your Docker host or Swarm cluster. | ||
|
||
## Prerequisites | ||
|
||
Before you can configure Portainer within Home Assistant, you need a few things: | ||
|
||
- have Portainer installed and a user with administrator rights on Portainer. | ||
- an Access Token. | ||
|
||
Create a Portainer Access Token by following these steps: | ||
|
||
1. Log in to your Portainer instance. | ||
erwindouna marked this conversation as resolved.
Show resolved
Hide resolved
|
||
2. To create an access token, follow the steps in the [Portainer documentation](https://docs.portainer.io/api/access). | ||
3. Copy the generated Access Token and store it somewhere safe, you will need it in the next steps. | ||
|
||
{% include integrations/config_flow.md %} | ||
|
||
## Supported functionality | ||
|
||
c0ffeeca7 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
{% note %} | ||
c0ffeeca7 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
This integration is currently being actively developed and tested. More platforms and features will be added in. | ||
{% endnote %} | ||
|
||
There is currently support for the following device types within Home Assistant: | ||
|
||
- Binary sensor - for monitoring the status of Portainer services. | ||
|
||
c0ffeeca7 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
## Removing the integration | ||
|
||
erwindouna marked this conversation as resolved.
Show resolved
Hide resolved
|
||
This integration follows standard integration removal. | ||
|
||
{% include integrations/remove_device_service.md %} | ||
erwindouna marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
After removing the integration, consider deleting the Portainer access token. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.