generated from yediyuz/laravel-package
-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added package description and cloudflare rule to readme
- Loading branch information
Showing
1 changed file
with
23 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -9,6 +9,8 @@ | |
<a href="https://github.com/mertasan/tailwindcss-variables/blob/master/LICENSE"><img src="https://img.shields.io/badge/License-MIT-green.svg?label=license" alt="License"></a> | ||
</p> | ||
|
||
You can serve millions of requests with this package. This package provides cacheable routes for Cloudflare. Thanks to Cloudflare, your static pages are served efficiently, reducing the load on your servers if they are cached for the TTL (Time to Live) duration. You can purge the cache whenever you need with this package. | ||
|
||
## Installation | ||
|
||
You can install the package via composer: | ||
|
@@ -24,6 +26,7 @@ php artisan vendor:publish --tag="cloudflare-cache-config" | |
``` | ||
|
||
Add environment variables to .env file | ||
|
||
```dotenv | ||
[email protected] #Cloudflare account email address | ||
CLOUDFLARE_CACHE_KEY=XXXXXXX #Cloudflare API_KEY | ||
|
@@ -32,6 +35,22 @@ CLOUDFLARE_DEFAULT_CACHE_TTL=600 #10 minutes | |
CLOUDFLARE_CACHE_DEBUG=false | ||
``` | ||
|
||
### Add `Rule` on Cloudflare | ||
To active caching on static pages, you need to add `page rule` **OR** `cache rule` on Cloudflare. | ||
|
||
For page rule: | ||
- If the URL matches: `www.example.com/*` | ||
- Setting: Cache Level | ||
- Value: Cache Everything | ||
|
||
For the cache rule: | ||
- Field: hostname | ||
- Operator: equals | ||
- Value: `example.com` | ||
- Then: Eligible for cache | ||
|
||
https://developers.cloudflare.com/cache/how-to/cache-rules/create-dashboard/ | ||
|
||
## Usage | ||
|
||
### Define routes to cache | ||
|
@@ -56,6 +75,10 @@ Route::cache(tags: ['staticPages'])->group(function () { | |
// | ||
}); | ||
``` | ||
|
||
> [!WARNING] | ||
> Be careful caching your routes! Do not cache your dynamic pages such as admin panel or form based pages! | ||
### Clear Cache | ||
|
||
#### Purges everything | ||
|