-
Notifications
You must be signed in to change notification settings - Fork 522
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Revert ":tada: Release of add-on Nginx Proxy Manager 1.0.0"
This reverts commit 8752ae7.
- Loading branch information
Showing
8 changed files
with
106 additions
and
123 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,105 +1,21 @@ | ||
| ### 🚨 THIS RELEASE HAS MAJOR BREAKING CHANGES! | ||
| ### 🛑 DO NOT UPGRADE WITHOUT READING THE RELEASE NOTES! | ||
| ### ⚠️ BE SURE TO BACKUP BEFORE UPGRADING! | ||
|
|
||
| **The v1.0.0 release is NOT backward-compatible with any existing installation prior v1.0.0.** | ||
|
|
||
| Unfortunately, no stable/good migration path is possible; thus, on upgrade, you will **lose all your current NPM settings and configuration**. After the upgrade, you must set up your proxy configuration from scratch. | ||
|
|
||
| **Please make sure you have the time to do this when you decide to upgrade.** | ||
|
|
||
| After upgrading, you can log in with the default username & password: `[email protected]` / `changeme`. | ||
|
|
||
| Additionally, support for the `i386` and `armhf` OS/CPU architecture has been dropped (as has been dropped previously for all other Community Add-ons as well). | ||
|
|
||
| [If you have any more questions, please check this issue.](https://github.com/hassio-addons/addon-nginx-proxy-manager/issues/507) | ||
|
|
||
| ## What’s changed | ||
|
|
||
| - Based on the latest Nginx Proxy Manager [v2.10.4](https://github.com/NginxProxyManager/nginx-proxy-manager/releases/tag/v2.10.4), which closes [CVE-2023-27224](https://www.cvedetails.com/cve/CVE-2023-27224/). | ||
| - Based on the latest Alpine Linux 3.19. | ||
| - The add-on no longer uses the MariaDB add-on. This means after you have upgraded/migrated, you could uninstall the MariaDB add-on (if you solely used it for NPM). | ||
| - Certbot now functions properly, which means all DNS challenges work as expected. | ||
| - Backups of this add-on are now complete. They will contain all data, settings, and certificates; and can be restored easily/as normal. | ||
| - All raw configuration data of NPM is now accessible via the `adddons_config` folder (for example, using Samba). | ||
|
|
||
| ## 🚨 Breaking changes | ||
|
|
||
| - Remove MariaDB/MySQL support @frenck ([#474](https://github.com/hassio-addons/addon-nginx-proxy-manager/pull/474)) | ||
| - Drop support for armhf & i386 @frenck ([#498](https://github.com/hassio-addons/addon-nginx-proxy-manager/pull/498)) | ||
|
|
||
| ## 🐛 Bug fixes | ||
|
|
||
| - Fix NPM build with NodeJS 18x @frenck ([#429](https://github.com/hassio-addons/addon-nginx-proxy-manager/pull/429)) | ||
| - Clean up upstream user @frenck ([#473](https://github.com/hassio-addons/addon-nginx-proxy-manager/pull/473)) | ||
| - Fix copy paste error in npm init script @frenck ([#501](https://github.com/hassio-addons/addon-nginx-proxy-manager/pull/501)) | ||
| - Patch certbot plugin handling @frenck ([#508](https://github.com/hassio-addons/addon-nginx-proxy-manager/pull/508)) | ||
|
|
||
| ## 🚀 Enhancements | ||
|
|
||
| - Migrate add-on to new Home Assistant configuration mapping @frenck ([#500](https://github.com/hassio-addons/addon-nginx-proxy-manager/pull/500)) | ||
| - Patch Nginx Proxy Manager instead of hacking around it @frenck ([#505](https://github.com/hassio-addons/addon-nginx-proxy-manager/pull/505)) | ||
|
|
||
| ## 🧰 Maintenance | ||
|
|
||
| - 🎆 Updates maintenance/license year to 2023 @frenck ([#408](https://github.com/hassio-addons/addon-nginx-proxy-manager/pull/408)) | ||
| - Add Renovate for dependency management @frenck ([#411](https://github.com/hassio-addons/addon-nginx-proxy-manager/pull/411)) | ||
| - Updated icon and logo @InTheDaylight14 ([#399](https://github.com/hassio-addons/addon-nginx-proxy-manager/pull/399)) | ||
| - Remove mariadb dependencies @frenck ([#475](https://github.com/hassio-addons/addon-nginx-proxy-manager/pull/475)) | ||
| - Migrate old-style base scripts s6-rc @frenck ([#499](https://github.com/hassio-addons/addon-nginx-proxy-manager/pull/499)) | ||
|
|
||
| ## 📚 Documentation | ||
|
|
||
| - Fix broken URL @wrt54g ([#430](https://github.com/hassio-addons/addon-nginx-proxy-manager/pull/430)) | ||
| - Update documentation for upcoming release @frenck ([#506](https://github.com/hassio-addons/addon-nginx-proxy-manager/pull/506)) | ||
| - 🚑 Update add-on to handle new log file paths @krisbogaerts (#357) | ||
| - 🚑 Exclude logs from backup @frenck (#382) | ||
|
|
||
| ## ⬆️ Dependency updates | ||
|
|
||
| <details> | ||
| <summary>Details</summary> | ||
|
|
||
| - ⬆️ Update alpine_3_17/nodejs to v18 @renovate ([#415](https://github.com/hassio-addons/addon-nginx-proxy-manager/pull/415)) | ||
| - ⬆️ Update alpine_3_17/npm to v9 @renovate ([#416](https://github.com/hassio-addons/addon-nginx-proxy-manager/pull/416)) | ||
| - ⬆️ Update Python to v3.10.10-r0 @renovate ([#413](https://github.com/hassio-addons/addon-nginx-proxy-manager/pull/413)) | ||
| - ⬆️ Update ghcr.io/hassio-addons/base Docker tag to v13 @renovate ([#417](https://github.com/hassio-addons/addon-nginx-proxy-manager/pull/417)) | ||
| - ⬆️ Update alpine_3_17/mariadb-client to v10.6.12-r0 @renovate ([#420](https://github.com/hassio-addons/addon-nginx-proxy-manager/pull/420)) | ||
| - ⬆️ Update alpine_3_17/certbot to v1.32.0-r0 @renovate ([#422](https://github.com/hassio-addons/addon-nginx-proxy-manager/pull/422)) | ||
| - ⬆️ Update alpine_3_17/git to v2.38.4-r1 @renovate ([#423](https://github.com/hassio-addons/addon-nginx-proxy-manager/pull/423)) | ||
| - ⬆️ Update alpine_3_17/apache2-utils to v2.4.56-r0 @renovate ([#418](https://github.com/hassio-addons/addon-nginx-proxy-manager/pull/418)) | ||
| - ⬆️ Update alpine_3_17/patch to v2.7.6-r8 @renovate ([#421](https://github.com/hassio-addons/addon-nginx-proxy-manager/pull/421)) | ||
| - ⬆️ Update alpine_3_17/py3-pip to v22.3.1-r1 @renovate ([#426](https://github.com/hassio-addons/addon-nginx-proxy-manager/pull/426)) | ||
| - ⬆️ Update alpine_3_17/logrotate to v3.20.1-r3 @renovate ([#425](https://github.com/hassio-addons/addon-nginx-proxy-manager/pull/425)) | ||
| - ⬆️ Update alpine_3_17/libffi-dev to v3.4.4-r0 @renovate ([#419](https://github.com/hassio-addons/addon-nginx-proxy-manager/pull/419)) | ||
| - ⬆️ Update alpine_3_17/libcap to v2.66-r0 @renovate ([#424](https://github.com/hassio-addons/addon-nginx-proxy-manager/pull/424)) | ||
| - ⬆️ Update OpenSSL to v3 (major) @renovate ([#427](https://github.com/hassio-addons/addon-nginx-proxy-manager/pull/427)) | ||
| - ⬆️ Update OpenSSL to v3.0.8-r2 @renovate ([#431](https://github.com/hassio-addons/addon-nginx-proxy-manager/pull/431)) | ||
| - ⬆️ Update ghcr.io/hassio-addons/base Docker tag to v13.1.5 @renovate ([#433](https://github.com/hassio-addons/addon-nginx-proxy-manager/pull/433)) | ||
| - ⬆️ Update alpine_3_17/patch to v2.7.6-r9 @renovate ([#432](https://github.com/hassio-addons/addon-nginx-proxy-manager/pull/432)) | ||
| - ⬆️ Update NginxProxyManager/nginx-proxy-manager to v2.10.1 @renovate ([#412](https://github.com/hassio-addons/addon-nginx-proxy-manager/pull/412)) | ||
| - ⬆️ Update OpenSSL to v3.0.8-r3 @renovate ([#434](https://github.com/hassio-addons/addon-nginx-proxy-manager/pull/434)) | ||
| - ⬆️ Update ghcr.io/hassio-addons/base Docker tag to v13.2.0 @renovate ([#435](https://github.com/hassio-addons/addon-nginx-proxy-manager/pull/435)) | ||
| - ⬆️ Update NginxProxyManager/nginx-proxy-manager to v2.10.2 @renovate ([#436](https://github.com/hassio-addons/addon-nginx-proxy-manager/pull/436)) | ||
| - ⬆️ Update Python to v3.10.11-r0 @renovate ([#440](https://github.com/hassio-addons/addon-nginx-proxy-manager/pull/440)) | ||
| - ⬆️ Update alpine_3_17/apache2-utils to v2.4.57-r0 @renovate ([#441](https://github.com/hassio-addons/addon-nginx-proxy-manager/pull/441)) | ||
| - ⬆️ Update ghcr.io/hassio-addons/base Docker tag to v13.2.1 @renovate ([#442](https://github.com/hassio-addons/addon-nginx-proxy-manager/pull/442)) | ||
| - ⬆️ Update OpenSSL to v3.0.8-r4 @renovate ([#443](https://github.com/hassio-addons/addon-nginx-proxy-manager/pull/443)) | ||
| - ⬆️ Update ghcr.io/hassio-addons/base Docker tag to v13.2.2 @renovate ([#444](https://github.com/hassio-addons/addon-nginx-proxy-manager/pull/444)) | ||
| - ⬆️ Update alpine_3_17/git to v2.38.5-r0 @renovate ([#445](https://github.com/hassio-addons/addon-nginx-proxy-manager/pull/445)) | ||
| - ⬆️ Update NginxProxyManager/nginx-proxy-manager to v2.10.4 @renovate ([#448](https://github.com/hassio-addons/addon-nginx-proxy-manager/pull/448)) | ||
| - ⬆️ Update certbot-dns-cloudflare to v2 @renovate ([#428](https://github.com/hassio-addons/addon-nginx-proxy-manager/pull/428)) | ||
| - ⬆️ Update ghcr.io/hassio-addons/base Docker tag to v14 @renovate ([#453](https://github.com/hassio-addons/addon-nginx-proxy-manager/pull/453)) | ||
| - ⬆️ Update NGINX to v1.24.0-r7 @renovate ([#472](https://github.com/hassio-addons/addon-nginx-proxy-manager/pull/472)) | ||
| - ⬆️ Update alpine_3_18/apache2-utils to v2.4.58-r0 @renovate ([#479](https://github.com/hassio-addons/addon-nginx-proxy-manager/pull/479)) | ||
| - ⬆️ Update certbot-dns-cloudflare to v2.7.2 @renovate ([#480](https://github.com/hassio-addons/addon-nginx-proxy-manager/pull/480)) | ||
| - ⬆️ Update ghcr.io/hassio-addons/base Docker tag to v14.3.0 @renovate ([#481](https://github.com/hassio-addons/addon-nginx-proxy-manager/pull/481)) | ||
| - ⬆️ Update OpenSSL to v3.1.4-r0 @renovate ([#482](https://github.com/hassio-addons/addon-nginx-proxy-manager/pull/482)) | ||
| - ⬆️ Update ghcr.io/hassio-addons/base Docker tag to v14.3.1 @renovate ([#484](https://github.com/hassio-addons/addon-nginx-proxy-manager/pull/484)) | ||
| - ⬆️ Update certbot-dns-cloudflare to v2.7.3 @renovate ([#483](https://github.com/hassio-addons/addon-nginx-proxy-manager/pull/483)) | ||
| - ⬆️ Update OpenSSL to v3.1.4-r1 @renovate ([#489](https://github.com/hassio-addons/addon-nginx-proxy-manager/pull/489)) | ||
| - ⬆️ Update ghcr.io/hassio-addons/base Docker tag to v14.3.2 @renovate ([#491](https://github.com/hassio-addons/addon-nginx-proxy-manager/pull/491)) | ||
| - ⬆️ Update certbot-dns-cloudflare to v2.8.0 @renovate ([#486](https://github.com/hassio-addons/addon-nginx-proxy-manager/pull/486)) | ||
| - ⬆️ Update ghcr.io/hassio-addons/base Docker tag to v15 @renovate ([#494](https://github.com/hassio-addons/addon-nginx-proxy-manager/pull/494)) | ||
| - ⬆️ Update OpenSSL to v3.1.4-r3 @renovate ([#503](https://github.com/hassio-addons/addon-nginx-proxy-manager/pull/503)) | ||
| - ⬆️ Update ghcr.io/hassio-addons/base-nodejs Docker tag to v0.1.1 @renovate ([#504](https://github.com/hassio-addons/addon-nginx-proxy-manager/pull/504)) | ||
|
|
||
| </details> | ||
| - ⬆️ Upgrades add-on base image to 12.2.4 @frenck (#360) | ||
| - ⬆️ Bump certbot-dns-cloudflare from 1.29.0 to 1.30.0 in /proxy-manager @dependabot (#356) | ||
| - ⬆️ Bump certbot-dns-cloudflare from 1.30.0 to 1.31.0 in /proxy-manager @dependabot (#367) | ||
| - ⬆️ Upgrades git to 2.36.3-r0 @frenck (#375) | ||
| - ⬆️ Upgrades openssl to 1.1.1s-r0 @frenck (#376) | ||
| - ⬆️ Upgrades python3 to 3.10.8-r0 @frenck (#377) | ||
| - ⬆️ Upgrades nodejs to 16.17.1-r0 @frenck (#378) | ||
| - ⬆️ Upgrades mariadb-client to 10.6.10-r0 @frenck (#379) | ||
| - ⬆️ Upgrades nginx to 1.22.1-r0 @frenck (#380) | ||
| - ⬆️ Upgrades add-on base image to 12.2.7 @frenck (#381) | ||
| - ⬆️ Bump certbot-dns-cloudflare from 1.31.0 to 1.32.0 in /proxy-manager @dependabot (#371) | ||
| - ⬆️ Upgrades NGINX Proxy Manager to v2.9.19 @frenck (#383) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -19,6 +19,8 @@ Nginx proxy manager by providing additional Nginx directives. | |
| 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. Click the Home Assistant My button below to open the add-on on your Home | ||
| Assistant instance. | ||
|
|
||
|
|
@@ -29,13 +31,57 @@ comparison to installing any other Home Assistant 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: | ||
| `[email protected]` / `changeme` | ||
| 1. Forward port `443` (and optionally `80`) from your router to your | ||
| Home Assistant machine. | ||
| 1. Forward port `80` and `443` from your router to your Home Assistant machine. | ||
| 1. Enjoy the add-on! | ||
|
|
||
| ## Configuration | ||
|
|
||
| This add-on does not provide any 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. | ||
|
|
||
| ### Option: `reset_database` | ||
|
|
||
| By setting to `true` provides the option to delete and recreate the database. As | ||
| the data is held within the MariaDB addon, it is not removed on an uninstall. | ||
|
|
||
| **Note**: _Once the database is reset the configuration for the addon will be | ||
| cleared automatically_ | ||
|
|
||
| ## 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 | ||
|
|
||
|
|
@@ -76,7 +122,7 @@ check [the contributor's page][contributors]. | |
|
|
||
| MIT License | ||
|
|
||
| Copyright (c) 2019-2024 Franck Nijhof | ||
| Copyright (c) 2019-2022 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 | ||
|
|
@@ -106,4 +152,4 @@ SOFTWARE. | |
| [issue]: https://github.com/hassio-addons/addon-nginx-proxy-manager/issues | ||
| [reddit]: https://reddit.com/r/homeassistant | ||
| [releases]: https://github.com/hassio-addons/addon-nginx-proxy-manager/releases | ||
| [semver]: https://semver.org/spec/v2.0.0.html | ||
| [semver]: http://semver.org/spec/v2.0.0.htm | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,22 +1,34 @@ | ||
| name: Nginx Proxy Manager | ||
| version: 1.0.0 | ||
| slug: nginxproxymanager | ||
| description: Manage Nginx proxy hosts with a simple, powerful interface | ||
| url: https://github.com/hassio-addons/addon-nginx-proxy-manager | ||
| codenotary: [email protected] | ||
| webui: http://[HOST]:[PORT:81] | ||
| init: false | ||
| arch: | ||
| - aarch64 | ||
| - amd64 | ||
| - armhf | ||
| - armv7 | ||
| - i386 | ||
| backup_exclude: | ||
| - '*/logs' | ||
| codenotary: [email protected] | ||
| description: Manage Nginx proxy hosts with a simple, powerful interface | ||
| hassio_api: true | ||
| image: ghcr.io/hassio-addons/nginxproxymanager/{arch} | ||
| init: false | ||
| map: | ||
| - ssl:rw | ||
| - backup:rw | ||
| name: Nginx Proxy Manager | ||
| ports: | ||
| 443/tcp: 443 | ||
| 80/tcp: 80 | ||
| 81/tcp: 81 | ||
| 443/tcp: 443 | ||
| map: | ||
| - addon_config:rw | ||
| backup_exclude: | ||
| - '*/logs' | ||
| image: ghcr.io/hassio-addons/nginxproxymanager/{arch} | ||
| ports_description: | ||
| 443/tcp: HTTPS/SSL Entrance port | ||
| 80/tcp: HTTP Entrance port | ||
| 81/tcp: Proxy management web interface | ||
| schema: | ||
| log_level: list(trace|debug|info|notice|warning|error|fatal)? | ||
| reset_database: bool? | ||
| services: | ||
| - mysql:need | ||
| slug: nginxproxymanager | ||
| url: https://github.com/hassio-addons/addon-nginx-proxy-manager | ||
| version: 0.12.3 | ||
| webui: http://[HOST]:[PORT:81] |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters