Install Elasticsearch

Version 6.5 and 7.3 and higher of Identity Panel uses Elasticsearch version 8.x as a full-text indexing service. The following guide may be used to prepare for a clean installation of Identity Panel or as part of upgrading

Elasticsearch requires Java, and supports Oracle Java and OpenJDK. Elasticsearch is bundled with OpenJDK.

Elasticsearch 8 is the only supported version of Elasticsearch to use with Identity Panel.

Install Elasticsearch

1. Download an 8.x release of Elasticsearch. Choose the Windows download
    
2. Right click on the downloaded zip, choose properties, and unblock it if necessary.
   
3. Create a folder in a suitable location (e.g. C:\Program Files\SoftwareIDM\Elastic), and extract the downloaded zip archive:
   
4. Optional: edit configuration to provide custom data and log paths
   1. Edit \elasticsearch-8.x\config\elasticsearch.yml
   2. Un-comment path.data and path.logs and revise as needed
5. Optional: run as localhost listener only, and disable encryption and authentication (for cluster setup with security see Elasticsearch documentation):
   1. Edit elastcsearch-8.x\config\elasticsearch.yml and set the following properties:
      http.port: 9200
      xpack.security.enabled: false
      xpack.security.http.ssl.enabled: false
6. Validate the java runtime accessibility and configuration by running bin\elasticsearch.bat
7. Install Service
   1. Open an administrative command prompt in the extracted location's bin folder, e.g. C:\Program Files\SoftwareIDM\Elastic\elasticsearch-8.x.x\bin\
   2. Run: elasticsearch-service.bat install <custom service name e.g. SoftwareIDM.ElasticSearch>
       
   3. Optional: You may  change the service display name so that it sorts close to the Identity Panel web maintenance service:
      sc config <custom service name> displayName= "SoftwareIDM Elastic"
   4. Change the service to autostart: sc config <custom service name> start= auto
   5. Start the service: net start <custom service name>
       
8. Validate the Elastic search configuration by browsing to http://localhost:9200/
   

Troubleshooting

If the service fails to start and writes "Missing service ImageFile" in the Elastic.yyyy-mm-dd.txt log, the Java environment may be missing or incorrectly configured. Ensure Java is installed and the JAVA_HOME variable is present as per the Install and configure OpenJDK section above.

Further reading

• Setup Overview: https://www.elastic.co/guide/en/elasticsearch/reference/current/setup.html
• Installing on Windows: https://www.elastic.co/guide/en/elasticsearch/reference/current/zip-windows.html
• Downloads (Past Releases: choose a 8.x version): https://www.elastic.co/downloads/past-releases#elasticsearch