Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/michaelnisi/pushup
Copy files to S3 bucket
https://github.com/michaelnisi/pushup
Last synced: 3 months ago
JSON representation
Copy files to S3 bucket
- Host: GitHub
- URL: https://github.com/michaelnisi/pushup
- Owner: michaelnisi
- License: mit
- Created: 2012-08-27T16:34:48.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2016-10-18T06:34:06.000Z (about 8 years ago)
- Last Synced: 2024-10-10T15:52:16.785Z (3 months ago)
- Language: JavaScript
- Homepage:
- Size: 85.9 KB
- Stars: 5
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# pushup - copy files to S3
The **pushup** [Node](http://nodejs.org/) module copies local files to an [Amazon S3](http://aws.amazon.com/s3/) bucket. It is designed to deploy file trees to S3 supporting gzip compression and the Cache-Control header.
[](http://travis-ci.org/michaelnisi/pushup)
## Usage
**pushup** is a [Transform](http://nodejs.org/api/stream.html#stream_class_stream_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.
```js
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.
```js
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:
```js
{ '.xml': false }
```
### ttl()
Optional settings to configure `Cache-Control` [headers](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html) by filename or extension in (max-age) delta-seconds. For example:
```js
{ '.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:
```js
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()](#gzip)
- `ttl` [ttl()](#ttl)
- `root` [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](https://github.com/LearnBoost/knox).
## Installation
With [npm](https://www.npmjs.com/package/pushup) do:
```
$ npm install pushup
```
## License
[MIT License](https://raw.github.com/michaelnisi/pushup/master/LICENSE)