Skip to content

Commit 970f65e

Browse files
BBrixenBennett Patrick Brixenjonhealy1
authored
update ES env variable documentation (#410)
fixes incorrect or missing documentation for ES_USE_SSL, ES_VERIFY_CERTS, and ES_API_KEY **Description:** - README.md documentation has incorrect default values for ES_USE_SSL and ES_VERIFY_CERTS - The default values that are used can be found at: `./stac_fastapi/elasticsearch/stac_fastapi/elasticsearch/config.py` and `./stac_fastapi/opensearch/stac_fastapi/opensearch/config.py` - Adds documentation for ES_API_KEY **PR Checklist:** - [X] Code is formatted and linted (run `pre-commit run --all-files`) - [X] Tests pass (run `make test`) - [X] Documentation has been updated to reflect changes, if applicable - [X] Changes are added to the changelog --------- Co-authored-by: Bennett Patrick Brixen <bpbrixe@sandia.gov> Co-authored-by: Jonathan Healy <jonathan.d.healy@gmail.com>
1 parent 90fd9ca commit 970f65e

File tree

2 files changed

+6
-3
lines changed

2 files changed

+6
-3
lines changed

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
1515
### Changed
1616

1717
- Updated collection to index logic to support searching a large amount of indices [#412](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/pull/412)
18+
- Updated documentation to reflect use of ES environment variables [#410](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/pull/410)
19+
- Updated documentation to reflect `APP_PORT` in [stac-fastapi-core ApiSettings](https://github.com/stac-utils/stac-fastapi/blob/fa42985255fad0bab7dbe3aadbf1f74cb1635f3a/stac_fastapi/types/stac_fastapi/types/config.py#L30) [#410](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/pull/410)
1820

1921
## [v6.0.0] - 2025-06-22
2022

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -205,15 +205,16 @@ You can customize additional settings in your `.env` file:
205205
|------------------------------|--------------------------------------------------------------------------------------|--------------------------|---------------------------------------------------------------------------------------------|
206206
| `ES_HOST` | Hostname for external Elasticsearch/OpenSearch. | `localhost` | Optional |
207207
| `ES_PORT` | Port for Elasticsearch/OpenSearch. | `9200` (ES) / `9202` (OS)| Optional |
208-
| `ES_USE_SSL` | Use SSL for connecting to Elasticsearch/OpenSearch. | `false` | Optional |
209-
| `ES_VERIFY_CERTS` | Verify SSL certificates when connecting. | `false` | Optional |
208+
| `ES_USE_SSL` | Use SSL for connecting to Elasticsearch/OpenSearch. | `true` | Optional |
209+
| `ES_VERIFY_CERTS` | Verify SSL certificates when connecting. | `true` | Optional |
210+
| `ES_API_KEY` | API Key for external Elasticsearch/OpenSearch. | N/A | Optional |
210211
| `ES_TIMEOUT` | Client timeout for Elasticsearch/OpenSearch. | DB client default | Optional |
211212
| `STAC_FASTAPI_TITLE` | Title of the API in the documentation. | `stac-fastapi-<backend>` | Optional |
212213
| `STAC_FASTAPI_DESCRIPTION` | Description of the API in the documentation. | N/A | Optional |
213214
| `STAC_FASTAPI_VERSION` | API version. | `2.1` | Optional |
214215
| `STAC_FASTAPI_LANDING_PAGE_ID` | Landing page ID | `stac-fastapi` | Optional |
215216
| `APP_HOST` | Server bind address. | `0.0.0.0` | Optional |
216-
| `APP_PORT` | Server port. | `8080` | Optional |
217+
| `APP_PORT` | Server port. | `8000` | Optional |
217218
| `ENVIRONMENT` | Runtime environment. | `local` | Optional |
218219
| `WEB_CONCURRENCY` | Number of worker processes. | `10` | Optional |
219220
| `RELOAD` | Enable auto-reload for development. | `true` | Optional |

0 commit comments

Comments
 (0)