README

💡 What is Cloudinary?

Cloudinary is basically a fantastic way to store and serve assets like images or videos. You can upload your full resolution image to Cloudinary, and they handle the optimization for you. The only thing you have to do is to add additional parameters to your url 😉

🛠 Requirements

Cloudinary Account

⚙️ Installation

You can install the package via composer:

composer require codebar-ag/laravel-flysystem-cloudinary

Add the following disk to your filesystem "disks" list in your filesystems.php configuration:

    'disks' => [
        //

        'cloudinary' => [
            'driver' => 'cloudinary',
            'cloud_name' => env('CLOUDINARY_CLOUD_NAME'),
            'api_key' => env('CLOUDINARY_API_KEY'),
            'api_secret' => env('CLOUDINARY_API_SECRET'),
            'url' => [
                'secure' => (bool) env('CLOUDINARY_SECURE_URL', true),
            ],
        ],

    ],

Add the following environment variables to your .env file:

FILESYSTEM_DRIVER=cloudinary

CLOUDINARY_CLOUD_NAME=my-cloud-name
CLOUDINARY_API_KEY=my-api-key
CLOUDINARY_API_SECRET=my-api-secret

🏗 File extension problem

Let's look at the following example:

use Illuminate\Support\Facades\Storage;

Storage::disk('cloudinary')->put('cat.jpg', $contents);

This will generate following URL with double extensions:

https://res.cloudinary.com/my-cloud-name/image/upload/v1/cat.jpg.jpg

To prevent this you should store your images without the file extension:

use Illuminate\Support\Facades\Storage;

Storage::disk('cloudinary')->put('cat', $contents);

This is now much better:

https://res.cloudinary.com/my-cloud-name/image/upload/v1/cat.jpg

🪐 How to use with Nova

We have a package for use with Laravel Nova: Laravel Flysystem Cloudinary Nova

🗂 How to use folder prefix

Imagine the following example. We have different clients but want to store the assets in the same Cloudinary account. Normally we have to prefix every path with the correct client folder name. Fortunately, the package helps us here. We can configure a folder in our environment file like this:

CLOUDINARY_FOLDER=client_cat

Now all our assets will be prefixed with the client_cat/ folder. When we store following image:

use Illuminate\Support\Facades\Storage;

Storage::disk('cloudinary')->put('meow', $contents);

It will produce following URL:

https://res.cloudinary.com/my-cloud-name/image/upload/v1/client_cat/meow.jpg

In the Media Library it is stored in client_cat/meow and you can retrieve the image with meow:

use Illuminate\Support\Facades\Storage;

Storage::disk('cloudinary')->getUrl('meow');

This should increase the trust to store and retrieve your assets from the correct folder.

🔋 Rate limit gotchas

All files in Cloudinary are stored with a resource type. There are three kinds of it: image, raw and video. For example if we want to check if a video exists, we need to make up to 3 requests. Every type needs to be checked on their own with a separate request.

Keep this in mind because the admin API is rate limited to 500 calls per hour.

The package does check in following sequence:

image ➡️ raw ➡️ video

⚙️ Optional Parameters

Cloudinary has a lot of optional parameters to customize the upload. You can find all options in the official documentation optional parameters section.

You can pass all parameters as an array to the put method:

use Illuminate\Support\Facades\Storage;

Storage::disk('cloudinary')->put('meow', $contents, [
    'options' [
        'notification_url' => 'https://mysite.example.com/notify_endpoint',
        'async' => true,
    ]
]);

Note: if you find yourself using the same parameters for all requests, you should consider adding them to the config file. (see below)

🔧 Configuration file

You can publish the config file with:

php artisan vendor:publish --tag="flysystem-cloudinary-config"

This is the contents of the published config file:

<?php

return [

    /*
    |--------------------------------------------------------------------------
    | Cloudinary Upload Preset
    |--------------------------------------------------------------------------
    |
    | Upload preset allow you to define the default behavior for all your
    | assets. They have precedence over client-side upload parameters.
    | You can define your upload preset in your cloudinary settings.
    |
    */

    'upload_preset' => env('CLOUDINARY_UPLOAD_PRESET'),

    /*
    |--------------------------------------------------------------------------
    | Cloudinary Folder
    |--------------------------------------------------------------------------
    |
    | An optional folder name where the uploaded asset will be stored. The
    | public ID contains the full path of the uploaded asset, including
    | the folder name. This is very useful to prefix assets directly.
    |
    */

    'folder' => env('CLOUDINARY_FOLDER'),

    /*
    |--------------------------------------------------------------------------
    | Cloudinary Secure URL
    |--------------------------------------------------------------------------
    |
    | This value determines that the asset delivery is forced to use HTTPS
    | URLs. If disabled all your assets will be delivered as HTTP URLs.
    | Please do not use unsecure URLs in your production application.
    |
    */

    'secure_url' => (bool) env('CLOUDINARY_SECURE_URL', true),

    /*
    |--------------------------------------------------------------------------
    | Cloudinary Global Upload Options
    |--------------------------------------------------------------------------
    |
    | Here you may specify the upload options that will be applied to all
    | your assets. This will be merged with the options that you may
    | define in the `Storage::disk('cloudinary')` call.
    |
    */

    'options' => [
        // 'async' => true,
    ],
];

🚧 Testing

Run the tests:

composer test

📝 Changelog

Please see CHANGELOG for more information on what has changed recently.

✏️ Contributing

Please see CONTRIBUTING for details.

🧑‍💻 Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

🙏 Credits

License

The MIT License (MIT). Please see License File for more information.

codebar-ag / laravel-flysystem-cloudinary

Maintainers

Details