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

Removed all references to site plugins from plugin docs

Browse source
This commit is contained in:
Clinton Gormley 2016-04-12 19:28:09 +02:00
parent 5af6982338
commit 098b2e03b5
11 changed files with 12 additions and 196 deletions
Download patch file Download diff file Expand all files Collapse all files

47
docs/plugins/plugin-script.asciidoc
View file

@ -20,7 +20,7 @@ sudo bin/elasticsearch-plugin -h
.Running as root
=====================
If Elasticsearch was installed using the deb or rpm package then run
`bin/elasticsearch-plugin` as `root` so it can write to the appropriate files on disk.
`/usr/share/elasticsearch-plugin` as `root` so it can write to the appropriate files on disk.
Otherwise run `bin/elasticsearch-plugin` as the user that owns all of the Elasticsearch
files.
=====================
@ -53,41 +53,6 @@ sudo bin/elasticsearch-plugin install analysis-icu
This command will install the version of the plugin that matches your
Elasticsearch version.
[float]
=== Community and non-core plugins
Non-core plugins provided by Elasticsearch, or plugins provided by the
community, can be installed from `download.elastic.co`, from Maven (Central
and Sonatype), or from GitHub. In this case, the command is as follows:
[source,shell]
-----------------------------------
sudo bin/elasticsearch-plugin install [org]/[user|component]/[version]
-----------------------------------
For instance, to install the https://github.com/lmenezes/elasticsearch-kopf[Kopf]
plugin from GitHub, run one of the following commands:
[source,shell]
-----------------------------------
sudo bin/elasticsearch-plugin install lmenezes/elasticsearch-kopf <1>
sudo bin/elasticsearch-plugin install lmenezes/elasticsearch-kopf/2.x <2>
-----------------------------------
<1> Installs the latest version from GitHub.
<2> Installs the 1.x version from GitHub.
When installing from Maven Central/Sonatype, `[org]` should be replaced by
the artifact `groupId`, and `[user|component]` by the `artifactId`. For
instance, to install the {plugins}/mapper-attachments.html[`mapper-attachments`]
plugin from Sonatype, run:
[source,shell]
-----------------------------------
sudo bin/elasticsearch-plugin install org.elasticsearch.plugin/mapper-attachments/3.0.0 <1>
-----------------------------------
<1> When installing from `download.elastic.co` or from Maven Central/Sonatype, the
version is required.
[float]
=== Custom URL or file system
@ -186,13 +151,13 @@ waits. Here is some examples of setting it to different values:
[source,shell]
-----------------------------------
# Wait for 30 seconds before failing
sudo bin/elasticsearch-plugin install mobz/elasticsearch-head --timeout 30s
sudo bin/elasticsearch-plugin install analysis-icu --timeout 30s
# Wait for 1 minute before failing
sudo bin/elasticsearch-plugin install mobz/elasticsearch-head --timeout 1m
sudo bin/elasticsearch-plugin install analysis-icu --timeout 1m
# Wait forever (default)
sudo bin/elasticsearch-plugin install mobz/elasticsearch-head --timeout 0
sudo bin/elasticsearch-plugin install analysis-icu --timeout 0
-----------------------------------
[float]
@ -212,7 +177,7 @@ On Windows, they need to be added to the `ES_JAVA_OPTS` environment variable:
[source,shell]
-----------------------------------
set ES_JAVA_OPTS="-DproxyHost=host_name -DproxyPort=port_number"
bin/elasticsearch-plugin install mobz/elasticsearch-head
bin/elasticsearch-plugin install analysis-icu
-----------------------------------
=== Settings related to plugins
@ -243,7 +208,7 @@ example:
[source,yaml]
--------------------------------------------------
plugin.mandatory: mapper-attachments,lang-python
plugin.mandatory: analysis-icu,lang-js
--------------------------------------------------
For safety reasons, a node will not start if it is missing a mandatory plugin.