Install and Configure Kibana

Install and Configure Kibana (Required for Environment Watch Only)

Download Kibana 8.x.x or 9.x.x

1. Download the 8.x.x or 9.x.x Windows ZIP version of Kibana from Elastic's official Kibana download page.
2. Verify that the Elasticsearch service is installed and running before Kibana setup.
3. Before extracting, see How to Unblock Downloaded Files.
4. Extract the files to C:\elastic (e.g., C:\elastic\kibana-x.x.x).

Start Kibana from the command line

1. Navigate to Kibana's bin folder (e.g., C:\elastic\kibana-x.x.x\bin).

2. Open an elevated PowerShell window and run the following command:

   Copy

   .\kibana.bat
   

3. If successful, you should see output indicating that the Kibana server has started and is listening on port 5601. Look for lines similar to:

   Show sample output

   ```text [INFO][server][http] http server running at http://localhost:5601 ... kibana has not been configured Go to https://localhost:5601/?code=xyz to get started ```

Enroll Kibana

1. In your terminal, click the generated link to open Kibana in your browser.
2. In your browser, paste the enrollment token that was generated in the terminal when you started Elasticsearch, then click the Configure Elastic button to connect your Kibana instance with Elasticsearch. See where the enrollment token is generated.
3. If the token has expired, generate a new one by running the following command in the Elasticsearch's bin folder (e.g., C:\elastic\elasticsearch-x.x.x\bin).

.\elasticsearch-create-enrollment-token.bat --scope kibana

eyJ2ZXIiOiI4LjE0LjAiLCJhZHIiOlsiMTAuMC4yLjI6OTIwMCJdLCJmZ3IiOiI4ZGE1MWZkYTExZmM1ZDAwNDBhZWZlNTJlNmRiYzQ5ZTM2NmYxYTkyOGIwY2NiMzExOGY0MWFjZTczODNkZDliIiwia2V5IjoiOGFfc1BKZ0Jra09qNlh6dngycS06bG5sWkNEMnpSbFNiZjZZclpRSHF6dyJ9

4. Log in to Kibana as the elastic user with the password that was generated when you started Elasticsearch.
5. You will see the Kibana enrollment page. Paste the enrollment token you saved earlier and click the enrollment button.

Enable TLS for Kibana

Configure kibana.yml

1. Open C:\elastic\kibana-x.x.x\config\kibana.yml and set:

   Show Kibana TLS configuration

   Copy

   server.host: "<bind address>"  # Use the specific interface or hostname; avoid 0.0.0.0 unless required
   server.port: 5601
   server.publicBaseUrl: "https://your.kibana.host:5601"
   server.ssl.enabled: true
   server.ssl.certificate: "C:/elastic/kibana/config/certs/kibana.crt"
   server.ssl.key: "C:/elastic/kibana/config/certs/kibana.key"
   

Generate Kibana encryption keys

1. Open an elevated PowerShell window, navigate to the Kibana bin folder (e.g., C:\elastic\kibana-x.x.x\bin), and run the following command:

   Copy

   .\kibana-encryption-keys generate
   

2. If successful, you will see output showing the generated encryption keys. For example:

   Sample output

   Copy

   xpack.encryptedSavedObjects.encryptionKey: "<randomly-generated-key-1>"
   xpack.reporting.encryptionKey: "<randomly-generated-key-2>"
   xpack.security.encryptionKey: "<randomly-generated-key-3>"
   

3. Store encryption keys securely (production)

Kibana Stack Monitoring (Optional)

Create Kibana Windows Service

C:\elastic\kibana-x.x.x\bin\kibana.bat

1. Download and extract the Relativity Windows Service Manager (RWSM) NuGet package:

   • Open a browser and navigate to the following URL to download the package:

     Copy

     https://relativitypackageseastus.jfrog.io/artifactory/api/nuget/server-nuget-virtual/Download/Relativity.Windows.ServiceManager/2.24.0
     

   • After downloading, unblock the file before use. See How to Unblock Downloaded Files.

   • Once downloaded, the package file is named Relativity.Windows.ServiceManager.2.24.0.nupkg. Rename it to .zip using File Explorer:

     • In File Explorer, right-click Relativity.Windows.ServiceManager.2.24.0.nupkg and select Rename.
     • Change the extension from .nupkg to .zip so the file is named Relativity.Windows.ServiceManager.2.24.0.zip.
     • Click Yes when prompted to confirm the extension change.

   • Extract the Relativity.Windows.ServiceManager.2.24.0.zip file to the C:\elastic folder using File Explorer:

     • Create the folder rwsm in C:\elastic.
     • Right-click Relativity.Windows.ServiceManager.2.24.0.zip and select Extract All.
     • Set the destination to C:\elastic\rwsm and click Extract.

   • Navigate to C:\elastic\rwsm\tools\ and extract the inner package:

     • Right-click the archive inside the tools folder and select Extract All.
     • Set the destination to C:\elastic\rwsm\tools\ and click Extract.
     • This creates the folder C:\elastic\rwsm\tools\rwsm-2.24.0\.
     • The RWSM executable is located at: C:\elastic\rwsm\tools\rwsm-2.24.0\win64\rwsm.exe.

   Kibana does not install as a Windows service by default. We recommend using Relativity Windows Service Manager (RWSM) to run Kibana as a Windows service.

2. Open an elevated PowerShell window, navigate to C:\elastic\rwsm\tools\rwsm-2.24.0\win64, and run the following command:

   Copy

   .\rwsm.exe install kibana
   

   This will open a popup to create a Windows service for Kibana.

3. In the Application tab:

   • Path:C:\elastic\kibana-x.x.x\bin\kibana.bat
   • Startup directory:C:\elastic\kibana-x.x.x\bin

   Editing Kibana Service Properties: If you accidentally install the Kibana service before completing your configuration (for example, by pressing Return too early in the RWSM dialog), you can easily edit the service properties afterward. This allows you to update the application path, log file settings, or other options without reinstalling the service. Open an elevated PowerShell window, navigate to C:\elastic\rwsm\tools\rwsm-2.24.0\win64, and run the following command:

   Copy

   .\rwsm.exe edit kibana
   

4. In the I/O tab, configure log file storage:

   • Create a folder: C:\elastic\kibana-x.x.x\service_logs
   • Create a blank log file: C:\elastic\kibana-x.x.x\service_logs\kibana_service.log

5. Copy the full log file path into the stdout, stderr, and stdin sections.

   Show screenshot

   

6. In the File rotation tab, check all boxes. In the Restrict rotation to files bigger than field, enter 10485760 bytes so a new log file is generated for every 10 MB of logs.

   Show screenshot

   

7. Click the Install service button to create the Windows service for Kibana.

8. Service account (recommended)

   • Create a dedicated, least-privilege Windows service account (for example: svc_kibana). Do not run Kibana under LocalSystem in production.

   • In RWSM, you can set the account under the Log On tab in the GUI after installing the service, or via command.

   • Open an elevated PowerShell window, navigate to C:\elastic\rwsm\tools\rwsm-2.24.0\win64, and run the following command:

     Copy

     .\rwsm.exe set kibana ObjectName "DOMAIN\svc_kibana" "<service-account-password>"
     

   • Verify that the service account has read access to Kibana installation, config, certs and the kibana keystore, and only those privileges required.

9. Go to the Services app in Windows, search for the kibana service, right click, and start the service.

10. Verify that Kibana is running by opening it in your browser.

Verify Kibana Server

1. Open a browser and go to https://<hostname_or_ip>:5601.
2. Log in using the elastic username and the password you generated earlier.
3. You should see the Kibana home page, confirming successful access.

Register Remote Cluster Connection (Multi-Cluster Setup Only)