diff --git a/README.md b/README.md index 9fda645a..20c389d2 100644 --- a/README.md +++ b/README.md @@ -41,76 +41,7 @@ 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. +[:books: Read the full add-on documentation][docs] ## Support @@ -176,7 +107,6 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. [aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg -[alpine-packages]: https://pkgs.alpinelinux.org/packages [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 @@ -186,7 +116,6 @@ SOFTWARE. [discord-ha]: https://discord.gg/c5DvZ4e [discord-shield]: https://img.shields.io/discord/478094546522079232.svg [discord]: https://discord.me/hassioaddons -[dockerhub]: https://hub.docker.com/r/hassioaddons/nginxproxymanager [forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg [forum]: https://community.home-assistant.io/t/home-assistant-community-add-on-nginx-proxy-manager/111830?u=frenck [frenck]: https://github.com/frenck @@ -194,18 +123,15 @@ SOFTWARE. [github-sponsors]: https://github.com/sponsors/frenck [gitlabci-shield]: https://gitlab.com/hassio-addons/addon-nginx-proxy-manager/badges/master/pipeline.svg [gitlabci]: https://gitlab.com/hassio-addons/addon-nginx-proxy-manager/pipelines -[home-assistant]: https://home-assistant.io [i386-shield]: https://img.shields.io/badge/i386-yes-green.svg [issue]: https://github.com/hassio-addons/addon-nginx-proxy-manager/issues -[keepchangelog]: http://keepachangelog.com/en/1.0.0/ [license-shield]: https://img.shields.io/github/license/hassio-addons/addon-nginx-proxy-manager.svg [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 -[python-packages]: https://pypi.org/ [reddit]: https://reddit.com/r/homeassistant [releases-shield]: https://img.shields.io/github/release/hassio-addons/addon-nginx-proxy-manager.svg [releases]: https://github.com/hassio-addons/addon-nginx-proxy-manager/releases [repository]: https://github.com/hassio-addons/repository -[semver]: http://semver.org/spec/v2.0.0.htm +[docs]: https://github.com/hassio-addons/addon-nginx-proxy-manager/blob/master/proxy-manager/DOCS.md diff --git a/proxy-manager/.README.j2 b/proxy-manager/.README.j2 index 2f78120d..2f331e45 100644 --- a/proxy-manager/.README.j2 +++ b/proxy-manager/.README.j2 @@ -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] {% if channel == "edge" %} @@ -71,7 +69,6 @@ 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 -[docs]: {{ repo }}/blob/{{ version }}/README.md [forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg [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 diff --git a/proxy-manager/DOCS.md b/proxy-manager/DOCS.md new file mode 100644 index 00000000..7bf1f47c --- /dev/null +++ b/proxy-manager/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