Skip to content

Commit

Permalink
Add more details to the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Radiokot committed Dec 3, 2023
1 parent a77332e commit 0f377f0
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 2 deletions.
17 changes: 15 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,18 @@
# umbrel-cloudflared
Umbrel web app for Cloudflare Tunnel client (cloudflared)
# 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 it from:
- Umbrel app store – comming soon
- [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. 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.

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

## Environment variables
|Name|Meaning|
Expand Down
Binary file added repository-assets/screen-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added repository-assets/screen-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added repository-assets/screen-3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 0f377f0

Please sign in to comment.