Skip to content

Latest commit

 

History

History
64 lines (40 loc) · 2.34 KB

README.md

File metadata and controls

64 lines (40 loc) · 2.34 KB

Laravel Nova Cloudflare Card

Latest Version on Packagist Total Downloads

Purge your Cloudflare's cache in two clicks from a Laravel Nova dashboard card.

nova-cloudflare-card

Installation

You can install the package in to a Laravel app that uses Laravel Nova via composer:

composer require zoxta/nova-cloudflare-card

Once the package is installed, you need to add the card to your NovaServiceProvider.php file:

// in app/Providers/NovaServiceProvder.php

// ...

public function cards()
{
    return [
        // ...
        new \Zoxta\NovaCloudflareCard\NovaCloudflareCard(),
    ];
}

Config

You need to add your Cloudflare's credentials to config/services.php file as shown:

    'cloudflare' => [
        'email'   => env('CLOUDFLARE_EMAIL', ''), # your cloudflare email
        'key'     => env('CLOUDFLARE_KEY', ''), # your cloudflare api key, from https://dash.cloudflare.com/profile
        'zone_id' => env('CLOUDFLARE_ZONE_ID', ''), # your domain's zone id, from the domain overview page
        'bearer' => env('CLOUDFLARE_BEARER', false), # if present use Authorization Bearer token instead of X-Auth-Key Header, use X-Auth if acc token, and Bearer if scoped token
    ],

nova-cloudflare-card-config When creating an API key/token if you decide to use the account's Global API Key, you need to set the CLOUDFLARE_KEY env variable, but if you decide to use an API Token, which you can scope to specific zones, you need to set the CLOUDFLARE_BEARER env variable

Usage

A new card will appear on your dashboard giving you the option to purge your Cloudflare's cache in two clicks whenever you need.

Credits

License

This card is released under the MIT License (MIT). Please see the included license file for more information.