diff --git a/cloudflared/CHANGELOG.md b/cloudflared/CHANGELOG.md index 79168ea..2e5b19b 100644 --- a/cloudflared/CHANGELOG.md +++ b/cloudflared/CHANGELOG.md @@ -1,3 +1,7 @@ +## v0.2.5 +- Update Cloudflare to 2022.1.3 +- Add option to use Quick Tunnels + ## v0.2.4 - Add originRequest support for disableChunkedEncoding flag for additional_hosts - Change hassio_role from admin to manager diff --git a/cloudflared/DOCS.md b/cloudflared/DOCS.md index b4bc9aa..2a9c0e9 100644 --- a/cloudflared/DOCS.md +++ b/cloudflared/DOCS.md @@ -17,6 +17,13 @@ Please make sure to be compliant with the add-on. Especially [section 2.8][cloudflare-sssa-28] could be breached when mainly streaming videos or other Non-HTML content. +## Quick Tunnel for Testing + +You can get started with zero setup by using +[Cloudflare Quick Tunnels](https://developers.cloudflare.com/cloudflare-one/connections/connect-apps/run-tunnel/trycloudflare). + +See [below](#option-quick_tunnel) for the detailed configuration. + ## Installation The installation of this add-on is pretty straightforward but requires some prerequisites @@ -29,14 +36,15 @@ 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 [Domain Name and Cloudlfare Set-Up](#domain-name-and-cloudlfare-set-up) for details. -1. Set the `additional_hosts` add-on option with your domain name or a subdomain +1. Add the `http` integration settings to your HA-config as described [below](#Configuration.yaml). +1. Set the `external_hostname` add-on option with your domain name or a subdomain that you want to use to access Home Assistant. 1. (Optional) Change the `tunnel_name` add-on option (default: homeassistant). 1. (Optional) Add additional hosts to forward to in the `additional_hosts` array - (see [detailed description below](#Option:-`additional_hosts`)). + (see [detailed description below](#option-additional_hosts)). 1. (Optional) Add the `nginxproxymanager` flag to use the Cloudflare tunnel with the Nginxproxymanager add-on (see - [detailed description below](#Option:-`nginxproxymanager`)). + [detailed description below](#option-nginxproxymanager)). 1. **Any existing DNS entries with your desired external hostname and additional hosts will be overridden at Cloudflare**. 1. Start the "Cloudflare" add-on. @@ -146,6 +154,25 @@ CNAME records in Cloudflare for all of them, pointing to your `external_hostname Finally, you have to set-up your proxy hosts in Nginx Proxy Manager and forward them to wherever you like. +### Option: `quick_tunnel` + +You can get started with zero setup by using +[Cloudflare Quick Tunnels](https://developers.cloudflare.com/cloudflare-one/connections/connect-apps/run-tunnel/trycloudflare). +Set `quick_tunnel` to `true` , all other configuration will be ignored. After +starting the addon check the logs for your unique randomly generated +`trycloudflare.com` URL. +Please note that you still have to add the `http` integration settings to your +HA-config as described [here](#Configuration.yaml). + +Quick Tunnel add-on configuration: + +```yaml +quick_tunnel: true +external_hostname: "" +tunnel_name: "" +additional_hosts: [] +``` + ### Option: `log_level` The `log_level` option controls the level of log output by the addon and can @@ -228,6 +255,8 @@ SOFTWARE. [advancedconfiguration]: https://www.home-assistant.io/getting-started/configuration/ [cloudflare]: https://www.cloudflare.com/ +[cloudflare-sssa]: https://www.cloudflare.com/en-gb/terms/ +[cloudflare-sssa-28]: https://www.cloudflare.com/en-gb/terms/#:~:text=2.8%20Limitation%20on%20Serving%20Non%2DHTML%20Content [cloudflaretutorial]: https://support.cloudflare.com/hc/en-us/articles/360027989951-Getting-Started-with-Cloudflare [domainarticle]: https://www.linkedin.com/pulse/what-do-domain-name-how-get-one-free-tobias-brenner?trk=public_post-content_share-article [freenom]: https://freenom.com diff --git a/cloudflared/config.yaml b/cloudflared/config.yaml index 61ed3f4..bc9fc46 100644 --- a/cloudflared/config.yaml +++ b/cloudflared/config.yaml @@ -28,5 +28,6 @@ schema: service: str disableChunkedEncoding: bool? nginxproxymanager: bool? + quick_tunnel: bool? log_level: list(trace|debug|info|notice|warning|error|fatal)? reset_cloudflared_files: bool?