pushup - copy files to S3

The pushup Node module copies local files to an Amazon S3 bucket. It is designed to deploy file trees to S3 supporting gzip compression and the Cache-Control header.

Usage

pushup is a Transform stream to which you write filenames of files you want to copy to S3. If you export your S3 credentials to your process environment, you can neglect the options object.

var pushup = require('pushup')

var push = pushup()
push.write('/some/file')
push.write('/some/other/file')
push.end()

Options let you control compression, caching, and the root of the path in the bucket.

function gzip () {
  return { '.xml': false }
}

function ttl () {
  return { 'file': 3600 * 24 }
}

function opts () {
  return {
    gzip: gzip(),
    ttl: ttl(),
    root: '/some'
  }
}

var pushup = require('pushup')

var push = pushup(opts())
push.write('/some/file')
push.write('/some/other/file')
push.end()

Types

gzip()

An optional bag of settings to toggle gzip compression by filename or extension as Boolean() (defaults to true). pushup compresses text files using gzip and sets proper content/encoding headers. The following would compress all but XML files:

{ '.xml': false }

ttl()

Optional settings to configure Cache-Control headers by filename or extension in (max-age) delta-seconds. For example:

{ '.html': 3600 * 24 * 30, '.css': 3600 * 24 * 30, 'hot.html': 3600 }

root()

With the root option you can control the root of the replicated file tree in your bucket. For example:

var pushup = require('pushup')

var push = pushup({root:'/some')
push.write('/some/file')
push.write('/some/other/file')
push.end()

This would copy the files to /file and /other/file in your S3 bucket. If root is undefined or your defined root is not part of the given file path, the entire path will be replicated.

opts()

An optional configuration Object passed to the Transform stream constructor.

• gzip gzip()
• ttl ttl()
• root root()
• tmp String() defaults to '/tmp/pushup'
• key String() defaults to process.env.AWS_ACCESS_KEY_ID
• secret String() defaults to process.env.AWS_SECRET_ACCESS_KEY
• bucket String() defaults to process.env.S3_BUCKET
• region String() defaults to process.env.S3_REGION

Exports

pushup(opts())

A Transform stream that consumes filenames and emits paths of files copied to S3 using knox.

Installation

With npm do:

$ npm install pushup

License

MIT License