diff --git a/README.md b/README.md index 9345230d..b4204299 100644 --- a/README.md +++ b/README.md @@ -1040,10 +1040,10 @@ SOFTWARE. [plex-armhf-shield]: https://img.shields.io/badge/armhf-no-red.svg [plex-armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg [plex-i386-shield]: https://img.shields.io/badge/i386-yes-green.svg -[addon-portainer]: https://github.com/hassio-addons/addon-portainer/tree/v1.1.0 -[addon-doc-portainer]: https://github.com/hassio-addons/addon-portainer/blob/v1.1.0/README.md +[addon-portainer]: https://github.com/hassio-addons/addon-portainer/tree/v1.2.0 +[addon-doc-portainer]: https://github.com/hassio-addons/addon-portainer/blob/v1.2.0/README.md [portainer-issue]: https://github.com/hassio-addons/addon-portainer/issues -[portainer-version-shield]: https://img.shields.io/badge/version-v1.1.0-blue.svg +[portainer-version-shield]: https://img.shields.io/badge/version-v1.2.0-blue.svg [portainer-pulls-shield]: https://img.shields.io/docker/pulls/hassioaddons/portainer-armhf.svg [portainer-aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg [portainer-amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg diff --git a/portainer/CHANGELOG.md b/portainer/CHANGELOG.md index 2184ec5f..b4f68910 100644 --- a/portainer/CHANGELOG.md +++ b/portainer/CHANGELOG.md @@ -2,12 +2,14 @@ ### 🔨 Changes -- :arrow_up: Upgrades Portainer to v1.23.2 -- :arrow_up: Upgrades add-on base image to v7.0.5 -- :hammer: Disable Docker init -- :hammer: Hide CLI & Audio containers by default +- ⬆ Upgrades add-on base image to v7.2.0 +- 🔨 Implement OCI image specification on labels +- 🔨 Hide Home Assistant Multicast container by default +- 🔨 Mark add-on as advanced +- ✏ Split add-on documentation +- ⬆ Upgrades Portainer to v1.24.0 -[changelog]: https://github.com/hassio-addons/addon-portainer/compare/v1.0.0...v1.1.0 +[changelog]: https://github.com/hassio-addons/addon-portainer/compare/v1.1.0...v1.2.0 Questions? Join our Discord server! https://discord.me/hassioaddons Enjoying my add-ons? Consider supporting my work: diff --git a/portainer/DOCS.md b/portainer/DOCS.md new file mode 100644 index 00000000..2ecd0c60 --- /dev/null +++ b/portainer/DOCS.md @@ -0,0 +1,146 @@ +# Home Assistant Community Add-on: Portainer + +Portainer is an open-source lightweight management UI which allows you to +easily manage 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 access to virtually +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 no different +compared to installing any other Home Assistant 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. + +1. Search for the "Portainer" add-on in the Supervisor add-on store and + install it. +1. Set the "Protection mode" switch to off. +1. Start the "Portainer" add-on. +1. Check the logs of the "Portainer" add-on to see if everything went well. + +## Configuration + +**Note**: _Remember to restart the add-on when the configuration is changed._ + +Example add-on configuration: + +```yaml +log_level: info +agent_secret: password +``` + +**Note**: _This is just an example, don't copy and paste it! Create your own!_ + +### Option: `log_level` + +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. + +### Option: `agent_secret` + +An option to set a shared agent secret. Must also be set in the remote agent +as an Environment variable. + +## Known issues and limitations + +By default all Home Assistant managed containers are hidden from Portainer. +This is recommended since fooling around with Home Assistant managed containers +can easily lead to a broken system. + +Access to these containers can be gained by going into Portainer -> +Settings -> Hidden containers. Then delete the listed hidden labels +(io.hass.type labels). **Only do this if you know what you're doing!** + +## Changelog & Releases + +This repository keeps a change log using [GitHub's releases][releases] +functionality. The format of the log is based on +[Keep a Changelog][keepchangelog]. + +Releases are based on [Semantic Versioning][semver], 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 [Home Assistant Community Add-ons Discord chat server][discord] for add-on + support and feature requests. +- The [Home Assistant Discord chat server][discord-ha] for general Home + Assistant discussions and questions. +- The Home Assistant [Community Forum][forum]. +- Join the [Reddit subreddit][reddit] in [/r/homeassistant][reddit] + +You could also [open an issue here][issue] GitHub. + +## Authors & contributors + +The original setup of this repository is by [Franck Nijhof][frenck]. + +For a full list of all authors and contributors, +check [the contributor's page][contributors]. + +## License + +MIT License + +Copyright (c) 2018-2020 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. + +[contributors]: https://github.com/hassio-addons/addon-portainer/graphs/contributors +[discord-ha]: https://discord.gg/c5DvZ4e +[discord]: https://discord.me/hassioaddons +[forum]: https://community.home-assistant.io/t/home-assistant-community-add-on-portainer/68836?u=frenck +[frenck]: https://github.com/frenck +[issue]: https://github.com/hassio-addons/addon-portainer/issues +[keepchangelog]: http://keepachangelog.com/en/1.0.0/ +[reddit]: https://reddit.com/r/homeassistant +[releases]: https://github.com/hassio-addons/addon-portainer/releases +[semver]: http://semver.org/spec/v2.0.0.htm diff --git a/portainer/README.md b/portainer/README.md index c77c442d..738a26ec 100644 --- a/portainer/README.md +++ b/portainer/README.md @@ -19,8 +19,6 @@ 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. -[Click here for the full documentation][docs] - ## WARNING The Portainer add-on is really powerful and gives you virtually access to @@ -32,7 +30,6 @@ it could damage your system. [discord-shield]: https://img.shields.io/discord/478094546522079232.svg [discord]: https://discord.me/hassioaddons -[docs]: https://github.com/hassio-addons/addon-portainer/blob/v1.1.0/README.md [forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg [forum]: https://community.home-assistant.io/t/home-assistant-community-add-on-portainer/68836?u=frenck [github-sponsors-shield]: https://frenck.dev/wp-content/uploads/2019/12/github_sponsor.png @@ -41,6 +38,6 @@ it could damage your system. [patreon-shield]: https://frenck.dev/wp-content/uploads/2019/12/patreon.png [patreon]: https://www.patreon.com/frenck [project-stage-shield]: https://img.shields.io/badge/project%20stage-production%20ready-brightgreen.svg -[release-shield]: https://img.shields.io/badge/version-v1.1.0-blue.svg -[release]: https://github.com/hassio-addons/addon-portainer/tree/v1.1.0 +[release-shield]: https://img.shields.io/badge/version-v1.2.0-blue.svg +[release]: https://github.com/hassio-addons/addon-portainer/tree/v1.2.0 [screenshot]: https://github.com/hassio-addons/addon-portainer/raw/master/images/screenshot.png \ No newline at end of file diff --git a/portainer/config.json b/portainer/config.json index 02ea6d34..1be89fea 100644 --- a/portainer/config.json +++ b/portainer/config.json @@ -1,9 +1,10 @@ { "name": "Portainer", - "version": "1.1.0", + "version": "1.2.0", "slug": "portainer", "description": "Manage your Docker environment with ease", "url": "https://github.com/hassio-addons/addon-portainer", + "advanced": true, "ingress": true, "ingress_port": 1337, "startup": "services",