Skip to content

Commit

Permalink
Merge pull request elastic#7635 from jbudz/missing-plugin-refactor
Browse files Browse the repository at this point in the history
[folder structure] Cleanup missing folder changes, update docs

Former-commit-id: 216f610
  • Loading branch information
epixa authored Jul 5, 2016
2 parents 7c72e4c + bb806ac commit 14530f5
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 17 deletions.
30 changes: 15 additions & 15 deletions docs/plugins.asciidoc
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
[[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
`installedPlugins` directory and unpacking the plugin files into a new directory.
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
`plugins` 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].

Expand Down Expand Up @@ -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]
Expand All @@ -63,7 +63,7 @@ Use the `remove` command to remove a plugin, including any configuration informa
[source,shell]
$ bin/kibana-plugin remove timelion

You can also remove a plugin manually by deleting the plugin's subdirectory under the `installedPlugins/` directory.
You can also remove a plugin manually by deleting the plugin's subdirectory under the `plugins/` directory.

[float]
=== Listing Installed Plugins
Expand All @@ -78,28 +78,28 @@ 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
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]
Expand All @@ -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]
Expand All @@ -126,4 +126,4 @@ Use the following command to disable a plugin:
[source,shell]
./bin/kibana --<plugin ID>.enabled=false

You can find a plugin's plugin ID as the value of the `name` property in the plugin's `package.json` file.
You can find a plugin's plugin ID as the value of the `name` property in the plugin's `package.json` file.
2 changes: 1 addition & 1 deletion src/cli/cluster/cluster_manager.js
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ module.exports = class ClusterManager {

const watchPaths = uniq(
[
fromRoot('src/plugins'),
fromRoot('src/core_plugins'),
fromRoot('src/server'),
fromRoot('src/ui'),
fromRoot('src/utils'),
Expand Down
2 changes: 1 addition & 1 deletion src/optimize/base_optimizer.js
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ class BaseOptimizer {
{ test: /\.(html|tmpl)$/, loader: 'raw' },
{ test: /\.png$/, loader: 'url?limit=10000&name=[path][name].[ext]' },
{ test: /\.(woff|woff2|ttf|eot|svg|ico)(\?|$)/, loader: 'file?name=[path][name].[ext]' },
{ test: /[\/\\]src[\/\\](plugins|ui)[\/\\].+\.js$/, loader: `rjs-repack${mapQ}` },
{ test: /[\/\\]src[\/\\](core_plugins|ui)[\/\\].+\.js$/, loader: `rjs-repack${mapQ}` },
{
test: /\.js$/,
exclude: babelExclude.concat(this.env.noParse),
Expand Down

0 comments on commit 14530f5

Please sign in to comment.