🚀 Big News: Socket Acquires Coana to Bring Reachability Analysis to Every Appsec Team.Learn more
Socket
Sign inDemoInstall
Socket

basin

Package Overview
Dependencies
Maintainers
1
Versions
6
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

basin

Deploy sites to Amazon S3

0.3.0
latest
Source
npm
Version published
Weekly downloads
6
-62.5%
Maintainers
1
Weekly downloads
 
Created
Source

Node.js - basin

Deploy sites to Amazon S3

Why?

Sometimes you want a simple, cheap, no-fuss way to deploy a static site. Amazon S3 is a decent solution for this.

Installation

npm install [-g] basin

API

create(dir, callback)

Generates a skeleton sample site at dir, including basin.conf.json.

var basin = require('basin')

basin.create('/tmp/basin-test', function(err) {
  //generates a skeleton example site
})

deploy([dir], callback)

Deploys dir to S3. Configures all objects and bucket for web access. If dir is not specified, then present working directory is used. The directory must contain basin.conf.json.

basin.deploy(function(err, url) {
 console.log(url); // 'http://MY-BUCKET-NAME.s3-website-us-east-1.amazonaws.com';
})

Configuration (basin.conf.json)

  • key: required, the S3 key. Can be found on the AWS Web Console.
  • secret: required, the S3 secret. Can be found on the AWS Web Console.
  • bucket: required, the name of the bucket.
  • region: defaults to us-east-1.
  • site.index: defaults to index.html.
  • site.error: defaults to error.html.
{
  "key": "",
  "secret": "",
  "bucket": "",
  "region": "us-east-1",
  "site": {
    "index": "index.html",
    "error": "error.html"
  }
}

Command Line Interface

Usage: basin [options]

Options:

  -h, --help       output usage information
  -V, --version    output the version number
  --create [dir]   Creates a skeleton site at the destination directory.
  --deploy         Deploys/publishes the current directory and sub directories. Must have basin.conf.json file present.
  --remote-delete  Deletes the remote S3 bucket. Must have basin.conf.json file present in current directory.

License

(MIT License)

Copyright 2012-2013, JP Richardson jprichardson@gmail.com

Keywords

amazon

FAQs

Package last updated on 23 May 2014

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts