From 2c6a34f2b8f0c98a7062252251319cba75355735 Mon Sep 17 00:00:00 2001 From: Brenner-Bot Date: Thu, 22 Sep 2022 18:41:21 +0000 Subject: [PATCH] :tada: Release of add-on Cloudflared 2.0.18 --- README.md | 6 +++--- cloudflared/CHANGELOG.md | 9 ++------- cloudflared/DOCS.md | 23 +++++++++++------------ cloudflared/config.yaml | 6 +++--- cloudflared/translations/en.yaml | 12 ++++++------ 5 files changed, 25 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index 9810f4b..01b5186 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/v2.0.17 -[addon-doc-cloudflared]: https://github.com/brenner-tobias/addon-cloudflared/blob/v2.0.17/README.md +[addon-cloudflared]: https://github.com/brenner-tobias/addon-cloudflared/tree/v2.0.18 +[addon-doc-cloudflared]: https://github.com/brenner-tobias/addon-cloudflared/blob/v2.0.18/README.md [cloudflared-issue]: https://github.com/brenner-tobias/addon-cloudflared/issues -[cloudflared-version-shield]: https://img.shields.io/badge/version-v2.0.17-blue.svg +[cloudflared-version-shield]: https://img.shields.io/badge/version-v2.0.18-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 8bc936f..13f8702 100644 --- a/cloudflared/CHANGELOG.md +++ b/cloudflared/CHANGELOG.md @@ -1,13 +1,8 @@ ## What’s changed ## 📚 Documentation -- Fix typo @AlecRust (#180) -- Move "docs" in "cloudflare" to include in add-on repository @brenner-tobias (#181) -- Move docs folder back and add documentation link to github @brenner-tobias (#183) -- Tidy docs @AlecRust (#182) +- Tidy add-on description @AlecRust (#184) ## ⬆️ Dependency updates -- Bump frenck/action-yamllint from 1.2 to 1.3 @dependabot (#177) -- ⬆️ Update yq to 4.25.1-r4 @elcajon (#178) -- ⬆️ Update base image to v12.2.4 @elcajon (#179) +- ℹ️ Update Cloudflared to version 2022.9.1 @github-actions (#185) diff --git a/cloudflared/DOCS.md b/cloudflared/DOCS.md index 11cabcf..20a2843 100644 --- a/cloudflared/DOCS.md +++ b/cloudflared/DOCS.md @@ -52,7 +52,7 @@ still persists. Workaround: -1. Create a new Cloudflare Account and invite it to your Cloudflare account +1. Create a new Cloudflare account and invite it to your Cloudflare account that manages your Domain:\ Cloudflare Dashboard -> Manage Account -> Members -> Invite Member 1. Instead of using your primary account to authenticate the tunnel, @@ -188,7 +188,7 @@ or directly to the tunnel URL that you can get from the CNAME entry of ### Option: `nginx_proxy_manager` -If you want to use the Cloudflare Tunnel with the Add-on +If you want to use Cloudflare Tunnel with the Add-on [Nginx Proxy Manager][nginx_proxy_manager], you can do so by setting this option. It will automatically set the catch_all_service to the internal URL of Nginx Proxy Manager. You do not have to add the option `catch_all_service` to your config (if @@ -292,13 +292,12 @@ services (e.g. a homeassistant ingress rule) inside `config.yml`. ### Option: `warp_enable` (advanced option) If you want to route your home network(s) you can set this option to -`true`. This will enable your cloudflared tunnel to proxy network traffic -through your tunnel. +`true`. This will enable proxying network traffic through your tunnel. Before setting this to `true` please have a look at the [cloudflared documentation][cloudflared-route]. -This add-on will take care of setting up cloudflared tunnel and routing specific -configuration. All other configuration is up to you. +This add-on will take care of setting up the Cloudflare Tunnel and routing +specific configuration. All other configuration is up to you. An excerpt from the above documentation: @@ -314,7 +313,7 @@ This option controls which routes will be added to your tunnel. This option is mandatory if `warp_enable` is set to `true`. -See the example below on how to specifie networks (IP/CIDR) in +See the example below on how to specify networks (IP/CIDR) in `warp_routes`. ```yaml @@ -370,7 +369,7 @@ you are troubleshooting. ### Option: `reset_cloudflared_files` -In case something went wrong or you want to reset your Cloudflare tunnel +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`. @@ -379,7 +378,7 @@ reset_cloudflared_files: true ``` **Note**: _After deleting the files, the option `reset_cloudflared_files` will -automaticaly be removed from the add-on configuration._ +automatically be removed from the add-on configuration._ ### Option: `warp_reset` @@ -400,13 +399,13 @@ removed from the add-on configuration._ ### configuration.yaml Since Home Assistant blocks requests from proxies / reverse proxies, you have to -tell your instance to allow requests from the Cloudflared Add-on. The add-on runs +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` (there is no need to adapt anything in these lines since the IP range of the docker network is always the same): -**Note**: _Remember to restart Home Assistance when the configuration is changed._ +**Note**: _Remember to restart Home Assistant when the configuration is changed._ ```yaml http: @@ -438,7 +437,7 @@ following [this article][domainarticle]. ### Cloudflare -Create a free Cloudflare Account at [cloudflare.com][cloudflare] and follow +Create a free Cloudflare account at [cloudflare.com][cloudflare] and follow the tutorial [Getting started with Cloudflare][cloudflaretutorial]. ## Authors & contributors diff --git a/cloudflared/config.yaml b/cloudflared/config.yaml index beafc45..cac9c92 100644 --- a/cloudflared/config.yaml +++ b/cloudflared/config.yaml @@ -5,8 +5,8 @@ arch: - armv7 - i386 codenotary: dev@brenner.tech -description: Use a Cloudflared tunnel (formerly Argo Tunnel) to remotely connect to - Home Assistant without opening any ports +description: Use a Cloudflare Tunnel to remotely connect to Home Assistant without + opening any ports hassio_api: true hassio_role: homeassistant image: ghcr.io/brenner-tobias/cloudflared/{arch} @@ -42,4 +42,4 @@ schema: - str? slug: cloudflared url: https://github.com/brenner-tobias/addon-cloudflared/ -version: 2.0.17 +version: 2.0.18 diff --git a/cloudflared/translations/en.yaml b/cloudflared/translations/en.yaml index 3ba4a1d..9ac9bde 100644 --- a/cloudflared/translations/en.yaml +++ b/cloudflared/translations/en.yaml @@ -5,7 +5,7 @@ configuration: description: >- Defines the log level for add-on and the Cloudflare service. external_hostname: - name: External Homeassistant Hostname + name: External Home Assistant Hostname description: >- Set this to your domain name or a subdomain that you want to use to access Home Assistant. @@ -18,7 +18,7 @@ configuration: additional_hosts: name: Additional Hosts description: >- - Define a list of additional hosts to be routed by the Cloudflare tunnel. + Define a list of additional hosts to be routed by the Cloudflare Tunnel. catch_all_service: name: Catch-All Service description: >- @@ -37,7 +37,7 @@ configuration: reset_cloudflared_files: name: Reset Cloudflared files description: >- - When enabled, the add-on configuration will be resetted upon next add-on + When enabled, the add-on configuration will be reset upon next add-on start. data_folder: name: Custom Data Folder @@ -52,17 +52,17 @@ configuration: name: Enable Cloudflare Warp description: >- This option enables Cloudflare Warp functionality. Warp allows you to - route your whole network through the Cloudflare tunnel. + route your whole network through the Cloudflare Tunnel. warp_routes: name: Define Cloudflare Warp routes description: >- - Define networks to route through your Cloudflare tunnel if Warp function + Define networks to route through your Cloudflare Tunnel if Warp function is enabled. warp_reset: name: Reset Cloudflare Warp description: >- When enabled, the Cloudflare Warp related add-on configuration will - be resetted upon next add-on start. + be reset upon next add-on start. tunnel_token: name: Cloudflare Tunnel Token description: >-