imbo/imbo-s3-adapters

AWS S3 adapters for Imbo

Maintainers

Details

github.com/imbo/imbo-s3-adapters

Homepage

Source

Issues

Installs: 23

Dependents: 0

Suggesters: 1

Security: 0

Stars: 0

Watchers: 1

Forks: 0

Open Issues: 1

dev-main 2023-04-09 09:38 UTC

Requires

Requires (Dev)

MIT 85296c627af527e17e82394b7a2e81381d500c70

imbo

This package is auto-updated.

Last update: 2024-12-20 01:05:39 UTC

README

CI

AWS S3 storage adapters for Imbo.

Installation

composer require imbo/imbo-s3-adapters

Usage

This package provides two storage adapters for Imbo. One for the main images, and one for image variations.

use Imbo\Storage\S3 as MainStorage;
use Imbo\EventListener\ImageVariations\Storage\S3 as ImageVariationStorage;

$mainAdapter           = new MainStorage($keyId, $applicationKey, $bucketId, $bucketName);
$imageVariationAdapter = new ImageVariationStorage($keyId, $applicationKey, $bucketId, $bucketName);

Running integration tests

If you want to run the integration tests for this adapter you need to export the following environment variables:

  • S3_KEY
  • S3_SECRET
  • S3_BUCKET
  • S3_REGION

You will also need to copy phpunit.xml.dist to phpunit.xml and comment out or remove the part in the configuration that excludes the integration test group.

Warning: The integration tests will empty the specified bucket, so if you intend to run the integration tests you should create a dedicated bucket for this purpose.

License

MIT, see LICENSE.