Bumped Version to 0.1.6

cloudflared/CHANGELOG.md

@@ -1,3 +1,7 @@
+## v0.1.6
+
+- Added tunnel connection to Nginxproxymanager
+
 ## v0.1.5
 
 - Optimised reset

cloudflared/DOCS.md

@@ -6,13 +6,17 @@ Internet without opening ports in your router. Additionally, you can utilize
 Cloudflare Teams, their Zero Trust platform to further secure your Home Assistant
 connection.
 
-**To use this add-on you have to own a domain name (e.g. example.com) and use the
+**To use this add-on, you have to own a domain name (e.g. example.com) and use the
-DNS servers of cloudflare.**
+DNS servers of Cloudflare.**
 
 ## Installation
 
 The installation of this add-on is pretty straightforward but requires some prerequisites
-and a manual step at the first set-up:
+and a manual step at the first set-up.
+
+**Before starting, please make sure to remove all other add-ons or configuration
+entries handling SSL certificates, domain names and so on (e.g. DuckDNS) and
+restart your HomeAssistant instance.**
 
 1. (Optional if you don't yet have a working Cloudflare set-up):
    Get a domain name and set-up Cloudflare. See section
@@ -26,9 +30,9 @@ and a manual step at the first set-up:
    no existing tunnel with your desired tunnel name at Cloudflare**.
 1. Start the "Cloudflare" add-on.
 1. Check the logs of the "Cloudflare" add-on and **follow the instruction to authenticate
-   at cloudflare**.
+   at Cloudflare**.
    You need to copy a URL from the logs and visit it to authenticate.
-1. A tunnel and a DNS entry will be created and show up in your cloudflare DNS /
+1. A tunnel and a DNS entry will be created and show up in your Cloudflare DNS /
    Teams dashboard.
 
 ## Configuration
@@ -50,8 +54,9 @@ tunnel_name: homeassistant
 Since HomeAssistant blocks requests via proxies or reverse proxies, you have to tell
 your instance to allow requests from the Cloudflared Add-On. The add-on runs locally,
 so HA has to trust the docker network. In order to do so, add the following lines
-to your /config/configuration.yaml (if you need assistance changing the config,
+to your /config/configuration.yaml and restart your HA instance.
-please follow the [Advanced Configuration Tutorial][advancedconfiguration]):
+(if you need assistance changing the config, please follow the
+[Advanced Configuration Tutorial][advancedconfiguration]):
 
 ```yaml
 http:
@@ -60,6 +65,22 @@ http:
     - 172.30.33.0/24
 ```
 
+### Option: `nginxproxymanager`
+
+If you want to use the Cloudflare Tunnel with the Add-On
+[Nginx Proxy Manager][nginxproxymanager], you can do so by setting this option.
+
+**Note**: _This will still route your defined `external_hostname` to HomeAssistant
+and any other incoming domain to Nginx Proxy Manager._
+
+In order to route multiple sub-domains through the tunnel, you have to create individual
+CNAME records in Cloudflare for all of them, pointing to your `external_hostname`
+(or directly to the tunnel URL that you can get from the CNAME entry of
+`external_hostname`).
+
+Finally, you have to set-up your proxy hosts in Nginx Proxy Manager and forward
+them to wherever you like.
+
 ### Option: `log_level`
 
 The `log_level` option controls the level of log output by the addon and can
@@ -78,6 +99,15 @@ 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_cloudflared_files`
+
+In case something went wrong or you want to reset your Cloudflare tunnel
+for some other reason (e.g., switch to another Cloudflare account), you can reset
+all your local Cloudflare files by setting this option to `true`.
+
+**Note**: _After deleting the files, the option `reset_cloudflared_files` will
+automaticaly be removed from the add-on configuration._
+
 ## Domain Name and Cloudlfare Set-Up
 
 To use this plugin, you need a domain name that is using Cloudflare for its
@@ -85,9 +115,7 @@ DNS entries.
 
 ### Domain Name
 
-If you do not already have a domain name, get one. In case you dont want
+If you do not already have a domain name, get one.
-to pay for a domain name, you can look for a free domain name at
-[freenom][freenom].
 
 ### Cloudflare
 
@@ -126,4 +154,5 @@ SOFTWARE.
 [cloudflare]: https://www.cloudflare.com/
 [cloudflaretutorial]: https://support.cloudflare.com/hc/en-us/articles/360027989951-Getting-Started-with-Cloudflare
 [freenom]: https://freenom.com
+[nginxproxymanager]: https://github.com/hassio-addons/addon-nginx-proxy-manager
 [tobias]: https://github.com/brenner-tobias

cloudflared/config.yaml

@@ -1,6 +1,6 @@
 ---
 name: Cloudflared
-version: 0.1.5
+version: 0.1.6
 slug: cloudflared
 description: >
   Use a Cloudflared tunnel (formerly Argo Tunnel)
@@ -9,6 +9,8 @@ url: "https://github.com/brenner-tobias/addon-cloudflared/"
 image: ghcr.io/brenner-tobias/cloudflared/{arch}
 startup: services
 init: false
+hassio_api: true
+hassio_role: admin
 arch:
   - aarch64
   - amd64
@@ -23,5 +25,6 @@ schema:
   external_hostname: str
   internal_ha_port: port
   tunnel_name: str
-  reset_cloudflared_files: bool?
+  nginxproxymanager: bool?
   log_level: list(trace|debug|info|notice|warning|error|fatal)?
+  reset_cloudflared_files: bool?