Compatible with AWSSDK 2.0+
Allows images located on Amazon S3 to be processed and resized as if they were located locally on the disk. Also serves files located on S3 - not restricted to images (unless vpp="false") is used.
See Samples/S3ReaderSample/ in the download for a sample project.
- Fast - no unnecessary http requests
- Offers mode for checking for newer files on a configured interval (useful when combined with disk caching)
- Works great with the DiskCache and CloudFront caching plugins
- Has an optional ssl mode
- Can be configured to access private bucket files with an access key
Install-Package ImageResizer.Plugins.S3Reader2 in the NuGet package manager, or:
- Add ImageResizer.Plugins.S3Reader2.dll to your project.
<add name="S3Reader2" buckets="my-bucket-1,my-bucket-2,my-bucket-3" />inside
You must specify a comma-delimited list of permitted bucket names that can be accessed.
If you want to access non-public bucket items, you will need to specify an access ID and key.
- buckets (required) - Comma-delimited list of permitted bucket names that can be accessed.
- prefix - the virtual folder that all buckets can be accessed under. Defaults to ~/s3/
- checkForModifiedFiles - If true, S3Reader will check for updated source files on S3 when a cached file is requested. The metadata is cached for an hour after it is last accessed (configurable by code). If false, S3 will never be checked for newer versions of cached files, reducing latency costs by 50%. Defaults to false.
- useSsl - Defaults to false. Set to true to transfer the image data over an encrypted connection. Slows things down significantly.
- accessKeyId, secretAccessKey - Use these if you need to access non-public files in your amazon buckets.
- vpp - Set to false to only serve image URLs that have a querystring.
- region - Set to the region containing your buckets.
The default region is 'us-east-1', which works for buckets in both 'us-east-1' and 'us-west-1', but not 'us-west-2' or any other buckets. Use multiple installations of S3Reader2 with different prefixes if you need to support multiple regions.
"us-east-1", "US East (Virginia)" "us-west-1", "US West (N. California)" "us-west-2", "US West (Oregon)" "eu-west-1", "EU West (Ireland)" "ap-northeast-1", "Asia Pacific (Tokyo)" "ap-southeast-1", "Asia Pacific (Singapore)" "ap-southeast-2", "Asia Pacific (Sydney)" "sa-east-1", "South America (Sao Paulo)" "us-gov-west-1", "US GovCloud West (Oregon)"
Notes on bucket naming
When creating a bucket, you should avoid certain characters to ensure that DNS works properly. While Amazon will let you create buckets that violate some of these rules, you may have trouble accessing them using the subdomain syntax or over HTTPS. Make sure every bucket is also a valid DNS address. Read more.
- Bucket names should not contain upper case letters
- Bucket names should not contain underscores (_)
- Bucket names should not end with a dash
- Bucket names should be between 3 and 63 characters long
- Bucket names cannot contain dashes next to periods (e.g., "my-.bucket.com" and "my.-bucket" are invalid)
- Bucket names cannot contain periods - Amazon states this is not supported for SSL-secured access, due to DNS complications. Your mileage may vary.
This plugin (S3Reader2 plugin) is part of the Performance Edition
Where is the plugins section?
<plugins> section is located in Web.config, and is nested inside the
<resizer> element, which is nested inside
<configuration>. For examples, see this sample Web.config file.
Where can I find the dll?
We prefer that you install via NuGet, but you can also find the plugin DLL files in the /dlls/release folder of your download.
How do I typically install a plugin via Web.Config?
- In Visual Studio, right click on your project and choose "Add reference". Browse to the plugin DLL and click "OK".
- In the <plugins> section of Web.config, insert <add name="PluginName" />
- Look at the plugin documentation to see what configuration options (if any) are available.