diff --git a/apps/__tests__/apps.test.ts b/apps/__tests__/apps.test.ts index 98e154a7..9c68fa83 100644 --- a/apps/__tests__/apps.test.ts +++ b/apps/__tests__/apps.test.ts @@ -33,6 +33,7 @@ const networkExceptions = [ "gladys", "scrypted", "homebridge", + "cloudflared", ]; const getAppConfigs = (): AppConfig[] => { const apps: AppConfig[] = []; diff --git a/apps/cloudflared/config.json b/apps/cloudflared/config.json new file mode 100644 index 00000000..a3b0e264 --- /dev/null +++ b/apps/cloudflared/config.json @@ -0,0 +1,17 @@ +{ + "$schema": "../schema.json", + "name": "Cloudflared", + "port": 14333, + "available": true, + "exposable": false, + "id": "cloudflared", + "tipi_version": 1, + "version": "2023.8.2", + "categories": ["utilities"], + "description": "Cloudflared-web is a docker image that packages both cloudflared cli and a no-frills Web UI for easy starting/stopping of cloudflare tunnel.", + "short_desc": "Cloudflare Tunnels in a Web UI", + "author": "WisdomSky", + "source": "https://github.com/WisdomSky/Cloudflared-web", + "form_fields": [ + ] +} diff --git a/apps/cloudflared/docker-compose.yml b/apps/cloudflared/docker-compose.yml new file mode 100644 index 00000000..a539c8fd --- /dev/null +++ b/apps/cloudflared/docker-compose.yml @@ -0,0 +1,10 @@ +version: "3.9" + +services: + cloudflared: + image: wisdomsky/cloudflared-web:2023.8.2 + container_name: cloudflared + restart: unless-stopped + network_mode: host + volumes: + - ${APP_DATA_DIR}/data/cloudflared/config:/config \ No newline at end of file diff --git a/apps/cloudflared/metadata/description.md b/apps/cloudflared/metadata/description.md new file mode 100644 index 00000000..f44bc5e3 --- /dev/null +++ b/apps/cloudflared/metadata/description.md @@ -0,0 +1,31 @@ +_Cloudflared-web is a docker image that packages both cloudflared cli and a no-frills Web UI for easy starting/stopping of cloudflare tunnel._ + +___ + +## Why use `Cloudflared-web`? + +#### Pros + +✅ Only need to run a docker command once. No need to run docker commands everytime you want to start or stop the container or when updating the token. + +✅ Start and stop cloudflare tunnel anytime with a single click. + +#### Cons + +❌ Only supports Cloudflare Tunnel. + +❌ Can only update hostname policies through the [ZeroTrust](https://one.dash.cloudflare.com/) dashboard. + +___ + +The Web UI where you can setup the Cloudflared token can be accessed from port `14333`: + +``` +http://localhost:14333 +``` + +## [Screenshots](https://github.com/WisdomSky/Cloudflared-web#screenshots) + +[![Screenshot 1](https://raw.githubusercontent.com/WisdomSky/Cloudflared-web/main/screenshot-1.png)](https://raw.githubusercontent.com/WisdomSky/Cloudflared-web/main/screenshot-1.png) + +[![Screenshot 2](https://raw.githubusercontent.com/WisdomSky/Cloudflared-web/main/screenshot-2.png)](https://raw.githubusercontent.com/WisdomSky/Cloudflared-web/main/screenshot-2.png) diff --git a/apps/cloudflared/metadata/logo.jpg b/apps/cloudflared/metadata/logo.jpg new file mode 100644 index 00000000..585973c1 Binary files /dev/null and b/apps/cloudflared/metadata/logo.jpg differ