From 3401a88208ebc562aac8e1fcc65237b989b6ccbf Mon Sep 17 00:00:00 2001 From: Kohinoor Chatterjee Date: Tue, 7 Nov 2023 10:04:31 -0800 Subject: [PATCH] added server.host to dev guide (#917) * added server.host to dev guide Signed-off-by: kohinoor98 * emp server.host and moved command to Test section Signed-off-by: kohinoor98 --------- Signed-off-by: kohinoor98 --- DEVELOPER_GUIDE.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/DEVELOPER_GUIDE.md b/DEVELOPER_GUIDE.md index 20aff9fee..b4a45f17b 100644 --- a/DEVELOPER_GUIDE.md +++ b/DEVELOPER_GUIDE.md @@ -5,6 +5,7 @@ - [Build](#build) - [Run](#run) - [Test](#test) + - [Backport](#backport) ## Developer guide @@ -57,6 +58,13 @@ In the base OpenSearch Dashboards directory, run ### Test +- `yarn start --no-base-path --no-watch --server.host="0.0.0.0"` + + Starts OpenSearch Dashboards and includes this plugin. This setup is necessary for running tests using `Cypress` on `localhost:5601`. + + **Important:** The `--server.host="0.0.0.0"` parameter is crucial as it configures the server to accept connections from any IP address, which is necessary for `Cypress` to connect to the dashboard server. + + - `yarn test:jest` - Runs the plugin tests.