kolchfa-aws bf4ad6bbbc
Adds windows installation documentation (#1825)
* Adds windows installation documentation

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Added the link to download the windows distribution

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Added windows server 2109 as a platform

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Adds Windows installation documentation

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Updated responses

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Updated responses

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Added curl.exe

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Added steps to set environment variables

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Added statement about long path and doc review

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Incorporated doc review comments

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Implemented editorial feedback

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
2022-11-15 11:04:21 -05:00

2.5 KiB

layout title parent nav_order
default Windows Install OpenSearch Dashboards 37

Run OpenSearch Dashboards on Windows

Perform the following steps to install OpenSearch Dashboards on Windows.

Make sure you have a zip utility installed. {: .note }

  1. Download the opensearch-dashboards-{{site.opensearch_version}}-windows-x64.zip{:target='_blank'} archive.

  2. To extract the archive contents, right-click to select Extract All.

    Note: Some versions of the Windows operating system limit the file path length. If you encounter a path-length-related error when unzipping the archive, perform the following steps to enable long path support:

    1. Open Powershell by entering powershell in the search box next to Start on the taskbar.
    2. Run the following command in Powershell:
      Set-ItemProperty -Path HKLM:\SYSTEM\CurrentControlSet\Control\FileSystem LongPathsEnabled -Type DWORD -Value 1 -Force
      
    3. Restart your computer.
  3. Run OpenSearch Dashboards.

    There are two ways of running OpenSearch Dashboards:

    1. Run the batch script using the Windows UI:

      1. Navigate to the top directory of your OpenSearch Dashboards installation and open the opensearch-dashboards-{{site.opensearch_version}} folder.
      2. If desired, modify opensearch_dashboards.yml located in the config folder, to change the default OpenSearch Dashboards settings.
      3. Open the bin folder and run the batch script by double-clicking the opensearch-dashboards.bat file. This opens a command prompt with an OpenSearch Dashboards instance running.
    2. Run the batch script from Command Prompt or Powershell:

      1. Open Command Prompt by entering cmd, or Powershell by entering powershell, in the search box next to Start on the taskbar.
      2. Change to the top directory of your OpenSearch Dashboards installation.
        cd \path\to\opensearch-dashboards-{{site.opensearch_version}}
        
      3. If desired, modify config\opensearch_dashboards.yml.
      4. Run the batch script to start OpenSearch Dashboards.
        .\bin\opensearch-dashboards.bat
        

To stop OpenSearch Dashboards, press Ctrl+C in Command Prompt or Powershell, or simply close the Command Prompt or Powershell window. {: .tip}