PHPackages                             nexxai/laravel-cfcache - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Caching](/categories/caching)
4. /
5. nexxai/laravel-cfcache

ActiveLibrary[Caching](/categories/caching)

nexxai/laravel-cfcache
======================

A handful of Cloudflare cache helpers for Laravel

v1.1.0(1mo ago)1317.7k↓30.2%7[4 PRs](https://github.com/nexxai/laravel-cfcache/pulls)MITPHPPHP ^8.3CI passing

Since Oct 21Pushed 1mo ago9 watchersCompare

[ Source](https://github.com/nexxai/laravel-cfcache)[ Packagist](https://packagist.org/packages/nexxai/laravel-cfcache)[ RSS](/packages/nexxai-laravel-cfcache/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (9)Dependencies (16)Versions (13)Used By (0)

 [![Build Status](https://github.com/nexxai/laravel-cfcache/workflows/Build/badge.svg)](https://github.com/nexxai/laravel-cfcache/actions) [![Latest Stable Version](https://camo.githubusercontent.com/63f2b0e659acb5fc43c270be68190c8d8cf985df33369447c7663b13325e6dab/68747470733a2f2f706f7365722e707567782e6f72672f6e65787861692f6c61726176656c2d636663616368652f762f737461626c652e737667)](https://packagist.org/packages/nexxai/laravel-cfcache) [![License](https://camo.githubusercontent.com/5087d89f52b0e66b7baf4f088b2883addef03ddfb4bb48a19ded81697b144c92/68747470733a2f2f706f7365722e707567782e6f72672f6e65787861692f6c61726176656c2d636663616368652f6c6963656e73652e737667)](https://github.com/badges/poser/blob/master/LICENSE)

Laravel Cloudflare Cache
========================

[](#laravel-cloudflare-cache)

This package provides tools to manage Cloudflare integration with your Laravel application. It includes commands for generating Cloudflare security rules and purging cached content.

The WAF rule generation was inspired by Jason McCreary's tweet:

Requirements
------------

[](#requirements)

A Laravel application running Laravel 12 or higher. *Not running a stable version of Laravel?* [Upgrade with Shift](https://laravelshift.com).

Installation / Updating
-----------------------

[](#installation--updating)

You can install this package by running the following command:

```
composer require -W nexxai/laravel-cfcache
```

To publish the configuration file (needed for WAF rule syncing):

```
php artisan vendor:publish --tag=cfcache-config
```

### Basic Usage

[](#basic-usage)

#### WAF Rule Generation

[](#waf-rule-generation)

Generate the WAF rule expression for your Laravel routes:

```
php artisan cloudflare:waf-rule
```

Once generated, you can copy and paste the expression into your domain's security rules by going to Security -> Security Rules -> Create Rule -> Custom Rule -> Edit expression

#### Cache Purging

[](#cache-purging)

Purge all cached content or specific paths/routes:

```
# Purge all cache
php artisan cloudflare:purge --all

# Purge specific paths (absolute or relative, separated by spaces, wildcards supported)
php artisan cloudflare:purge / /about https://example.com/faq https://example.com/our-team/*

# Purge by route names
php artisan cloudflare:purge --route=home --route=users.index --route=auth.login
```

Please see the [Notes](#notes) section below for additional information and examples, and potential gotchas.

### Advanced Usage

[](#advanced-usage)

#### Cloudflare API Configuration

[](#cloudflare-api-configuration)

To use the live Cloudflare features, you need to configure your Cloudflare API credentials. Add the following to your `.env` file:

```
CFCACHE_API_TOKEN=your-api-token-here
CFCACHE_ZONE_ID=your-zone-id-here
```

#### Getting Your Cloudflare Credentials

[](#getting-your-cloudflare-credentials)

1. **API Token**:

    - Go to [Cloudflare Dashboard](https://dash.cloudflare.com/profile/api-tokens)
    - Click "Create Token"
    - Use the "Custom token" template
    - Name the token "CFCache package token"
    - Based on the features you need, grant the following permissions:
        - **WAF rules**: Zone -> Firewall Services -> Edit
        - **Cache purging**: Zone -> Cache Purge -> Purge
    - Include your specific zone(s) in the Zone Resources
    - Create the token and copy it to your `.env` file as `CFCACHE_API_TOKEN`
2. **Zone ID**:

    - Go to your domain's overview page in Cloudflare
    - Find the Zone ID in the right sidebar under "API"
    - Copy it to your `.env` file as `CFCACHE_ZONE_ID`

Note

You may create a single token that applies to multiple zones, but ensure that you use the correct zone ID as the `CFCACHE_ZONE_ID` in each respective app's `.env` file.

#### Sync to Cloudflare API

[](#sync-to-cloudflare-api)

Automatically create or update the WAF rule in Cloudflare:

```
php artisan cloudflare:waf-rule --sync
```

#### Configuration

[](#configuration)

After publishing the configuration file, you can customize additional settings in `config/cfcache.php`:

```
return [
    'api' => [
        'token' => env('CFCACHE_API_TOKEN'),
        'zone_id' => env('CFCACHE_ZONE_ID'),
        'settings' => [
            'base_url' => env('CFCACHE_API_BASE_URL', 'https://api.cloudflare.com/client/v4'),
            'timeout' => env('CFCACHE_API_TIMEOUT', 30),
            'retry_attempts' => env('CFCACHE_API_RETRY_ATTEMPTS', 3),
            'retry_delay' => env('CFCACHE_API_RETRY_DELAY', 1000),
        ],
    ],

    'features' => [
        'waf' => [
            'rule_identifier' => env('CFCACHE_RULE_ID', 'laravel-waf-rule'),
            'rule_description' => env('CFCACHE_RULE_DESCRIPTION', 'Valid Laravel Routes'),
            'rule_action' => env('CFCACHE_RULE_ACTION', 'block'),
            'ignorable_paths' => ['/_dusk/*'],
        ],
    ],
];
```

#### Available Rule Actions

[](#available-rule-actions)

- `block` - Block the request entirely
- `challenge` - Present a challenge to the visitor
- `js_challenge` - Present a JavaScript challenge
- `managed_challenge` - Use Cloudflare's managed challenge
- `allow` - Allow the request
- `log` - Log the request without taking action
- `bypass` - Bypass all security features

#### Ignorable Paths

[](#ignorable-paths)

You can configure paths that should be excluded from the WAF rule generation. This is useful for local development routes that shouldn't be included in production security rules:

```
'ignorable_paths' => [
    '/_dusk/*',     // Laravel Dusk testing routes
    '/admin/test',  // Specific test routes
    '/debug/*',     // Debug routes
],
```

The patterns support wildcards using Laravel's `Str::is()` syntax:

- `/_dusk/*` matches `/dusk/login`, `/dusk/test`, etc.
- `/admin/*` matches any path under `/admin/`
- Exact matches like `/debug` work too

By default, only `/_dusk/*` is ignored to prevent Dusk testing routes from being included in production rules.

Cache Purging
-------------

[](#cache-purging-1)

This package also provides commands to purge Cloudflare's cache for specific paths or routes in your Laravel application.

### Basic Cache Purging

[](#basic-cache-purging)

Purge all cached content from Cloudflare:

```
php artisan cloudflare:purge --all
```

### Purge Specific Paths

[](#purge-specific-paths)

Purge specific paths (relative paths will be prefixed with your app URL):

```
# Purge specific relative paths
php artisan cloudflare:purge / /about /contact

# Purge full URLs
php artisan cloudflare:purge https://example.com/page1 https://example.com/page2

# Mix relative and full URLs
php artisan cloudflare:purge /blog https://example.com/api/data

# Purge by route names
php artisan cloudflare:purge --route=home --route=users.index --route=auth.login

# Wildcards are supported
php artisan cloudflare:purge /blog/*
```

### Purge by Route Names

[](#purge-by-route-names)

Purge cache for specific Laravel routes by name (route parameters are converted to wildcards):

```
# Purge by route names
php artisan cloudflare:purge --routes=home --routes=about --routes=users.show

# Combine routes and paths
php artisan cloudflare:purge /blog --routes=contact --routes=api.users.index
```

### Cloudflare API Configuration for Cache Purging

[](#cloudflare-api-configuration-for-cache-purging)

To use cache purging, you need to configure your Cloudflare API credentials with cache purge permissions. Add the following to your `.env` file:

```
CFCACHE_API_TOKEN=your-api-token-here
CFCACHE_ZONE_ID=your-zone-id-here
```

#### Getting Cache Purge Permissions

[](#getting-cache-purge-permissions)

For cache purging, your API token needs the following permission:

- **Zone -> Cache Purge -> Edit**

You can create a token with both WAF and Cache Purge permissions if you plan to use both features.

Notes
-----

[](#notes)

#### Multiple subdomains

[](#multiple-subdomains)

If you use multiple subdomains (e.g., `example.com` and `sub.example.com`), you will need to add a separate rule for each subdomain, and prefix each with `http.host eq "example.com" and ` or `http.host eq "sub.example.com" and `when generating WAF rules.

#### Certbot / .well-known

[](#certbot--well-known)

If you're using [Certbot](https://certbot.org/) and the `.well-known` directory to manage your SSL certificates (or for other purposes), you will need to manually add a `.well-known/*` rule to the wildcard section of your WAF rule.

#### Cache Purging Notes

[](#cache-purging-notes)

- Route parameters (like `{id}`) are converted to wildcards (`*`) for Cloudflare compatibility
- Relative paths are automatically prefixed with your `APP_URL`
- Full URLs (starting with `http://` or `https://`) are used as-is
- Unknown route names are silently skipped
- Cache purging requires different API permissions than WAF rule management

Contributing
------------

[](#contributing)

Contributions to this project are welcome. You may open a Pull Request against the `main` branch. Please ensure you write a clear description (ideally with code samples) and all workflows are passing. PRs without tests confirming the proposed behavior will not be accepted.

###  Health Score

55

—

FairBetter than 98% of packages

Maintenance89

Actively maintained with recent releases

Popularity42

Moderate usage in the ecosystem

Community18

Small or concentrated contributor base

Maturity57

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 60.6% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~18 days

Recently: every ~27 days

Total

9

Last Release

56d ago

Major Versions

v0.7.0 → v1.0.02025-12-16

PHP version history (2 changes)v0.1.0PHP ^8.2

v0.7.0PHP ^8.3

### Community

Maintainers

![](https://www.gravatar.com/avatar/e48fc34e6154f57ae5f057f674f4c03f497fe1fe66ca931b305fc927bc2f0f9d?d=identicon)[nexxai](/maintainers/nexxai)

---

Top Contributors

[![nexxai](https://avatars.githubusercontent.com/u/4316564?v=4)](https://github.com/nexxai "nexxai (20 commits)")[![jasonmccreary](https://avatars.githubusercontent.com/u/161071?v=4)](https://github.com/jasonmccreary "jasonmccreary (11 commits)")[![laravel-shift](https://avatars.githubusercontent.com/u/15991828?v=4)](https://github.com/laravel-shift "laravel-shift (1 commits)")[![refringe](https://avatars.githubusercontent.com/u/127057?v=4)](https://github.com/refringe "refringe (1 commits)")

---

Tags

cachecloudflarelaravellaravelcachecloudflarecdnCfwaf

###  Code Quality

TestsPest

Code StyleLaravel Pint

### Embed Badge

![Health badge](/badges/nexxai-laravel-cfcache/health.svg)

```
[![Health](https://phpackages.com/badges/nexxai-laravel-cfcache/health.svg)](https://phpackages.com/packages/nexxai-laravel-cfcache)
```

###  Alternatives

[spatie/laravel-responsecache

Speed up a Laravel application by caching the entire response

2.8k8.2M51](/packages/spatie-laravel-responsecache)[yediyuz/laravel-cloudflare-cache

laravel-cloudflare-cache

28239.2k](/packages/yediyuz-laravel-cloudflare-cache)[spekkionu/assetcachebuster

Prefixes asset urls with a unique hash which will allow invalidation of asset files cached by the browser.

3243.2k](/packages/spekkionu-assetcachebuster)[dragon-code/laravel-cache

An improved interface for working with cache

6844.8k10](/packages/dragon-code-laravel-cache)[michele-angioni/support

Support is a Laravel package which promotes the use of best practices and design patterns.

181.4k1](/packages/michele-angioni-support)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)