🎉 Release of add-on Cloudflared 2.0.18

This commit is contained in:
Brenner-Bot
2022-09-22 18:41:21 +00:00
parent 2687355000
commit 2c6a34f2b8
5 changed files with 25 additions and 31 deletions
+3 -3
View File
@@ -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 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE. SOFTWARE.
[addon-cloudflared]: https://github.com/brenner-tobias/addon-cloudflared/tree/v2.0.17 [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.17/README.md [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-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-aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg
[cloudflared-amd64-shield]: https://img.shields.io/badge/amd64-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 [cloudflared-armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg
+2 -7
View File
@@ -1,13 +1,8 @@
## Whats changed ## Whats changed
## 📚 Documentation ## 📚 Documentation
- Fix typo @AlecRust (#180) - Tidy add-on description @AlecRust (#184)
- 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 ## ⬆️ Dependency updates
- Bump frenck/action-yamllint from 1.2 to 1.3 @dependabot (#177) - ️ Update Cloudflared to version 2022.9.1 @github-actions (#185)
- ⬆️ Update yq to 4.25.1-r4 @elcajon (#178)
- ⬆️ Update base image to v12.2.4 @elcajon (#179)
+11 -12
View File
@@ -52,7 +52,7 @@ still persists.
Workaround: 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:\ that manages your Domain:\
Cloudflare Dashboard -> Manage Account -> Members -> Invite Member Cloudflare Dashboard -> Manage Account -> Members -> Invite Member
1. Instead of using your primary account to authenticate the tunnel, 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` ### 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. [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 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 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) ### Option: `warp_enable` (advanced option)
If you want to route your home network(s) you can set this option to 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 `true`. This will enable proxying network traffic through your tunnel.
through your tunnel.
Before setting this to `true` please have a look at the [cloudflared documentation][cloudflared-route]. 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 This add-on will take care of setting up the Cloudflare Tunnel and routing
configuration. All other configuration is up to you. specific configuration. All other configuration is up to you.
An excerpt from the above documentation: 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`. 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`. `warp_routes`.
```yaml ```yaml
@@ -370,7 +369,7 @@ you are troubleshooting.
### Option: `reset_cloudflared_files` ### 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 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`. 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 **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` ### Option: `warp_reset`
@@ -400,13 +399,13 @@ removed from the add-on configuration._
### configuration.yaml ### configuration.yaml
Since Home Assistant blocks requests from proxies / reverse proxies, you have to 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 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 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 anything in these lines since the IP range of the docker network is always the
same): same):
**Note**: _Remember to restart Home Assistance when the configuration is changed._ **Note**: _Remember to restart Home Assistant when the configuration is changed._
```yaml ```yaml
http: http:
@@ -438,7 +437,7 @@ following [this article][domainarticle].
### Cloudflare ### 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]. the tutorial [Getting started with Cloudflare][cloudflaretutorial].
## Authors & contributors ## Authors & contributors
+3 -3
View File
@@ -5,8 +5,8 @@ arch:
- armv7 - armv7
- i386 - i386
codenotary: dev@brenner.tech codenotary: dev@brenner.tech
description: Use a Cloudflared tunnel (formerly Argo Tunnel) to remotely connect to description: Use a Cloudflare Tunnel to remotely connect to Home Assistant without
Home Assistant without opening any ports opening any ports
hassio_api: true hassio_api: true
hassio_role: homeassistant hassio_role: homeassistant
image: ghcr.io/brenner-tobias/cloudflared/{arch} image: ghcr.io/brenner-tobias/cloudflared/{arch}
@@ -42,4 +42,4 @@ schema:
- str? - str?
slug: cloudflared slug: cloudflared
url: https://github.com/brenner-tobias/addon-cloudflared/ url: https://github.com/brenner-tobias/addon-cloudflared/
version: 2.0.17 version: 2.0.18
+6 -6
View File
@@ -5,7 +5,7 @@ configuration:
description: >- description: >-
Defines the log level for add-on and the Cloudflare service. Defines the log level for add-on and the Cloudflare service.
external_hostname: external_hostname:
name: External Homeassistant Hostname name: External Home Assistant Hostname
description: >- description: >-
Set this to your domain name or a subdomain that you want to use to Set this to your domain name or a subdomain that you want to use to
access Home Assistant. access Home Assistant.
@@ -18,7 +18,7 @@ configuration:
additional_hosts: additional_hosts:
name: Additional Hosts name: Additional Hosts
description: >- 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: catch_all_service:
name: Catch-All Service name: Catch-All Service
description: >- description: >-
@@ -37,7 +37,7 @@ configuration:
reset_cloudflared_files: reset_cloudflared_files:
name: Reset Cloudflared files name: Reset Cloudflared files
description: >- 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. start.
data_folder: data_folder:
name: Custom Data Folder name: Custom Data Folder
@@ -52,17 +52,17 @@ configuration:
name: Enable Cloudflare Warp name: Enable Cloudflare Warp
description: >- description: >-
This option enables Cloudflare Warp functionality. Warp allows you to 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: warp_routes:
name: Define Cloudflare Warp routes name: Define Cloudflare Warp routes
description: >- 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. is enabled.
warp_reset: warp_reset:
name: Reset Cloudflare Warp name: Reset Cloudflare Warp
description: >- description: >-
When enabled, the Cloudflare Warp related add-on configuration will 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: tunnel_token:
name: Cloudflare Tunnel Token name: Cloudflare Tunnel Token
description: >- description: >-