poole v0.0.5

Poole

Easily push a Jekyll based static site to an AWS S3 bucket.

Setup

Install Poole via npm:

npm install -g poole

This will install Poole globally and allow you to run the program via command line.

Configuration

In order to access your S3 bucket, Poole needs to know your AWS keys and bucket information. This information is provided in a configuration file: .poole.ini in the root of your Jekyll based project.

Here's a simple example of a Poole config file:

key = myKey
secret = mySecret
bucket = bucketName
region = us-west-2

Make sure you DO NOT COMMIT this file into source control as it contains your secret AWS information!

Usage

Simply navigate to your Jekyll based project and run poole from the command line:

cd ~/myWebsite
poole

Why "Poole"?

Poole is the name of Dr. Jekyll's butler.

Poole is Dr Jekyll's butler who, upon noticing the reclusiveness and changes of his master, goes to Mr Utterson with the fear that his master has been murdered and his murderer, Mr Hyde, is residing in the chambers. Poole serves Jekyll faithfully, and attempts to do a good job and be loyal to his master. Yet events finally drive him into joining forces with Utterson to discover the truth.

Attribution

Poole was written by Geoff Blair for use by his indie game studio, Lost Decade Games.