Skip to content

Commit

Permalink
Merge branch 'develop' of github.com:DieProduktMacher/serverless-env-…
Browse files Browse the repository at this point in the history
…generator into develop
  • Loading branch information
Chris Schneider authored and Chris Schneider committed Aug 8, 2017
2 parents 10253b8 + 0d6d83d commit a34b0b7
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,10 @@ Serverless Env Generator Plugin

This plugin automatically creates a *.env* file during deployment by merging environment variables from one or more YAML files. During runtime these variables can then be loaded into *process.env* using *dotenv*.

Key features:
For a brief introduction, read our blogpost about [introducing serverless-env-generator](http://www.dieproduktmacher.com/introducing-serverless-env-generator/).


### Key features:

- Support for multi-stage configurations and custom profiles
- Value of environment variables can be encrypted with AWS KMS, allowing teams to manage sensitive information in git.
Expand All @@ -14,14 +17,17 @@ Key features:
- Environment variables can be loaded with *dotenv* at startup in Lambda without delays from KMS.
- Supports *serverless-local-dev-server* for local development.


### Notes

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*.

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.
Due to the reliance on KMS, encryption is only supported for AWS.


# Table of Contents
Expand Down

0 comments on commit a34b0b7

Please sign in to comment.