Skip to content

Commit

Permalink
Update README with instructions for running with OpenSearch
Browse files Browse the repository at this point in the history
updated README with download and setup instructions for both OpenSearch
and Dashboards.

Closes #223

Signed-off-by: Bishoy Boktor <[email protected]>
  • Loading branch information
Bishoy Boktor committed Mar 26, 2021
1 parent 33bb5e0 commit f09fab8
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,23 @@ We officially began work on the new fork on January 21st, 2021. Since then, we'v
* **Respectful, approachable, and friendly.** This will be a community where you will be heard, accepted, and valued, whether you are a new or experienced user or contributor.
* **A place to invent.** You will be able to innovate rapidly. This project will have a stable and predictable foundation that is modular, making it easy to extend.

## Getting Started

To run OpenSearch Dashboards locally, you first need build artifacts from OpenSearch.
* Clone the OpenSearch Repo [here](https://github.com/opensearch-project/OpenSearch.git)
* Follow installation and setup instructions in the OpenSearch repo
* Run ```./gradlew assemble``` to generate build artifacts for all platforms
* Run ```./gradlew run -Drun.distribution=oss``` to run the oss build

Or
* You can also manually find the tar.gz file (.zip on Windows) at ```./distribution/archives/<platform-dir>/build/distributions``` and extract to your desired directory.
* After extracting, run ```bin/opensearch`` inside of the extracted build artifact dir

To run Dashboards with OpenSearch
* Run ```yarn osd bootstrap``` in the OpenSearch Dashboards directory
* While OpenSearch is running locally, run ```yarn start --oss```
* Dashboards should be running locally on port 5601

## How you can help

### Look for the label "help wanted"
Expand Down

0 comments on commit f09fab8

Please sign in to comment.