Skip to content

Commit 3bd6290

Browse files
readme
1 parent 5b9c8fb commit 3bd6290

File tree

2 files changed

+19
-6
lines changed

2 files changed

+19
-6
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,22 @@ python -m stac_auth_proxy
4646
uvicorn --factory stac_auth_proxy:create_app
4747
```
4848

49+
### Docker compose
50+
51+
Run all of the services required to run the application locally including the a database, STAC API, and Mock OICD provider using Docker compose.
52+
The application can be run with [stac-fastapi-pgstac](https://github.com/stac-utils/stac-fastapi-pgstac) or with [stac-fastapi-elasticsearch-opensearch](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch)
53+
54+
Spin up the application stack for Opensearch with
55+
```sh
56+
UPSTREAM_URL=http://stac-os:8001 docker compose --profile os up
57+
```
58+
59+
and for pgstac with
60+
```sh
61+
UPSTREAM_URL=http://stac-pg:8001 docker compose --profile pg up
62+
```
63+
64+
4965
### Installation
5066

5167
For local development, we use [`uv`](https://docs.astral.sh/uv/) to manage project dependencies and environment.

docker-compose.yaml

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ services:
1111
POSTGRES_USER: username
1212
POSTGRES_PASS: password
1313
POSTGRES_DBNAME: postgis
14-
POSTGRES_HOST_READER: database
15-
POSTGRES_HOST_WRITER: database
14+
POSTGRES_HOST_READER: database-pg
15+
POSTGRES_HOST_WRITER: database-pg
1616
POSTGRES_PORT: 5432
1717
WEB_CONCURRENCY: 10
1818
VSI_CACHE: TRUE
@@ -58,6 +58,7 @@ services:
5858

5959
database-pg:
6060
profiles: ["pg"]
61+
container_name: database-pg
6162
image: ghcr.io/stac-utils/pgstac:v0.9.5
6263
environment:
6364
POSTGRES_USER: username
@@ -114,7 +115,3 @@ services:
114115
PORT: 8888
115116
ports:
116117
- "8888:8888"
117-
118-
networks:
119-
eoapi-network:
120-
name: eoapi-network

0 commit comments

Comments
 (0)