Skip to content

Commit

Permalink
Clarify when overriding plugin_dir is necessary
Browse files Browse the repository at this point in the history
  • Loading branch information
michaelklishin committed Jul 17, 2015
1 parent 78cabea commit b37ce9f
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Expand Up @@ -182,10 +182,16 @@ Actions: `:install`, `:remove`
Installs or removes a plugin to a given elasticsearch instance and plugin
directory.

When running a single instance per machine (VM, etc), it's typically
sufficient to rely on the default value of `plugin_dir`:

```
elasticsearch_plugin 'mobz/elasticsearch-head'
```

To run multiple instances per machine, an explicit `plugin_dir` location
has to be provided:

```
elasticsearch_plugin 'mobz/elasticsearch-head' do
plugin_dir '/usr/local/awesome/elasticsearch-1.5.0/plugins'
Expand Down

0 comments on commit b37ce9f

Please sign in to comment.