mirror of
https://github.com/hassio-addons/repository.git
synced 2025-05-03 18:51:29 +00:00
🎉 Release of add-on Nginx Proxy Manager 1.0.1
This commit is contained in:
parent
8eb9721692
commit
6ccead975b
8 changed files with 52 additions and 108 deletions
|
@ -805,10 +805,10 @@ SOFTWARE.
|
||||||
[nut-armhf-shield]: https://img.shields.io/badge/armhf-no-red.svg
|
[nut-armhf-shield]: https://img.shields.io/badge/armhf-no-red.svg
|
||||||
[nut-armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg
|
[nut-armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg
|
||||||
[nut-i386-shield]: https://img.shields.io/badge/i386-no-red.svg
|
[nut-i386-shield]: https://img.shields.io/badge/i386-no-red.svg
|
||||||
[addon-nginxproxymanager]: https://github.com/hassio-addons/addon-nginx-proxy-manager/tree/v0.12.3
|
[addon-nginxproxymanager]: https://github.com/hassio-addons/addon-nginx-proxy-manager/tree/v1.0.1
|
||||||
[addon-doc-nginxproxymanager]: https://github.com/hassio-addons/addon-nginx-proxy-manager/blob/v0.12.3/README.md
|
[addon-doc-nginxproxymanager]: https://github.com/hassio-addons/addon-nginx-proxy-manager/blob/v1.0.1/README.md
|
||||||
[nginxproxymanager-issue]: https://github.com/hassio-addons/addon-nginx-proxy-manager/issues
|
[nginxproxymanager-issue]: https://github.com/hassio-addons/addon-nginx-proxy-manager/issues
|
||||||
[nginxproxymanager-version-shield]: https://img.shields.io/badge/version-v0.12.3-blue.svg
|
[nginxproxymanager-version-shield]: https://img.shields.io/badge/version-v1.0.1-blue.svg
|
||||||
[nginxproxymanager-aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.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
|
[nginxproxymanager-amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg
|
||||||
[nginxproxymanager-armhf-shield]: https://img.shields.io/badge/armhf-no-red.svg
|
[nginxproxymanager-armhf-shield]: https://img.shields.io/badge/armhf-no-red.svg
|
||||||
|
|
|
@ -1,21 +1,32 @@
|
||||||
|
### 🚨 THIS RELEASE HAS MAJOR BREAKING CHANGES!
|
||||||
|
### 🛑 DO NOT UPGRADE WITHOUT READING THE RELEASE NOTES!
|
||||||
|
### ⚠️ BE SURE TO BACKUP BEFORE UPGRADING!
|
||||||
|
|
||||||
|
**The v1.0.1 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: `admin@example.com` / `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).
|
||||||
|
|
||||||
## What’s changed
|
## What’s changed
|
||||||
|
|
||||||
## 🐛 Bug fixes
|
## 🐛 Bug fixes
|
||||||
|
|
||||||
- 🚑 Update add-on to handle new log file paths @krisbogaerts (#357)
|
- Fix syntax error in certbot patch @frenck ([#510](https://github.com/hassio-addons/addon-nginx-proxy-manager/pull/510))
|
||||||
- 🚑 Exclude logs from backup @frenck (#382)
|
|
||||||
|
|
||||||
## ⬆️ Dependency updates
|
For all other changes in v1.0.0 see: <https://github.com/hassio-addons/addon-nginx-proxy-manager/releases/tag/v1.0.0>
|
||||||
|
|
||||||
- ⬆️ 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)
|
|
|
@ -19,8 +19,6 @@ Nginx proxy manager by providing additional Nginx directives.
|
||||||
The installation of this add-on is pretty straightforward and not different in
|
The installation of this add-on is pretty straightforward and not different in
|
||||||
comparison to installing any other Home Assistant add-on.
|
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
|
1. Click the Home Assistant My button below to open the add-on on your Home
|
||||||
Assistant instance.
|
Assistant instance.
|
||||||
|
|
||||||
|
@ -31,57 +29,13 @@ 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. 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:
|
1. Click the "OPEN WEB UI" button and login using:
|
||||||
`admin@example.com` / `changeme`
|
`admin@example.com` / `changeme`
|
||||||
1. Forward port `80` and `443` from your router to your Home Assistant machine.
|
1. Forward port `443` (and optionally `80`) from your router to your
|
||||||
|
Home Assistant machine.
|
||||||
1. Enjoy the add-on!
|
1. Enjoy the add-on!
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
**Note**: _Remember to restart the add-on when the configuration is changed._
|
This add-on does not provide any configuration.
|
||||||
|
|
||||||
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
|
## Changelog & Releases
|
||||||
|
|
||||||
|
@ -122,7 +76,7 @@ check [the contributor's page][contributors].
|
||||||
|
|
||||||
MIT License
|
MIT License
|
||||||
|
|
||||||
Copyright (c) 2019-2022 Franck Nijhof
|
Copyright (c) 2019-2024 Franck Nijhof
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
of this software and associated documentation files (the "Software"), to deal
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
@ -152,4 +106,4 @@ SOFTWARE.
|
||||||
[issue]: https://github.com/hassio-addons/addon-nginx-proxy-manager/issues
|
[issue]: https://github.com/hassio-addons/addon-nginx-proxy-manager/issues
|
||||||
[reddit]: https://reddit.com/r/homeassistant
|
[reddit]: https://reddit.com/r/homeassistant
|
||||||
[releases]: https://github.com/hassio-addons/addon-nginx-proxy-manager/releases
|
[releases]: https://github.com/hassio-addons/addon-nginx-proxy-manager/releases
|
||||||
[semver]: http://semver.org/spec/v2.0.0.htm
|
[semver]: https://semver.org/spec/v2.0.0.html
|
||||||
|
|
|
@ -34,10 +34,10 @@ Nginx proxy manager by providing additional Nginx directives.
|
||||||
[forum]: https://community.home-assistant.io/t/home-assistant-community-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-shield]: https://frenck.dev/wp-content/uploads/2019/12/github_sponsor.png
|
||||||
[github-sponsors]: https://github.com/sponsors/frenck
|
[github-sponsors]: https://github.com/sponsors/frenck
|
||||||
[maintenance-shield]: https://img.shields.io/maintenance/yes/2022.svg
|
[maintenance-shield]: https://img.shields.io/maintenance/yes/2024.svg
|
||||||
[patreon-shield]: https://frenck.dev/wp-content/uploads/2019/12/patreon.png
|
[patreon-shield]: https://frenck.dev/wp-content/uploads/2019/12/patreon.png
|
||||||
[patreon]: https://www.patreon.com/frenck
|
[patreon]: https://www.patreon.com/frenck
|
||||||
[project-stage-shield]: https://img.shields.io/badge/project%20stage-experimental-yellow.svg
|
[project-stage-shield]: https://img.shields.io/badge/project%20stage-experimental-yellow.svg
|
||||||
[release-shield]: https://img.shields.io/badge/version-v0.12.3-blue.svg
|
[release-shield]: https://img.shields.io/badge/version-v1.0.1-blue.svg
|
||||||
[release]: https://github.com/hassio-addons/addon-nginx-proxy-manager/tree/v0.12.3
|
[release]: https://github.com/hassio-addons/addon-nginx-proxy-manager/tree/v1.0.1
|
||||||
[screenshot]: https://github.com/hassio-addons/addon-nginx-proxy-manager/raw/main/images/screenshot.gif
|
[screenshot]: https://github.com/hassio-addons/addon-nginx-proxy-manager/raw/main/images/screenshot.gif
|
|
@ -1,34 +1,22 @@
|
||||||
|
name: Nginx Proxy Manager
|
||||||
|
version: 1.0.1
|
||||||
|
slug: nginxproxymanager
|
||||||
|
description: Manage Nginx proxy hosts with a simple, powerful interface
|
||||||
|
url: https://github.com/hassio-addons/addon-nginx-proxy-manager
|
||||||
|
codenotary: codenotary@frenck.dev
|
||||||
|
webui: http://[HOST]:[PORT:81]
|
||||||
|
init: false
|
||||||
arch:
|
arch:
|
||||||
- aarch64
|
- aarch64
|
||||||
- amd64
|
- amd64
|
||||||
- armhf
|
|
||||||
- armv7
|
- armv7
|
||||||
- i386
|
|
||||||
backup_exclude:
|
|
||||||
- '*/logs'
|
|
||||||
codenotary: codenotary@frenck.dev
|
|
||||||
description: Manage Nginx proxy hosts with a simple, powerful interface
|
|
||||||
hassio_api: true
|
hassio_api: true
|
||||||
image: ghcr.io/hassio-addons/nginxproxymanager/{arch}
|
|
||||||
init: false
|
|
||||||
map:
|
|
||||||
- ssl:rw
|
|
||||||
- backup:rw
|
|
||||||
name: Nginx Proxy Manager
|
|
||||||
ports:
|
ports:
|
||||||
443/tcp: 443
|
|
||||||
80/tcp: 80
|
80/tcp: 80
|
||||||
81/tcp: 81
|
81/tcp: 81
|
||||||
ports_description:
|
443/tcp: 443
|
||||||
443/tcp: HTTPS/SSL Entrance port
|
map:
|
||||||
80/tcp: HTTP Entrance port
|
- addon_config:rw
|
||||||
81/tcp: Proxy management web interface
|
backup_exclude:
|
||||||
schema:
|
- '*/logs'
|
||||||
log_level: list(trace|debug|info|notice|warning|error|fatal)?
|
image: ghcr.io/hassio-addons/nginxproxymanager/{arch}
|
||||||
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]
|
|
||||||
|
|
Binary file not shown.
Before Width: | Height: | Size: 9.8 KiB After Width: | Height: | Size: 41 KiB |
Binary file not shown.
Before Width: | Height: | Size: 4.8 KiB After Width: | Height: | Size: 46 KiB |
|
@ -1,13 +1,4 @@
|
||||||
---
|
---
|
||||||
configuration:
|
|
||||||
log_level:
|
|
||||||
name: Log level
|
|
||||||
description: >-
|
|
||||||
Controls the level of log details the add-on provides.
|
|
||||||
reset_database:
|
|
||||||
name: Reset database
|
|
||||||
description: >-
|
|
||||||
Enabling this option to delete and recreate the database.
|
|
||||||
network:
|
network:
|
||||||
80/tcp: HTTP Entrance port
|
80/tcp: HTTP Entrance port
|
||||||
81/tcp: NGinx Proxy Manager Admin web interface
|
81/tcp: NGinx Proxy Manager Admin web interface
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue