From 9c5bbf0f3c70f247ea30f343917678c163218481 Mon Sep 17 00:00:00 2001 From: vincentsarago Date: Mon, 9 Oct 2023 15:30:55 +0200 Subject: [PATCH] add docker images info --- README.md | 33 ++++++++++++++++++++++++++++++++- 1 file changed, 32 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index cbf589b3..64c16c2b 100644 --- a/README.md +++ b/README.md @@ -55,7 +55,7 @@ OGC Tiles Part 1: Core | ✅ | https://docs.ogc.org/is/20-057/2 Notes: -We chose to avoid implementing the second part of the specification to prevent the introduction of CRS-based GeoJSON. We may review this decision in the future. +We chose to avoid implementing the second part of the specification to prevent the introduction of CRS-based GeoJSON. We may review this decision in the future. While we tried to follow OGC specifications to the letter, some API endpoints might have more capabilities (e.g., geometry column selection). @@ -111,6 +111,37 @@ $ docker-compose up app

+ +## Docker images + +We are publishing two different docker images on `tag` and on every commit to `main` branch: + +| | Gunicorn | Uvicorn | +| -- | -- | -- | +main commit | `ghcr.io/developmentseed/tipg:latest` | `ghcr.io/developmentseed/tipg:uvicorn-latest` +tags | `ghcr.io/developmentseed/tipg:0.0.0` | `ghcr.io/developmentseed/tipg:uvicorn-0.0.0` +dockerfile | [/dockerfiles/Dockerfile.gunicorn](https://github.com/developmentseed/tipg/blob/main/dockerfiles/Dockerfile.gunicorn) | [/dockerfiles/Dockerfile.uvicorn](https://github.com/developmentseed/tipg/blob/main/dockerfiles/Dockerfile.uvicorn) + +See all version at https://github.com/developmentseed/tipg/pkgs/container/tipg + +``` +# Gunicorn image +$ docker run \ + -p 8081:8081 \ + -e PORT=8081 \ + -e DATABASE_URL=postgresql://username:password@0.0.0.0:5432/postgis \ + ghcr.io/developmentseed/tipg:latest + +# or Uvicorn image +$ docker run \ + -p 8081:8081 \ + -e PORT=8081 \ + -e DATABASE_URL=postgresql://username:password@0.0.0.0:5432/postgis \ + ghcr.io/developmentseed/tipg:uvicorn-latest +``` + +Note: If you are planning to use the docker image in a kubernetes deployment you may want to use the `uvicorn` image (ref: https://fastapi.tiangolo.com/deployment/server-workers/). + ## Contribution & Development See [CONTRIBUTING.md](https://github.com/developmentseed/tipg/blob/main/CONTRIBUTING.md)