README

Generates image handle from inside twig for AWS serverless image handler. More info Automatically detects client webp support.

Requirements

This plugin requires Craft CMS 3.0.0-beta.23 or later.
A working S3 volume is required. Use Craft AWS S3.
A working cloudformation stack For more info an instuctions. (Instructions comming soon)

Installation

S3

Install S3 volume plugin Use Craft AWS S3. The following IAM Policy allow's craft to access your bucket:

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

Create a volume with the following settings:
- Base URL is your cloudfront url (*.cloudfront.net)
- Access Key ID is your IAM ID
- Secret Access key is your IAM secret key
- Bucket name is the name of your S3 bucket
- Bucket region the region for exaple us-east-1
- Make Uploads Public false
- Focal point false

AWS serverless image handler

After setting up the S3 volume follow these instructions to install the plugin.

Open your terminal and go to your Craft project:
```
 cd /path/to/project
```

Then tell Composer to load the plugin:

 composer require dutchheight/aws-serverless-image-handler

In the Control Panel, go to Settings → Plugins and click the “Install” button for AWS Serverless Image Handler.
Add Toggle aws image processor to your s3 volume field layout.

Usage

In your twig template you can use:

{% set settings = {
    width: 2600,
    height: 450
} %}
    
{{ craft.awsserverlessimagehandler.getImgUrl(entry.slider.one(), settings) }}

This will generate the propper URL for the asset.

If you load the image with asset.url the original source will be served.

Availible settings

Properties	Values	Default	Note
width	px value in `number`	`1980px`
height	px value in `number`	`null`	Leave blank to keep ratio
fit	`cover`, `contain`, `fill`, `inside` or `outside`	`cover`
position	`top`, `right top`, `right`, `right bottom`, `bottom`, `left bottom`, `left` or `left top`	`focalpoint`
flip	`true`, `false`	`false`
flop	`true`, `false`	`false`
rotation	Between `0` and `360`	`0`
blur	Between `0.5` and `1000`	`0`
greyscale	`true`, `false`	`false`

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. Please make sure to update tests as appropriate.

Extra information

For more info about AWS serverless image handler and other ways to use AWS SIH with Craft CMS take a look at: Setting up your own image transform service

License

Craft

Contributors ✨

Thanks goes to these wonderful people (emoji key):

_{Andrew Menich}
💻

This project follows the all-contributors specification. Contributions of any kind welcome!

dutchheight / aws-serverless-image-handler

Maintainers

Details