From 8ac7e2f1e141d08264c7758785c423d42c7ed51c Mon Sep 17 00:00:00 2001 From: Christopher Date: Mon, 2 Dec 2024 18:09:21 -0600 Subject: [PATCH] =?UTF-8?q?=E2=9C=A8=20feat(cloudflared-web):=20Add=20clou?= =?UTF-8?q?dflared-web=20docker-compose=20and=20config?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This commit adds the necessary files to deploy the cloudflared-web application in a CasaOS environment. The docker-compose.yml file defines the service configuration, including environment variables, port mappings, and CasaOS- specific metadata. The config.json file provides additional information about the application, such as the version, image, and links to documentation and videos. The cloudflared-web application is a docker image that packages both the cloudflared CLI and a simple Web UI, allowing users to easily start or stop remotely-managed Cloudflare tunnels. --- Apps/cloudflared-web/config.json | 8 +++ Apps/cloudflared-web/docker-compose.yml | 92 +++++++++++++++++++++++++ 2 files changed, 100 insertions(+) create mode 100644 Apps/cloudflared-web/config.json create mode 100644 Apps/cloudflared-web/docker-compose.yml diff --git a/Apps/cloudflared-web/config.json b/Apps/cloudflared-web/config.json new file mode 100644 index 000000000..d6ddad654 --- /dev/null +++ b/Apps/cloudflared-web/config.json @@ -0,0 +1,8 @@ +{ + "id": "cloudflared-web", + "version": "2024.11.1", + "image": "wisdomsky/cloudflared-web", + "youtube": "", + "docs_link": "", + "big_bear_cosmos_youtube": "" +} diff --git a/Apps/cloudflared-web/docker-compose.yml b/Apps/cloudflared-web/docker-compose.yml new file mode 100644 index 000000000..70e71c966 --- /dev/null +++ b/Apps/cloudflared-web/docker-compose.yml @@ -0,0 +1,92 @@ +# Configuration for cloudflared-web setup + +# Name of the big-bear-cloudflared-web application +name: big-bear-cloudflared-web + +# Service definitions for the big-bear-cloudflared-web application +services: + # Service name: big-bear-cloudflared-web + # The `big-bear-cloudflared-web` service definition + big-bear-cloudflared-web: + # Name of the container + container_name: big-bear-cloudflared-web + + # Image to be used for the container + image: wisdomsky/cloudflared-web:2024.11.1 + + # Container restart policy + restart: unless-stopped + + # Network mode + network_mode: host + + # Environment variables for the container + environment: + - WEBUI_PORT=14333 + - EDGE_IP_VERSION=auto + - PROTOCOL=auto + - METRICS_ENABLE=false + - METRICS_PORT=60123 + - BASIC_AUTH_USER=admin + - BASIC_AUTH_PASS="" + + x-casaos: # CasaOS specific configuration + envs: + - container: WEBUI_PORT + description: + en_us: "Web UI Port" + - container: EDGE_IP_VERSION + description: + en_us: "Edge IP Version" + - container: PROTOCOL + description: + en_us: "Protocol" + - container: METRICS_ENABLE + description: + en_us: "Metrics Enable" + - container: METRICS_PORT + description: + en_us: "Metrics Port" + - container: BASIC_AUTH_USER + description: + en_us: "Basic Auth User" + - container: BASIC_AUTH_PASS + ports: + - container: "14333" + description: + en_us: "Container Port: 14333" + +# CasaOS specific configuration +x-casaos: + # Supported CPU architectures for the application + architectures: + - amd64 + - arm64 + # Main service of the application + main: big-bear-cloudflared-web + description: + # Description in English + en_us: Cloudflared-web is a docker image that packages both cloudflared cli and a simple Web UI to easily start or stop remotely-managed Cloudflare tunnel. + tagline: + # Short description or tagline in English + en_us: Cloudflared Web + # Developer's name or identifier + developer: "wisdomsky" + # Author of this configuration + author: BigBearTechWorld + # Icon for the application + icon: https://cdn.jsdelivr.net/gh/walkxcode/dashboard-icons/png/cloudflare.png + # Thumbnail image (currently empty) + thumbnail: "" + title: + # Title in English + en_us: Cloudflared Web + # Application category + category: BigBearCasaOS + # Port mapping information + port_map: "14333" + # Tips + tips: + before_install: + en_us: | + Read this before installing: https://community.bigbeartechworld.com/t/added-cloudflared-web-to-bigbearcasaos/2275?u=dragonfire1119