init
This commit is contained in:
29
nginxproxymanager/CHANGELOG.md
Normal file
29
nginxproxymanager/CHANGELOG.md
Normal file
@@ -0,0 +1,29 @@
|
||||
## What’s changed
|
||||
|
||||
## ✨ New features
|
||||
|
||||
- Add add-on translation support @frenck (#199)
|
||||
|
||||
## 🧰 Maintenance
|
||||
|
||||
- Apply updated repository structure & CI workflow @frenck (#198)
|
||||
|
||||
## ⬆️ Dependency updates
|
||||
|
||||
- ⬆️ Upgrade add-on base image to 9.1.6 @frenck (#184)
|
||||
- ⬆️ Bump ludeeus/action-shellcheck from 1.0.0 to 1.1.0 @dependabot (#182)
|
||||
- ⬆️ Bump certbot-dns-cloudflare from 1.13.0 to 1.14.0 in /proxy-manager @dependabot (#185)
|
||||
- ⬆️ Bump docker/build-push-action from v2.3.0 to v2.4.0 @dependabot (#186)
|
||||
- ⬆️ Upgrades nodejs to 14.16.1-r0 @frenck (#189)
|
||||
- ⬆️ Bump docker/setup-qemu-action from v1.0.1 to v1.0.2 @dependabot (#188)
|
||||
- ⬆️ Bump docker/setup-buildx-action from v1.1.1 to v1.1.2 @dependabot (#187)
|
||||
- ⬆️ Upgrades add-on base image to v9.1.7 @frenck (#190)
|
||||
- ⬆️ Bump actions/cache from v2.1.4 to v2.1.5 @dependabot (#192)
|
||||
- ⬆️ Upgrades nodejs to 14.16.1-r1 @frenck (#194)
|
||||
- ⬆️ Bump brpaz/hadolint-action from v1.3.1 to v1.4.0 @dependabot (#196)
|
||||
- Upgrades add-on base image to v9.2.0 @frenck (#197)
|
||||
- ⬆️ Upgrades mariadb to 10.5.9-r0 @frenck (#200)
|
||||
- ⬆️ Bump docker/setup-qemu-action from v1.0.2 to v1.1.0 @dependabot (#202)
|
||||
- ⬆️ Bump docker/setup-buildx-action from v1.1.2 to v1.2.0 @dependabot (#203)
|
||||
- ⬆️ Bump docker/login-action from v1.8.0 to v1.9.0 @dependabot (#205)
|
||||
- ⬆️ Bump docker/setup-buildx-action from v1.2.0 to v1.3.0 @dependabot (#206)
|
||||
149
nginxproxymanager/DOCS.md
Normal file
149
nginxproxymanager/DOCS.md
Normal file
@@ -0,0 +1,149 @@
|
||||
# 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.
|
||||
|
||||
### 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][releases]
|
||||
functionality.
|
||||
|
||||
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-2021 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
|
||||
[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
|
||||
43
nginxproxymanager/README.md
Normal file
43
nginxproxymanager/README.md
Normal file
@@ -0,0 +1,43 @@
|
||||
# Home Assistant Community Add-on: Nginx Proxy Manager
|
||||
|
||||
[![Release][release-shield]][release] ![Project Stage][project-stage-shield] ![Project Maintenance][maintenance-shield]
|
||||
|
||||
[![Discord][discord-shield]][discord] [![Community Forum][forum-shield]][forum]
|
||||
|
||||
[![Sponsor Frenck via GitHub Sponsors][github-sponsors-shield]][github-sponsors]
|
||||
|
||||
[![Support Frenck on Patreon][patreon-shield]][patreon]
|
||||
|
||||
Manage Nginx proxy hosts with a simple, powerful interface.
|
||||
|
||||
## About
|
||||
|
||||
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.
|
||||
|
||||
![Nginx Proxy Manager screenshot][screenshot]
|
||||
|
||||
[discord-shield]: https://img.shields.io/discord/478094546522079232.svg
|
||||
[discord]: https://discord.me/hassioaddons
|
||||
[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
|
||||
[github-sponsors]: https://github.com/sponsors/frenck
|
||||
[maintenance-shield]: https://img.shields.io/maintenance/yes/2021.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
|
||||
[release-shield]: https://img.shields.io/badge/version-v0.11.0-blue.svg
|
||||
[release]: https://github.com/hassio-addons/addon-nginx-proxy-manager/tree/v0.11.0
|
||||
[screenshot]: https://github.com/hassio-addons/addon-nginx-proxy-manager/raw/main/images/screenshot.gif
|
||||
39
nginxproxymanager/config.json
Normal file
39
nginxproxymanager/config.json
Normal file
@@ -0,0 +1,39 @@
|
||||
{
|
||||
"name": "Nginx Proxy Manager",
|
||||
"version": "0.11.0",
|
||||
"slug": "nginxproxymanager",
|
||||
"description": "Manage Nginx proxy hosts with a simple, powerful interface",
|
||||
"url": "https://github.com/hassio-addons/addon-nginx-proxy-manager",
|
||||
"webui": "http://[HOST]:[PORT:81]",
|
||||
"init": false,
|
||||
"arch": [
|
||||
"aarch64",
|
||||
"amd64",
|
||||
"armhf",
|
||||
"armv7",
|
||||
"i386"
|
||||
],
|
||||
"services": [
|
||||
"mysql:need"
|
||||
],
|
||||
"hassio_api": true,
|
||||
"ports": {
|
||||
"80/tcp": 80,
|
||||
"81/tcp": 81,
|
||||
"443/tcp": 443
|
||||
},
|
||||
"ports_description": {
|
||||
"80/tcp": "HTTP Entrance port",
|
||||
"81/tcp": "Proxy management web interface",
|
||||
"443/tcp": "HTTPS/SSL Entrance port"
|
||||
},
|
||||
"map": [
|
||||
"ssl:rw",
|
||||
"backup:rw"
|
||||
],
|
||||
"schema": {
|
||||
"log_level": "list(trace|debug|info|notice|warning|error|fatal)?",
|
||||
"reset_database": "bool?"
|
||||
},
|
||||
"image": "ghcr.io/hassio-addons/nginxproxymanager/{arch}"
|
||||
}
|
||||
BIN
nginxproxymanager/icon.png
Normal file
BIN
nginxproxymanager/icon.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 9.8 KiB |
BIN
nginxproxymanager/logo.png
Normal file
BIN
nginxproxymanager/logo.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 4.8 KiB |
14
nginxproxymanager/translations/en.yaml
Normal file
14
nginxproxymanager/translations/en.yaml
Normal file
@@ -0,0 +1,14 @@
|
||||
---
|
||||
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:
|
||||
80/tcp: HTTP Entrance port
|
||||
81/tcp: NGinx Proxy Manager Admin web interface
|
||||
443/tcp: HTTPS/SSL Entrance port
|
||||
Reference in New Issue
Block a user