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.8.2-elasticsearch-7.17.0.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.8.2-elasticsearch-7.17.0.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.8.2",
    "elasticsearch": "7.17.0"
  }
}

Step 4. Invoke the Setup API (Optional)

The Setup API creates the .zentity-models index. This is optional to invoke because zentity will create the index if it doesn't already exist upon invoking the Models API.

Example Request

POST http://localhost:9200/_zentity/_setup

Example Response

{
  "acknowledged": true
}

Installation on Elasticsearch Service

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

To install zentity on an Elasticsearch Service deployment:

1. Browse the releases and download one of the .zip files.
2. Sign in to Elasticsearch Service.
3. Navigate to the Extensions tab.
4. Click the "Create Extension" button.
5. Name the extension "zentity" or anything else.
6. Specify the version of your Elasticsearch deployment.
7. Under plugin type, select "An installable plugin (Compiled, no source code)".
8. Click the "Create plugin" button.
9. Upload the .zip file under the "Plugin file" section.
10. Create or restart your deployment. If creating a deployment, select the zentity extension 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.

Important

Amazon's Elasticsearch Service does not let you install community plugins. You will need to use the official Elasticsearch Service offered by Elastic. You can compare the services and then learn how to migrate from AWS to Elastic.

Sandbox

Just learning? Want to learn faster? Download and run the zentity sandbox development environment, which bundles Elasticsearch with zentity, analysis plugins, real data, and sample entity models.

Continue Reading