Skip to content

Commit 951da88

Browse files
committed
updated readme
1 parent d802446 commit 951da88

File tree

1 file changed

+25
-17
lines changed

1 file changed

+25
-17
lines changed

README.md

Lines changed: 25 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -17,25 +17,12 @@ While GeoLambda was initially intended for AWS Lambda it is also useful as a bas
1717
| 1.2.0 | 2.4.2 | Separate Python (3.7.4) image and Lambda Layer added |
1818
| 2.0.0 | 3.0.1 | libgeotiff 1.5.1, proj 6.2.0 |
1919

20-
### Docker images
21-
22-
The Docker images used to create the Lambda layer are also published to Docker Hub, and thus are also suitable for general use as a base image for geospatial applications.
23-
24-
The developmentseed/geolambda image in Docker Hub is tagged by version.
20+
#### Environment variables
2521

26-
$ docker pull developmentseed/geolambda:<version>
22+
When using GeoLambda some environment variables need to be set. These are set in the Docker image, but if using the Lambda Layer they will need to be set:
2723

28-
Or just include it in your own Dockerfile as the base image.
29-
30-
```
31-
FROM developmentseed/geolambda:<version>
32-
```
33-
34-
The GeoLambda image does not have an entrypoint defined, so a command must be provided when you run it. This example will mount the current directory to /work and run the container interactively.
35-
36-
$ docker run --rm -v $PWD:/home/geolambda -it developmentseed/geolambda:latest /bin/bash
37-
38-
All of the GDAL CLI tools are installed so could be run on images in the current directory.
24+
- GDAL_DATA=/opt/share/gdal
25+
- PROJ_LIB=/opt/share/proj (only needed for GeoLambda 2.0.0+)
3926

4027
### Lambda Layers
4128

@@ -86,6 +73,27 @@ See the [GeoLambda Python README](python/README.md). The Python Lambda Layer inc
8673
| eu-central-1 | arn:aws:lambda:eu-central-1:552188055668:layer:geolambda:1 |
8774

8875

76+
### Docker images
77+
78+
The Docker images used to create the Lambda layer are also published to Docker Hub, and thus are also suitable for general use as a base image for geospatial applications.
79+
80+
The developmentseed/geolambda image in Docker Hub is tagged by version.
81+
82+
$ docker pull developmentseed/geolambda:<version>
83+
84+
Or just include it in your own Dockerfile as the base image.
85+
86+
```
87+
FROM developmentseed/geolambda:<version>
88+
```
89+
90+
The GeoLambda image does not have an entrypoint defined, so a command must be provided when you run it. This example will mount the current directory to /work and run the container interactively.
91+
92+
$ docker run --rm -v $PWD:/home/geolambda -it developmentseed/geolambda:latest /bin/bash
93+
94+
All of the GDAL CLI tools are installed so could be run on images in the current directory.
95+
96+
8997
## Development
9098

9199
Contributions to the geolambda project are encouraged. The goal is to provide a turnkey method for developing and deploying geospatial applications to AWS. The 'master' branch in this repository contains the current state as deployed to the Docker Hub images `developmentseed/geolambda:latest` and `devlopmentseed/geolambda-python:latest`, along with a tag of the version. The 'develop' branch is the development version and is not deployed to Docker Hub.

0 commit comments

Comments
 (0)