Skip to content

Commit b38f04a

Browse files
committed
README usage updates [skip ci]
1 parent a97cc87 commit b38f04a

File tree

1 file changed

+34
-1
lines changed

1 file changed

+34
-1
lines changed

README.md

+34-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,37 @@
1-
# aws-lambda-runtime-local [ ![](https://img.shields.io/circleci/project/github/rdbatch02/lambda-runtime-kotlin-native/master.svg?style=flat) ](https://circleci.com/gh/rdbatch02/aws-lambda-runtime-local)
1+
# AWS Lambda Custom Runtime Local API [ ![](https://img.shields.io/circleci/project/github/rdbatch02/lambda-runtime-kotlin-native/master.svg?style=flat) ](https://circleci.com/gh/rdbatch02/aws-lambda-runtime-local)
22
AWS Lambda Runtime API for local testing of custom runtimes
33

44
This project runs an HTTP API that is intended to emulate the [AWS Lambda Runtime Interface](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-api.html) to enable local testing of custom runtimes.
5+
6+
## Usage
7+
8+
This utility is published as both a jar or Docker image.
9+
10+
### Jar
11+
Prerequisites:
12+
* JRE/JDK 11
13+
14+
Grab the [latest release](https://github.com/rdbatch02/aws-lambda-runtime-local/releases) and run:
15+
16+
```bash
17+
java -jar aws-lambda-runtime-local-<version>.jar
18+
```
19+
20+
Run on alternate port
21+
22+
```bash
23+
java -jar -Druntime.port=8080 aws-lambda-runtime-local-<version>.jar
24+
```
25+
26+
### Docker
27+
Dockerhub Link: [https://hub.docker.com/r/c1phr/aws-lambda-runtime-local](https://hub.docker.com/r/c1phr/aws-lambda-runtime-local)
28+
29+
```bash
30+
docker run -p 9000:9000 c1phr/aws-lambda-runtime-local -p
31+
```
32+
33+
Run on alternate port
34+
35+
```bash
36+
docker run -p 8080:8080 -e RUNTIME_PORT=8080 c1phr/aws-lambda-runtime-local
37+
```

0 commit comments

Comments
 (0)