diff --git a/README.md b/README.md index 3fbe15b..c4e8e60 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.7 -[addon-doc-cloudflared]: https://github.com/brenner-tobias/addon-cloudflared/blob/v4.0.7/README.md +[addon-cloudflared]: https://github.com/brenner-tobias/addon-cloudflared/tree/v4.0.8 +[addon-doc-cloudflared]: https://github.com/brenner-tobias/addon-cloudflared/blob/v4.0.8/README.md [cloudflared-issue]: https://github.com/brenner-tobias/addon-cloudflared/issues -[cloudflared-version-shield]: https://img.shields.io/badge/version-v4.0.7-blue.svg +[cloudflared-version-shield]: https://img.shields.io/badge/version-v4.0.8-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 4c7a04e..7419f84 100644 --- a/cloudflared/CHANGELOG.md +++ b/cloudflared/CHANGELOG.md @@ -1,4 +1,16 @@ ## What’s changed -## 🐛 Bug fixes +## 🧰 Maintenance -- Bugfix unbound variable @elcajon (#278) +- Update maintenance & license to 2023 @elcajon (#290) + +## 📚 Documentation + +- Introduce GitHub Wiki @brenner-tobias (#296) + +## ⬆️ Dependency updates + +- Bump frenck/action-addon-information from 1.4.1 to 1.4.2 @dependabot (#291) +- Bump frenck/action-yamllint from 1.3 to 1.4 @dependabot (#294) +- Update base image to v13.1.0 @elcajon (#295) +- Bump docker/build-push-action from 3.2.0 to 3.3.0 @dependabot (#297) +- Update cloudflare/cloudflared to version 2023.1.0 @github-actions (#298) diff --git a/cloudflared/DOCS.md b/cloudflared/DOCS.md index 6e6adce..e756b12 100644 --- a/cloudflared/DOCS.md +++ b/cloudflared/DOCS.md @@ -247,59 +247,10 @@ Remember to restart Home Assistant when the configuration is changed. If you need assistance changing the config, please follow the [Advanced Configuration Tutorial][advancedconfiguration]. -## Troubleshooting +## Add-On Wiki -### 400: Bad Request error - -Make sure to add the [trusted proxy setting](#configurationyaml) correctly. -Make sure to copy and paste the code snippet without adapting anything. -There is no need to adapt IP ranges as the add-on is working as proxy. - -### Securing access to your Cloudflare account - -The add-on downloads after authentication a `cert.pem` file to authenticate -your instance of cloudflared against your Cloudflare account. -You can not revoke access to this file from your Cloudflare account! -The [issue](https://github.com/cloudflare/cloudflared/issues/93) -still persists. - -Workaround: - -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, - use your secondary account. - -If your `cert.pem` file is compromised, you can revoke your -secondary account from your primary account. - -## Securing access to Home Assistant - -After your tunnel is setup and working, you may wish to add additional security -measures. - -For example you could add a [WAF rule](https://developers.cloudflare.com/waf/) in -Cloudflare which blocks requests outside your country. - -You can also use Cloudflare Access to present an authentication page before users -are able to access Home Assistant, see the -[self-hosted applications][self-hosted-applications] docs. - -## Domain name and Cloudflare set up - -To use this add-on, you need a domain name that is using Cloudflare for its -DNS entries. - -### Domain name - -If you do not already have a domain name, get one. You can get one at -[Freenom][freenom] following [this article][domainarticle]. - -### Cloudflare - -Create a free Cloudflare account at [cloudflare.com][cloudflare] and follow -the tutorial [Getting started with Cloudflare][cloudflaretutorial]. +For more advance [How-Tos][how-tos] and a Troubleshooting Section[troubleshooting], +please visit the [Add-On Wiki on GitHub][addon-wiki]. ## Authors & contributors @@ -309,7 +260,7 @@ The original setup of this repository is by [Tobias Brenner][tobias]. MIT License -Copyright (c) 2022 Tobias Brenner +Copyright (c) 2023 Tobias Brenner Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal @@ -330,17 +281,15 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. [addon-installation]: https://github.com/brenner-tobias/addon-cloudflared#installation +[addon-wiki]: https://github.com/brenner-tobias/addon-cloudflared/wiki [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 +[how-tos]: https://github.com/brenner-tobias/addon-cloudflared/wiki/How-tos [nginx_proxy_manager]: https://github.com/hassio-addons/addon-nginx-proxy-manager [tobias]: https://github.com/brenner-tobias +[troubleshooting]: https://github.com/brenner-tobias/addon-cloudflared/wiki/Troubleshooting [disablechunkedencoding]: https://developers.cloudflare.com/cloudflare-one/connections/connect-apps/configuration/configuration-file/ingress#disablechunkedencoding [create-remote-managed-tunnel]: https://developers.cloudflare.com/cloudflare-one/connections/connect-apps/install-and-setup/tunnel-guide/#1-create-a-tunnel -[self-hosted-applications]: https://developers.cloudflare.com/cloudflare-one/applications/configure-apps/self-hosted-apps/ -[addon-remote-tunnel]: https://github.com/brenner-tobias/addon-cloudflared/blob/main/docs/remote-tunnel.md -[addon-remote-or-local]: https://github.com/brenner-tobias/addon-cloudflared/blob/main/docs/tunnels.md +[addon-remote-tunnel]: https://github.com/brenner-tobias/addon-cloudflared/wiki/How-tos#how-to-configure-remote-tunnels +[addon-remote-or-local]: https://github.com/brenner-tobias/addon-cloudflared/wiki/How-tos#local-vs-remote-managed-tunnels diff --git a/cloudflared/README.md b/cloudflared/README.md index 360c8e3..cf23059 100644 --- a/cloudflared/README.md +++ b/cloudflared/README.md @@ -30,7 +30,7 @@ mainly streaming videos or other Non-HTML content. [cloudflare-sssa-28]: https://www.cloudflare.com/terms/#:~:text=2.8%20Limitation%20on%20Serving%20Non%2DHTML%20Content [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 -[maintenance-shield]: https://img.shields.io/maintenance/yes/2022.svg +[maintenance-shield]: https://img.shields.io/maintenance/yes/2023.svg [project-stage-shield]: https://img.shields.io/badge/project%20stage-production%20ready-brightgreen.svg [releases-shield]: https://img.shields.io/github/v/release/brenner-tobias/addon-cloudflared?include_prereleases [releases]: https://github.com/brenner-tobias/addon-cloudflared/releases \ No newline at end of file diff --git a/cloudflared/config.yaml b/cloudflared/config.yaml index 1e0a51b..79018ee 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.7 +version: 4.0.8