Skip to content

Commit 202acf4

Browse files
committed
Update project README file
1 parent 18db394 commit 202acf4

File tree

1 file changed

+12
-11
lines changed

1 file changed

+12
-11
lines changed

README.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,28 @@
1-
# AWS Lambda Adapter
1+
# AWS Lambda Web Adapter
22

33
A tool to run web applications on AWS Lambda
44

5-
AWS Lambda Adapter allows you to build web app (http api) with familiar frameworks (e.g. Express.js, Flask, SpringBoot, and Laravel, anything speaks HTTP 1.1/1.0) and run it on AWS Lambda.
6-
The exact same docker image can run on AWS Lambda, Amazon EC2, AWS Fargate, and local computers.
5+
AWS Lambda Web Adapter allows developers to build web app (http api) with familiar frameworks (e.g. Express.js, Flask, SpringBoot, and Laravel, anything speaks HTTP 1.1/1.0) and run it on AWS Lambda.
6+
The same docker image can run on AWS Lambda, Amazon EC2, AWS Fargate, and local computers.
77

8-
AWS Lambda adapter is developed as a Lambda extension (since v0.2.0). For details, checkout its [design](docs/design.md) and [development](docs/development.md) documents.
8+
AWS Lambda Web Adapter is developed as a Lambda extension (since v0.2.0). For details, checkout its [design](docs/design.md) and [development](docs/development.md) documents.
99

10-
![Lambda Adapter](docs/images/lambda-adapter-overview.png)
10+
![Lambda Web Adapter](docs/images/lambda-adapter-overview.png)
1111

1212
## Usage
1313

14-
AWS Lambda Adapter work with Lambda functions packaged as both docker images and Zip packages.
14+
AWS Lambda Web Adapter work with Lambda functions packaged as both docker images and Zip packages.
1515

1616
### Lambda functions packaged as Docker Images or OCI Images
1717

18-
To use Lambda Adapter with docker images, package your web app (http api) in a Dockerfile, and add one line to copy Lambda Adapter binary to /opt/extensions inside your container.
19-
By default, Lambda Adapter assumes the web app is listening on port 8080. If not, you can specify the port via [configuration](#Configurations).
18+
To use Lambda Web Adapter with docker images, package your web app (http api) in a Dockerfile, and add one line to copy Lambda Web Adapter binary to /opt/extensions inside your container.
19+
By default, Lambda Web Adapter assumes the web app is listening on port 8080. If not, you can specify the port via [configuration](#Configurations).
2020

2121
```dockerfile
2222
COPY --from=public.ecr.aws/awsguru/aws-lambda-adapter:0.3.2 /lambda-adapter /opt/extensions/lambda-adapter
2323
```
2424

25-
Pre-compiled Lambda Adapter binaries are provided in ECR public repo: [public.ecr.aws/awsguru/aws-lambda-adapter](https://gallery.ecr.aws/awsguru/aws-lambda-adapter).
25+
Pre-compiled Lambda Web Adapter binaries are provided in ECR public repo: [public.ecr.aws/awsguru/aws-lambda-adapter](https://gallery.ecr.aws/awsguru/aws-lambda-adapter).
2626
Multi-arch images are also provided in this repo. It works on both x86_64 and arm64 CPU architecture.
2727

2828
Below is a Dockerfile for [an example nodejs application](examples/expressjs).
@@ -43,9 +43,9 @@ This works with any base images except AWS managed base images. To use AWS manag
4343

4444
### Lambda functions packaged as Zip package for AWS managed runtimes
4545

46-
AWS Lambda Adapter also works with AWS managed Lambda runtimes. You need to do three things:
46+
AWS Lambda Web Adapter also works with AWS managed Lambda runtimes. You need to do three things:
4747

48-
1. attach Lambda Adapter layer to your function.
48+
1. attach Lambda Web Adapter layer to your function.
4949
1. x86_64: `arn:aws:lambda:${AWS::Region}:753240598075:layer:LambdaAdapterLayerX86:2`
5050
2. arm64: `arn:aws:lambda:${AWS::Region}:753240598075:layer:LambdaAdapterLayerArm64:2`
5151
2. configure Lambda environment variable `AWS_LAMBDA_EXEC_WRAPPER` to `/opt/bootstrap`.
@@ -76,6 +76,7 @@ Use REMOVE_BASE_PATH to remove the /orders prefix when routing requests to the a
7676
- [Express.js](examples/expressjs)
7777
- [Express.js in Zip](examples/expressjs-zip)
7878
- [SpringBoot](examples/springboot)
79+
- [SpringBoot in Zip](examples/springboot-zip)
7980
- [nginx](examples/nginx)
8081
- [php](examples/php)
8182

0 commit comments

Comments
 (0)