https://github.com/radiokot/umbrel-cloudflared

☂ Umbrel app for Cloudflare Tunnel (cloudflared)
https://github.com/radiokot/umbrel-cloudflared

cloudflare cloudflare-tunnel cloudflared home-server sveltekit umbrel

Last synced: 2 months ago
JSON representation

☂ Umbrel app for Cloudflare Tunnel (cloudflared)

• Host: GitHub
• URL: https://github.com/radiokot/umbrel-cloudflared
• Owner: Radiokot
• License: gpl-3.0
• Created: 2023-11-21T09:29:25.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-07-21T09:21:21.000Z (6 months ago)
• Last Synced: 2024-10-13T23:49:34.297Z (3 months ago)
• Topics: cloudflare, cloudflare-tunnel, cloudflared, home-server, sveltekit, umbrel
• Language: Svelte
• Homepage: https://radiokot.com.ua/p/umbrel-cloudflared
• Size: 648 KB
• Stars: 22
• Watchers: 2
• Forks: 3
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# Umbrel Cloudflare Tunnel client

Access your [Umbrel](https://umbrel.com/) apps from the Internet using Cloudflare network. Learn more about tunnels on [Cloudflare website](https://www.cloudflare.com/products/tunnel/).

![Screenshot](repository-assets/screen-1.png)

Get the app from:

- [Umbrel app store](https://apps.umbrel.com/app/cloudflared)

- [Radiokot's Umbrel apps](https://github.com/Radiokot/umbrel-app-store)

## How to use it

To use this app, you must have a set up Cloudflare account with added domains. Once you've done setting it up, check out [the guide with examples](https://github.com/Radiokot/umbrel-cloudflared/wiki/How-to-set-up-Cloudflare-Tunnel-on-your-Umbrel) to configure your own tunnel.

## Sponsors

[](https://github.com/BrutusBondBTC)




…and 1 anonymous sponsor.

*I am very grateful to everyone [supporting this project](https://radiokot.com.ua/tip) ❤️ To join this public list, email me the transaction reference once it is complete.*

## Development notes

This web UI for [cloudflared](https://github.com/cloudflare/cloudflared) is intended to be used only in docker-compose deployment under Umbrel. The connector image it uses is [umbrel-cloudflared-connector](https://github.com/Radiokot/umbrel-cloudflared-connector).

### Versioning

This app uses [Semantic Versioning 2.0.0](https://semver.org/#spec-item-11).

All the user-facing changes in the app are listed in the [changelog file](CHANGELOG.md).

### Environment variables

|Name|Meaning|

|-|-|

|`CLOUDFLARED_HOSTNAME`|Hostname or IP of the connector container|

|`CLOUDFLARED_METRICS_PORT`|`cloudflared` metrics server port in the connector container. The corresponding value must be set for connector|

|`CLOUDFLARED_TOKEN_FILE`|Path to a file to store the connector token. The corresponding value must be set for the connector|