AWS S3 Image Uploader

Flexible and efficient resize, rename, and upload images to Amazon S3 disk storage. Uses the official AWS Node SDK and GM for image processing.

Install

npm install s3-uploader --save

Requirements

• Node.JS >= v0.10
• imagemagic
• AWS credentials environment variables
  • AWS_ACCESS_KEY_ID
  • AWS_SECRET_ACCESS_KEY

API

var Upload = require('s3-uploader');

new Upload(string awsBucketName, object opts)

• string awsBucketName - name of Amazon S3 bucket
• object opts - global upload options
  • string awsBuckeRegion - region for you bucket; default "us-east-1"
  • string awsBucketPath - path within your bucket (ex. "/images")
  • string awsBucketAcl - default ACL for uploded images
  • number awsMaxRetries - max number of retries; default 3
  • number awsHttpTimeout - inactive time (ms) beofre timing out; default 10000
  • number resizeQuality - default resize quallity
  • boolean returnExif - return exif data for original image
  • string tmpDir - directory to store temporary files
  • number asyncLimit - limit number of async workers
  • object[] versions - versions to upload to S3
    • boolean original - if this is the original image
    • string suffix - this is appended to the file name
    • number quality - resized image quality
    • number maxWidth - max width for resized image
    • number maxHeight - max height for resized image

Example

var client = new Upload('my_s3_bucket', {
  awsBucketRegion: 'us-east-1',
  awsBucketPath: 'images/',
  awsBucketAcl: 'public-read',

  versions: [{
    original: true
  },{
    suffix: '-large',
    quality: 80,
    maxHeight: 1040,
    maxWidth: 1040,
  },{
    suffix: '-medium',
    maxHeight: 780,
    maxWidth: 780
  },{
    suffix: '-small',
    maxHeight: 320,
    maxWidth: 320
  }]
});

#upload(string src, object opts, function cb)

• string src - absolute path to source image to upload
• object opts - local upload config options (overwrites global config)
• function cb - callback function (Error err, object[] versions, object meta)
  • Error err - null if everything went fine
  • object[] versions - original and resized images with path/location
  • object meta - metadata for original image

Example

client.upload('/some/file/path.jpg', {}, function(err, images, meta) {
  if (err) {
    console.error(err);
  } else {
    for (var i = 0; i < images.length; i++) {
      console.log('Thumbnail with width %i, height %i, at %s', images[i].width, images[i].height, images[i].url);
    }
  }
});

Algorithm

A
+-- B
    `-- C
    `-- D
    `-- E

Where A is the original image uploaded by the user. An mpc image is created, B,
which is used to crate the thumbnails C, D, and E.

Lisence

MIT