IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Kibana Plugins Updating & Removing Plugins »
Elastic Docs ›Kibana User Guide [6.7] ›Kibana Plugins

Installing Plugins

edit

Installing Plugins

edit

Use the following command to install a plugin:

bin/kibana-plugin install <package name or URL>

When you specify a plugin name without a URL, the plugin tool attempts to download an official Elastic plugin, such as:

$ bin/kibana-plugin install x-pack

Installing Plugins from an Arbitrary URL

edit

You can download official Elastic plugins simply by specifying their name. You can alternatively specify a URL to a specific plugin, as in the following example:

$ bin/kibana-plugin install https://artifacts.elastic.co/downloads/packs/x-pack/x-pack-6.7.2.zip

You can specify URLs that use the HTTP, HTTPS, or file protocols.

Installing Plugins to an Arbitrary Directory

edit

Use the -d or --plugin-dir option after the install command to specify a directory for plugins, as in the following example:

$ bin/kibana-plugin install file:///some/local/path/my-plugin.zip -d path/to/directory

This command creates the specified directory if it does not already exist.

This option is deprecated and will be removed in Kibana 7. It is known to not work with some plugins, including X-Pack.

Installing Plugins with Linux packages

edit

The Kibana server needs to be able to write to files in the optimize directory. If you’re installing plugins using sudo or su you’ll want to make sure these commands are ran as the user kibana. This user is already added for you as part of the package installation.

$ sudo -u kibana bin/kibana-plugin install x-pack

If plugins were installed as a different user and the server is not starting, then you will need to change the owner of these files:

$ chown -R kibana:kibana /path/to/kibana/optimize

Installing plugins while deferring optimization

edit

The majority of the time spent installing a plugin is running the optimizer. If you’re installing multiple plugins it can make sense to omit that step and only run it once. This can be done by providing --no-optimize to the plugin installation command. You can then either execute bin/kibana --optimize to run the optimizer, or it will be ran the first time Kibana is started.

Proxy support for plugin installation

edit

Kibana supports plugin installation via a proxy. It uses the http_proxy and https_proxy environment variables to detect a proxy for HTTP and HTTPS URLs.

It also respects the no_proxy environment variable to exclude specific URLs from proxying.

You can specify the environment variable directly when installing plugins:

$ http_proxy="http://proxy.local:4242" bin/kibana-plugin install <package name or URL>
« Kibana Plugins Updating & Removing Plugins »