s3-prototype

Notes

This was forked from https://github.com/klaemo/s3-website

Great deploy tool! But we wanted the ability to create complex s3 bucket policies that we could use for password-protected prototypes. So, we forked it for our GUI deploy tool.

Easily publish password-protected Prototypes on Amazon S3 as static websites.

Creates a bucket with the specified name and enables static website hosting on it. Also, sets up a public-read bucket policy. Can optionally password protect a static site.

Your AWS credentials should either be in ~/.aws/credentials, a file in the local directory entitled .env with the values

[default]
aws_access_key_id = MY_ACCESS_KEY_ID
aws_secret_access_key = MY_SECRET_ACCESS_KEY

or in the environment variables AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY.

Your website policy and configuration will only be sent to S3 when it differs from the existing.

Note!

Because of limitations of the S3 API, any changes made to the website policy or configuration in the S3 web interface, or elsewhere, will be overwritten by the settings provided to s3-prototype.

Installation

s3-prototype is a node.js program/module.

npm i -g s3-prototype

Usage (CLI)

  $ s3-prototype -h
  Commands:

    create [options] <domain>      Will create and configure an s3 website
    deploy [options] <upload-dir>  Will push contents of directory to specified s3 website

To see options for each command s3-prototype command -h

Create

Usage s3-prototype create <desired.bucket.name> [options]

• Will create a new bucket with desired name
• Will configure bucket for static hosting

Deploy

Usage s3-prototype deploy <directory-to-upload> [options]

• Will upload all contents of directory to bucket, replacing existing files
• Bucket can be specified by providing command line argument -d, or --domain followed by the name of the s3 bucket. If no option is provided s3-prototype will look for config file written when bucket is created. ** Because there is an issue in the command line library, you must to put the "-d" option last. The next dependency version should fix this issue

All the options are optional ;-).

s3-prototype -r eu-central-1 cool.website.me creates a website bucket with the following URL http://cool.website.me.s3-prototype.eu-central-1.amazonaws.com. You can then set up a CNAME record for cool.website.me pointing to that hostname.

License

ISC