Community Hass.io Add-ons: Portainer
Manage your Docker environment with ease.
About
Portainer is an open-source lightweight management UI which allows you to easily manage your a Docker host(s) or Docker swarm clusters.
It has never been so easy to manage Docker. Portainer provides a detailed overview of Docker and allows you to manage containers, images, networks and volumes.
WARNING
The Portainer add-on is really powerful and gives you virtually access to your whole system. While this add-on is created and maintained with care and with security in mind, in the wrong or inexperienced hands, it could damage your system.
Installation
The installation of this add-on is pretty straightforward and not different in comparison to installing any other Hass.io add-on.
To be able to use this add-on, you'll need to disable protection mode on this add-on. Without it, the add-on is unable to access Docker.
- Add our Hass.io add-ons repository to your Hass.io instance.
- Install the "Portainer" add-on.
- Set the "Protection mode" switch to off.
- Start the "Portainer" add-on.
- Check the logs of the "Portainer" to see if everything went well.
NOTE: Do not add this repository to Hass.io, please use:
https://github.com/hassio-addons/repository
.
Docker status
Configuration
Note: Remember to restart the add-on when the configuration is changed.
Example add-on configuration:
{
"log_level": "info",
"ssl": true,
"certfile": "fullchain.pem",
"keyfile": "privkey.pem"
}
Note: This is just an example, don't copy and paste it! Create your own!
log_level
Option: The log_level
option controls the level of log output by the addon and can
be changed to be more or less verbose, which might be useful when you are
dealing with an unknown issue. Possible values are:
trace
: Show every detail, like all called internal functions.debug
: Shows detailed debug information.info
: Normal (usually) interesting events.warning
: Exceptional occurrences that are not errors.error
: Runtime errors that do not require immediate action.fatal
: Something went terribly wrong. Add-on becomes unusable.
Please note that each level automatically includes log messages from a
more severe level, e.g., debug
also shows info
messages. By default,
the log_level
is set to info
, which is the recommended setting unless
you are troubleshooting.
ssl
Option: Enables/Disables SSL (HTTPS) on the web interface.
Set it true
to enable it, false
otherwise.
certfile
Option: The certificate file to use for SSL.
Note: The file MUST be stored in /ssl/
, which is the default for Hass.io
keyfile
Option: The private key file to use for SSL.
Note: The file MUST be stored in /ssl/
, which is the default for Hass.io
hide_hassio_containers
Option: By default all Hassio managed containers are hidden from Portainer. This is recommended since fooling around with Hassio managed containers can easily lead to a broken system.
Set this option to false
, to gain access to Hassio managed containers as well.
leave_front_door_open
Option: Adding this option to the add-on configuration allows you to disable
authentication by setting it to true
.
Note: We STRONGLY suggest, not to use this, even if this add-on is only exposed to your internal network. USE AT YOUR OWN RISK!
Embedding into Home Assistant
It is possible to embed Portainer directly into Home Assistant, allowing you to access Portainer through the Home Assistant frontend.
Home Assistant provides the panel_iframe
component, for these purposes.
Example configuration:
panel_iframe:
portainer:
title: Portainer
icon: mdi:docker
url: https://addres.to.your.hass.io:9000
Changelog & Releases
This repository keeps a change log using GitHub's releases functionality. The format of the log is based on Keep a Changelog.
Releases are based on Semantic Versioning, and use the format
of MAJOR.MINOR.PATCH
. In a nutshell, the version will be incremented
based on the following:
MAJOR
: Incompatible or major changes.MINOR
: Backwards-compatible new features and enhancements.PATCH
: Backwards-compatible bugfixes and package updates.
Support
Got questions?
You have several options to get them answered:
- The Community Hass.io Add-ons Discord chat server for add-on support and feature requests.
- The Home Assistant Discord chat server for general Home Assistant discussions and questions.
- The Home Assistant Community Forum.
- Join the Reddit subreddit in /r/homeassistant
You could also open an issue here GitHub.
Contributing
This is an active open-source project. We are always open to people who want to use the code or contribute to it.
We have set up a separate document containing our contribution guidelines.
Thank you for being involved! 😍
Authors & contributors
The original setup of this repository is by Franck Nijhof.
For a full list of all authors and contributors, check the contributor's page.
We have got some Hass.io add-ons for you
Want some more functionality to your Hass.io Home Assistant instance?
We have created multiple add-ons for Hass.io. For a full list, check out our GitHub Repository.
License
MIT License
Copyright (c) 2018 Franck Nijhof
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.