README

Abstraction layers for interacting with AWS S3 storage.

Installation

You can install the package via composer:

composer require sfneal/aws-s3-helpers

In order to autoload to the helper functions add the following path to the autoload.files section in your composer.json.

"autoload": {
    "files": [
      "vendor/sfneal/aws-s3-helpers/src/Helpers/s3-helpers.php"
    ]
},

To modify the s3-helpers settings publish the ServiceProvider & modify the config.

php artisan vendor:publish --provider="Sfneal\Helpers\Aws\S3\Providers\S3HelpersServiceProvider"

Usage

Add 's3' disk to the 'disks' array in config/filesystems.php with your own AWS credentials.

's3' => [
    'driver' => 's3',
    'key' => env('S3_KEY'),
    'secret' => env('S3_SECRET'),
    'region' => env('S3_REGION'),
    'bucket' => env('S3_BUCKET'),
],

Add S3 keys to your .env files.

S3_KEY=********************
S3_SECRET=****************************************
S3_REGION=*********
S3_BUCKET=******************

Testing

composer test

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email stephen.neal14@gmail.com instead of using the issue tracker.

sfneal / aws-s3-helpers

Maintainers

Details