Image Manipulation (Glide)

Route

The route controls where your Glide images will be served.

'image_manipulation' => [
    'route' => 'img'
]

By default your Glide images will be served from '/img/...' but you are free to change that. Perhaps if you intend to have some actual images stored in the img directory.

Presets

Presets are pre-configured sets of manipulations that can be referenced at a later time. They are managed in config/statamic/assets.php as an array that holds a list of named presets and their desired parameters.

'image_manipulation' => [
    'presets' => [
        'thumbnail' => [ 'w' => 300,  'h' => 300, 'q' => 75 ],
        'hero'      => [ 'w' => 1440, 'h' => 600, 'q' => 90 ],
    ],
],

All standard Glide API parameters are available for use in presets.

Glide tag

Each named preset can be referenced with the preset parameter on the Glide tag:

{{ glide:thumbnail preset="thumbnail" }}
<!-- width: 300px, height: 300px, quality: 75% -->
 
{{ glide:hero_image preset="hero" }}
<!-- width: 1440px, height: 600px, quality: 90% -->

Generate on upload

When uploading an image asset, any configured presets will be generated so they're ready when you need to reference them, e.g. in the Glide tag.

By default, all presets are generated, however you can customize this per-container.

You may also choose to disable image generation on upload completely:

'image_manipulation' => [
    'generate_presets_on_upload' => false,
],

Generate manually

You may want to generate the presets manually (for example after you changed the config and you already uploaded the images, or if you've disable generation on upload) on the command line:

php please assets:generate-presets

Process Source Images

Sometimes you may wish to process your actual source images on upload. For example, maybe you need to enforce maximum dimensions on extremely large images in order to save on disk space.

To do this, first configure an image manipulation preset in config/statamic/assets.php for this purpose:

'image_manipulation' => [
    'presets' => [
        'max_upload_size' => ['w' => 2000, 'h' => 2000, 'fit' => 'max'],
    ],
],

Then in your asset container settings, you can configure uploads to use this preset:

Customize Preset Warming

As mentioned above, Statamic will generate for all of your configured presets on upload. (i.e. "warming" the generated images).

By default, Statamic will do this "intelligently", which means it'll generate all presets except for the one used for source processing:

However, you may wish to configure which presets are warmed in your asset container settings (or leave this option blank to disable warming altogether):

Caching

Out of the box, Glide will "just work". However you may want to adjust its caching methods for better performance.

In the context of Glide, the "source" is the filesystem where the original images are kept, and the "cache" is the filesystem where it saves the manipulated images.

Default (Dynamic)

The default behavior is for the cache to be "disabled" or "dynamic".

// config/statamic/assets.php
'image_manipulation' => [
    'route' => 'img',
    'cache' => false,
]

From a user's point of view, the "cache" is disabled, however technically it's just located at storage/statamic/glide.

The Glide tag will output URLs to the configured Glide route. When one of these URLs are visited, Statamic will use Glide to perform the transformation.

Custom Path (Static)

The next level of caching would be to specify a custom, publicly accessible location for the images to be generated.

// config/statamic/assets.php
 
'image_manipulation' => [
    'route' => 'img',
    'cache' => true,
    'cache_path' => public_path('img'),
]

When using this setting, the Glide tag will actually generate the images instead of just outputting a URL.

Since the images are generated to a publicly accessible location, the next time a user visits the image URL, the static image would be served directly by the server, and would not need to be touched by PHP or Statamic.

Custom Disk (CDN)

You may choose to save your cached Glide images to somewhere CDN based, like Amazon S3 or DigitalOcean Spaces. Instead of specifying true as mentioned above, you can point to a filesystem disk.

// config/statamic/assets.php
 
'image_manipulation' => [
    'cache' => 'glide',
],

// config/filesystems.php  
 
'disks' => [  
    'glide' => [  
        'driver' => 's3',  
        'key' => env('AWS_ACCESS_KEY_ID'),
        'secret' => env('AWS_SECRET_ACCESS_KEY'),
        'region' => env('AWS_DEFAULT_REGION'),
        'bucket' => env('AWS_BUCKET'),
        'url' => env('AWS_URL'),  
        'endpoint' => env('AWS_ENDPOINT'),
        'use_path_style_endpoint' => env('AWS_USE_PATH_STYLE_ENDPOINT', false),
        'visibility' => 'public',  
    ],
]

Path Cache Store

Before Glide tries to generate an image, it will look into the filesystem to determine whether the image has already been generated. This will prevent the need for the image to be needlessly re-generated.

However, when using the Custom Disk CDN caching option with a service like Amazon S3 for example, Glide will need to make an API call just to be able to check if a file exists. This would cause a slowdown.

To alleviate this problem, Statamic will keep track of whether the images have already been generated in its own separate cache.

This cache is separate from your application cache. Running php artisan cache:clear will not clear this Glide cache. This allows the Glide cache to persist through deployments or other scenarios where you might clear your application cache. It will be cleared when running php please glide:clear.

By default, this cache will be located in your filesystem with the storage directory.

If you would like to customize it, you can create a new store named glide in your config/cache.php configuration file. For example:

'stores' => [
    'glide' => [
        'driver' => 'redis',
        'connection' => 'glide',
    ],
]

In this example, you would also need to create a Redis database named glide in your config/database.php configuration file:

'redis' => [
    'glide' => [
        'url' => env('REDIS_URL'),
        'host' => env('REDIS_HOST', '127.0.0.1'),
        'password' => env('REDIS_PASSWORD'),
        'port' => env('REDIS_PORT', '6379'),
        'database' => env('REDIS_GLIDE_DB', '2'),
    ],
],

When using the database driver, make sure to specify the connection and table, like so:

'glide' => [
    'driver' => 'database',
    'connection' => 'mysql',
    'table' => 'cache',
],

Clearing the cache

You may manually clear the Glide cache by running the following command:

php please glide:clear

This will delete all the files within your Glide cache filesystem location, as well as clearing the path cache.