Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README with instructions for running with OpenSearch #235

Merged
merged 3 commits into from
Mar 26, 2021
Merged

Update README with instructions for running with OpenSearch #235

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f09fab8
Update README with instructions for running with OpenSearch
Mar 26, 2021
da55dfd
Address PR comments
Mar 26, 2021
4f4bb30
Address PR comments
Mar 26, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions README.md
View file
Open in desktop
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 with ```git clone [email protected]:opensearch-project/OpenSearch.git```
* Follow installation and setup instructions in the OpenSearch repo
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we just add git clone <> command here so users may not have to jump the page ???

* 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 with ```tar -xvf /path/to/tar/file```
* 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```
* You can now navigate to ```http://localhost:5601``` where Dashboards runs by default

## How you can help

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