Laravel OVH Object Storage driver

Laravel Storage facade provides support for many different filesystems.

This is a wrapper to provide support in Laravel for OVH Object Storage.

Installing

Install via composer:

composer require sausin/laravel-ovh

Please see below for the details on various branches. You can choose the version of the package which is suitable for your development. Also take note of the upgrade

Package version	PHP compatibility	Laravel versions	Special features of OVH	Status
1.2.x	7.0 - 7.1	>=5.4, <=5.8	temporaryUrl()	Deprecated
2.x	>=7.1	>=5.4, <=6.x	above + expiring objects	Deprecated
3.x	>=7.1	>=5.4, <=7.x	above	Maintained
4.x	>=7.2	>=5.4	above + set private key on container	Active

Then include the service provider in config/app.php

Sausin\LaravelOvh\OVHServiceProvider::class

in the providers array. This step is not required for Laravel 5.5 and above as the service provider is automatically registered!

Define the ovh driver in the config/filesystems.php as below

'ovh' => [
    'server' => env('OS_AUTH_URL', 'https://auth.cloud.ovh.net/v3/'),
    'driver' => 'ovh',
    'user' => env('OS_USERNAME'),
    'pass' => env('OS_PASSWORD'),
    'userDomain' => env('OS_USER_DOMAIN_NAME', 'Default'),
    'region' => env('OS_REGION_NAME', 'GRA'),
    'container' => env('OS_CONTAINER_NAME'),
    'projectId' => env('OS_TENANT_ID'),
    'urlKey' => env('OS_TEMP_URL_KEY'),
    // optional variable and only if you have setup a custom endpoint
    'endpoint' => env('OS_CUSTOM_ENDPOINT'),
    // optional variables for handling large objects. Defaults below are 300MB & 100MB
    'swiftLargeObjectThreshold' => env('OS_LARGE_OBJECT_THRESHOLD', 300 * 1024 * 1024),
    'swiftSegmentSize' => env('OS_SEGMENT_SIZE', 100 * 1024 * 1024),
    'swiftSegmentContainer' => env('OS_SEGMENT_CONTAINER'),
],

define the correct env variables above in your .env file (to correspond to the values above) and you should now have a working OVH Object Storage setup :).

IMPORTANT: Starting with 4.x branch, the variables to be defined in the .env file have been renamed to reflect the names used by OVH in their configuration file. This is to remove any discrepancy in understanding of which variable should go where. This also means that the package might fail to work unless the correct updated variables are defined in .env file if the above template is used.

The URL is normally not going to be any different for OVH users and hence doesn't need to be specified. To get the values for remaining variables (like user, region, container etc), you can download the configuration file with details in your OVH control panel (Public cloud -> Project Management -> Users & Roles -> Download Openstack's RC file).

Be sure to run

php artisan config:cache

again if you've been using the caching on your config file.

Usage

Refer to extensive laravel documentation for usage. Of note - this package includes support for the following additional methods:

Storage::url()

and

Storage::temporaryUrl()

The temporary url is relevant for private containers where files are not publicly accessible under normal conditions. This generates a temporary url with expiry (see details here for usage).

Note that this requires the container to have a proper header. The key in the header should match the urlKey specified in filesystems.php. For details on how to setup the header on your OVH container, see here. Alternatively, you can use the commandline (for version 4.x and above only)

php artisan ovh:set-temp-url-key --key=your-private-key

and the package will set the relevant key on your container. If a key has already been setup previously, the package will inform you of the same. If you'd like to setup a new key anyway, you may use the --force flag with the command.

Uploading expiring objects

If you would like to upload objects which expire (i.e. get auto deleted) at a certain time in future, you can add deleteAt or deleteAfter configuration options when uploading the object.

For eg, below code will upload a file which expires after one hour:

Storage::disk('ovh')->put('path/to/file.jpg', $contents, ['deleteAfter' => 60*60])

Usage of these variables is explained in the OVH documentation here

Credits

• thephpleage for the awesome flysystem!
• SwiftAdapter by Nimbusoft
• Rackspace for maintaining the Openstack repo