Git Product home page Git Product logo

umbrel-cloudflared's Introduction

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

umbrel-cloudflared's People

Contributors

radiokot avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

umbrel-cloudflared's Issues

can't create multiple routes

Due to there only being one connection string input that if modified deletes the existing route it's unclear how I can setup multiple. The walkthrough as well only shows the single route use case. Are multiple routes not supported yet?

Pre-Determine tunnels for apps

I had an idea for how to potentially use this to solve an issue with trying to setup fedimint as an umbrel app. but I think it could also be relevant for other apps. Fedimint needs to be available publicly and it needs to know what URL its available on before even starting up.

What are your thoughts on this change?:

This app could have a UI section where you associate one of your tunnels with an umbrel app ID. Then it writes the URL to a file somewhere in the app data like /data/umbrel-apps/my_umbrel_app_id and the contents of that file would just be the public URL you will be pointing to the app. This way when the fedimint app starts up it can mount the cloudflared app data dir somewhere and then read its URL from the file based on its app ID.

Or maybe there is an easier way to achieve this by setting a metadata flag on the tunnel or something and then using curl to get it?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.