From cc9680e356a52cfd4f23c05b68c9e07ecf6cff9c Mon Sep 17 00:00:00 2001 From: Brenner-Bot Date: Sun, 9 Oct 2022 20:25:17 +0000 Subject: [PATCH] :tada: Release of add-on Cloudflared 3.1.1 --- README.md | 6 +++--- cloudflared/CHANGELOG.md | 19 +++---------------- cloudflared/DOCS.md | 12 ++++++++++-- cloudflared/config.yaml | 2 +- cloudflared/translations/en.yaml | 4 ++-- 5 files changed, 19 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 828067c..0003ae1 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/v3.1.0 -[addon-doc-cloudflared]: https://github.com/brenner-tobias/addon-cloudflared/blob/v3.1.0/README.md +[addon-cloudflared]: https://github.com/brenner-tobias/addon-cloudflared/tree/v3.1.1 +[addon-doc-cloudflared]: https://github.com/brenner-tobias/addon-cloudflared/blob/v3.1.1/README.md [cloudflared-issue]: https://github.com/brenner-tobias/addon-cloudflared/issues -[cloudflared-version-shield]: https://img.shields.io/badge/version-v3.1.0-blue.svg +[cloudflared-version-shield]: https://img.shields.io/badge/version-v3.1.1-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 162abfd..6ead435 100644 --- a/cloudflared/CHANGELOG.md +++ b/cloudflared/CHANGELOG.md @@ -1,21 +1,8 @@ ## What’s changed -Please be aware that the option to configure **warp** within the add-on is deprecated and will be removed soon. We suggest to migrate to Cloudflare Managed tunnels to use this configuration as soon as possible. - -## ✨ New features - -- Make external_hostname and tunnel_name optional @brenner-tobias (#203) - -## 🚀 Enhancements - -- Change options order to reflect the default options positions @brenner-tobias (#207) +Please be aware that the options 'custom_config', 'data_folder' and 'warp_*' within the add-on are deprecated and will be removed soon. We suggest to migrate to Cloudflare Managed tunnels as soon as possible to use these ingress rules. ## 📚 Documentation -- Docs tidy @AlecRust (#204) -- Deprecate warp @brenner-tobias (#205) -- Tidy docs @AlecRust (#208) - -## ⬆️ Dependency updates - -- ℹ️ Update Cloudflared to version 2022.10.0 @github-actions (#202) +- Deprecate 'custom_config' @brenner-tobias (#211) +- Deprecate 'data_folder' with automatic migration @brenner-tobias (#212) diff --git a/cloudflared/DOCS.md b/cloudflared/DOCS.md index 73d700d..aa691e2 100644 --- a/cloudflared/DOCS.md +++ b/cloudflared/DOCS.md @@ -74,8 +74,8 @@ advanced configurations can be achieved using the remote tunnel setup. - [`additional_hosts`](#option-additional_hosts) - [`catch_all_service`](#option-catch_all_service) - [`nginx_proxy_manager`](#option-nginx_proxy_manager) -- [`data_folder`](#option-data_folder) -- [`custom_config`](#option-custom_config-advanced-option) +- [`data_folder (Deprecated)`](#option-data_folder) +- [`custom_config (Deprecated)`](#option-custom_config-advanced-option) - [`warp_enable (Deprecated)`](#option-warp_enable-advanced-option) - [`warp_routes (Deprecated)`](#option-warp_routes) - [`log_level`](#option-log_level) @@ -205,6 +205,10 @@ them to wherever you like. ### Option: `data_folder` +**Deprecated**: Please note that this option is deprecated and will be +removed soon. We strongly suggest to migrate to Cloudflare Managed Tunnels +in your Zero Trust dashboard. + The `data_folder` option allows to change the default storage location (`/data`) for the automatically created `cert.pem` and `tunnel.json` file. @@ -228,6 +232,10 @@ You have to take care of moving the files accordingly. ### Option: `custom_config` (advanced option) +**Deprecated**: Please note that this option is deprecated and will be +removed soon. We strongly suggest to migrate to Cloudflare Managed Tunnels +in your Zero Trust dashboard. + The `custom_config` option can be used to create a custom `config.yml` file to create more complex ingress configurations. diff --git a/cloudflared/config.yaml b/cloudflared/config.yaml index caa8999..48a627b 100644 --- a/cloudflared/config.yaml +++ b/cloudflared/config.yaml @@ -38,4 +38,4 @@ schema: - str? slug: cloudflared url: https://github.com/brenner-tobias/addon-cloudflared/ -version: 3.1.0 +version: 3.1.1 diff --git a/cloudflared/translations/en.yaml b/cloudflared/translations/en.yaml index 70ef3ec..065b38e 100644 --- a/cloudflared/translations/en.yaml +++ b/cloudflared/translations/en.yaml @@ -30,11 +30,11 @@ configuration: Sets the catch-all service to the "Nginx-Proxy-Manager Community Add-Ons" Add-on. data_folder: - name: Custom Data Folder + name: (Deprecated) Custom Data Folder description: >- Set custom data folder to store Cloudflare configuration. custom_config: - name: Enable Custom Configuration + name: (Deprecated) Enable Custom Configuration description: >- You can provide your own Cloudflare ingress configuration when this option is enabled.