From b34e23129f416ccbb184c6f45f1c80f846fe5b9c Mon Sep 17 00:00:00 2001 From: Brenner-Bot Date: Fri, 4 Feb 2022 20:37:02 +0000 Subject: [PATCH] :tada: Release of add-on Cloudflared 0.3.1 --- README.md | 6 ++--- cloudflared/CHANGELOG.md | 55 +++------------------------------------- cloudflared/DOCS.md | 3 +++ cloudflared/README.md | 2 +- cloudflared/apparmor.txt | 30 ++++++++++++++++++++++ cloudflared/config.yaml | 46 ++++++++++++++++----------------- 6 files changed, 62 insertions(+), 80 deletions(-) create mode 100644 cloudflared/apparmor.txt diff --git a/README.md b/README.md index e2f8310..5eac26e 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.2.5 -[addon-doc-cloudflared]: https://github.com/brenner-tobias/addon-cloudflared/blob/v0.2.5/README.md +[addon-cloudflared]: https://github.com/brenner-tobias/addon-cloudflared/tree/v0.3.1 +[addon-doc-cloudflared]: https://github.com/brenner-tobias/addon-cloudflared/blob/v0.3.1/README.md [cloudflared-issue]: https://github.com/brenner-tobias/addon-cloudflared/issues -[cloudflared-version-shield]: https://img.shields.io/badge/version-v0.2.5-blue.svg +[cloudflared-version-shield]: https://img.shields.io/badge/version-v0.3.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 2e5b19b..038d563 100644 --- a/cloudflared/CHANGELOG.md +++ b/cloudflared/CHANGELOG.md @@ -1,52 +1,3 @@ -## v0.2.5 -- Update Cloudflare to 2022.1.3 -- Add option to use Quick Tunnels - -## v0.2.4 -- Add originRequest support for disableChunkedEncoding flag for additional_hosts -- Change hassio_role from admin to manager -- Improve Documentation - -## v0.2.3 -- Changed Cloudflared config datatype to JSON -- Enable additional_hosts via https - -## v0.2.2 -- Fixed config parameter name - -## v0.2.1 -- Bump Cloudflared to 2022.1.2 - -## v0.2.0 -- Added possibility to configure additional hosts to forward to - -## v0.1.9 - -- Bump Cloudflared to 2022.1.0 -- Disabled Auto-Update of Cloudflared -- Automatically detect HA port, removed config option - -## v0.1.8 - -- Bump Cloudflared to 2021.12.0 -- Force DNS creation if there is an existing entry - -## v0.1.7 - -- Changed startup config to default "Application" to avoid race-condition with Nginxproxymanager - -## v0.1.6 - -- Added tunnel connection to Nginxproxymanager - -## v0.1.5 - -- Optimised reset - -## v0.1.4 - -- Changed folder of Cloudflared files to /data/ for persistent storage -- Included a reset option in the config to delete all existing cloudflared files -- Optimised logging -- Made config parameter to reset cloudflared file optional -- Optimised documentation \ No newline at end of file +## What's Changed +* Docu extension for quick tunnel (#30) @brenner-tobias +* First automatic deployment diff --git a/cloudflared/DOCS.md b/cloudflared/DOCS.md index 2a9c0e9..f69336b 100644 --- a/cloudflared/DOCS.md +++ b/cloudflared/DOCS.md @@ -24,6 +24,9 @@ You can get started with zero setup by using See [below](#option-quick_tunnel) for the detailed configuration. +**Please note that it is not recommended to use the quick tunnel for production +use since the URL can change anytime.** + ## Installation The installation of this add-on is pretty straightforward but requires some prerequisites diff --git a/cloudflared/README.md b/cloudflared/README.md index f56dc57..3556c09 100644 --- a/cloudflared/README.md +++ b/cloudflared/README.md @@ -36,4 +36,4 @@ mainly streaming videos or other Non-HTML content. [maintenance-shield]: https://img.shields.io/maintenance/yes/2022.svg [project-stage-shield]: https://img.shields.io/badge/project%20stage-experimental-yellow.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 +[releases]: https://github.com/brenner-tobias/addon-cloudflared/releases \ No newline at end of file diff --git a/cloudflared/apparmor.txt b/cloudflared/apparmor.txt new file mode 100644 index 0000000..559492a --- /dev/null +++ b/cloudflared/apparmor.txt @@ -0,0 +1,30 @@ +#include + +profile cloudflared flags=(attach_disconnected,mediate_deleted) { + #include + + # Capabilities + file, + signal, + + # S6-Overlay + /etc/services.d/** rwix, + /etc/cont-init.d/** rwix, + + # Bashio + /usr/lib/bashio/** ix, + /tmp/** rw, + + # Access to cloudflared files + /root/.cloudflared/** rw, + + # Start new profile for cloudflared service + cloudflared cx, + + profile cloudflared flags=(attach_disconnected,mediate_deleted) { + #include + + # Receive signals from S6-Overlay + signal receive, + } +} \ No newline at end of file diff --git a/cloudflared/config.yaml b/cloudflared/config.yaml index 4b8934e..14932fd 100644 --- a/cloudflared/config.yaml +++ b/cloudflared/config.yaml @@ -1,33 +1,31 @@ ---- -name: Cloudflared -version: 0.2.5 -slug: cloudflared -description: > - Use a Cloudflared tunnel (formerly Argo Tunnel) - to remotely connect to Home Assistant without opening any ports -url: "https://github.com/brenner-tobias/addon-cloudflared/" -image: ghcr.io/brenner-tobias/cloudflared/{arch} -init: false +arch: +- aarch64 +- amd64 +- armhf +- armv7 +- i386 +description: Use a Cloudflared tunnel (formerly Argo Tunnel) to remotely connect to + Home Assistant without opening any ports hassio_api: true hassio_role: manager -arch: - - aarch64 - - amd64 - - armhf - - armv7 - - i386 +image: ghcr.io/brenner-tobias/cloudflared/{arch} +init: false +name: Cloudflared options: - external_hostname: "" - tunnel_name: "homeassistant" additional_hosts: [] + external_hostname: '' + tunnel_name: homeassistant schema: - external_hostname: str - tunnel_name: str additional_hosts: - - hostname: str - service: str - disableChunkedEncoding: bool? + - disableChunkedEncoding: bool? + hostname: str + service: str + external_hostname: str + log_level: list(trace|debug|info|notice|warning|error|fatal)? nginxproxymanager: bool? quick_tunnel: bool? - log_level: list(trace|debug|info|notice|warning|error|fatal)? reset_cloudflared_files: bool? + tunnel_name: str +slug: cloudflared +url: https://github.com/brenner-tobias/addon-cloudflared/ +version: 0.3.1