diff --git a/LICENSE.md b/LICENSE.md index 95bbdfe4..6db2d79c 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,6 +1,6 @@ # MIT License -Copyright (c) 2019-2023 Franck Nijhof +Copyright (c) 2019-2024 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 diff --git a/README.md b/README.md index 6ab2c259..a32b04d3 100644 --- a/README.md +++ b/README.md @@ -86,7 +86,7 @@ our [GitHub Repository][repository]. MIT License -Copyright (c) 2019-2023 Franck Nijhof +Copyright (c) 2019-2024 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 @@ -127,7 +127,7 @@ SOFTWARE. [i386-shield]: https://img.shields.io/badge/i386-no-red.svg [issue]: https://github.com/hassio-addons/addon-nginx-proxy-manager/issues [license-shield]: https://img.shields.io/github/license/hassio-addons/addon-nginx-proxy-manager.svg -[maintenance-shield]: https://img.shields.io/maintenance/yes/2023.svg +[maintenance-shield]: https://img.shields.io/maintenance/yes/2024.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 diff --git a/proxy-manager/.README.j2 b/proxy-manager/.README.j2 index 8871b94d..5607dff0 100644 --- a/proxy-manager/.README.j2 +++ b/proxy-manager/.README.j2 @@ -73,7 +73,7 @@ If you are more interested in stable releases of our add-ons: [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/2023.svg +[maintenance-shield]: https://img.shields.io/maintenance/yes/2024.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 diff --git a/proxy-manager/DOCS.md b/proxy-manager/DOCS.md index bc2714dd..1a5001d6 100644 --- a/proxy-manager/DOCS.md +++ b/proxy-manager/DOCS.md @@ -29,45 +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. 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. Forward port `443` (and optionally `80`) 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 does not provide any configuration. ## Changelog & Releases @@ -108,7 +76,7 @@ check [the contributor's page][contributors]. MIT License -Copyright (c) 2019-2023 Franck Nijhof +Copyright (c) 2019-2024 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