Loading

Install plugins

Each plugin typically documents its own installation requirements. This page covers the elasticsearch-plugin CLI for self-managed package and archive installs.

If you run Elasticsearch with the official Docker image, use the declarative configuration file instead of running elasticsearch-plugin install directly.

Refer to Plugins and bundles for options that apply to other deployment types.

The elasticsearch-plugin tool is located in the $ES_HOME/bin directory by default, but it might be in a different location depending on which Elasticsearch package you installed. For more information, see Plugins directory.

Run the following command to get usage instructions:

sudo bin/elasticsearch-plugin -h
		
Important

If Elasticsearch was installed using the deb or rpm package, then run /usr/share/elasticsearch/bin/elasticsearch-plugin as root so it can write to the appropriate files on disk. Otherwise, run bin/elasticsearch-plugin as the user that owns all of the Elasticsearch files.

Core Elasticsearch plugins can be installed as follows:

sudo bin/elasticsearch-plugin install [plugin_name]
		

For example, to install the core ICU plugin:

sudo bin/elasticsearch-plugin install analysis-icu
		

This command installs the version of the plugin that matches your Elasticsearch version and shows a progress bar while downloading.

After installation, restart each node before the plugin is available. Plugins that contribute custom cluster state metadata require a full cluster restart. You can still upgrade those plugins with a rolling restart.