Skip to content

Radiokot/umbrel-cloudflared

Repository files navigation

Umbrel Cloudflare Tunnel client

Access your Umbrel apps from the Internet using Cloudflare network. Learn more about tunnels on Cloudflare website.

Screenshot

Get the app from:

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 to configure your own tunnel.

Sponsors

BrutusBondBTC
…and 1 anonymous sponsor.

I am very grateful to everyone supporting this project ❤️ To join this public list, email me the transaction reference once it is complete.

Development notes

This web UI for cloudflared is intended to be used only in docker-compose deployment under Umbrel. The connector image it uses is umbrel-cloudflared-connector.

Versioning

This app uses Semantic Versioning 2.0.0. Hence it is closely connected to cloudflared, the corresponding version is specified in the build metadata part, after the "+" sign.

All the user-facing changes in the app are listed in the changelog file.

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