Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/wintercms/wn-driveraws-plugin

Adds support for the AWS SDK (S3 storage, SQS queues, DynamoDB, SES mailer, streamed file uploads, etc) to Winter CMS
https://github.com/wintercms/wn-driveraws-plugin

aws dynamodb hacktoberfest laravel plugin s3 sqs wintercms

Last synced: 27 days ago
JSON representation

Adds support for the AWS SDK (S3 storage, SQS queues, DynamoDB, SES mailer, streamed file uploads, etc) to Winter CMS

Host: GitHub
URL: https://github.com/wintercms/wn-driveraws-plugin
Owner: wintercms
License: mit
Created: 2022-04-05T20:07:02.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2024-03-21T15:15:52.000Z (4 months ago)
Last Synced: 2024-03-25T01:37:43.303Z (3 months ago)
Topics: aws, dynamodb, hacktoberfest, laravel, plugin, s3, sqs, wintercms
Language: PHP
Homepage:
Size: 107 KB
Stars: 2
Watchers: 4
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Lists

awesome-wintercms - Winter.DriverAWS - Driver that adds support for AWS (S3 storage driver & streamed uploads, SQS queues, DynamoDB, SES mail driver). (Uncategorized / Uncategorized)

README

## Installation

This plugin is available for installation via [Composer](http://getcomposer.org/).

```bash
composer require winter/wn-driveraws-plugin
```

## Usage

Simply installing & enabling this plugin should be enough to enable support for the AWS drivers for various core Winter / Laravel functionality (i.e. `s3` filesystem disks, `sqs` queues, `dynamodb` caches, `ses` mailers, etc).

This plugin also provides some additional functionality over and above the AWS SDK, including:

- [Backend configuration of SES as a Mailer](#backend-ses-mailer)
- [Streamed File Uploads to S3](#streamed-uploads)

### Backend Configuration of SES as a Mailer

By default you can setup SES as a mail transport by configuring the `mail.mailers.*` option to `ses` and providing the `services.aws.key`, `services.aws.secret`, and `services.aws.region` configuration values in your configuration files. This plugin also provides the ability to configure these values through the backend Mail Settings form.

### Streamed File Uploads to S3

>**NOTE:** This feature requires Winter v1.2.1 or greater.

When dealing with large files or serverless application infrastructure it can be extremely useful to support client-side direct uploads to S3 (i.e. file uploads are streamed to S3 directly from the browser without going through the application server). This plugin provides the ability to do this by automatically hooking into the FileUpload, MediaManager, RichEditor, & MarkdownEditor Widgets and providing the ability to upload directly to S3 when their respective disk configurations are set to `s3` and have the `stream_uploads` option set to `true`.

The following additional configuration options are available to be set on `s3` disk configurations:

```php
's3' => [
// Default options
'bucket' => env('AWS_BUCKET'),
'driver' => 's3',
'endpoint' => env('AWS_ENDPOINT'),
'key' => env('AWS_ACCESS_KEY_ID'),
'region' => env('AWS_DEFAULT_REGION'),
'secret' => env('AWS_SECRET_ACCESS_KEY'),
'stream_uploads' => env('AWS_S3_STREAM_UPLOADS', false),
'url' => env('AWS_URL'),
'use_path_style_endpoint' => env('AWS_USE_PATH_STYLE_ENDPOINT', false)

// Additional options used by the StreamS3Uploads functionality:
// The lifespan of the signed URL in minutes
'stream_uploads_ttl' => 5,
// The max upload size of a single file in bytes, default 128 MB
'stream_uploads_max_size' => 128 * 1024 * 1024,
],
```

>**NOTE:** In order to use the streamed uploads functionality, your AWS credential require access to the following actions on the desired S3 bucket:

- `s3:PutObject`
- `s3:PutObjectAcl`
- `s3:GetObject`
- `s3:GetObjectAcl`
- `s3:DeleteObject`

See below for an example IAM policy that shoud work:

```json
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"s3:ListBucket",
"s3:ListAllMyBuckets",
"s3:GetBucketLocation"
],
"Resource": [
"arn:aws:s3:::my-bucket-name-here"
]
},
{
"Effect": "Allow",
"Action": [
"s3:PutObject",
"s3:PutObjectAcl",
"s3:GetObject",
"s3:GetObjectAcl",
"s3:DeleteObject"
],
"Resource": [
"arn:aws:s3:::my-bucket-name-here/*"
]
}
]
}
```