Deploy your website to S3
s3_website can do for you
- Create and configure an S3 website for you
- Upload your static website to AWS S3
- Jekyll and Nanoc are automatically supported
- Help you use AWS Cloudfront to distribute your website
- Improve page speed with HTTP cache control and gzipping
- Set HTTP redirects for your website
- (for other features, see the documentation below)
gem install s3_website
Here's how you can get started:
- Create API credentials that have sufficient permissions to S3. More info here.
- Go to your website directory
s3_website cfg create. This generates a configuration file called
- Put your AWS credentials and the S3 bucket name into the file
s3_website cfg apply. This will configure your bucket to function as an S3 website. If the bucket does not exist, the command will create it for you.
s3_website pushto push your website to S3. Congratulations! You are live.
Specifying the location of your website
S3_website will automatically discover websites in the _site and public/output directories.
If your website is not in either of those directories, you can point the location of your website in two ways:
- Add the line
site: path-to-your-websiteinto the
- Or, use the
If you want to store the
s3_website.yml file in a directory other than
the project's root you can specify the directory like so:
s3_website push --config-dir config.
Using environment variables
You can use ERB in your
s3_website.yml file which incorporates environment variables:
s3_id: <%= ENV['S3_ID'] %> s3_secret: <%= ENV['S3_SECRET'] %> s3_bucket: blog.example.com
(If you are using
s3_website on an EC2 instance with IAM
you can omit the
s3_secret keys in the config file.)
S3_website implements supports for reading environment variables from a file using
the dotenv gem. You can create a
in the project's root directory to take advantage of this feature. Please have
a look at dotenv's usage guide for
- Provide a command-line interface tool for deploying and managing S3 websites
- Let the user have all the S3 website configurations in a file
- Minimise or remove the need to use the AWS Console
- Allow the user to deliver the website via CloudFront
- Automatically detect the most common static website tools, such as Jekyll or Nanoc
- Be simple to use: require only the S3 credentials and the name of the S3 bucket
- Let the power users benefit from advanced S3 website features such as redirects, Cache-Control headers and gzip support
- Be as fast as possible. Do in parallel all that can be done in parallel.
s3_website attempts to be a command-line interface tool that is easy to
understand and use. For example,
s3_website --help should print you all the
things it can perform. Please create an issue if you think the tool is
incomprehensible or inconsistent.
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:
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
After changing the
max_age setting, push with the
Force-pushing allows you to update the S3 object metadata of existing files.
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
Note that you can additionally specify the file extensions you want to Gzip
.txt will be compressed when
gzip: - .html - .css - .md
Remember that the extensions here are referring to the compiled extensions, not the pre-processed extensions.
After changing the
gzip setting, push with the
Using non-standard AWS regions
s3_website uses the US Standard Region. You can upload your
website to other regions by adding the setting
s3_endpoint into the
For example, the following line in
s3_website.yml will instruct
push your site into the Tokyo region:
s3_endpoint values consist of the S3 location constraint
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:
You may also specify the values as a list:
ignore_on_server: - that_folder_of_stuff_i_dont_keep_locally - file_managed_by_somebody_else
If you add the magic word
s3_website push will never delete any objects on the bucket.
Excluding files from upload
You can instruct
s3_website not to push certain files:
The value can be a regex, and you can specify many of them:
exclude_from_upload: - test - (draft|secret)
You can reduce the cost of hosting your blog on S3 by using Reduced Redundancy Storage:
- 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
After changing the
s3_reduced_redundancy setting, push with the
How to use Cloudfront to deliver your blog
It is easy to deliver your S3-based web site via Cloudfront, the CDN of Amazon.
Creating a new CloudFront distribution
When you run the command
s3_website cfg apply, it will ask you whether you
want to deliver your website via CloudFront. If you answer yes, the command will
create a CloudFront distribution for you.
If you do not want to receive this prompt, or if you are running the command in a non-interactive session, you can use
s3_website cfg apply --headless.
Using your existing CloudFront distribution
If you already have a CloudFront distribution that serves data from your website
S3 bucket, just add the following line into the file
Next time you run
s3_website push, it will invalidate the items on CloudFront and
thus force the CDN system to reload the changes from your website S3 bucket.
Specifying custom settings for your CloudFront distribution
s3_website lets you define custom settings for your CloudFront distribution.
For example, like this you can define a your own TTL and CNAME:
cloudfront_distribution_config: default_cache_behavior: min_TTL: <%= 60 * 60 * 24 %> aliases: quantity: 1 items: CNAME: your.website.com
Once you've saved the configuration into
s3_website.yml, you can apply them by
s3_website cfg apply.
Invalidating root resources instead of index.htmls
s3_website push calls the CloudFront invalidation API with the
file-name-as-it-is. This means that if your file is article/index.html, the
push command will call the invalidation API on the resource
You can instruct the push command to invalidate the root resource instead of the index.html resource by adding the following setting into the configuration file:
To recap, this setting instructs s3_website to invalidate the root resource (e.g., article/) instead of the filename'd resource (e.g., article/index.html).
No more index.htmls in your URLs!
Note: If the root resource on your folder displays an error instead of the index file, your source bucket in Cloudfront likely is pointing to the S3 Origin, example.com.s3.amazonaws.com. Update the source to the S3 Website Endpoint, e.g. example.com.s3-website-us-east-1.amazonaws.com, to fix this.
Configuring redirects on your S3 website
You can set HTTP redirects on your S3 website in two ways. If you only need simple "301 Moved Premanently" redirects for certain keys, use the Simple Redirects method. Otherwise, use the Routing Rules method.
For simple redirects
s3_website uses Amazon S3's
metadata. It will create zero-byte objects for each path you want
redirected with the appropriate
For setting up simple redirect rules, simply list each path and target
as key-value pairs under the
redirects configuration option:
redirects: index.php: / about.php: /about.html music-files/promo.mp4: http://www.youtube.com/watch?v=dQw4w9WgXcQ
You can configure more complex redirect rules by adding the following
configuration into the
routing_rules: - condition: key_prefix_equals: blog/some_path redirect: host_name: blog.example.com replace_key_prefix_with: some_new_path/ http_redirect_code: 301
After adding the configuration, run the command
s3_website cfg apply on your
command-line interface. This will apply the routing rules on your S3 bucket.
For more information on configuring redirects, see the documentation of the
gem, which comes as a transitive dependency of the
s3_website gem. (The
s3_website cfg apply internally calls the
On skipping application of redirects
If your website has a lot of redirects, you may find the following setting helpful:
The setting allows
s3_website push to infer whether a redirect exists on the S3 bucket.
You will experience faster
push performance when this setting is
If this setting is enabled and you modify the
redirects setting in
push --force to apply the modified values.
For backward-compatibility reasons, this setting is
false by default.
In this context, the word object refers to object on S3, not file-system file.
Specifying custom concurrency level
s3_website does 3 operations in parallel. An operation can be an
HTTP PUT operation against the S3 API, for example.
You can increase the concurrency level by adding the following setting into the
However, because S3 throttles connections, there's an upper limit to the level of parallelism. If you start to see end-of-file errors, decrease the concurrency level. Conversely, if you don't experience any errors, you can increase the concurrency level and thus benefit from faster uploads.
If you experience the "too many open files" error, either increase the amount of
maximum open files (on Unix-like systems, see
man ulimit) or decrease the
You can simulate the
s3_website push operation by adding the
--dry-run switch. The dry run mode will not apply any modifications on your S3
bucket or CloudFront distribution. It will merely print out what the
operation would actually do if run without the dry switch.
You can use the dry run mode if you are unsure what kind of effects the
operation would cause to your live website.
Migrating from v1 to v2
Please read the release note on version 2. It contains information on backward incompatible changes.
You can find the v1 branch here. It's in maintenance mode. This means that v1 will see only critical bugfix releases.
If the source code of your website is publicly
available, ensure that the
s3_website.yml file is in the list of ignored files.
For git users this means that the file
.gitignore should mention the
If you use the .dotenv gem, ensure that you do not push the
.env file to a
public git repository.
Please create an issue and send a pull request if you spot any.
s3_website uses Semantic Versioning.
In the spirit of semantic versioning, here is the definition of public API for s3_website: Within a major version, s3_website will not break backwards-compatibility of anything that is mentioned in this README file.
We (users and developers of s3_website) 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 s3_website tests.
If you are not sure how to test your pull request, you can ask the gem owners to supplement the request with tests. However, by including proper tests, you increase the chances of your pull request being incorporated into future releases.
MIT. See the LICENSE file for more information.
Contributors (in alphabetical order)
- Alan deLevie
- Almir Sarajčić
- Andrew T. Baker
- Cory Kaufman-Schofield
- Chris Kelly
- Chris Moos
- Christian Grobmeier
- Christopher Petersen
- David Michael Barr
- David Raffensperger
- Douglas Teoh
- Greg Karékinian
- Ian Hattendorf
- John Allison
- Jon Frisby
- Jordan White
- Justin Latimer
- László Bácsi
- Mason Turner
- Michael Bleigh
- Philip I. Thomas
- Philippe Creux
- Piotr Janik
- Rodrigo Reis
- Ross Hunter
- Shigeaki Matsumura
- Tate Johnson
- Toby Marsden
- Tom Bell
- Trevor Fitzgerald
- Zee Spencer