Install
Install with npm:
npm install ts-s3-publish --save-devRequired params
| Attribute | Description |
|---|---|
BUCKET |
Name of the bucket in S3 |
KEY |
User's key hash |
SECRET |
User's secret hash |
Optional params
| Attribute | Default | Description |
|---|---|---|
UPLOAD_FOLDER |
. (root)
|
Name of the folder from current working directory |
AWS_FOLDER |
public |
Name of the folder to upload the files to in S3 Bucket (. for root)
|
NO_CACHE_LIST |
index.html,robots.txt (comma separated list)
|
Names of the files that will have the header CacheControl set to max-age=0
|
IGNORE_LIST |
Thumbs.db,.DS_Store (comma separated list)
|
Names of the files that will be ignored when uploading |
PURGE_CACHE |
false |
If set to true, will create a Cloudfront Invalidation (User needs to have access to: cloudfront:CreateInvalidation) |
PURGE_PATHS* |
/* (comma separated list, wildcards allowed)
|
Object paths to purge cache for Invalidation Paths (Amazon AWS Docs) |
DISTRIBUTION_ID* |
null | If not provided, will use the BUCKET name to find the Distribution ID using distribution aliases (User needs to have access to: cloudfront:ListDistributions)
|
*Only applicable if
PURGE_CACHEis set to true.
Usage
BUCKET=BUCKET_NAME KEY=KEY SECRET=SECRET ts-s3-publish
Change log
- 1.1.7 -
UPLOAD_FOLDERnow supports single files. - 1.1.8 -
UPLOAD_FOLDERnow supports wildcard to upload multiple files. eg: `target/filename*.war'