github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-23 17:28:26 -04:00
Code Issues Projects Releases Packages Wiki Activity

[DOCS] Removed plugin-dir (#47488) (#47511)

Browse source
This commit is contained in:
Kaarina Tungseth 2019-10-07 14:48:03 -05:00 • committed by GitHub
parent bc9971df2b
commit a603f96f39
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 19 additions and 30 deletions
Download patch file Download diff file Expand all files Collapse all files

49
docs/user/plugins.asciidoc
View file

@ -1,22 +1,22 @@
[[kibana-plugins]]
= Kibana Plugins
= Kibana plugins
[partintro]
--
Add-on functionality for Kibana is implemented with plug-in modules. You use the `bin/kibana-plugin`
Add-on functionality for {kib} is implemented with plug-in modules. You use the `bin/kibana-plugin`
command to manage these modules.
[IMPORTANT]
.Plugin compatibility
==============================================
The Kibana plugin interfaces are in a state of constant development. We cannot provide backwards compatibility for plugins due to the high rate of change. Kibana enforces that the installed plugins match the version of Kibana itself. Plugin developers will have to release a new version of their plugin for each new Kibana release as a result.
The {kib} plugin interfaces are in a state of constant development. We cannot provide backwards compatibility for plugins due to the high rate of change. {kib} enforces that the installed plugins match the version of {kib} itself. Plugin developers will have to release a new version of their plugin for each new {kib} release as a result.
==============================================
--
[[install-plugin]]
== Installing Plugins
== Install plugins
Use the following command to install a plugin:
@ -28,9 +28,9 @@ When you specify a plugin name without a URL, the plugin tool attempts to downlo
["source","shell",subs="attributes"]
$ bin/kibana-plugin install x-pack
[float]
=== Installing Plugins from an Arbitrary URL
[[install-plugin-url]]
=== Install plugins from an arbitrary URL
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
@ -42,22 +42,10 @@ $ bin/kibana-plugin install https://artifacts.elastic.co/downloads/packs/x-pack/
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
example:
[source,shell]
$ bin/kibana-plugin install file:///some/local/path/my-plugin.zip -d path/to/directory
NOTE: This command creates the specified directory if it does not already exist.
WARNING: This option is deprecated and will be removed in Kibana 7. It is known to not work with some plugins, including {xpack}.
[float]
[[install-plugin-proxy-support]]
=== Proxy support for plugin installation
Kibana supports plugin installation via a proxy. It uses the `http_proxy` and `https_proxy`
{kib} 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.
@ -67,9 +55,8 @@ You can specify the environment variable directly when installing plugins:
[source,shell]
$ http_proxy="http://proxy.local:4242" bin/kibana-plugin install <package name or URL>
[[update-remove-plugin]]
== Updating & Removing Plugins
== Update and remove plugins
To update a plugin, remove the current version and reinstall the plugin.
@ -80,10 +67,10 @@ $ bin/kibana-plugin remove x-pack
You can also remove a plugin manually by deleting the plugin's subdirectory under the `plugins/` directory.
NOTE: Removing a plugin will result in an "optimize" run which will delay the next start of Kibana.
NOTE: Removing a plugin will result in an "optimize" run which will delay the next start of {kib}.
[[disable-plugin]]
== Disabling Plugins
== Disable plugins
Use the following command to disable a plugin:
@ -92,12 +79,12 @@ Use the following command to disable a plugin:
./bin/kibana --<plugin ID>.enabled=false <1>
-----------
NOTE: Disabling or enabling a plugin will result in an "optimize" run which will delay the start of Kibana.
NOTE: Disabling or enabling a plugin will result in an "optimize" run which will delay the start of {kib}.
<1> You can find a plugin's plugin ID as the value of the `name` property in the plugin's `package.json` file.
[[configure-plugin-manager]]
== Configuring the Plugin Manager
== Configure 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
@ -116,15 +103,17 @@ bin/kibana-plugin install --timeout 30s sample-plugin
bin/kibana-plugin install --timeout 1m sample-plugin
[float]
=== Plugins and Custom Kibana Configurations
[[plugin-custom-configuration]]
=== Plugins and custom {kib} 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,
used to start {kib}. By default, {kib} uses the configuration file `config/kibana.yml`. When you change your installed
plugins, the `bin/kibana-plugin` command restarts the {kib} 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]
=== Plugin Manager Exit Codes
[[plugin-manager-exit-codes]]
=== Plugin manager exit codes
[horizontal]
0:: Success