README.md in s3_website-3.0.0 vs README.md in s3_website-3.1.0
- old
+ new
@@ -64,20 +64,20 @@
(If you are using `s3_website` on an [EC2 instance with IAM
roles](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UsingIAM.html#UsingIAMrolesWithAmazonEC2Instances),
you can omit the `s3_id` and `s3_secret` keys in the config file.)
-S3_website implements supports for reading environment variables from a file using
+S3_website implements support for reading environment variables from a file using
the [dotenv](https://github.com/bkeepers/dotenv) gem. You can create a `.env` file
in the project's root directory to take advantage of this feature. Please have
a look at [dotenv's usage guide](https://github.com/bkeepers/dotenv#usage) for
syntax information.
Your `.env` file should containing the following variables:
- AWS_ACCESS_KEY_ID=FOO
- AWS_SECRET_ACCESS_KEY=BAR
+ S3_ID=FOO
+ S3_SECRET=BAR
## Project goals
* Provide a command-line interface tool for deploying and managing S3 websites
* Let the user have all the S3 website configurations in a file
@@ -283,15 +283,15 @@
For example, like this you can define a your own TTL and CNAME:
```yaml
cloudfront_distribution_config:
default_cache_behavior:
- min_TTL: <%= 60 * 60 * 24 %>
+ min_ttl: <%= 60 * 60 * 24 %>
aliases:
quantity: 1
items:
- CNAME: your.website.com
+ - your.website.com
```
Once you've saved the configuration into `s3_website.yml`, you can apply them by
running `s3_website cfg apply`.
@@ -444,10 +444,20 @@
```yaml
s3_key_prefix: your-subdirectory
```
+### Temporary security credentials with Session Token
+
+[AWS temporary security credentials](http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html) (eg: when [assuming IAM roles](http://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html))
+
+Usage:
+
+```yaml
+session_token: your-token
+```
+
## Migrating from v1 to v2
Please read the [release note](/changelog.md#200) on version 2. It contains
information on backward incompatible changes.
@@ -524,10 +534,10 @@
## Community articles
* [Deploying websites to FTP or Amazon S3 with BitBucket Pipelines](https://www.savjee.be/2016/06/Deploying-website-to-ftp-or-amazon-s3-with-BitBucket-Pipelines/)
* [How To: Hosting on Amazon S3 with CloudFront](https://paulstamatiou.com/hosting-on-amazon-s3-with-cloudfront/)
-* [PageSpeed 100 with Jekyll, S3 and CloudFront](https://habd.as/pagespeed-100-with-jekyll-s3-and-cloudfront/)
+* [Zero to HTTP/2 with AWS and Hugo](https://habd.as/zero-to-http-2-aws-hugo/)
## Donations
[](https://www.gittip.com/laurilehmijoki/)