Project

simple-s3

0.01
No commit activity in last 3 years
No release in over 3 years
This Gem allows you to push your static content to AWS S3.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Runtime

>= 0
 Project Readme

Simple-S3

A super simple uploader for S3 using Ruby.

Updates

  • Dec 30th 2012: Added the s3_bucket_endpoint configuration parameter to suit S3 buckets that are not in the standard S3 zone (which is s3.amazonaws.com by default).

Installation

Install as a gem using gem install simple-s3 or place a Gemfile within your website directory with the following info:

source :rubygems
gem "simple-s3"

Then run bundle install or rvmsudo bundle install if you're using RVM.

Usage

Setup a file called simple-s3.yml with the following information:

s3_bucket: '...'
s3_access_key: '...'
s3_secret_key: '...'
cloudfront_distribution_id: '...' # (optional)
s3_bucket_endpoint: '...' # (set this if you're not in the standard US zone)

And then run the command simple-s3 from the command line within the same directory where your simple-s3.yml file is saved.

You can also include the library directly into another file (like a Rakefile for example):

require 'rubygems'
require 'simple-s3'

# do some stuff
# run the uploader
SimpleS3.run!
# do other stuff

Excluding Files

You can exclude files from the upload by defining a list of files within your simple-s3.yml file:

exclude_files:
- one.html
- two.rb
- three.something

# ... the rest of the simple-s3.yml file

Including Files

You can also include specific files for the upload

include_files:
- "**/*" #default
- /path/to/some/other/file.rb

# ... the rest of the simple-s3.yml file

More Info

Click here to view more information about this amazing gem.

http://www.yearofmoo.com/2012/10/launch-a-static-website-with-simple-s3.html