Skip to content

Commit

Permalink
Updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Chris Schneider authored and Chris Schneider committed Jul 12, 2017
1 parent 6b916fd commit 03547dc
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@ Key features:
- By using KMS, access to secrets can be controlled with IAM. We recommend to create one KMS key per serverless-profile, so you can limit access to credentials to deployment privileges.
- During deployment a temporary .env file is created and uploaded to Lambda by merging and decrypting values of your environment YAML files.
- Environment variables can be loaded with *dotenv* at startup in Lambda without delays from KMS.
- Supports local development with *invoke local* and *serverless-local-dev-server* plugin.
- Supports *serverless-local-dev-server* for local development.

Please note that the uploaded *.env* file contains secrets in cleartext. Therefore we recommend to use [Serverless Crypt](https://github.com/marcy-terui/serverless-crypt) for critical secrets. This tool aims to strike a balance between storing secrets in plaintext in Lambda environment variables and having to decrypt them at runtime using KMS.

Furthermore the tool does not support environment variables generated by Serverless. We recommend to set these variables directly in each functions configuration in *serverless.yml*.

During local development variables are directly loaded into *process.env* via Serverless by overwriting the environment variables of every function. No *.env* file is created, so your local development and deployment tasks do not interfere :-)
When used with *serverless-local-dev-server* your environment variables are directly loaded into *process.env*. No *.env* file is created to make sure that your local development and deployment tasks do not interfere :-)

This package requires node >= 6.0.
Encryption is only supported for AWS due to the reliance on KMS.
Expand Down

0 comments on commit 03547dc

Please sign in to comment.