Skip to content

Commit 32bc53f

Browse files
committed
Add usage instructions to README
1 parent 0021c07 commit 32bc53f

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,35 @@ Committed alongside the Dockerfiles in the branches are the tarballs, which ball
2525

2626
Although we force-push the files away, the older versions of our images remain present on DockerHub and Amazon ECR.
2727

28+
## Usage
29+
30+
### Requirements
31+
To re-create the AWS Lambda base images, make sure you have the following pre-requisites set up:
32+
- [git](https://git-scm.com/downloads)
33+
- [git-lfs](https://git-lfs.github.com/)
34+
- [docker](https://docs.docker.com/get-docker/)
35+
36+
### Building an image
37+
First, clone this repository:
38+
```
39+
git clone https://github.com/aws/aws-lambda-base-images
40+
```
41+
42+
Then, checkout the branch relevant to the Lambda base image you want to build.
43+
44+
eg. to build the `nodejs12.x` image, start by checking out the `nodejs12.x` branch:
45+
```
46+
git checkout nodejs12.x
47+
```
48+
49+
Finally you can build your image as such:
50+
```
51+
docker build -t nodejs12.x:local -f Dockerfile.nodejs12.x .
52+
```
53+
54+
This will use the Dockerfile at `Dockerfile.nodejs12.x` and tag the newly-built image as `nodejs12.x:local`.
55+
56+
2857
## Licence
2958

3059
This project is licensed under the Apache-2.0 License.

0 commit comments

Comments
 (0)