IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Plugin Management Custom URL or file system »
Elastic Docs ›Elasticsearch Plugins and Integrations [2.4] ›Plugin Management

Installing Plugins

edit
IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Installing Plugins

edit

The documentation for each plugin usually includes specific installation instructions for that plugin, but below we document the various available options:

Core Elasticsearch plugins

edit

Core Elasticsearch plugins can be installed as follows:

sudo bin/plugin install [plugin_name]

For instance, to install the core ICU plugin, just run the following command:

sudo bin/plugin install analysis-icu

This command will install the version of the plugin that matches your Elasticsearch version.

Community and non-core plugins

edit

Non-core plugins provided by Elasticsearch, or plugins provided by the community, can be installed from download.elastic.co, from Maven (Central and Sonatype), or from GitHub. In this case, the command is as follows:

sudo bin/plugin install [org]/[user|component]/[version]

For instance, to install the Kopf plugin from GitHub, run one of the following commands:

sudo bin/plugin install lmenezes/elasticsearch-kopf 
sudo bin/plugin install lmenezes/elasticsearch-kopf/2.x

Installs the latest version from GitHub.

Installs the 2.x version from GitHub.

When installing from Maven Central/Sonatype, [org] should be replaced by the artifact groupId, and [user|component] by the artifactId:

sudo bin/plugin install groupId/artifactId/version

When installing from download.elastic.co or from Maven Central/Sonatype, the version is required.
« Plugin Management Custom URL or file system »