From e9e865272f2546f9cb3b4fa24508f48ef74488a1 Mon Sep 17 00:00:00 2001 From: Brenner-Bot Date: Wed, 30 Nov 2022 15:56:41 +0000 Subject: [PATCH] :tada: Release of add-on Cloudflared 4.0.5 --- README.md | 6 +++--- cloudflared/CHANGELOG.md | 11 +++-------- cloudflared/DOCS.md | 37 +++++++++++++++++++------------------ cloudflared/config.yaml | 2 +- 4 files changed, 26 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index 45ebbfb..bd256be 100644 --- a/README.md +++ b/README.md @@ -86,10 +86,10 @@ 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. -[addon-cloudflared]: https://github.com/brenner-tobias/addon-cloudflared/tree/v4.0.4 -[addon-doc-cloudflared]: https://github.com/brenner-tobias/addon-cloudflared/blob/v4.0.4/README.md +[addon-cloudflared]: https://github.com/brenner-tobias/addon-cloudflared/tree/v4.0.5 +[addon-doc-cloudflared]: https://github.com/brenner-tobias/addon-cloudflared/blob/v4.0.5/README.md [cloudflared-issue]: https://github.com/brenner-tobias/addon-cloudflared/issues -[cloudflared-version-shield]: https://img.shields.io/badge/version-v4.0.4-blue.svg +[cloudflared-version-shield]: https://img.shields.io/badge/version-v4.0.5-blue.svg [cloudflared-aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg [cloudflared-amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg [cloudflared-armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg diff --git a/cloudflared/CHANGELOG.md b/cloudflared/CHANGELOG.md index c8f32a3..79f2dca 100644 --- a/cloudflared/CHANGELOG.md +++ b/cloudflared/CHANGELOG.md @@ -1,14 +1,9 @@ ## What’s changed -## 🧰 Maintenance - -- Change security reporting to Security Advisories @brenner-tobias (#247) - ## 📚 Documentation -- Add CODE_OF_CONDUCT.md and CONTRIBUTING.md @brenner-tobias (#244) +- Clarify final URL in docs @AlecRust (#261) ## ⬆️ Dependency updates -- ⬆️ Update base image to v12.2.6 @elcajon (#241) -- ⬆️ Update base image to 12.2.7 @elcajon (#248) -- ℹ️ Update Cloudflared to version 2022.11.0 @github-actions (#256) +- Bump frenck/action-setup-cas from 0.1.0 to 0.1.1 @dependabot (#258) +- ℹ️ Update Cloudflared to version 2022.11.1 @github-actions (#262) diff --git a/cloudflared/DOCS.md b/cloudflared/DOCS.md index cc2f0ce..6e6adce 100644 --- a/cloudflared/DOCS.md +++ b/cloudflared/DOCS.md @@ -32,35 +32,36 @@ In the following steps a Cloudflare Tunnel will be automatically created by the add-on to expose your Home Assistant instance. If you only want to expose other services, you can leave `external_hostname` -empty and set `additional_hosts` as [shown below](#configuration). +empty and set `additional_hosts` as [described below](#configuration). -1. Add the `http` integration settings to your Home Assistant config as - [described below](#configurationyaml). -1. Set the `external_hostname` add-on option to the domain name or subdomain - that you want to use to access Home Assistant. -1. (Optional) Change the `tunnel_name` add-on option (default: `homeassistant`). -1. Start the "Cloudflared" add-on. **This will overwrite any existing DNS entries - matching `external_hostname` or `additional_hosts`**. -1. Check the logs of the "Cloudflared" add-on and **follow the instruction to - authenticate with Cloudflare**. - You need to copy a URL from the logs and visit it to authenticate. +1. Configure the `http` integration in your Home Assistant config as + [described below](#configurationyaml) +1. Set `external_hostname` add-on option to the domain/subdomain + you want to use for remote access e.g. `ha.example.com` +1. Start the add-on (this will overwrite any existing DNS entries matching + `external_hostname` or `additional_hosts`) +1. Paste the URL from the add-on logs in a new tab to authenticate with Cloudflare +1. Access your Home Assistant via the remote URL without port e.g. + `https://ha.example.com/` A tunnel should now be listed in your Cloudflare Teams dashboard. Please review the additional configuration options below. -### Remote tunnel add-on setup (advanced setups only) +### Remote tunnel add-on setup (advanced) In the following steps you will manually create a Cloudflare Tunnel in the Zero Trust Dashboard and provide the token to the add-on. -1. Add the `http` integration settings to your Home Assistant config as - [described below](#configurationyaml). +1. Configure the `http` integration in to your Home Assistant config as + [described below](#configurationyaml) 1. Create a Cloudflare Tunnel in the Cloudflare Teams dashboard following - [this how-to][addon-remote-tunnel]. + [this how-to][addon-remote-tunnel] 1. Set `tunnel_token` add-on option to your [tunnel token][create-remote-managed-tunnel] - (all other configuration will be ignored). -1. Start the "Cloudflared" add-on, check the logs to see whether everything went - as expected. + (all other configuration will be ignored) +1. Start the add-on, check the logs to confirm everything went as + expected +1. Access your Home Assistant via the remote URL without port e.g. + `https://ha.example.com/` Your tunnel should now be associated with the Cloudflared add-on. Any configuration changes should be made in the Cloudflare Teams dashboard. diff --git a/cloudflared/config.yaml b/cloudflared/config.yaml index 986911a..ff13697 100644 --- a/cloudflared/config.yaml +++ b/cloudflared/config.yaml @@ -32,4 +32,4 @@ schema: tunnel_token: str? slug: cloudflared url: https://github.com/brenner-tobias/addon-cloudflared/ -version: 4.0.4 +version: 4.0.5