diff --git a/docs/plugins.asciidoc b/docs/plugins.asciidoc index d6e086e53ddd..c7bde98bcf44 100644 --- a/docs/plugins.asciidoc +++ b/docs/plugins.asciidoc @@ -1,8 +1,8 @@ [[kibana-plugins]] == Kibana Plugins -Add-on functionality for Kibana is implemented with plug-in modules. You can use the `bin/kibana-plugin` -command to manage these modules. You can also install a plugin manually by moving the plugin file to the +Add-on functionality for Kibana is implemented with plug-in modules. You can use the `bin/kibana-plugin` +command to manage these modules. You can also install a plugin manually by moving the plugin file to the `installedPlugins` directory and unpacking the plugin files into a new directory. A list of existing Kibana plugins is available on https://github.com/elastic/kibana/wiki/Known-Plugins[GitHub]. @@ -23,8 +23,8 @@ When you specify a plugin name without a URL, the plugin tool attempts to downlo You can specify a URL to a specific plugin, as in the following example: [source,shell] -$ bin/kibana-plugin install https://download.elastic.co/kibana/x-pack/x-pack-5.0.0-alpha3.zip -Attempting to transfer from https://download.elastic.co/kibana/x-pack//x-pack-5.0.0-alpha3.zip +$ bin/kibana-plugin install https://download.elastic.co/kibana/x-pack/x-pack-5.0.0-alpha4.zip +Attempting to transfer from https://download.elastic.co/kibana/x-pack/x-pack-5.0.0-alpha4.zip Transferring bytes.................... Transfer complete Retrieving metadata from plugin archive @@ -38,7 +38,7 @@ You can specify URLs that use the HTTP, HTTPS, or `file` protocols. [float] === Installing Plugins to an Arbitrary Directory -Use the `-d` or `--plugin-dir` option after the `install` command to specify a directory for plugins, as in the following +Use the `-d` or `--plugin-dir` option after the `install` command to specify a directory for plugins, as in the following example: [source,shell] @@ -78,9 +78,9 @@ To update a plugin, remove the current version and reinstall the plugin. [float] === Configuring the Plugin Manager -By default, the plugin manager provides you with feedback on the status of the activity you've asked the plugin manager -to perform. You can control the level of feedback for the `install` and `remove` commands with the `--quiet` and -`--silent` options. Use the `--quiet` option to suppress all non-error output. Use the `--silent` option to suppress all +By default, the plugin manager provides you with feedback on the status of the activity you've asked the plugin manager +to perform. You can control the level of feedback for the `install` and `remove` commands with the `--quiet` and +`--silent` options. Use the `--quiet` option to suppress all non-error output. Use the `--silent` option to suppress all output. By default, plugin manager installation requests do not time out. Use the `--timeout` option, followed by a time, to @@ -88,18 +88,18 @@ change this behavior, as in the following examples: [source,shell] .Waits for 30 seconds before failing -bin/kibana-plugin install --timeout 30s sample-plugin +bin/kibana-plugin install --timeout 30s sample-plugin [source,shell] .Waits for 1 minute before failing -bin/kibana-plugin install --timeout 1m sample-plugin +bin/kibana-plugin install --timeout 1m sample-plugin [float] ==== Plugins and Custom Kibana Configurations -Use the `-c` or `--config` options with the `install` and `remove` commands to specify the path to the configuration file -used to start Kibana. By default, Kibana uses the configuration file `config/kibana.yml`. When you change your installed -plugins, the `bin/kibana-plugin` command restarts the Kibana server. When you are using a customized configuration file, +Use the `-c` or `--config` options with the `install` and `remove` commands to specify the path to the configuration file +used to start Kibana. By default, Kibana uses the configuration file `config/kibana.yml`. When you change your installed +plugins, the `bin/kibana-plugin` command restarts the Kibana server. When you are using a customized configuration file, you must specify the path to that configuration file each time you use the `bin/kibana-plugin` command. [float] @@ -115,7 +115,7 @@ you must specify the path to that configuration file each time you use the `bin/ [[plugin-switcher]] == Switching Plugin Functionality -The Kibana UI serves as a framework that can contain several different plugins. You can switch between these +The Kibana UI serves as a framework that can contain several different plugins. You can switch between these plugins by clicking the icons for your desired plugins in the left-hand navigation bar. [float]