chore: AWS env variables and introduction to nginx lambda gateway

Author: shawnhankim

README.md

@@ -2,10 +2,21 @@
 
 ## Introduction
 
+This project provides a working configuration of NGINX configured to act as an authenticating gateway for to AWS Lambda service. This allows you to proxy a private Lambda function without requiring users to authenticate to it. Within the proxy layer, additional functionality can be configured such as:
+
+- Providing an authentication gateway using an alternative authentication
+   system to Lambda functions
+- For internal/micro services that can't authenticate against the Lambda functions
+   (e.g. don't have libraries available) the gateway can provide a means
+   to accessing Lambda functions without authentication
+- Protecting Lambda function from arbitrary public access and traversal
+- Rate limiting Lambda functions
+- Protecting Lambda functions with a [WAF](https://docs.nginx.com/nginx-waf/)
+
+
 ## Getting Started
 
-Refer to the [Getting Started Guide](docs/getting_started.md) for how to build
-and run the gateway.
+Refer to the [Getting Started Guide](docs/getting_started.md) for how to build and run the gateway.
 
 ## Directory Structure and File Descriptions
 

docker-compose.yml

@@ -17,4 +17,4 @@ services:
     ports:
       - "80:80"
     env_file:
-      - settings.test
+      - settings.env

docs/development.md

@@ -0,0 +1 @@
+# Development Guide

docs/getting_started.md

@@ -0,0 +1,8 @@
+# Getting Started Guide
+
+- Create a AWS Lambda Function
+- Configure Environment Variables
+- Start a NGINX Lambda Gateway
+- Stop a NGINX Lambda Gateway
+- Clean a NGINX Lambda Gateway Container Image
+

examples/01-all-lambda-function-arns/docker-compose.yml

@@ -17,4 +17,4 @@ services:
     ports:
       - "80:80"
     env_file:
-      - ../../settings.test
+      - ../../settings.env

examples/02-one-lambda-function-arn/docker-compose.yml

@@ -17,4 +17,4 @@ services:
     ports:
       - "80:80"
     env_file:
-      - ../../settings.test
+      - ../../settings.env

examples/03-one-lambda-function-url/docker-compose.yml

@@ -17,4 +17,4 @@ services:
     ports:
       - "80:80"
     env_file:
-      - ../../settings.test
+      - ../../settings.env

examples/04-lambda-function-arn-and-url/docker-compose.yml

@@ -17,4 +17,4 @@ services:
     ports:
       - "80:80"
     env_file:
-      - ../../settings.test
+      - ../../settings.env

settings.env

@@ -1,6 +1,6 @@
-AWS_ACCESS_KEY_ID=ZZZZZZZZZZZZZZZZZZZZ
-AWS_SECRET_ACCESS_KEY=aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
-AWS_SESSION_TOKEN=bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb
+AWS_ACCESS_KEY_ID=${AWS_ACCESS_KEY_ID}
+AWS_SECRET_ACCESS_KEY=${AWS_SECRET_ACCESS_KEY}
+AWS_SESSION_TOKEN=${AWS_SESSION_TOKEN}
 DEBUG=false
 HEADER_PREFIXES_TO_STRIP=false
 LAMBDA_REGION=us-east-2