Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yoelpc4/laravel-cloudinary
Laravel Cloudinary filesystem cloud driver.
https://github.com/yoelpc4/laravel-cloudinary
cloudinary cloudinary-integration laravel php
Last synced: 4 months ago
JSON representation
Laravel Cloudinary filesystem cloud driver.
- Host: GitHub
- URL: https://github.com/yoelpc4/laravel-cloudinary
- Owner: yoelpc4
- License: mit
- Created: 2020-03-09T06:16:42.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-04-23T07:31:24.000Z (about 1 year ago)
- Last Synced: 2024-02-25T14:21:08.580Z (4 months ago)
- Topics: cloudinary, cloudinary-integration, laravel, php
- Language: PHP
- Homepage:
- Size: 73.2 KB
- Stars: 24
- Watchers: 4
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Lists
- awesome-cloudinary - yoelpc4/laravel-cloudinary
README
# Laravel Cloudinary
[![Packagist][ico-packagist]][link-packagist]
[![Downloads][ico-downloads]][link-packagist]
[![Tests][ico-tests]][link-tests]
[![Code Coverage][ico-code-coverage]][link-code-coverage]
[![Software License][ico-license]](LICENSE.md)
[![Contributor Covenant][ico-code-of-conduct]](CODE_OF_CONDUCT.md)
_Laravel Cloudinary filesystem driver._
## Requirement
- [Laravel](https://laravel.com)
- [Cloudinary Account Details](https://cloudinary.com)
## Laravel Version Compatibilities
| Laravel | Package |
|---------|---------|
| 10.x.x | 4.x |
| 9.x.x | 3.x |
| 8.x.x | 2.x |
| 7.x.x | 2.x |
| 6.x.x | 2.x |
## Install
Requires this package with composer via command:
```shell
composer require yoelpc4/laravel-cloudinary
```
## Environment Variable
Register your Cloudinary account details [here](https://cloudinary.com/console).
Then add these lines to your .env.
```dotenv
FILESYSTEM_DISK=cloudinary
CLOUDINARY_API_KEY=
CLOUDINARY_API_SECRET=
CLOUDINARY_CLOUD_NAME=
CLOUDINARY_SECURE=true
```
## Filesystem Configuration
Register cloudinary driver configuration in `config/filesystems.php` at disks section as follows
```php
'cloudinary' => [
'driver' => 'cloudinary',
'api_key' => env('CLOUDINARY_API_KEY'),
'api_secret' => env('CLOUDINARY_API_SECRET'),
'cloud_name' => env('CLOUDINARY_CLOUD_NAME'),
'secure' => env('CLOUDINARY_SECURE', true),
'resource_types' => [
'image' => [
'png',
'jpeg',
'jpg',
],
'video' => [
'mp4',
'avi',
'mp3',
'flac',
],
'raw' => [
'pdf',
'xlsx',
'csv',
'txt',
],
],
],
```
The secure option is applied when generating url from storage, when `secure = true` will use `https`
otherwise `secure = false` will use `http` as protocol.
The resource_types option is applied when generating resource type & public id whenever we call storage method such as
write, writeStream, url, has, etc. Registers the appropriate file extensions according to cloudinary resource type e.g:
png in image, mp4 in video, xlsx in raw, for audio files registers in video. `The default resource type is image`,
visit [image upload api reference](https://cloudinary.com/documentation/image_upload_api_reference#upload_method) for more information.
## Tips
To use pre-defined filename as public ID when uploading to cloudinary, you need to tweak some configuration
in `Settings -> Upload -> Upload presets` as follows:
- Click edit button on signed mode preset, initial preset is `ml_default` you can update it.
- Turn on `Use filename or externally defined public ID` to using the pre-defined filename instead of random characters.
- Turn off `Unique filename` to prevent cloudinary from adding random characters at the end of filename.
- Click `Save` and you're good to go.
## License
The Laravel Cloudinary is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT).
[ico-packagist]: https://img.shields.io/packagist/v/yoelpc4/laravel-cloudinary.svg?style=flat-square
[ico-downloads]: https://img.shields.io/packagist/dt/yoelpc4/laravel-cloudinary.svg?style=flat-square
[ico-tests]: https://github.com/yoelpc4/laravel-cloudinary/actions/workflows/tests.yml/badge.svg?style=flat-square
[ico-code-coverage]: https://codecov.io/gh/yoelpc4/laravel-cloudinary/branch/master/graph/badge.svg?style=flat-square
[ico-license]: https://img.shields.io/packagist/l/yoelpc4/laravel-cloudinary.svg?style=flat-square
[ico-code-of-conduct]: https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg
[link-packagist]: https://packagist.org/packages/yoelpc4/laravel-cloudinary
[link-tests]: https://github.com/yoelpc4/laravel-cloudinary/actions/workflows/tests.yml
[link-code-coverage]: https://codecov.io/gh/yoelpc4/laravel-cloudinary