init
This commit is contained in:
15
portainer/CHANGELOG.md
Normal file
15
portainer/CHANGELOG.md
Normal file
@@ -0,0 +1,15 @@
|
||||
## What’s changed
|
||||
|
||||
## ⬆️ Dependency updates
|
||||
|
||||
- ⬆️ Bump brpaz/hadolint-action from v1.4.0 to v1.5.0 @dependabot (#95)
|
||||
- ⬆️ Bump frenck/action-addon-linter from 2 to 2.1 @dependabot (#96)
|
||||
- ⬆️ Bump actions/stale from 3.0.18 to 3.0.19 @dependabot (#97)
|
||||
- ⬆️ Bump frenck/action-addon-information from 1.0.0 to 1.1 @dependabot (#98)
|
||||
- ⬆️ Bump micnncim/action-label-syncer from 1.2.0 to 1.3.0 @dependabot (#99)
|
||||
- ⬆️ Bump actions/cache from 2.1.5 to 2.1.6 @dependabot (#102)
|
||||
- ⬆️ Bump docker/build-push-action from 2.4.0 to 2.5.0 @dependabot (#100)
|
||||
- ⬆️ Bump docker/setup-qemu-action from 1.1.0 to 1.2.0 @dependabot (#101)
|
||||
- ⬆️ Bump frenck/action-addon-information from 1.1 to 1.2 @dependabot (#103)
|
||||
- ⬆️ Upgrades add-on base image to v9.2.2 @frenck (#107)
|
||||
- ⬆️ Upgrades Portainer to v1.24.2 @frenck (#108)
|
||||
145
portainer/DOCS.md
Normal file
145
portainer/DOCS.md
Normal file
@@ -0,0 +1,145 @@
|
||||
# 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
|
||||
|
||||
To install this add-on, you'll first need to go to your profile and turn on
|
||||
"Advanced Mode", once that is done go back to Home Assistant add-ons and search
|
||||
for "Portainer" and install it as you would any other 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.
|
||||
|
||||
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-2021 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
|
||||
[reddit]: https://reddit.com/r/homeassistant
|
||||
[releases]: https://github.com/hassio-addons/addon-portainer/releases
|
||||
[semver]: http://semver.org/spec/v2.0.0.htm
|
||||
43
portainer/README.md
Normal file
43
portainer/README.md
Normal file
@@ -0,0 +1,43 @@
|
||||
# Home Assistant Community Add-on: Portainer
|
||||
|
||||
[![Release][release-shield]][release] ![Project Stage][project-stage-shield] ![Project Maintenance][maintenance-shield]
|
||||
|
||||
[![Discord][discord-shield]][discord] [![Community Forum][forum-shield]][forum]
|
||||
|
||||
[![Sponsor Frenck via GitHub Sponsors][github-sponsors-shield]][github-sponsors]
|
||||
|
||||
[![Support Frenck on Patreon][patreon-shield]][patreon]
|
||||
|
||||
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.
|
||||
|
||||
![Portainer screenshot][screenshot]
|
||||
|
||||
[discord-shield]: https://img.shields.io/discord/478094546522079232.svg
|
||||
[discord]: https://discord.me/hassioaddons
|
||||
[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
|
||||
[github-sponsors]: https://github.com/sponsors/frenck
|
||||
[maintenance-shield]: https://img.shields.io/maintenance/yes/2021.svg
|
||||
[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.5.1-blue.svg
|
||||
[release]: https://github.com/hassio-addons/addon-portainer/tree/v1.5.1
|
||||
[screenshot]: https://github.com/hassio-addons/addon-portainer/raw/main/images/screenshot.png
|
||||
36
portainer/config.json
Normal file
36
portainer/config.json
Normal file
@@ -0,0 +1,36 @@
|
||||
{
|
||||
"name": "Portainer",
|
||||
"version": "1.5.1",
|
||||
"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",
|
||||
"panel_icon": "mdi:docker",
|
||||
"homeassistant": "0.92.0b2",
|
||||
"arch": [
|
||||
"aarch64",
|
||||
"amd64",
|
||||
"armhf",
|
||||
"armv7"
|
||||
],
|
||||
"init": false,
|
||||
"map": [
|
||||
"ssl"
|
||||
],
|
||||
"ports": {
|
||||
"8000/tcp": null
|
||||
},
|
||||
"ports_description": {
|
||||
"8000/tcp": "Edge Agent Api (Enable when managing remote edge agents)"
|
||||
},
|
||||
"hassio_api": true,
|
||||
"docker_api": true,
|
||||
"schema": {
|
||||
"log_level": "list(trace|debug|info|notice|warning|error|fatal)?",
|
||||
"agent_secret": "str?"
|
||||
},
|
||||
"image": "ghcr.io/hassio-addons/portainer/{arch}"
|
||||
}
|
||||
BIN
portainer/icon.png
Normal file
BIN
portainer/icon.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 4.7 KiB |
BIN
portainer/logo.png
Normal file
BIN
portainer/logo.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 30 KiB |
13
portainer/translations/en.yaml
Normal file
13
portainer/translations/en.yaml
Normal file
@@ -0,0 +1,13 @@
|
||||
---
|
||||
configuration:
|
||||
log_level:
|
||||
name: Log level
|
||||
description: >-
|
||||
Controls the level of log details the add-on provides.
|
||||
agent_secret:
|
||||
name: Agent Secret
|
||||
description: >-
|
||||
An option to set a shared agent secret. Must also be set in the remote
|
||||
agent as an Environment variable.
|
||||
network:
|
||||
8000/tcp: Edge Agent Api (Enable when managing remote edge agents)
|
||||
Reference in New Issue
Block a user