Skip to content

Commit c2f8df5

Browse files
committed
update readme
1 parent d2af923 commit c2f8df5

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626

2727
- 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.
2828
- 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.
3030
- 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.
3131

3232
- For changes, see the [Changelog](CHANGELOG.md)
@@ -63,15 +63,15 @@ docker pull ghcr.io/stac-utils/stac-fastapi-os:latest
6363

6464
## Run Elasticsearch API backend on localhost:8080
6565

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.
6767

6868
```shell
69-
docker-compose up elasticsearch app-elasticsearch
69+
docker compose up elasticsearch app-elasticsearch
7070
```
7171

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.
7373
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:
7575

7676
```shell
7777
ELASTICSEARCH_VERSION=7.17.1
@@ -171,7 +171,7 @@ These templates will be used implicitly when creating new Collection and Item in
171171
This section covers how to create a snapshot repository and then create and restore snapshots with this.
172172

173173
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
175175
`/usr/share/elasticsearch/snapshots` within the Elasticsearch container and grant permissions on using it.
176176

177177
```shell

0 commit comments

Comments
 (0)