Skip to content

Commit

Permalink
Fix Elasticsearch/OpenSearch documentation in README
Browse files Browse the repository at this point in the history
  • Loading branch information
julianladisch committed Sep 19, 2024
1 parent e8c8fba commit ec25cf8
Showing 1 changed file with 4 additions and 8 deletions.
12 changes: 4 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ This module provides a search functionality for instance and authorities via RES
[The Contextual Query Language](https://www.loc.gov/standards/sru/cql/) as a formal language to query
records using filters, boolean conditions, etc.

mod-search has switched from Elasticsearch to OpenSearch for integration tests, however,
mod-search works with either Elasticsearch and OpenSearch, however,
many variables still have Elasticsearch in their name for backwards compatibility.

## Compiling
Expand All @@ -79,17 +79,13 @@ See that it says "BUILD SUCCESS" near the end.
By default the integration tests run against an OpenSearch server.
To run them against an Elasticsearch server use

```shell
SEARCH_ENGINE_DOCKERFILE="docker/elasticsearch/Dockerfile" mvn install
```

for Elasticsearch 7 or

```shell
SEARCH_ENGINE_DOCKERFILE="docker/elasticsearch8/Dockerfile" mvn install
```

for Elasticsearch 8 or run [GitHub Action elasticsearch.yml](.github/workflows/elasticsearch.yml).
or run [GitHub Action elasticsearch.yml](.github/workflows/elasticsearch.yml).

The GitHub Action automatically runs whenever a commit is pushed to the master branch.

## Running it

Expand Down

0 comments on commit ec25cf8

Please sign in to comment.