Home / Documentation / Installation

Installation

Step 1. Install Elasticsearch

Download and install: https://www.elastic.co/downloads/elasticsearch

Step 2. Install zentity

Once you have installed Elasticsearch, you can install zentity from a remote URL or a local file.

Install from remote URL

  1. Browse the releases.
  2. Find a release that matches your version of Elasticsearch. Copy the name of the .zip file.
  3. Install the plugin using the elasticsearch-plugin script that comes with Elasticsearch.

Example:

elasticsearch-plugin install https://zentity.io/releases/zentity-1.0.2-elasticsearch-6.5.2.zip

Install from local file

  1. Browse the releases.
  2. Find a release that matches your version of Elasticsearch. Download the .zip file.
  3. Install the plugin using the elasticsearch-plugin script that comes with Elasticsearch.

Example:

elasticsearch-plugin install file:///path/to/zentity-1.0.2-elasticsearch-6.5.2.zip

Step 3. Verify installation

Example Request

GET http://localhost:9200/_zentity

Example Response

{
  "name": "zentity",
  "description": "Real-time entity resolution for Elasticsearch.",
  "website": "http://zentity.io",
  "version": {
    "zentity": "1.0.2",
    "elasticsearch": "6.5.2"
  }
}

Installation on Elastic Cloud

Elastic Cloud is a hosted Elasticsearch service offered by Elastic, the creators of Elasticsearch and the Elastic Stack. Elastic Cloud supports the usage of custom Elasticsearch plugins such as zentity.

To install zentity on an Elastic Cloud cluster:

  1. Browse the releases and download one of the .zip files.
  2. Sign into Elastic Cloud and navigate to the plugins tab.
  3. Select "This is an installable plugin. (Compiled, not the plugin's source code)".
  4. Name the plugin "zentity".
  5. Specify the version of your Elasticsearch cluster.
  6. Upload the .zip file.
  7. Create or restart your cluster. If creating a cluster, select "zentity" under the list of custom plugins.

If you will be creating indices and performing entity resolution with data that has names of people or companies or other fields that often have data quality challenges, consider also selecting analysis-icu and analysis-phonetic from the list of plugins, which can help you index cleaner representations of that data.

 


Continue Reading

Contents Basic Usage
© 2018 Dave Moore.
Licensed under the Apache License, Version 2.0.
Elasticsearch is a trademark of Elasticsearch BV.
This website uses Google Analytics.