Skip to content

Commit c033dfb

Browse files
committed
added docs in README
1 parent 10eba9b commit c033dfb

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,18 @@ or
4343
pip install stac_fastapi.opensearch
4444
```
4545

46+
### To install and run via pre-built Docker Images
47+
48+
We provide ready-to-use Docker images through GitHub Container Registry ([ElasticSearch](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/pkgs/container/stac-fastapi-es) and [OpenSearch](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/pkgs/container/stac-fastapi-os) backends). You can easily pull and run these images:
49+
50+
```shell
51+
# For Elasticsearch backend
52+
docker pull ghcr.io/stac-utils/stac-fastapi-es:latest
53+
54+
# For OpenSearch backend
55+
docker pull ghcr.io/stac-utils/stac-fastapi-os:latest
56+
```
57+
4658
## Run Elasticsearch API backend on localhost:8080
4759

4860
You need to ensure [**Docker Compose**](https://docs.docker.com/compose/install/) or [**Podman Compose**](https://podman-desktop.io/docs/compose) installed and running on your machine. In the follwoing command instead of `docker-compose` you can use `podman-compose` as well.

0 commit comments

Comments
 (0)