README

Start and manage Cloudflare Tunnels directly from Artisan. Expose your local Laravel application to the internet with a single command — using either a quick tunnel (random URL, zero config) or a named tunnel (static hostname, permanent URL).

php artisan cloudflare:tunnel

Features

• Quick tunnels — Random *.trycloudflare.com URL, no account required
• Named tunnels — Static hostname under your own domain (e.g. tunnel.example.com)
• Events — TunnelConnected and TunnelDisconnected events for webhook registration, notifications, etc.
• Graceful shutdown — Clean process termination on Ctrl+C

Requirements

• PHP 8.2+
• Laravel 10, 11, 12, or 13
• The pcntl PHP extension
• The cloudflared CLI binary

Installation

1. Install cloudflared

macOS (Homebrew):

brew install cloudflared

Linux (Debian/Ubuntu):

curl -fsSL https://pkg.cloudflare.com/cloudflare-main.gpg | sudo tee /usr/share/keyrings/cloudflare-main.gpg >/dev/null
echo "deb [signed-by=/usr/share/keyrings/cloudflare-main.gpg] https://pkg.cloudflare.com/cloudflared $(lsb_release -cs) main" | sudo tee /etc/apt/sources.list.d/cloudflared.list
sudo apt update && sudo apt install cloudflared

Other platforms: See the official download page.

Verify the installation:

cloudflared --version

2. Install the package

composer require laratusk/cloudflare-tunnel

3. Publish the config (optional)

php artisan vendor:publish --tag=cloudflare-tunnel-config

Quick Start

Quick Tunnel (zero config)

Run the command with no additional setup — you get a random public URL instantly:

php artisan cloudflare:tunnel

 Tunnel URL: https://random-words.trycloudflare.com
 Tunnel is running. Press Ctrl+C to stop.

Named Tunnel (static hostname)

A named tunnel gives you a permanent, predictable URL under your own domain. Follow these steps once to set it up:

Step 1: Authenticate with Cloudflare

cloudflared tunnel login

This opens your browser. Select the domain you want to use and authorize cloudflared.

Step 2: Create a tunnel

cloudflared tunnel create my-app

Note the tunnel ID in the output — you'll see it in cloudflared tunnel list too.

Step 3: Route DNS to the tunnel

cloudflared tunnel route dns my-app tunnel.example.com

This creates a CNAME record pointing tunnel.example.com to your tunnel.

Step 4: Create the cloudflared config file

Create ~/.cloudflared/config.yml:

tunnel: <TUNNEL-ID>
credentials-file: /path/to/.cloudflared/<TUNNEL-ID>.json

ingress:
  - hostname: tunnel.example.com
    service: http://127.0.0.1
    originRequest:
      httpHostHeader: my-app.test
  - service: http_status:404

Replace <TUNNEL-ID> with your actual tunnel ID. The httpHostHeader should match your local development domain. The credentials file path is printed when you create the tunnel.

Step 5: Configure the package

Add to your .env:

CLOUDFLARE_TUNNEL_MODE=named
CLOUDFLARE_TUNNEL_NAME=my-app
CLOUDFLARE_TUNNEL_HOSTNAME=tunnel.example.com

Step 6: Run it

php artisan cloudflare:tunnel

 Tunnel URL: https://tunnel.example.com
 Tunnel is running. Press Ctrl+C to stop.

Configuration

Events

The package dispatches two events you can hook into with standard Laravel listeners:

Example: Register a Telegram webhook

Create a listener:

php artisan make:listener RegisterTelegramWebhook --event='\Laratusk\CloudflareTunnel\Events\TunnelConnected'

namespace App\Listeners;

use Laratusk\CloudflareTunnel\Events\TunnelConnected;
use Telegram\Bot\Laravel\Facades\Telegram;

class RegisterTelegramWebhook
{
    public function handle(TunnelConnected $event): void
    {
        Telegram::setWebhook(['url' => $event->url . '/api/telegram/webhook']);
    }
}

namespace App\Listeners;

use Laratusk\CloudflareTunnel\Events\TunnelDisconnected;
use Telegram\Bot\Laravel\Facades\Telegram;

class RemoveTelegramWebhook
{
    public function handle(TunnelDisconnected $event): void
    {
        Telegram::deleteWebhook();
    }
}

Laravel auto-discovers listeners, so no manual registration is needed.

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

License

The MIT License (MIT). Please see License File for more information.