added server.host to dev guide (#917)

* added server.host to dev guide Signed-off-by: kohinoor98 <[email protected]> * emp server.host and moved command to Test section Signed-off-by: kohinoor98 <[email protected]> --------- Signed-off-by: kohinoor98 <[email protected]> (cherry picked from commit 3401a88) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
opensearch-project · Nov 7, 2023 · eaf01d1 · eaf01d1
1 parent 0f1c03f
commit eaf01d1
Showing 1 changed file with 8 additions and 0 deletions.
diff --git 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.