sebdesign/artisan-cloudflare

Laravel artisan commands for Cloudflare

Laravel artisan commands for Cloudflare

, _(*1)

Laravel artisan commands for interacting with the CloudFlare API., _(*2)

, _(*3)

Installation

You can install the package via composer. This package requires Laravel 5.5 or higher., _(*4)

``` bash composer require sebdesign/artisan-cloudflare, <sub>(*5)</sub>

Since version 5.5, Laravel uses package auto-discovery, so doesn't require you to manually add the ServiceProvider. If you don't use auto-discovery or you are using an older version, add the service provider in `config/app.php`.

``` php
<?php

'providers' => [
    Sebdesign\ArtisanCloudflare\ServiceProvider::class,
],

Configuration

Publish the config file in config/cloudflare.php., <sub>(*6)</sub>

To authenticate with an API key set CLOUDFLARE_KEY and CLOUDFLARE_EMAIL in the .env., <sub>(*7)</sub>

Otherwise you can use an API token by setting the CLOUDFLARE_TOKEN in the .env., <sub>(*8)</sub>

``` bash php artisan vendor:publish --provider="Sebdesign\ArtisanCloudflare\ServiceProvider", <sub>(*9)</sub>

The following options are available:

``` php
<?php

return [
    /**
     * API token generated from the User Profile 'My Profile > Api Tokens > API Tokens' page.
     * create token > Edit zone DNS > "Permissions" Zone:Cache Purge:Purge
     */
    'token' => env('CLOUDFLARE_TOKEN'),

    /**
     * Global API Key on the "My Profile > Api Tokens > API Keys" page.
     */
    'key' => env('CLOUDFLARE_KEY'),

    /**
     * Email address associated with your account.
     */
    'email' => env('CLOUDFLARE_EMAIL'),

    /**
     * Array of zones.
     *
     * Each zone must have its identifier as a key. The value is an
     * associated array with *optional* arrays of files and/or tags.
     *
     * you can find your zoneId under 'Account Home > site > Api'.
     *
     * E.g.
     *
     * '023e105f4ecef8ad9ca31a8372d0c353' => [
     *      'files' => [
     *          'http://example.com/css/app.css',
     *      ],
     *      'tags' => [
     *          'styles',
     *          'scripts',
     *      ],
     *      'hosts' => [
     *          'www.example.com',
     *          'images.example.com',
     *      ],
     * ],
     */
    'zones' => [
        //
    ],
];

Usage

Purge command

Read more about Purging cached resources from Cloudflare on the support article., <sub>(*10)</sub>

Execute the cloudflare:cache:purge command in your console or integrate it in your deployment workflow., <sub>(*11)</sub>

Purge all the zones with their files and tags.

``` bash php artisan cloudflare:cache:purge, <sub>(*12)</sub>

#### Purge a single zone.

If the zone exists in the config, then its files and tags will be purged. Otherwise everything will be purged from the given zone.

``` bash
php artisan cloudflare:cache:purge 023e105f4ecef8ad9ca31a8372d0c353

Purge individual files from all the zones.

``` bash php artisan cloudflare:cache:purge --file="http://example.com/css/app.css" --file="http://example.com/img/logo.svg", <sub>(*13)</sub>

#### Purge individual tags from all the zones.

Purging tags is available for **Enterprise** accounts only.

``` bash
php artisan cloudflare:cache:purge --tag=styles --tag=scripts

Purge individual hosts from all the zones.

Purging hosts is available for Enterprise accounts only., <sub>(*14)</sub>

``` bash php artisan cloudflare:cache:purge --host=www.example.com --host=images.example.com, <sub>(*15)</sub>

#### Purge individual files, tags, and hosts from all the zones.

``` bash
php artisan cloudflare:cache:purge --file="http://example.com/css/app.css" --tag=scripts --tag=images --host=www.example.com

Purge individual files, tags, and hosts from a single zone.

``` bash php artisan cloudflare:cache:purge 023e105f4ecef8ad9ca31a8372d0c353 --file="http://example.com/css/app.css" --tag=scripts --tag=images --host=www.example.com, <sub>(*16)</sub>

### Block IP command
#### Block an IP address for all the zones.

``` bash
php artisan cloudflare:waf:block-ip 6.6.6.6

Block an IP address for a specific zone.

``` bash php artisan cloudflare:waf:block-ip 6.6.6.6 023e105f4ecef8ad9ca31a8372d0c353, <sub>(*17)</sub>

#### Block an IP address for all the zones with a custom comment.

``` bash
php artisan cloudflare:waf:block-ip 6.6.6.6 --notes="By Artisan Cloudflare"

Block an IP address for a specific zone with a custom comment.

``` bash php artisan cloudflare:waf:block-ip 6.6.6.6 023e105f4ecef8ad9ca31a8372d0c353 --notes="By Artisan Cloudflare", <sub>(*18)</sub>

## Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

## Testing

``` bash
composer test

Contributing

Please see CONTRIBUTING for details., <sub>(*19)</sub>

Security

If you discover any security related issues, please email info@sebdesign.eu instead of using the issue tracker., <sub>(*20)</sub>

License

The MIT License (MIT). Please see License File for more information., <sub>(*21)</sub>