From 2f83f93eb98d4d77a5e9fa6d39d5110c2dcf3ab6 Mon Sep 17 00:00:00 2001 From: Alexandre <44178713+alexbelgium@users.noreply.github.com> Date: Fri, 15 Oct 2021 19:13:06 +0200 Subject: [PATCH] Update and rename .README.j2 to README.md --- portainer/.README.j2 | 82 -------------------------------------------- portainer/README.md | 66 +++++++++++++++++++++++++++++++++++ 2 files changed, 66 insertions(+), 82 deletions(-) delete mode 100644 portainer/.README.j2 create mode 100644 portainer/README.md diff --git a/portainer/.README.j2 b/portainer/.README.j2 deleted file mode 100644 index 30617f201..000000000 --- a/portainer/.README.j2 +++ /dev/null @@ -1,82 +0,0 @@ -# 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] - -{% if channel == "edge" %} -## WARNING! THIS IS AN EDGE VERSION! - -This Home Assistant Add-ons repository contains edge builds of add-ons. -Edge builds add-ons are based upon the latest development version. - -- They may not work at all. -- They might stop working at any time. -- They could have a negative impact on your system. - -This repository was created for: - -- Anybody willing to test. -- Anybody interested in trying out upcoming add-ons or add-on features. -- Developers. - -If you are more interested in stable releases of our add-ons: - - - -{% endif %} -{% if channel == "beta" %} -## WARNING! THIS IS A BETA VERSION! - -This Home Assistant Add-ons repository contains beta releases of add-ons. - -- They might stop working at any time. -- They could have a negative impact on your system. - -This repository was created for: - -- Anybody willing to test. -- Anybody interested in trying out upcoming add-ons or add-on features. - -If you are more interested in stable releases of our add-ons: - - - -{% endif %} -[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-{{ version }}-blue.svg -[release]: {{ repo }}/tree/{{ version }} -[screenshot]: https://github.com/hassio-addons/addon-portainer/raw/main/images/screenshot.png diff --git a/portainer/README.md b/portainer/README.md new file mode 100644 index 000000000..226ac4893 --- /dev/null +++ b/portainer/README.md @@ -0,0 +1,66 @@ +# Home assistant add-on: Portainer +![Supports aarch64 Architecture][aarch64-shield] ![Supports amd64 Architecture][amd64-shield] ![Supports armhf Architecture][armhf-shield] ![Supports armv7 Architecture][armv7-shield] +![Supports smb mounts][smb-shield] ![Supports openvpn][openvpn-shield] ![Supports ingress][ingress-shield] ![Supports ssl][ssl-shield] + +Forked from : https://github.com/hassio-addons/addon-portainer +Implemented changes : update to latest versions ; ingress ; ssl ; password setting through addon option ; allow manual override + +# 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 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) +[![Open your Home Assistant instance and show the add add-on repository dialog with a specific repository URL pre-filled.](https://my.home-assistant.io/badges/supervisor_add_addon_repository.svg)](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 , 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 +manual_override : optional, prevents database configuration to allow restoring previous backups +``` + +## Support +Create an issue on github + +# Illustration +-------------- +![illustration](https://github.com/hassio-addons/addon-portainer/raw/main/images/screenshot.png) + +[repository]: https://github.com/alexbelgium/hassio-addons +[smb-shield]: https://img.shields.io/badge/smb-yes-green.svg +[openvpn-shield]: https://img.shields.io/badge/openvpn-yes-green.svg +[ingress-shield]: https://img.shields.io/badge/ingress-yes-green.svg +[ssl-shield]: https://img.shields.io/badge/ssl-yes-green.svg +[aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg +[amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg +[armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg +[armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg