repository-edge/nginxproxymanager/DOCS.md

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.

2. Click the Home Assistant My button below to open the add-on on your Home Assistant instance.

   

3. Click the "Install" button to install the add-on.

4. Start the "Nginx Proxy Manager" add-on

5. Check the logs of the "Nginx Proxy Manager" add-on to see if everything went well.

6. Click the "OPEN WEB UI" button and login using: admin@example.com / changeme

7. Forward port 80 and 443 from your router to your Home Assistant machine.

8. Enjoy the add-on!

Configuration

Note: Remember to restart the add-on when the configuration is changed.

Example add-on configuration:

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

This repository keeps a change log using GitHub's releases functionality.

Releases are based on Semantic Versioning, 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 for add-on support and feature requests.
• The Home Assistant Discord chat server for general Home Assistant discussions and questions.
• The Home Assistant Community Forum.
• Join the Reddit subreddit in /r/homeassistant

You could also open an issue here GitHub.

Authors & contributors

The original setup of this repository is by Franck Nijhof.

For a full list of all authors and contributors, check the contributor's page.

License

MIT License

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 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.