elasticsearch/docs/plugins/install_remove.asciidoc

[discrete]
[id="{plugin_name}-install"]
==== Installation

ifeval::["{release-state}"=="unreleased"]

Version {version} of the Elastic Stack has not yet been released.

endif::[]

ifeval::["{release-state}"!="unreleased"]

This plugin can be installed using the plugin manager:

["source","sh",subs="attributes,callouts"]
----------------------------------------------------------------
sudo bin/elasticsearch-plugin install {plugin_name}
----------------------------------------------------------------

The plugin must be installed on every node in the cluster, and each node must
be restarted after installation.

You can download this plugin for <<plugin-management-custom-url,offline
install>> from {plugin_url}/{plugin_name}/{plugin_name}-{version}.zip. To verify
the `.zip` file, use the
{plugin_url}/{plugin_name}/{plugin_name}-{version}.zip.sha512[SHA hash] or
{plugin_url}/{plugin_name}/{plugin_name}-{version}.zip.asc[ASC key].
endif::[]

[discrete]
[id="{plugin_name}-remove"]
==== Removal

The plugin can be removed with the following command:

["source","sh",subs="attributes,callouts"]
----------------------------------------------------------------
sudo bin/elasticsearch-plugin remove {plugin_name}
----------------------------------------------------------------

The node must be stopped before removing the plugin.