Repository files navigation

Manage Nginx proxy hosts with a simple, powerful interface.

This add-on enables you to easily forward incoming connections to anywhere,including free SSL, without having to know too much about Nginxor Let’s Encrypt.

Forward your domain to your Home Assistant, Hass.io add-ons, or websites runningat 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 accessthat specific application.

For the power users, you can customize the behavior of each host in theNginx proxy manager by providing additional Nginx directives.

The installation of this add-on is pretty straightforward and not different incomparison to installing any other Hass.io add-on.

1. Add our Hass.io add-ons repository to your Hass.io instance.
2. Install the "Nginx Proxy Manager" add-on.
3. Start the "Nginx Proxy Manager" add-on
4. Check the logs of the "Nginx Proxy Manager" add-on to see if everything went well.
5. Click the "OPEN WEB UI" button and login using:admin@example.com /changeme
6. Forward port80 and443 from your router to your Hass.io machine.
7. Enjoy the add-on!

NOTE: Do not add this repository to Hass.io, please use:https://github.com/hassio-addons/repository.

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!

Thelog_level option controls the level of log output by the addon and canbe changed to be more or less verbose, which might be useful when you aredealing 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 amore severe level, e.g.,debug also showsinfo messages. By default,thelog_level is set toinfo, which is the recommended setting unlessyou are troubleshooting.

• The original NGinx Proxy Manager has support for forwarding TCP/UDP streams,which is removed from this add-on. It makes no sense from aHass.io / Home Assistant / Home perspective and, by removing it, it alsoremoved the need for this add-on to run on the Docker host network.

This repository keeps a change log usingGitHub's releasesfunctionality. The format of the log is based onKeep a Changelog.

Releases are based onSemantic Versioning, and use the formatofMAJOR.MINOR.PATCH. In a nutshell, the version will be incrementedbased on the following:

• MAJOR: Incompatible or major changes.
• MINOR: Backwards-compatible new features and enhancements.
• PATCH: Backwards-compatible bugfixes and package updates.

Got questions?

You have several options to get them answered:

• TheCommunity Hass.io Add-ons Discord chat server for add-onsupport and feature requests.
• TheHome Assistant Discord chat server for general HomeAssistant discussions and questions.
• The Home AssistantCommunity Forum.
• Join theReddit subreddit in/r/homeassistant

You could alsoopen an issue here GitHub.

This is an active open-source project. We are always open to people who want touse the code or contribute to it.

We have set up a separate document containing ourcontribution guidelines.

Thank you for being involved! 😍

The original setup of this repository is byFranck Nijhof.

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

Want some more functionality to your Hass.io Home Assistant instance?

We have created multiple add-ons for Hass.io. For a full list, check outourGitHub Repository.

MIT License

Copyright (c) 2019 Franck Nijhof

Permission is hereby granted, free of charge, to any person obtaining a copyof this software and associated documentation files (the "Software"), to dealin the Software without restriction, including without limitation the rightsto use, copy, modify, merge, publish, distribute, sublicense, and/or sellcopies of the Software, and to permit persons to whom the Software isfurnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in allcopies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS ORIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THEAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHERLIABILITY, 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 THESOFTWARE.