mzur/laravel-openstack-swift

OpenStack Swift storage driver for Laravel/Lumen.

v2.2.0 2023-11-21 07:55 UTC

README

OpenStack Swift storage driver for Laravel/Lumen.

Installation

Require the package with Composer:

composer require mzur/laravel-openstack-swift

Laravel

This package is auto-discovered.

Lumen

Add the service provider to bootstrap/app.php:

$app->register(Mzur\Filesystem\SwiftServiceProvider::class);

Configuration

Add a new storage disk to config/filesystems.php (using v3 of the identity API):

'disks' => [
   'openstack' => [
      'driver'    => 'swift',
      'authUrl'   => env('OS_AUTH_URL', ''),
      'region'    => env('OS_REGION_NAME', ''),
      'user'      => env('OS_USERNAME', ''),
      'domain'    => env('OS_USER_DOMAIN_NAME', 'default'),
      'password'  => env('OS_PASSWORD', ''),
      'container' => env('OS_CONTAINER_NAME', ''),
   ],
]

Additional configuration options:

  • projectId (default: null) if you want to scope access to a specific project

  • debugLog (default: false), logger (default: null), messageFormatter (default: null) [ref]

  • requestOptions (default: []) [ref]

  • swiftLargeObjectThreshold [ref]

  • swiftSegmentSize [ref]

  • swiftSegmentContainer [ref]

  • root (default: null): Prefix to use for the names of the objects in the container.

  • url (default: null): Override URL to use for public URLs to objects. If this is not set, the public URL will point to the public URL of Swift. This configuration is useful if you use a reverse proxy to pass through requests to public Swift containers.

  • tempUrlKey: The account or container level key for temporary URLs. If set, support for temporary URLs is automatically enabled for the storage disk.

  • ttl: Override the duration the OpenStack authentication token should be cached (in seconds). Values that are longer than the expires_at of the token are ignored.