From c7080f15f8a72419e86c6a1bc7f2468f20fbce70 Mon Sep 17 00:00:00 2001 From: "Community Hass.io Add-ons Bot" Date: Sat, 30 May 2020 20:52:54 +0000 Subject: [PATCH] :tada: Release of add-on Nginx Proxy Manager 0.6.0-beta.2 --- README.md | 6 +- nginxproxymanager/CHANGELOG.md | 39 +++------ nginxproxymanager/DOCS.md | 143 +++++++++++++++++++++++++++++++++ nginxproxymanager/README.md | 9 +-- nginxproxymanager/config.json | 3 +- 5 files changed, 164 insertions(+), 36 deletions(-) create mode 100644 nginxproxymanager/DOCS.md diff --git a/README.md b/README.md index 609ad87b..cd30b887 100644 --- a/README.md +++ b/README.md @@ -1016,10 +1016,10 @@ SOFTWARE. [nut-armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg [nut-armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg [nut-i386-shield]: https://img.shields.io/badge/i386-yes-green.svg -[addon-nginxproxymanager]: https://github.com/hassio-addons/addon-nginx-proxy-manager/tree/v0.5.0 -[addon-doc-nginxproxymanager]: https://github.com/hassio-addons/addon-nginx-proxy-manager/blob/v0.5.0/README.md +[addon-nginxproxymanager]: https://github.com/hassio-addons/addon-nginx-proxy-manager/tree/v0.6.0-beta.2 +[addon-doc-nginxproxymanager]: https://github.com/hassio-addons/addon-nginx-proxy-manager/blob/v0.6.0-beta.2/README.md [nginxproxymanager-issue]: https://github.com/hassio-addons/addon-nginx-proxy-manager/issues -[nginxproxymanager-version-shield]: https://img.shields.io/badge/version-v0.5.0-blue.svg +[nginxproxymanager-version-shield]: https://img.shields.io/badge/version-v0.6.0-beta.2-blue.svg [nginxproxymanager-pulls-shield]: https://img.shields.io/docker/pulls/hassioaddons/nginxproxymanager-armhf.svg [nginxproxymanager-aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg [nginxproxymanager-amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg diff --git a/nginxproxymanager/CHANGELOG.md b/nginxproxymanager/CHANGELOG.md index f27ebacd..112b5b56 100644 --- a/nginxproxymanager/CHANGELOG.md +++ b/nginxproxymanager/CHANGELOG.md @@ -1,34 +1,21 @@ [Full Changelog][changelog] -This is a big major release! - -This release upgrades the Nginx Proxy Manager to the latest and greatest, furthermore, it now leverages the official MariaDB add-on to store its data in. - -### ⚠️ Breaking change - -This add-on now depends on and requires the official Home Assistant MariaDB add-on in order to run. - -All data of the NGINX Proxy Manager is now stored in that add-on. This removes the need for the add-on to run and maintain its own database server. This reduces memory & CPU usages and makes it easier to maintain the add-on overall. - -If you are upgrading, please make sure you have installed the MariaDB add-on (version 2.0 or higher). The NGINX Proxy Manager add-on will automatically migrate your existing data. - ### πŸ”¨ Changes -- :hammer: Re-branding -- :books: Update add-on documentation to use new YAML configuration format -- :ambulance: Fix Patreon link -- :hammer: Update add-on config with new password & list features -- :hammer: Updates for upstream Supervisor changes -- :arrow_up: Upgrades nodejs to 12.15.0-r1 -- :arrow_up: Upgrades nginx to 1.16.1-r6 -- :arrow_up: Upgrades mariadb to 10.4.12-r0 -- :arrow_up: Upgrades nginx-proxy-manager to v2.1.1 -- :rocket: Remove unneeded eslint from build -- :arrow_up: Upgrades add-on base image to v7.0.2 -- :hammer: Adds migration to official MariaDB add-on (#77) -- :books: Update add-on instructions +- πŸ”¨ Update community forum links +- ⬆ Upgrades apache2-utils to 2.4.43-r0 +- πŸ”¨ Disable IPv6 by default +- πŸ”¨ Disable Docker init +- ⬆ Upgrades add-on base image to v7.2.0 +- πŸ”¨ Implement OCI image specification on labels +- ⬆ Upgrades git to 2.24.3-r0 +- ⬆ Upgrades python2 to 2.7.18-r0 +- ⬆ Upgrades mariadb to 10.4.13-r0 +- ⬆ Upgrades openssl to 1.1.1g-r0 +- ✏ Split add-on documentation +- ⬆ Upgrades NGINX Proxy Manager to v2.3.0 -[changelog]: https://github.com/hassio-addons/addon-nginx-proxy-manager/compare/v0.4.0...v0.5.0 +[changelog]: https://github.com/hassio-addons/addon-nginx-proxy-manager/compare/v0.5.0...v0.6.0-beta.2 Questions? Join our Discord server! https://discord.me/hassioaddons Enjoying my add-ons? Consider supporting my work: diff --git a/nginxproxymanager/DOCS.md b/nginxproxymanager/DOCS.md new file mode 100644 index 00000000..7bf1f47c --- /dev/null +++ b/nginxproxymanager/DOCS.md @@ -0,0 +1,143 @@ +# Home Assistant Community Add-on: Nginx Proxy Manager + +This add-on enables you to easily forward incoming connections to anywhere, +including free SSL, without having to know too much about Nginx +or Let’s Encrypt. + +Forward your domain to your Home Assistant, add-ons, or websites running +at home or anywhere else, straight from a simple, powerful interface. + +Want to protect the website with a username/password? Well, it can do that too! +Enable authentication and create a list of usernames/password that can access +that specific application. + +For the power users, you can customize the behavior of each host in the +Nginx proxy manager by providing additional Nginx directives. + +## Installation + +The installation of this add-on is pretty straightforward and not different in +comparison to installing any other Home Assistant add-on. + +1. Ensure you are running the MariaDB add-on. This add-on is required to use + the Nginx Proxy Manager add-on as it uses the database services provided. +1. Search for the "Nginx Proxy Manager" add-on in the Supervisor add-on store + and install it. +1. Start the "Nginx Proxy Manager" add-on +1. Check the logs of the "Nginx Proxy Manager" add-on to see if everything went well. +1. Click the "OPEN WEB UI" button and login using: + `admin@example.com` / `changeme` +1. Forward port `80` and `443` from your router to your Home Assistant machine. +1. Enjoy the add-on! + +## Configuration + +**Note**: _Remember to restart the add-on when the configuration is changed._ + +Example add-on configuration: + +```yaml +log_level: info +``` + +**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. + +## Known issues and limitations + +- The original NGinx Proxy Manager has support for forwarding TCP/UDP streams, + which is removed from this add-on. It makes no sense from a + Home Assistant / Home perspective and, by removing it, it also + removed the need for this add-on to run on the Docker host network. +- This add-on stores its database on the MariaDB add-on. This also means that + by taking a snapshot of just the Nginx Proxy Manager add-on, will not + contain the data from this add-on. Please make sure you backup both + the Nginx Proxy Manager and the MariaDB add-ons. + +## 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) 2019-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-nginx-proxy-manager/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-nginx-proxy-manager/111830?u=frenck +[frenck]: https://github.com/frenck +[issue]: https://github.com/hassio-addons/addon-nginx-proxy-manager/issues +[keepchangelog]: http://keepachangelog.com/en/1.0.0/ +[reddit]: https://reddit.com/r/homeassistant +[releases]: https://github.com/hassio-addons/addon-nginx-proxy-manager/releases +[semver]: http://semver.org/spec/v2.0.0.htm diff --git a/nginxproxymanager/README.md b/nginxproxymanager/README.md index 71ea9416..2cd00955 100644 --- a/nginxproxymanager/README.md +++ b/nginxproxymanager/README.md @@ -26,8 +26,6 @@ that specific application. For the power users, you can customize the behavior of each host in the Nginx proxy manager by providing additional Nginx directives. -[Click here for the full documentation][docs] - ![Nginx Proxy Manager screenshot][screenshot] ## WARNING! THIS IS A BETA VERSION! @@ -48,15 +46,14 @@ If you are more interested in stable releases of our add-ons: [discord-shield]: https://img.shields.io/discord/478094546522079232.svg [discord]: https://discord.me/hassioaddons -[docs]: https://github.com/hassio-addons/addon-nginx-proxy-manager/blob/v0.5.0/README.md [forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg -[forum]: https://community.home-assistant.io/t/community-hass-io-add-on-nginx-proxy-manager/111830?u=frenck +[forum]: https://community.home-assistant.io/t/home-assistant-community-add-on-nginx-proxy-manager/111830?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/2020.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-experimental-yellow.svg -[release-shield]: https://img.shields.io/badge/version-v0.5.0-blue.svg -[release]: https://github.com/hassio-addons/addon-nginx-proxy-manager/tree/v0.5.0 +[release-shield]: https://img.shields.io/badge/version-v0.6.0-beta.2-blue.svg +[release]: https://github.com/hassio-addons/addon-nginx-proxy-manager/tree/v0.6.0-beta.2 [screenshot]: https://github.com/hassio-addons/addon-nginx-proxy-manager/raw/master/images/screenshot.gif \ No newline at end of file diff --git a/nginxproxymanager/config.json b/nginxproxymanager/config.json index 25be584c..1cc45e09 100644 --- a/nginxproxymanager/config.json +++ b/nginxproxymanager/config.json @@ -1,11 +1,12 @@ { "name": "Nginx Proxy Manager", - "version": "0.5.0", + "version": "0.6.0-beta.2", "slug": "nginxproxymanager", "description": "Manage Nginx proxy hosts with a simple, powerful interface", "url": "https://github.com/hassio-addons/addon-nginx-proxy-manager", "webui": "http://[HOST]:[PORT:81]", "startup": "application", + "init": false, "arch": [ "aarch64", "amd64",