Skip to content

Commit fa0b9d6

Browse files
rhysrevans3rhysrevans3
committed
Adding to README, CHANGELOG, & docker composes.
1 parent 8f8ca18 commit fa0b9d6

File tree

8 files changed

+27
-16
lines changed

8 files changed

+27
-16
lines changed

‎CHANGELOG.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
99

1010
### Changed
1111

12+
### Added
13+
14+
- Added configurable landing page ID `STAC_FASTAPI_LANDING_PAGE_ID` [#352](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/pull/352)
15+
1216
## [v3.2.4] - 2025-03-14
1317

1418
### Added

‎README.md‎

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -80,22 +80,23 @@ You can customize additional settings in your `.env` file:
8080

8181
| Variable | Description | Default | Required |
8282
|------------------------------|--------------------------------------------------------------------------------------|--------------------------|---------------------------------------------------------------------------------------------|
83-
| `ES_HOST` | Hostname for external Elasticsearch/OpenSearch. | `localhost` | Optional |
84-
| `ES_PORT` | Port for Elasticsearch/OpenSearch. | `9200` (ES) / `9202` (OS)| Optional |
85-
| `ES_USE_SSL` | Use SSL for connecting to Elasticsearch/OpenSearch. | `false` | Optional |
86-
| `ES_VERIFY_CERTS` | Verify SSL certificates when connecting. | `false` | Optional |
87-
| `STAC_FASTAPI_TITLE` | Title of the API in the documentation. | `stac-fastapi-elasticsearch` or `stac-fastapi-opensearch` | Optional |
88-
| `STAC_FASTAPI_DESCRIPTION` | Description of the API in the documentation. | N/A | Optional |
89-
| `STAC_FASTAPI_VERSION` | API version. | `2.1` | Optional |
90-
| `APP_HOST` | Server bind address. | `0.0.0.0` | Optional |
91-
| `APP_PORT` | Server port. | `8080` | Optional |
92-
| `ENVIRONMENT` | Runtime environment. | `local` | Optional |
93-
| `WEB_CONCURRENCY` | Number of worker processes. | `10` | Optional |
94-
| `RELOAD` | Enable auto-reload for development. | `true` | Optional |
95-
| `STAC_FASTAPI_RATE_LIMIT` | API rate limit per client. | `200/minute` | Optional |
96-
| `BACKEND` | Tests-related variable | `elasticsearch` or `opensearch` based on the backend | Optional |
97-
| `ELASTICSEARCH_VERSION` | ElasticSearch version | `7.17.1` | Optional |
98-
| `OPENSEARCH_VERSION` | OpenSearch version | `2.11.0` | Optional |
83+
| `ES_HOST` | Hostname for external Elasticsearch/OpenSearch. | `localhost` | Optional |
84+
| `ES_PORT` | Port for Elasticsearch/OpenSearch. | `9200` (ES) / `9202` (OS)| Optional |
85+
| `ES_USE_SSL` | Use SSL for connecting to Elasticsearch/OpenSearch. | `false` | Optional |
86+
| `ES_VERIFY_CERTS` | Verify SSL certificates when connecting. | `false` | Optional |
87+
| `STAC_FASTAPI_TITLE` | Title of the API in the documentation. | `stac-fastapi-elasticsearch` or `stac-fastapi-opensearch` | Optional |
88+
| `STAC_FASTAPI_DESCRIPTION` | Description of the API in the documentation. | N/A | Optional |
89+
| `STAC_FASTAPI_VERSION` | API version. | `2.1` | Optional |
90+
| `STAC_FASTAPI_LANDING_PAGE_ID` | Landing page ID | `stac-fastapi` | Optional |
91+
| `APP_HOST` | Server bind address. | `0.0.0.0` | Optional |
92+
| `APP_PORT` | Server port. | `8080` | Optional |
93+
| `ENVIRONMENT` | Runtime environment. | `local` | Optional |
94+
| `WEB_CONCURRENCY` | Number of worker processes. | `10` | Optional |
95+
| `RELOAD` | Enable auto-reload for development. | `true` | Optional |
96+
| `STAC_FASTAPI_RATE_LIMIT` | API rate limit per client. | `200/minute` | Optional |
97+
| `BACKEND` | Tests-related variable | `elasticsearch` or `opensearch` based on the backend | Optional |
98+
| `ELASTICSEARCH_VERSION` | ElasticSearch version | `7.17.1` | Optional |
99+
| `OPENSEARCH_VERSION` | OpenSearch version | `2.11.0` | Optional |
99100

100101
> [!NOTE]
101102
> The variables `ES_HOST`, `ES_PORT`, `ES_USE_SSL`, and `ES_VERIFY_CERTS` apply to both Elasticsearch and OpenSearch backends, so there is no need to rename the key names to `OS_` even if you're using OpenSearch.

‎docker-compose.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ services:
1212
- STAC_FASTAPI_TITLE=stac-fastapi-elasticsearch
1313
- STAC_FASTAPI_DESCRIPTION=A STAC FastAPI with an Elasticsearch backend
1414
- STAC_FASTAPI_VERSION=2.1
15+
- STAC_FASTAPI_LANDING_PAGE_ID=stac-fastapi-elasticsearch
1516
- APP_HOST=0.0.0.0
1617
- APP_PORT=8080
1718
- RELOAD=true

‎examples/auth/docker-compose.basic_auth.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ services:
1212
- STAC_FASTAPI_TITLE=stac-fastapi-elasticsearch
1313
- STAC_FASTAPI_DESCRIPTION=A STAC FastAPI with an Elasticsearch backend
1414
- STAC_FASTAPI_VERSION=3.0.0a2
15+
- STAC_FASTAPI_LANDING_PAGE_ID=stac-fastapi-elasticsearch
1516
- APP_HOST=0.0.0.0
1617
- APP_PORT=8080
1718
- RELOAD=true

‎examples/auth/docker-compose.oauth2.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ services:
1212
- STAC_FASTAPI_TITLE=stac-fastapi-elasticsearch
1313
- STAC_FASTAPI_DESCRIPTION=A STAC FastAPI with an Elasticsearch backend
1414
- STAC_FASTAPI_VERSION=3.0.0a1
15+
- STAC_FASTAPI_LANDING_PAGE_ID=stac-fastapi-elasticsearch
1516
- APP_HOST=0.0.0.0
1617
- APP_PORT=8080
1718
- RELOAD=true

‎examples/auth/docker-compose.route_dependencies.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ services:
1212
- STAC_FASTAPI_TITLE=stac-fastapi-elasticsearch
1313
- STAC_FASTAPI_DESCRIPTION=A STAC FastAPI with an Elasticsearch backend
1414
- STAC_FASTAPI_VERSION=3.0.0a2
15+
- STAC_FASTAPI_LANDING_PAGE_ID=stac-fastapi-elasticsearch
1516
- APP_HOST=0.0.0.0
1617
- APP_PORT=8080
1718
- RELOAD=true

‎examples/pip_docker/docker-compose.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ services:
1919
- ES_PORT=9200
2020
- ES_USE_SSL=false
2121
- ES_VERIFY_CERTS=false
22+
- STAC_FASTAPI_LANDING_PAGE_ID=stac-fastapi-elasticsearch
2223
ports:
2324
- "8080:8080"
2425
volumes:

‎examples/rate_limit/docker-compose.rate_limit.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ services:
1212
- STAC_FASTAPI_TITLE=stac-fastapi-elasticsearch
1313
- STAC_FASTAPI_DESCRIPTION=A STAC FastAPI with an Elasticsearch backend
1414
- STAC_FASTAPI_VERSION=2.1
15+
- STAC_FASTAPI_LANDING_PAGE_ID=stac-fastapi-elasticsearch
1516
- APP_HOST=0.0.0.0
1617
- APP_PORT=8080
1718
- RELOAD=true

0 commit comments

Comments
 (0)