Skip to content

Commit b22cc58

Browse files
committed
Bump README
1 parent b1f3c38 commit b22cc58

File tree

1 file changed

+2
-39
lines changed

1 file changed

+2
-39
lines changed

README.md

Lines changed: 2 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,13 @@
22

33
This repository provides a lightweight Docker image to emulate **AWS Lambda Function URLs** locally. It uses **AWS Lambda Runtime Interface Emulator (RIE)** to replicate the behavior of Function URLs for local development and testing.
44

5-
---
6-
75
## Features
86

97
- Emulates **AWS Lambda Function URLs** locally.
108
- Automatically forwards HTTP requests to a locally running Lambda function using the AWS Lambda Runtime Interface Emulator.
119
- Supports `APIGatewayProxyEventV2` for HTTP API requests.
1210
- Handles `isBase64Encoded` for binary data.
1311

14-
---
15-
1612
## Getting Started
1713

1814
### Pull the Docker Image
@@ -31,47 +27,16 @@ docker run --rm -p 8080:8080 \
3127

3228
The emulator will be available at `http://localhost:8080`.
3329

34-
---
35-
36-
## Usage
37-
38-
1. **Start the Emulator**
39-
40-
Run the Docker container as described above.
41-
42-
2. **Start a Local Lambda Function with RIE**
43-
44-
Use **AWS Lambda Runtime Interface Emulator (RIE)** to run your Lambda function locally. Example:
45-
46-
```bash
47-
docker run --rm -v $(pwd):/var/task \
48-
-p 9000:8080 \
49-
amazon/aws-lambda-nodejs:20 \
50-
node index.js
51-
```
30+
### Use Docker Compose to work with RIE
5231

53-
Replace `node index.js` with your Lambda handler code.
54-
55-
3. **Send a Request to the Emulator**
56-
57-
Use `curl`, Postman, or any HTTP client to test your Lambda function through the emulator.
58-
59-
Example:
60-
61-
```bash
62-
curl http://localhost:8080/?key=example-file.txt
63-
```
64-
65-
---
32+
For a practical example of integrating this emulator with RIE using Docker Compose, refer to the [example](./example/) directory.
6633

6734
## Environment Variables
6835

6936
| Variable | Description | Default Value |
7037
| -------------- | --------------------------------------------------- | ----------------------------------------------------------------- |
7138
| `RIE_ENDPOINT` | URL for the Lambda Runtime Interface Emulator (RIE) | `http://localhost:8080/2015-03-31/functions/function/invocations` |
7239

73-
---
74-
7540
## Build the Docker Image Locally
7641

7742
If you want to build the Docker image yourself:
@@ -80,8 +45,6 @@ If you want to build the Docker image yourself:
8045
docker build -t aws-lambda-function-url-emulator .
8146
```
8247

83-
---
84-
8548
## License
8649

8750
This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for details.

0 commit comments

Comments
 (0)