Skip to content

Commit 9c5bbf0

Browse files
committed
add docker images info
1 parent e75fd75 commit 9c5bbf0

File tree

1 file changed

+32
-1
lines changed

1 file changed

+32
-1
lines changed

README.md

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ OGC Tiles Part 1: Core | ✅ | https://docs.ogc.org/is/20-057/2
5555

5656
Notes:
5757

58-
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.
58+
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.
5959

6060
While we tried to follow OGC specifications to the letter, some API endpoints might have more capabilities (e.g., geometry column selection).
6161

@@ -111,6 +111,37 @@ $ docker-compose up app
111111
<img width="700" src="https://github.com/developmentseed/tipg/assets/10407788/17494573-da43-4fd5-81f9-1cfb4e8c91f2">
112112
</p>
113113

114+
115+
## Docker images
116+
117+
We are publishing two different docker images on `tag` and on every commit to `main` branch:
118+
119+
| | Gunicorn | Uvicorn |
120+
| -- | -- | -- |
121+
main commit | `ghcr.io/developmentseed/tipg:latest` | `ghcr.io/developmentseed/tipg:uvicorn-latest`
122+
tags | `ghcr.io/developmentseed/tipg:0.0.0` | `ghcr.io/developmentseed/tipg:uvicorn-0.0.0`
123+
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)
124+
125+
See all version at https://github.com/developmentseed/tipg/pkgs/container/tipg
126+
127+
```
128+
# Gunicorn image
129+
$ docker run \
130+
-p 8081:8081 \
131+
-e PORT=8081 \
132+
-e DATABASE_URL=postgresql://username:[email protected]:5432/postgis \
133+
ghcr.io/developmentseed/tipg:latest
134+
135+
# or Uvicorn image
136+
$ docker run \
137+
-p 8081:8081 \
138+
-e PORT=8081 \
139+
-e DATABASE_URL=postgresql://username:[email protected]:5432/postgis \
140+
ghcr.io/developmentseed/tipg:uvicorn-latest
141+
```
142+
143+
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/).
144+
114145
## Contribution & Development
115146

116147
See [CONTRIBUTING.md](https://github.com/developmentseed/tipg/blob/main/CONTRIBUTING.md)

0 commit comments

Comments
 (0)