-
Notifications
You must be signed in to change notification settings - Fork 500
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add documentation to run a development OpenSearch Dashboards
Signed-off-by: closingin <[email protected]>
- Loading branch information
Showing
1 changed file
with
54 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
--- | ||
layout: default | ||
title: Development server | ||
parent: Install OpenSearch Dashboards | ||
nav_order: 35 | ||
--- | ||
|
||
# Run OpenSearch Dashboards using the development server | ||
|
||
If you want to develop on OpenSearch Dashboards or maybe create plugins for it, | ||
you need to run it from source using the included development server. | ||
|
||
### Prerequisites | ||
|
||
You need to have an OpenSearch server up and running to be able to run OpenSearch | ||
Dashboards. The easiest way to do it is [using Docker]({{site.url}}{{site.baseurl}}/opensearch/install/docker). | ||
|
||
We recommend using [Node Version Manager](https://github.com/nvm-sh/nvm) to install | ||
the node version we need. | ||
|
||
## Bootstrap OpenSearch Dashboards | ||
|
||
While OpenSearch is starting, you can already bootstrap OpenSearch Dashboards: | ||
```bash | ||
$ git clone https://github.com/opensearch-project/OpenSearch-Dashboards.git | ||
$ cd OpenSearch-Dashboards | ||
$ nvm use | ||
$ yarn osd bootstrap # This command will also install npm dependencies | ||
``` | ||
|
||
## Configure OpenSearch Dashboards | ||
|
||
*This step is only mandatory if you have https/authentication enabled, or if you use the OpenSearch Docker image in its default configuration.* | ||
|
||
Once the bootstrap of OpenSearch Dashboards is finished, you need to apply some | ||
changes to `opensearch_dashboards.yml` in order to connect to OpenSearch. | ||
|
||
```yml | ||
opensearch.hosts: ["https://localhost:9200"] | ||
opensearch.username: "admin" # Default OpenSearch username | ||
opensearch.password: "admin" # Default OpenSearch password | ||
opensearch.ssl.verificationMode: none | ||
``` | ||
## Run OpenSearch Dashboards | ||
After you've installed OpenSearch Dashboards and configured it, you can start | ||
the development server: | ||
```bash | ||
$ yarn start | ||
``` | ||
|
||
When the server is up and ready, click on the link displayed in your terminal to | ||
access it. |