Skip to content

Commit 590c14a

Browse files
committed
Update CHANGELOG & README
1 parent e197c5e commit 590c14a

File tree

2 files changed

+40
-20
lines changed

2 files changed

+40
-20
lines changed

CHANGELOG.md

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

1111
### Added
1212

13+
- `STAC_INDEX_ASSETS` environment variable to allow asset serialization to be configurable. [#433](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/pull/433)
14+
1315
### Changed
1416

1517
- Changed assets serialization to prevent mapping explosion while allowing asset inforamtion to be indexed. [#341](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/pull/341)

README.md

Lines changed: 38 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -66,26 +66,43 @@ This project is built on the following technologies: STAC, stac-fastapi, FastAPI
6666

6767
## Table of Contents
6868

69-
- [Documentation & Resources](#documentation--resources)
70-
- [Package Structure](#package-structure)
71-
- [Examples](#examples)
72-
- [Performance](#performance)
73-
- [Quick Start](#quick-start)
74-
- [Installation](#installation)
75-
- [Running Locally](#running-locally)
76-
- [Configuration reference](#configuration-reference)
77-
- [Interacting with the API](#interacting-with-the-api)
78-
- [Configure the API](#configure-the-api)
79-
- [Collection pagination](#collection-pagination)
80-
- [Ingesting Sample Data CLI Tool](#ingesting-sample-data-cli-tool)
81-
- [Elasticsearch Mappings](#elasticsearch-mappings)
82-
- [Managing Elasticsearch Indices](#managing-elasticsearch-indices)
83-
- [Snapshots](#snapshots)
84-
- [Reindexing](#reindexing)
85-
- [Auth](#auth)
86-
- [Aggregation](#aggregation)
87-
- [Rate Limiting](#rate-limiting)
88-
- [Datetime-Based Index Management](#datetime-based-index-management)
69+
- [stac-fastapi-elasticsearch-opensearch](#stac-fastapi-elasticsearch-opensearch)
70+
- [Sponsors \& Supporters](#sponsors--supporters)
71+
- [Project Introduction - What is SFEOS?](#project-introduction---what-is-sfeos)
72+
- [Common Deployment Patterns](#common-deployment-patterns)
73+
- [Technologies](#technologies)
74+
- [Table of Contents](#table-of-contents)
75+
- [Documentation \& Resources](#documentation--resources)
76+
- [Package Structure](#package-structure)
77+
- [Examples](#examples)
78+
- [Performance](#performance)
79+
- [Direct Response Mode](#direct-response-mode)
80+
- [Quick Start](#quick-start)
81+
- [Installation](#installation)
82+
- [Running Locally](#running-locally)
83+
- [Using Pre-built Docker Images](#using-pre-built-docker-images)
84+
- [Using Docker Compose](#using-docker-compose)
85+
- [Configuration Reference](#configuration-reference)
86+
- [Datetime-Based Index Management](#datetime-based-index-management)
87+
- [Overview](#overview)
88+
- [When to Use](#when-to-use)
89+
- [Configuration](#configuration)
90+
- [Enabling Datetime-Based Indexing](#enabling-datetime-based-indexing)
91+
- [Related Configuration Variables](#related-configuration-variables)
92+
- [How Datetime-Based Indexing Works](#how-datetime-based-indexing-works)
93+
- [Index and Alias Naming Convention](#index-and-alias-naming-convention)
94+
- [Index Size Management](#index-size-management)
95+
- [Interacting with the API](#interacting-with-the-api)
96+
- [Configure the API](#configure-the-api)
97+
- [Collection Pagination](#collection-pagination)
98+
- [Ingesting Sample Data CLI Tool](#ingesting-sample-data-cli-tool)
99+
- [Elasticsearch Mappings](#elasticsearch-mappings)
100+
- [Managing Elasticsearch Indices](#managing-elasticsearch-indices)
101+
- [Snapshots](#snapshots)
102+
- [Reindexing](#reindexing)
103+
- [Auth](#auth)
104+
- [Aggregation](#aggregation)
105+
- [Rate Limiting](#rate-limiting)
89106

90107
## Documentation & Resources
91108

@@ -228,6 +245,7 @@ You can customize additional settings in your `.env` file:
228245
| `DATABASE_REFRESH` | Controls whether database operations refresh the index immediately after changes. If set to `true`, changes will be immediately searchable. If set to `false`, changes may not be immediately visible but can improve performance for bulk operations. If set to `wait_for`, changes will wait for the next refresh cycle to become visible. | `false` | Optional |
229246
| `ENABLE_TRANSACTIONS_EXTENSIONS` | Enables or disables the Transactions and Bulk Transactions API extensions. If set to `false`, the POST `/collections` route and related transaction endpoints (including bulk transaction operations) will be unavailable in the API. This is useful for deployments where mutating the catalog via the API should be prevented. | `true` | Optional |
230247
| `STAC_ITEM_LIMIT` | Sets the environment variable for result limiting to SFEOS for the number of returned items and STAC collections. | `10` | Optional |
248+
| `STAC_INDEX_ASSETS` | Controls if Assets are indexed when added to Elasticsearch/Opensearch. This allows asset fields to be included in search queries. | `false` | Optional |
231249

232250
> [!NOTE]
233251
> The variables `ES_HOST`, `ES_PORT`, `ES_USE_SSL`, `ES_VERIFY_CERTS` and `ES_TIMEOUT` 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.

0 commit comments

Comments
 (0)