diff --git a/README.md b/README.md index 1f1cedb..2b55ec3 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.16 -[addon-doc-cloudflared]: https://github.com/brenner-tobias/addon-cloudflared/blob/v2.0.16/README.md +[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 [cloudflared-issue]: https://github.com/brenner-tobias/addon-cloudflared/issues -[cloudflared-version-shield]: https://img.shields.io/badge/version-v2.0.16-blue.svg +[cloudflared-version-shield]: https://img.shields.io/badge/version-v2.0.17-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 61268b1..8bc936f 100644 --- a/cloudflared/CHANGELOG.md +++ b/cloudflared/CHANGELOG.md @@ -1,4 +1,13 @@ ## 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) + ## ⬆️ Dependency updates -- ℹ️ Update Cloudflared to version 2022.9.0 @github-actions (#174) +- 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) diff --git a/cloudflared/DOCS.md b/cloudflared/DOCS.md index d3c1664..11cabcf 100644 --- a/cloudflared/DOCS.md +++ b/cloudflared/DOCS.md @@ -36,7 +36,7 @@ and a manual step at the first set-up. 1. 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. + restart your Home Assistant instance. 1. If you don't yet have a working Cloudflare set-up: Get a domain name and set-up Cloudflare. See section [Domain Name and Cloudflare Set-Up](#domain-name-and-cloudflare-set-up) for details. @@ -46,7 +46,7 @@ and a manual step at the first set-up. 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! +You can not revoke access to this file from your Cloudflare account! The [issue](https://github.com/cloudflare/cloudflared/issues/93) still persists. @@ -69,9 +69,9 @@ The following instructions describe the minimum necessary steps to use this add- 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. Start the "Cloudflare" add-on. **Any existing DNS entries matching your defined +1. Start the "Cloudflared" add-on. **Any existing DNS entries matching your defined `external_hostname` and `additional_hosts` will be overridden at Cloudflare**. -1. Check the logs of the "Cloudflare" add-on and **follow the instruction to authenticate +1. Check the logs of the "Cloudflared" add-on and **follow the instruction to authenticate 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 / @@ -135,10 +135,10 @@ warp_routes: ### Option: `additional_hosts` You can use the internal reverse proxy of Cloudflare Tunnel to define additional -hosts next to home assistant. That way, you can use the tunnel to also access +hosts next to Home Assistant. That way, you can use the tunnel to also access other systems like a diskstation, router or anything else. -Like with the `external_hostname` of HomeAssistant, DNS entries will be +Like with the `external_hostname` of Home Assistant, DNS entries will be automatically created at Cloudflare. Add the (optional) `disableChunkedEncoding` option to a hostname, to disable @@ -177,7 +177,7 @@ as reverse proxy, you should set the flag `nginx_proxy_manager` (see catch_all_service: "http://192.168.1.100" ``` -**Note**: _This will still route your defined `external_hostname`to HomeAssistant +**Note**: _This will still route your defined `external_hostname`to Home Assistant as well as any potential `additional_hosts` to where you defined in the config. Any other incoming traffic will be routed to the defined service._ @@ -199,7 +199,7 @@ nginx_proxy_manager: true ``` **Note**: _As with `catch_all_service`, this will still route your defined -`external_hostname`to HomeAssistant as well as any potential `additional_hosts` +`external_hostname`to Home Assistant as well as any potential `additional_hosts` to where you defined in the config. Any other incoming traffic will be routed to Nginx Proxy Manager._ @@ -312,7 +312,7 @@ An excerpt from the above documentation: This option controls which routes will be added to your tunnel. -This option is mandatory if `warp_enable` is set to `true. +This option is mandatory if `warp_enable` is set to `true`. See the example below on how to specifie networks (IP/CIDR) in `warp_routes`. @@ -399,11 +399,12 @@ removed from the add-on configuration._ ### configuration.yaml -Since HomeAssistant blocks requests from proxies / 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` (there is no need to adapt anything in these -lines since the IP range of the docker network is always the same): +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 +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._ @@ -483,5 +484,5 @@ SOFTWARE. [cloudflared-route-st]: https://developers.cloudflare.com/cloudflare-one/connections/connect-networks/private-net#optional-ensure-that-traffic-can-reach-your-network [remote-managed-tunnel]: https://developers.cloudflare.com/cloudflare-one/connections/connect-apps/install-and-setup/tunnel-guide/#set-up-a-tunnel-remotely-dashboard-setup [create-remote-managed-tunnel]: https://developers.cloudflare.com/cloudflare-one/connections/connect-apps/install-and-setup/tunnel-guide/#1-create-a-tunnel -[addon-remote-tunnel]: ../docs/remote-tunnel.md -[addon-remote-or-local]: ../docs/tunnels.md +[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 diff --git a/cloudflared/config.yaml b/cloudflared/config.yaml index 39471b1..beafc45 100644 --- a/cloudflared/config.yaml +++ b/cloudflared/config.yaml @@ -42,4 +42,4 @@ schema: - str? slug: cloudflared url: https://github.com/brenner-tobias/addon-cloudflared/ -version: 2.0.16 +version: 2.0.17