Version 5.x of Identity Panel uses Elasticsearch version 7.5 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 to 5.x
NOTE: If upgrading from an earlier version of Identity Panel you may remove the JAVA_HOME variable, and optionally the installed Java. Current versions of Elasticsearch include a bundled version of OpenJDK. If you leave JAVA_HOME set, Elasticsearch will use that version of Java.
The JDK distribution included with Elasticsearch for windows commonly doesn't work when performing an upgrade. Installing OpenJDK 13 first is recommended.
If the service fails to start and writes "Missing service ImageFile" in the Elastic.yyyy-mm-dd.txt log, you may need to install a Java run time. The version recommended for use with Elastic 7.5 is OpenJDK 13, which may be downloaded from: https://jdk.java.net/13/
- Download OpenJDK
- Unblock and Extract
- Open System Environment Variables and add JAVA_HOME pointing to extracted jdk-13* folder
- Download a 7.5.x release of Elasticsearch. Choose the Windows zip download:
- Right click on the downloaded zip, choose properties, and unblock it if necessary.
- Create a folder in a suitable location (e.g. C:\Program Files\SoftwareIDM\Elastic), and extract the downloaded zip archive:
- Optional: edit configuration to provide custom data and log paths
- Edit \elasticsearch-7.5.2\config\elasticsearch.yml
- Un-comment path.data and path.logs and revise as needed
- Install Service
- Open an administrative command prompt in the extracted location's bin folder, e.g. C:\Program Files\SoftwareIDM\Elastic\elasticsearch-7.5.2\bin\
- Optional: You may change the service display name so that it sorts close to the Identity Panel web maintenance service:
sc config elasticsearch-service-x64 displayName= "SoftwareIDM Elastic"
- Change the service to autostart:
sc config elasticsearch-service-x64 start= auto
- Start the service:
net start elasticsearch-service-x64
- Validate the Elastic search configuration by opening an administrative command prompt in the extracted location's bin folder, running elasticsearch.bat, and browsing to http://localhost:9200/
For additional Elasticsearch documentation see:
- 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 7.5.x version): https://www.elastic.co/downloads/past-releases#elasticsearch