Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hedii/laravel-ovh-swift-storage
Out of the box Ovh Swift storage usage for Laravel
https://github.com/hedii/laravel-ovh-swift-storage
disk flysystem flysystem-adapter laravel object-storage openstack openstack-swift ovh ovh-swift-storage storage storage-containers temporary-urls
Last synced: about 2 months ago
JSON representation
Out of the box Ovh Swift storage usage for Laravel
- Host: GitHub
- URL: https://github.com/hedii/laravel-ovh-swift-storage
- Owner: hedii
- License: mit
- Created: 2020-01-30T11:15:22.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2021-12-11T09:19:08.000Z (about 3 years ago)
- Last Synced: 2024-10-16T05:11:59.274Z (2 months ago)
- Topics: disk, flysystem, flysystem-adapter, laravel, object-storage, openstack, openstack-swift, ovh, ovh-swift-storage, storage, storage-containers, temporary-urls
- Language: PHP
- Homepage:
- Size: 31.3 KB
- Stars: 7
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
[](https://github.com/hedii/laravel-ovh-swift-storage/actions)
[](//packagist.org/packages/hedii/laravel-ovh-swift-storage)
[](https://github.com/hedii/laravel-ovh-swift-storage/blob/master/LICENSE.md)
[](//packagist.org/packages/hedii/laravel-ovh-swift-storage)
# Laravel Ovh Swift Storage
Out of the box [Ovh Swift storage](https://www.ovhcloud.com/en-ie/public-cloud/object-storage/) usage for Laravel 6.0+
## Table of contents
- [Table of contents](#table-of-contents)
- [Installation](#installation)
- [Usage](#usage)
- [Private containers](#private-containers)
- [Request options](#request-options)
- [Example](#example)
- [Testing](#testing)
- [License](#license)
## Installation
Install via [composer](https://getcomposer.org/doc/00-intro.md)
```sh
composer require hedii/laravel-ovh-swift-storage
```
Edit `config/filesystems.php` to add the new `ovh-swift` disk
```php
return [
'disks' => [
/* ... */
'ovh-swift' => [
'driver' => 'ovh-swift',
'authUrl' => env('OVH_SWIFT_OPENSTACK_AUTH_URL', 'https://auth.cloud.ovh.net/v3/'),
'region' => env('OVH_SWIFT_OPENSTACK_REGION'),
'projectId' => env('OVH_SWIFT_OPENSTACK_PROJECT_ID'),
'containerName' => env('OVH_SWIFT_CONTAINER_NAME'),
'prefix' => env('OVH_SWIFT_PREFIX'),
'username' => env('OVH_SWIFT_OPENSTACK_USERNAME'),
'password' => env('OVH_SWIFT_OPENSTACK_PASSWORD'),
'visibility' => env('OVH_SWIFT_VISIBILITY', 'public'),
'publicUrl' => env('OVH_SWIFT_PUBLIC_URL'),
'urlKey' => env('OVH_SWIFT_URL_KEY'),
'requestOptions' => [],
],
],
];
```
Edit `.env` to add the required environment variables
```
OVH_SWIFT_OPENSTACK_REGION=GRA
OVH_SWIFT_OPENSTACK_PROJECT_ID=xxxxxxxxxxxxxxxxxxx
OVH_SWIFT_CONTAINER_NAME=xxxxxxxxxxxxxxxxxxx
OVH_SWIFT_OPENSTACK_USERNAME=xxxxxxxxxxxxxxxxxxx
OVH_SWIFT_OPENSTACK_PASSWORD=xxxxxxxxxxxxxxxxxxx
```
## Usage
Once you have modified the Laravel filesystem configuration and the environment variables, you can use the new Ovh Swift storage disk [as any Laravel storage disk](https://laravel.com/docs/6.x/filesystem#obtaining-disk-instances).
### Private containers
By default, this package assumes you are using a public Object Storage container.
If you want to use a private container with temporary urls, you have to configure a [temporary url key](https://docs.ovh.com/ie/en/public-cloud/share_an_object_via_a_temporary_url/) and set the visibility to `private`.
```
OVH_SWIFT_OPENSTACK_REGION=GRA
OVH_SWIFT_OPENSTACK_PROJECT_ID=xxxxxxxxxxxxxxxxxxx
OVH_SWIFT_CONTAINER_NAME=xxxxxxxxxxxxxxxxxxx
OVH_SWIFT_OPENSTACK_USERNAME=xxxxxxxxxxxxxxxxxxx
OVH_SWIFT_OPENSTACK_PASSWORD=xxxxxxxxxxxxxxxxxxx
OVH_SWIFT_VISIBILITY=private
OVH_SWIFT_URL_KEY=xxxxxxxxxxxxxxxxxxx
```
Be aware you will not be able to retrieve regular urls with a private container, only temporary urls.
### Request options
If you want to use http [request options](https://docs.guzzlephp.org/en/6.5/request-options.html#on-headers) like `timeout`, `connect_timeout` or any other valid option, put them in the driver configuration.
```php
return [
'disks' => [
/* ... */
'ovh-swift' => [
/* ... */
'requestOptions' => [
'timeout' => 3.14,
'connect_timeout' => 3.14,
],
],
],
];
```
### Example
```php
use Illuminate\Support\Facades\Storage;
Storage::disk('ovh-swift')->put('avatars/1', $fileContents);
$url = Storage::url('avatars/1');
// if using private containers:
$temporaryUrl = Storage::temporaryUrl('avatars/1', now()->addMinute());
```
## Testing
If you want to test the package, you must create a new Openstack user and two new Ovh Object Storage containers:
- A public container named `test`
- A private container named `test-private`
Once it's done, copy `phpunit.xml.dist` to `phpunit.xml` and update the environment variables.
Be aware that the test suite will delete all files in the containers after each test. **Do not test against a production containers!**
To start test suite, run this command:
```
composer test
```
## License
laravel-ovh-swift-storage is released under the MIT Licence. See the bundled [LICENSE](https://github.com/hedii/laravel-ovh-swift-storage/blob/master/LICENSE.md) file for details.