Skip to content

About

Free desktop app (GUI) for Cloudflare quick tunnels: share localhost with a public HTTPS trycloudflare.com link. Windows, macOS, Linux. Built with Rust + Tauri.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

Cloudfairy: a free Cloudflare Tunnel GUI to share localhost

Cloudfairy, a desktop app for Cloudflare quick tunnels. Type a port, get a public link: localhost:3000 becomes https://maple-ranges-quietly-orbit.trycloudflare.com.

Build Latest release Platforms: Windows, macOS, Linux Built with Tauri 2

Cloudfairy is a free desktop app for Cloudflare quick tunnels. Type a local port and get a public https://….trycloudflare.com link, without running cloudflared tunnel --url http://localhost:3000 in a terminal and copying the URL out of its logs. You don't need a Cloudflare account or a domain.

Use it to show a dev server to a teammate, test a site on your phone, or receive webhooks on your laptop. It works like a simple ngrok alternative, on Cloudflare's network.

Download · Website · Build from source · Troubleshooting

The Cloudfairy window with three tunnels. Storefront (localhost:3000) is Live with a trycloudflare.com link and Copy, Open and QR buttons. Docs site (localhost:8080) is getting a URL and warns that nothing is answering on the port yet. API (localhost:8000) is stopped.

Download

Get the installer for your OS from GitHub Releases:

Platform Installers
Windows 10 / 11 (x64) .msi, .exe (NSIS)
macOS (Apple Silicon and Intel) .dmg, .app
Linux (x64) .deb, .rpm, .AppImage

You don't need to install cloudflared first. If Cloudfairy can't find it, one click downloads the official release.

Features

  • Several tunnels at once, each with its own Start/Stop button, status, and uptime.
  • Any local address: 3000, :8080, localhost:5173, 127.0.0.1:8000/app or https://localhost:8443.
  • Copy, Open in browser, or show a QR code to open the link on your phone.
  • Checks your local server. If nothing is listening on the port, a warning appears. It clears by itself once your server starts.
  • Readable errors. Rate limits, crashes and a missing binary show up on the tunnel's card.
  • Live cloudflared logs for each tunnel, with errors and warnings highlighted.
  • Finds or downloads cloudflared. It checks your Settings path first, then a copy it downloaded, then your PATH and the usual install locations (Homebrew, winget, Program Files).
  • Settings: a custom cloudflared path, and the protocol (Auto / QUIC / HTTP2). Use HTTP2 on networks that block UDP.
  • Updates itself. When a new version is out, Cloudfairy offers to install it when it opens, then restarts. Signed updates come from GitHub Releases.
  • Tunnels are saved between launches. They don't start automatically, and every cloudflared process is stopped when you quit the app.

How it works

Cloudfairy starts cloudflared, which opens an outbound connection to Cloudflare. Visitors open the trycloudflare.com link and Cloudflare forwards their requests through cloudflared to your app. Cloudfairy reads cloudflared's output: the URL makes the link appear, 'Registered tunnel connection' turns the status Live, ERR lines become readable errors, and a port check warns until your server answers.

Cloudfairy runs cloudflared tunnel --no-autoupdate --url <target> for each tunnel and reads its output line by line. cloudflared only makes outbound connections, so you don't open any ports on your router or firewall.

Code layout and where files are stored
ui/ (HTML/CSS/JS) ──invoke──▶ src-tauri/src/main.rs (commands)
        ▲                          │
        └──── events ◀──── tunnel.rs: spawns `cloudflared tunnel --no-autoupdate --url <target>`
               tunnel-update         reads stdout/stderr line by line:
               tunnel-log              • URL in the banner box         → publicUrl
               download-progress       • "Registered tunnel connection" → status "running"
                                       • "ERR …"                        → error message
               app-update-progress   polls the child process for exit → "stopped" / "error"
File Purpose
src-tauri/src/tunnel.rs Process lifecycle, log parsing, local-port check, input normalization
src-tauri/src/cloudflared.rs Finding the binary, reading its version, downloading from GitHub releases (.tgz on macOS)
src-tauri/src/app_update.rs Updating Cloudfairy itself: checking the latest GitHub release, downloading and verifying the signed update
src-tauri/src/settings.rs settings.json persistence
src-tauri/src/main.rs Tauri commands and app setup; kills all tunnels on exit
ui/ The interface. Plain HTML/CSS/JS, no bundler. Follows the system light/dark theme.
site/ The project website (landing page, robots.txt, sitemap.xml, social image). pages.yml publishes it to GitHub Pages on every push to main that changes it.
Settings Downloaded cloudflared
Linux ~/.config/dev.cloudfairy.desktop/ ~/.local/share/dev.cloudfairy.desktop/bin/
macOS ~/Library/Application Support/dev.cloudfairy.desktop/ same folder, bin/
Windows %APPDATA%\dev.cloudfairy.desktop\ same folder, bin\

Build from source

Built with Rust and Tauri 2. You need:

Needed
All Rust (stable) and Node.js 18+ (only used to run the Tauri CLI)
Linux sudo apt install libwebkit2gtk-4.1-dev libgtk-3-dev libsoup-3.0-dev librsvg2-dev build-essential (or your distro's equivalents)
macOS Xcode Command Line Tools: xcode-select --install
Windows Microsoft C++ Build Tools ("Desktop development with C++"). WebView2 is already included in Windows 10/11.
npm install             # installs the Tauri CLI
npm run dev             # run the app in development mode
npm run build:unsigned  # release build + installers in src-tauri/target/release/bundle/

npm run build also signs the installers for the in-app updater, so it needs the signing key (see "CI, releases and code signing" below). Use build:unsigned without it.

Both build commands make installers for the OS you run it on: .deb, .rpm and .AppImage on Linux, .app and .dmg on macOS, .msi and NSIS .exe on Windows.

CI, releases and code signing

Tauri doesn't cross-compile installers, so each one is built on its own OS. GitHub Actions does this for you (.github/workflows/build.yml):

  • Every push to main and every pull request: runs clippy and the unit tests on all three OSes. Then it builds Linux (x64), Windows (x64) and macOS (universal: Apple Silicon + Intel) installers and attaches them to the workflow run as artifacts.

  • Pushing a version tag creates a draft GitHub Release with every installer attached:

    git tag v0.1.1 && git push origin v0.1.1

    Keep version in src-tauri/tauri.conf.json in step with the tag. Publish the draft to make it the latest release. Installed copies then see the update.

Update signing. The in-app updater only installs files signed with the project's private key. CI reads it from the TAURI_SIGNING_PRIVATE_KEY repository secret, and the matching public key is plugins.updater.pubkey in src-tauri/tauri.conf.json. If the key is lost, installed copies can't update anymore, so keep a backup. To build signed installers locally, set TAURI_SIGNING_PRIVATE_KEY to the key file's path before npm run build.

For apps you distribute, also set up code signing: Apple notarization on macOS, and a signing certificate on Windows so SmartScreen doesn't warn users. See the Tauri distribution docs.

Tests

cd src-tauri
cargo test                                         # unit tests: input parsing, log parsing, args
cargo test -- --ignored quick_tunnel_end_to_end    # real tunnel through Cloudflare (needs network + cloudflared on PATH)

The end-to-end test opens a tunnel to an empty port and checks that the warning appears. Then it starts a server on that port and checks that the warning clears. It fetches the public trycloudflare.com URL to confirm it reaches the local server, and stops the tunnel.

Troubleshooting

  • "429 Too Many Requests": Cloudflare limits how often quick tunnels can be created. Wait a minute and press Retry.
  • The tunnel fails right away and you have ~/.cloudflared/config.yml: cloudflared doesn't support quick tunnels while a config file exists. Rename the file while you use quick tunnels.
  • It never reaches "Live" on an office or school network: set the protocol to HTTP/2 in Settings.
  • The URL shows a Cloudflare 502 page: your local server isn't running, or it's on a different port.
  • Vite / webpack dev server says "host not allowed": add .trycloudflare.com to the dev server's allowed hosts. For Vite, that's server.allowedHosts.

Quick tunnels are meant for testing and sharing. They have no uptime guarantee, and the URL changes every time you start one.

About

Free desktop app (GUI) for Cloudflare quick tunnels: share localhost with a public HTTPS trycloudflare.com link. Windows, macOS, Linux. Built with Rust + Tauri.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Contributors

Languages