mirror of
https://github.com/alexbelgium/hassio-addons.git
synced 2026-01-10 09:51:02 +01:00
First build https://github.com/alexbelgium/hassio-addons/issues/840 https://github.com/alexbelgium/hassio-addons/issues/565
This commit is contained in:
Alexandre
84
portainer_agent/README.md
Normal file
84
portainer_agent/README.md
Normal file
@@ -0,0 +1,84 @@
|
||||
# Home assistant add-on: Portainer_agent
|
||||
|
||||
[![Donate][donation-badge]](https://www.buymeacoffee.com/alexbelgium)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
[](https://www.codacy.com/gh/alexbelgium/hassio-addons/dashboard?utm_source=github.com&utm_medium=referral&utm_content=alexbelgium/hassio-addons&utm_campaign=Badge_Grade)
|
||||
[](https://github.com/marketplace/actions/super-linter)
|
||||
[](https://github.com/alexbelgium/hassio-addons/actions/workflows/builder.yaml)
|
||||
|
||||
[donation-badge]: https://img.shields.io/badge/Buy%20me%20a%20coffee-%23d32f2f?logo=buy-me-a-coffee&style=flat&logoColor=white
|
||||
|
||||
Forked from : https://github.com/hassio-addons/addon-portainer_agent
|
||||
Implemented changes : update to latest versions ; ingress ; ssl ; password setting through addon option ; allow manual override
|
||||
|
||||
_Thanks to everyone having starred my repo! To star it click on the image below, then it will be on top right. Thanks!_
|
||||
|
||||
[](https://github.com/alexbelgium/hassio-addons/stargazers)
|
||||
|
||||
|
||||
|
||||
## About
|
||||
|
||||
---
|
||||
|
||||
portainer_agent 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_agent provides a detailed
|
||||
overview of Docker and allows you to manage containers, images, networks and
|
||||
volumes.
|
||||
|
||||
## RESTORE BACKUP
|
||||
|
||||
Open the addon options and set the password to "". Restart the addon, it will allow to restore portainer_agent from a backup. You need to put your backup in an accessible folder such as /share to have it mounted in the addon
|
||||
|
||||
## WARNING
|
||||
|
||||
The portainer_agent 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 add-on.
|
||||
|
||||
1. Add my add-ons repository to your home assistant instance (in supervisor addons store at top right, or click button below if you have configured my HA)
|
||||
[](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Falexbelgium%2Fhassio-addons)
|
||||
1. Install this add-on.
|
||||
1. Click the `Save` button to store your configuration.
|
||||
1. Set the add-on options to your preferences
|
||||
1. Start the add-on.
|
||||
1. Check the logs of the add-on to see if everything went well.
|
||||
1. Open the webUI and adapt the software options
|
||||
|
||||
## Configuration
|
||||
|
||||
---
|
||||
|
||||
Webui can be found at <http://your-ip:port>, or in your sidebar using Ingress.
|
||||
The default username/password : described in the startup log.
|
||||
Configurations can be done through the app webUI, except for the following options
|
||||
|
||||
```yaml
|
||||
ssl: true/false
|
||||
certfile: fullchain.pem #ssl certificate, must be located in /ssl
|
||||
keyfile: privkey.pem #sslkeyfile, must be located in /ssl
|
||||
password: define admin password. If kept blank, will allow manual restore of previous backup. At least 12 characters.
|
||||
```
|
||||
|
||||
## Support
|
||||
|
||||
Create an issue on github
|
||||
|
||||
## Illustration
|
||||
|
||||
---
|
||||
|
||||
|
||||
Reference in New Issue
Block a user