|
26 | 26 |
|
27 | 27 | - Our Api core library can be used to create custom backends. See [stac-fastapi-mongo](https://github.com/Healy-Hyperspatial/stac-fastapi-mongo) for a working example. |
28 | 28 | - Reach out on our [Gitter](https://app.gitter.im/#/room/#stac-fastapi-elasticsearch_community:gitter.im) channel or feel free to add to our [Discussions](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/discussions) page here on github. |
29 | | -- There is [Postman](https://documenter.getpostman.com/view/12888943/2s8ZDSdRHA) documentation here for examples on how to run some of the API routes locally - after starting the elasticsearch backend via the docker-compose.yml file. |
| 29 | +- There is [Postman](https://documenter.getpostman.com/view/12888943/2s8ZDSdRHA) documentation here for examples on how to run some of the API routes locally - after starting the elasticsearch backend via the compose.yml file. |
30 | 30 | - The `/examples` folder shows an example of running stac-fastapi-elasticsearch from PyPI in docker without needing any code from the repository. There is also a Postman collection here that you can load into Postman for testing the API routes. |
31 | 31 |
|
32 | 32 | - For changes, see the [Changelog](CHANGELOG.md) |
@@ -63,15 +63,15 @@ docker pull ghcr.io/stac-utils/stac-fastapi-os:latest |
63 | 63 |
|
64 | 64 | ## Run Elasticsearch API backend on localhost:8080 |
65 | 65 |
|
66 | | -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. |
| 66 | +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 following command instead of `docker compose` you can use `podman-compose` as well. |
67 | 67 |
|
68 | 68 | ```shell |
69 | | -docker-compose up elasticsearch app-elasticsearch |
| 69 | +docker compose up elasticsearch app-elasticsearch |
70 | 70 | ``` |
71 | 71 |
|
72 | | -By default, docker-compose uses Elasticsearch 8.x and OpenSearch 2.11.1. |
| 72 | +By default, Docker Compose uses Elasticsearch 8.x and OpenSearch 2.11.1. |
73 | 73 | If you wish to use a different version, put the following in a |
74 | | -file named `.env` in the same directory you run docker-compose from: |
| 74 | +file named `.env` in the same directory you run Docker Compose from: |
75 | 75 |
|
76 | 76 | ```shell |
77 | 77 | ELASTICSEARCH_VERSION=7.17.1 |
@@ -171,7 +171,7 @@ These templates will be used implicitly when creating new Collection and Item in |
171 | 171 | This section covers how to create a snapshot repository and then create and restore snapshots with this. |
172 | 172 |
|
173 | 173 | Create a snapshot repository. This puts the files in the `elasticsearch/snapshots` in this git repo clone, as |
174 | | -the elasticsearch.yml and docker-compose files create a mapping from that directory to |
| 174 | +the elasticsearch.yml and compose files create a mapping from that directory to |
175 | 175 | `/usr/share/elasticsearch/snapshots` within the Elasticsearch container and grant permissions on using it. |
176 | 176 |
|
177 | 177 | ```shell |
|
0 commit comments