@maxletou/ngx-aws-deploy
v4.2.5
Published
Deploy an Angular app to Amazon S3 directly from the Angular CLI
Downloads
3
Maintainers
Readme
Disclaimer: This is a temporary fork from @jefiozie/ngx-aws-deploy <-- use this instead
This temporary fork adds the new feature waiting to be merged in the original repo, linked below and described at step #7 of the Quick Start documentation below.
add a globFileUploadParamsList option to set properties on uploaded files
NGX-AWS-DEPLOY
☁️🚀 Deploy your Angular app to Amazon S3 directly from the Angular CLI 🚀☁️
Quick Start
Install the latest version of Angular cli
yarn global add @angular/cli
Create a new Angular project
ng new hello-world --defaults cd hello-world
Add
@jefiozie/ngx-aws-deploy
to your projectng add @jefiozie/ngx-aws-deploy
After these steps your
angular.json
is updated with a new builder:"deploy": { "builder": "@jefiozie/ngx-aws-deploy:deploy", "options": {} }
Due to security risk we have made the decision to never add any options to the
angular.json
. You should set the environments variable during theng deploy
command. Below is an example on how you could do this.
npx cross-env NG_DEPLOY_AWS_ACCESS_KEY_ID=1234 NG_DEPLOY_AWS_SECRET_ACCESS_KEY=321ACCESS NG_DEPLOY_AWS_BUCKET=mys3bucket NG_DEPLOY_AWS_REGION=eu-1-region NG_DEPLOY_AWS_SUB_FOLDER=path/on/bucker ng deploy
- To trigger an optional invalidation of the files in an AWS CloudFront distribution, add these parameters to the above command line:
npx cross-env ... NG_DEPLOY_AWS_CF_DISTRIBUTION_ID=1234 ... ng deploy
- To apply properties on uploaded files, use the
NG_DEPLOY_AWS_GLOB_FILE_UPLOAD_PARAMS_LIST
variable or the target optionglobFileUploadParamsList
as shown below.
We use an array of objects to represent the different configurations.
Each config object needs aglob
property to define on which files the params will be set.
Other properties on the config object are the params to apply. For informations about the possible params (ACL, Bucket, CacheControl, etc), checkout the documentation of thes3.upload
method (https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html#upload-property)
"deploy": {
"builder": "@jefiozie/ngx-aws-deploy:deploy",
"options": {
"globFileUploadParamsList": [
{
"glob": "*",
"ACL": "public-read",
"CacheControl": "max-age=3600"
},
{
"glob": "*.html",
"CacheControl": "max-age=300"
}
]
}
},
The order of the config objects matters, the one that comes last is the one that will be used, as shown above:
- CacheControl is set for all files but it's overidden by the next config object only for html files. Convenient for declaring exceptions and not repeat global settings.
To set this using the environment variable NG_DEPLOY_AWS_GLOB_FILE_UPLOAD_PARAMS_LIST
, simply stringify the config object to JSON with JSON.stringify
.
npx cross-env ... NG_DEPLOY_AWS_GLOB_FILE_UPLOAD_PARAMS_LIST='[{"glob":"*","ACL":"public-read","CacheControl":"max-age=3600"},{"glob":"*.html","CacheControl":"max-age=300"}]' ... ng deploy
- Run
ng deploy
to deploy your application to Amazon S3.
🚀**Happy deploying!** 🚀
Security 🔑
Keep in mind that with the default config, everybody that has access to the angular.json will have your aws secret.
If you want more security, you can also use environment variable with NG_DEPLOY_AWS_ACCESS_KEY_ID
, NG_DEPLOY_AWS_SECRET_ACCESS_KEY
, NG_DEPLOY_AWS_BUCKET
and NG_DEPLOY_AWS_REGION
.
Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
The builder is located in the libs\ngx-aws-deploy
folder.
The sample app is located in the apps\demo-app
folder.
Please make sure to update tests as appropriate.
License
Contributors ✨
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!