Installation & setup | laravel-medialibrary | Spatie SPATIE Laravel Media Library ======================== spatie.be/open-source [Docs](https://spatie.be/docs) [Laravel-medialibrary](https://spatie.be/docs/laravel-medialibrary/v5) Installation & setup Version v11 v10 v9 v8 v7 v6 v5 v4 v3 Other versions for crawler [v11](https://spatie.be/docs/laravel-medialibrary/v11) [v10](https://spatie.be/docs/laravel-medialibrary/v10) [v9](https://spatie.be/docs/laravel-medialibrary/v9) [v8](https://spatie.be/docs/laravel-medialibrary/v8) [v7](https://spatie.be/docs/laravel-medialibrary/v7) [v6](https://spatie.be/docs/laravel-medialibrary/v6) [v5](https://spatie.be/docs/laravel-medialibrary/v5) [v4](https://spatie.be/docs/laravel-medialibrary/v4) [v3](https://spatie.be/docs/laravel-medialibrary/v3) - [ Introduction ](https://spatie.be/docs/laravel-medialibrary/v5/introduction) - [ Postcardware ](https://spatie.be/docs/laravel-medialibrary/v5/postcardware) - [ Requirements ](https://spatie.be/docs/laravel-medialibrary/v5/requirements) - [ Installation & setup ](https://spatie.be/docs/laravel-medialibrary/v5/installation-setup) - [ Questions and issues ](https://spatie.be/docs/laravel-medialibrary/v5/questions-issues) - [ Changelog ](https://spatie.be/docs/laravel-medialibrary/v5/changelog) - [ About us ](https://spatie.be/docs/laravel-medialibrary/v5/about-us) Basic usage ----------- - [ Preparing your model ](https://spatie.be/docs/laravel-medialibrary/v5/basic-usage/preparing-your-model) - [ Associating files ](https://spatie.be/docs/laravel-medialibrary/v5/basic-usage/associating-files) - [ Retrieving media ](https://spatie.be/docs/laravel-medialibrary/v5/basic-usage/retrieving-media) - [ Working with collections ](https://spatie.be/docs/laravel-medialibrary/v5/basic-usage/working-with-collections) Converting images ----------------- - [ Defining conversions ](https://spatie.be/docs/laravel-medialibrary/v5/converting-images/defining-conversions) - [ Retrieving converted images ](https://spatie.be/docs/laravel-medialibrary/v5/converting-images/retrieving-converted-images) - [ Regenerating images ](https://spatie.be/docs/laravel-medialibrary/v5/converting-images/regenerating-images) Converting other file types --------------------------- - [ Using image generators ](https://spatie.be/docs/laravel-medialibrary/v5/converting-other-file-types/using-image-generators) - [ Creating a custom image generator ](https://spatie.be/docs/laravel-medialibrary/v5/converting-other-file-types/creating-a-custom-image-generator) Advanced usage -------------- - [ Working with multiple filesystems ](https://spatie.be/docs/laravel-medialibrary/v5/advanced-usage/working-with-multiple-filesystems) - [ Adding custom properties ](https://spatie.be/docs/laravel-medialibrary/v5/advanced-usage/adding-custom-properties) - [ Generating custom urls ](https://spatie.be/docs/laravel-medialibrary/v5/advanced-usage/generating-custom-urls) - [ Storing media specific manipulations ](https://spatie.be/docs/laravel-medialibrary/v5/advanced-usage/storing-media-specific-manipulations) - [ Using your own model ](https://spatie.be/docs/laravel-medialibrary/v5/advanced-usage/using-your-own-model) - [ Using a custom directory structure ](https://spatie.be/docs/laravel-medialibrary/v5/advanced-usage/using-a-custom-directory-structure) - [ Ordering media ](https://spatie.be/docs/laravel-medialibrary/v5/advanced-usage/ordering-media) - [ Consuming events ](https://spatie.be/docs/laravel-medialibrary/v5/advanced-usage/consuming-events) - [ Overriding default filesystem behavior ](https://spatie.be/docs/laravel-medialibrary/v5/advanced-usage/overriding-the-default-filesystem-behaviour) - [ Soft deleting ](https://spatie.be/docs/laravel-medialibrary/v5/advanced-usage/soft-deletes) API --- - [ Adding files ](https://spatie.be/docs/laravel-medialibrary/v5/api/adding-files) - [ Defining conversions ](https://spatie.be/docs/laravel-medialibrary/v5/api/defining-conversions) You are viewing the documentation for **an older version** of this package. You can check the version you are using with the following command: ` composer show spatie/laravel-medialibrary ` Installation & setup ======================== Medialibrary can be installed via composer: ``` $ composer require spatie/laravel-medialibrary:^5.0.0 ``` Next, you need to register the service provider: ``` // config/app.php 'providers' => [ ... Spatie\MediaLibrary\MediaLibraryServiceProvider::class, ]; ``` And publish and run the migration: ``` php artisan vendor:publish --provider="Spatie\MediaLibrary\MediaLibraryServiceProvider" --tag="migrations" php artisan migrate ``` Publishing the config file is optional: ``` php artisan vendor:publish --provider="Spatie\MediaLibrary\MediaLibraryServiceProvider" --tag="config" ``` The config file contains a number of default values: ``` return [ /* * The filesystems on which to store added files and derived images by default. Choose * one or more of the filesystems you configured in app/config/filesystems.php */ 'defaultFilesystem' => 'media', /* * The maximum file size of an item in bytes. Adding a file * that is larger will result in an exception. */ 'max_file_size' => 1024 * 1024 * 10, /* * This queue will be used to generate derived images. * Leave empty to use the default queue. */ 'queue_name' => '', /* * The class name of the media model to be used. */ 'media_model' => Spatie\MediaLibrary\Media::class, /* * The engine that will perform the image conversions. * Should be either `gd` or `imagick` */ 'image_driver' => 'gd', /* * When urls to files get generated this class will be called. Leave empty * if your files are stored locally above the site root or on s3. */ 'custom_url_generator_class' => null, /* * The class that contains the strategy for determining a media file's path. */ 'custom_path_generator_class' => null, 's3' => [ /* * The domain that should be prepended when generating urls. */ 'domain' => 'https://xxxxxxx.s3.amazonaws.com', ], 'remote' => [ /* * Any extra headers that should be included when uploading media to * a remote disk. Even though supported headers may vary between * different drivers, a sensible default has been provided. * * Supported by S3: CacheControl, Expires, StorageClass, * ServerSideEncryption, Metadata, ACL, ContentEncoding */ 'extra_headers' => [ 'CacheControl' => 'max-age=604800', ], ], /* * These generators will be used to created conversion of media files. */ 'image_generators' => [ Spatie\MediaLibrary\ImageGenerators\FileTypes\Image::class, Spatie\MediaLibrary\ImageGenerators\FileTypes\Pdf::class, Spatie\MediaLibrary\ImageGenerators\FileTypes\Svg::class, Spatie\MediaLibrary\ImageGenerators\FileTypes\Video::class, ], /* * FFMPEG & FFProbe binaries path, only used if you try to generate video * thumbnails and have installed the php-ffmpeg/php-ffmpeg composer * dependency. */ 'ffmpeg_binaries' => '/usr/bin/ffmpeg', 'ffprobe_binaries' => '/usr/bin/ffprobe', ]; ``` Finally you should add a disk to `app/config/filesystems.php`. All files added to the media library will be stored on that disk, this would be a typical configuration: ``` return [ ... 'disks' => [ 'media' => [ 'driver' => 'local', 'root' => public_path('media'), ], ... ]; ``` Don't forget to ignore the directory of your media disk so the files won't end up in your git repo. If you are planning on working with image manipulations it's recommended to configure a queue on your server and specify it in the config file. Want to use S3? Then follow Laravel's instructions on [how to add the S3 Flysystem driver](https://laravel.com/docs/5.4/filesystem#configuration).