README

This plugin offers a easy way to upload your images assets to Cloudflare Images from Craft CMS assets interface. It exposes the a file system and supports craft image transforms.

Installation:

1. Install with composer

composer require deuxhuithuit/craft-cloudflare-images

1. Install in craft

craft plugin/install cloudflare-images

1. Add your account id, account hash and api token in the settings. Those can be found in your Cloudflare dashboard. We recommend to use env vars for this.

2. Go in craft and create a new File System using the Cloudflare Image FS. Also create a new Volume that uses this FS. It can be used as the main FS, or simply as a transform FS in an existing Volume.

3. Make sure Flexible Variants are enabled in your Cloudflare dashboard (see https://developers.cloudflare.com/images/cloudflare-images/transform/flexible-variants/). By default, Cloudflare Images do not generate publicly accessible images. Enabling flexible variants will generate publicly accessible images and allow for craft image transform to work. The public url is accessible via the $asset->cloudflareImagesUrl() method. If flexible variants are not enabled, the image is only accessible via Craft's Control Panel.

4. Profit!

Account migration

When moving images from one Cloudflare account to another:

1. Run download while the plugin still uses the old account credentials.
2. Update the plugin settings to the new account ID, hash, and API token.
3. Run reupload with --dry-run first to validate local files, then without it to upload.

php craft cloudflare-images/download <volume>
# update CLOUDFLARE_* env vars / plugin settings
php craft cloudflare-images/reupload <volume> --dry-run
php craft cloudflare-images/reupload <volume>

Reupload skips assets already on the current account. Use --force to upload them again.

Made with ❤️ in Montréal.

(c) Deux Huit Huit