Skip to content

Commit

Permalink
📝 update readme on error checking
Browse files Browse the repository at this point in the history
  • Loading branch information
jdub233 committed Jun 18, 2020
1 parent 1cd6473 commit 1e3ae0d
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ For example, capturing the home page at `www.bu.edu` will also pull in and relin

The lambda is triggered by a secure API gateway interface using an API key.

The function includes error checking, and will cancel downloads on any assets that do not return a status code 200 (OK). If the root page capture fails, the entire capture is cancelled and no changes will be made to the current contents of the S3 bucket.

## How to configure

The capture URL, S3 bucket name, and S3 bucket path are configurable by setting values in a `config.yml` file. Also, the captured assets can be stored in a separate subdirectory, if one is specified in the config.
Expand Down

0 comments on commit 1e3ae0d

Please sign in to comment.