jekyll-s3

Deploy your jekyll site to S3.

What jekyll-s3 can do for you

Upload your site to AWS S3
Help you use AWS Cloudfront to distribute your Jekyll blog
Create an S3 website for you

Install

gem install jekyll-s3

Usage

Go to your jekyll site directory

Run jekyll-s3. It generates a configuration file called _jekyll_s3.yml that looks like this:


s3_id: YOUR_AWS_S3_ACCESS_KEY_ID
s3_secret: YOUR_AWS_S3_SECRET_ACCESS_KEY
s3_bucket: your.blog.bucket.com

Edit it with your details (you can use ERB in the file)
Run configure-s3-website --config-file _jekyll_s3.yml This will configure your bucket to function as an S3 website. If the bucket does not exist, configure-s3-website will create it for you.
Run jekyll-s3 to push your Jekyll blog to S3. Congratulations! You are live.

Additional features

Cache Control

You can use the max_age configuration option to enable more effective browser caching of your static assets. There are two possible ways to use the option: you can specify a single age (in seconds) like so:

max_age: 300

Or you can specify a hash of globs, and all files matching those globs will have the specified age:

max_age:
  "assets/*": 6000
  "*": 300

Place the configuration into the file _jekyll_s3.yml.

Gzip Compression

If you choose, you can use compress certain file types before uploading them to S3. This is a recommended practice for maximizing page speed and minimizing bandwidth usage.

To enable Gzip compression, simply add a gzip option to your _jekyll_s3.yml configuration file:

gzip: true

Note that you can additionally specify the file extensions you want to Gzip (.html, .css, .js, and .txt will be compressed when gzip: true):

gzip:
  - .html
  - .css
  - .md

Remember that the extensions here are referring to the compiled extensions, not the pre-processed extensions.

Using non-standard AWS regions

By default, jekyll-s3 uses the US Standard Region. You can upload your Jekyll site to other regions by adding the setting s3_endpoint into the _jekyll_s3.yml file.

For example, the following line in _jekyll_s3.yml will instruct jekyll_s3 to push your site into the Tokyo region:

s3_endpoint: ap-northeast-1

The valid s3_endpoint values consist of the S3 location constraint values.

Ignoring files you want to keep on AWS

Sometimes there are files or directories you want to keep on S3, but not on your local machine. You may define a regular expression to ignore files like so:

ignore_on_server: that_folder_of_stuff_i_dont_keep_locally

Reduced Redundancy

You can reduce the cost of hosting your blog on S3 by using Reduced Redundancy Storage:

In _jekyll_s3.yml, set s3_reduced_redundancy: true
All objects uploaded after this change will use the Reduced Redundancy Storage.
If you want to change all of the files in the bucket, you can change them through the AWS console, or update the timestamp on the files before running jekyll-s3 again

How to use Cloudfront to deliver your blog

It is easy to deliver your S3-based web site via Cloudfront, the CDN of Amazon.

Go to https://console.aws.amazon.com/cloudfront/home
Create a distribution and set the your Jekyll S3 bucket as the origin
Add the cloudfront_distribution_id: your-dist-id setting into _jekyll_s3.yml
Run jekyll-s3 to deploy your site to S3 and invalidate the Cloudfront distribution

The headless mode

Jekyll-s3 has a headless mode, where human interactions are disabled.

In the headless mode, jekyll-s3 will automatically delete the files on the S3 bucket that are not on your local computer.

Enable the headless mode by adding the --headless or -h argument after jekyll-s3.

Using `jekyll-s3` as a library

By nature, jekyll-s3 is a command-line interface tool. You can, however, use it programmatically by calling the same API as the executable jekyll-s3 does:

require 'jekyll-s3'
is_headless = true
Jekyll::S3::CLI.new.run('/path/to/your/jekyll-site/_site/', is_headless)

You can also use a basic Hash instead of a _jekyll_s3.yml file:

config = {
  "s3_id"     => YOUR_AWS_S3_ACCESS_KEY_ID,
  "s3_secret" => YOUR_AWS_S3_SECRET_ACCESS_KEY,
  "s3_bucket" => your.blog.bucket.com
}
in_headless = true
Jekyll::S3::Uploader.run('/path/to/your/jekyll-site/_site/', config, in_headless)

The code above will assume that you have the _jekyll_s3.yml in the directory /path/to/your/jekyll-site.

Known issues

None. Please send a pull request if you spot any.

Development

Versioning

Jekyll-s3 uses Semantic Versioning.

Tests

Install bundler and run bundle install
Run all tests by invoking rake test
Run the integration tests by running bundle exec cucumber
Run the unit tests by running bundle exec rspec spec/lib/*.rb

Contributing

We (users and developers of Jekyll-s3) welcome patches, pull requests and ideas for improvement.

When sending pull requests, please accompany them with tests. Favor BDD style in test descriptions. Use VCR-backed integration tests where possible. For reference, you can look at the existing Jekyll-s3 tests.

If you are not sure how to test your pull request, you can ask the main developer (currently Lauri Lehmijoki) to supplement the request with tests. However, by including proper tests, you increase the chances of your pull request being incorporated into future releases.

License

MIT

Copyright

Contributors (in alphabetical order)

Alan deLevie
Cory Kaufman-Schofield
Chris Kelly
Chris Moos
Lauri Lehmijoki
Mason Turner
Michael Bleigh
Shigeaki Matsumura
stanislas