From 66223f037b9b2c65ecd47491bc6d9f38f37f0989 Mon Sep 17 00:00:00 2001 From: Brenner-Bot Date: Sat, 12 Mar 2022 11:47:07 +0000 Subject: [PATCH] :tada: Release of add-on Cloudflared 0.6.0 --- README.md | 6 ++--- cloudflared/CHANGELOG.md | 14 +++++++++-- cloudflared/DOCS.md | 54 ++++++++++++++++++++++++++++++++++++++++ cloudflared/config.yaml | 6 ++++- 4 files changed, 74 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index b881d10..b15dcd3 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/v0.5.3 -[addon-doc-cloudflared]: https://github.com/brenner-tobias/addon-cloudflared/blob/v0.5.3/README.md +[addon-cloudflared]: https://github.com/brenner-tobias/addon-cloudflared/tree/v0.6.0 +[addon-doc-cloudflared]: https://github.com/brenner-tobias/addon-cloudflared/blob/v0.6.0/README.md [cloudflared-issue]: https://github.com/brenner-tobias/addon-cloudflared/issues -[cloudflared-version-shield]: https://img.shields.io/badge/version-v0.5.3-blue.svg +[cloudflared-version-shield]: https://img.shields.io/badge/version-v0.6.0-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 c51935f..511ab3b 100644 --- a/cloudflared/CHANGELOG.md +++ b/cloudflared/CHANGELOG.md @@ -1,4 +1,14 @@ ## What’s changed -## 🐛 Bug fixes +- ℹ️ Update Cloudflared to version 2022.3.1 @github-actions (#67) -- Bugfix reading tunnel name from tunnel.json for changed setup since Cloudflared 2022.3.0 @elcajon (#64) +## ✨ New features + +- Add Cloudflare Warp routing @elcajon (#65) + +## 📚 Documentation + +- Add warp routing documentation @elcajon (#66) + +## ⬆️ Dependency updates + +- Bump frenck/action-addon-information from 1.3.1 to 1.4 @dependabot (#68) diff --git a/cloudflared/DOCS.md b/cloudflared/DOCS.md index 1ef3f44..5a5da3e 100644 --- a/cloudflared/DOCS.md +++ b/cloudflared/DOCS.md @@ -109,6 +109,7 @@ additional_hosts: disableChunkedEncoding: true nginx_proxy_manager: true log_level: "debug" +warp_enable: true ``` **Note**: _This is just an example, don't copy and paste it! Create your own!_ @@ -270,6 +271,43 @@ ingress: `external_hostname` options will be ignored. Make sure to add all needed services (e.g. a homeassistant ingress rule) inside `config.yml`. +### Option: `warp_enable` + +If you want to route your home network(s) you can set this option to +`true`. This will enable your cloudflared tunnel to proxy related 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. + +From the above documentation: + +- Enable HTTP filtering by turning on the Proxy switch under Settings > + Network > L7 Firewall. +- Create device enrollment rules to determine which devices can enroll + to your Zero Trust organization. +- Install the WARP client on the devices you want to allow into your network. + +### Option: `warp_routes` + +This option controls which routes will be added to your tunnel. +The default setting (no `warp_routes` configured in add-on configuration) will +route all connected networks through your tunnel. + +You can override this by setting specifing networks (IP/CIDR) in `warp_routes`. + +```yaml +warp_routes: + - 192.168.0.0/24 + - 192.168.10.0/24 +``` + +**Note**: _By default, Cloudflare Zero Trust excludes traffic for private +address spaces (RFC 191), you need to adapt the +[Split Tunnel][cloudflared-route-st] configuration._ + ### Option: `log_level` The `log_level` option controls the level of log output by the addon and can @@ -307,6 +345,20 @@ reset_cloudflared_files: true **Note**: _After deleting the files, the option `reset_cloudflared_files` will automaticaly be removed from the add-on configuration._ +### Option: `warp_reset` + +In case something went wrong or you no longer want to use this add-on to +route your networks, you can reset warp related settings by setting this option +to `true`. + +```yaml +warp_reset: true +``` + +**Note**: _This will delete the routes assigned to your tunnel. The add-on +options `warp_reset`, `warp_enable` and `warp_routes` will automatically be +removed from the add-on configuration._ + ## Domain Name and Cloudlfare Set-Up To use this plugin, you need a domain name that is using Cloudflare for its @@ -361,3 +413,5 @@ SOFTWARE. [tobias]: https://github.com/brenner-tobias [disablechunkedencoding]: https://developers.cloudflare.com/cloudflare-one/connections/connect-apps/configuration/configuration-file/ingress#disablechunkedencoding [cloudflared-ingress]: https://developers.cloudflare.com/cloudflare-one/connections/connect-apps/configuration/configuration-file/ingress +[cloudflared-route]: https://developers.cloudflare.com/cloudflare-one/connections/connect-networks/private-net/ +[cloudflared-route-st]: https://developers.cloudflare.com/cloudflare-one/connections/connect-networks/private-net#optional-ensure-that-traffic-can-reach-your-network diff --git a/cloudflared/config.yaml b/cloudflared/config.yaml index 1eca980..d250cb9 100644 --- a/cloudflared/config.yaml +++ b/cloudflared/config.yaml @@ -33,6 +33,10 @@ schema: quick_tunnel: bool? reset_cloudflared_files: bool? tunnel_name: str + warp_enable: bool? + warp_reset: bool? + warp_routes: + - str? slug: cloudflared url: https://github.com/brenner-tobias/addon-cloudflared/ -version: 0.5.3 +version: 0.6.0