|
1 | | ---- |
2 | | -layout: guide |
3 | | -title: Plugins |
4 | | -cat: guide |
5 | | -sidebar: reference_modules |
6 | | ---- |
7 | | - |
8 | | -h1. Plugins |
9 | | - |
10 | | -p. Plugins are a way to enhance the basic elasticsearch functionality in a custom manner. They range from adding custom mapping types, custom analyzers (in a more built in fashion), native scripts, custom discovery and more. |
11 | | - |
12 | | -h2. Installing plugins |
13 | | - |
14 | | -p. Installing plugins can either be done manually by placing them under the @plugins@ directory, or using the @plugin@ script. Several plugins can be found under the "elasticsearch":https://github.com/elasticsearch organization in GitHub, starting with @elasticsearch-@. |
15 | | - |
16 | | -p. Plugins can also be automatically downloaded and installed from gitub using: @user_name/repo_name@ structure, or, for explicit versions, using @user_name/repo_name/version_number@. When no version number is specified, first a version based on the elasticsearch version is tried, and if it does not work, then master is used. |
17 | | - |
18 | | -h2. Site Plugins |
19 | | - |
20 | | -p. Plugins can have "sites" in them, any plugin that exists under the @plugins@ directory with a @_site@ directory, its content will be statically served when hitting @/_plugin/[plugin_name]/@ url. Those can be added even after the process has started. |
21 | | - |
22 | | -p. Installed plugins that do not contain any java related content, will automatically be detected as site plugins, and their content will be moved under @_site@. |
23 | | - |
24 | | -p. The ability to install plugins from github allows to easily install site plugins hosted there, for example, running: |
25 | | - |
26 | | -<pre class="prettyprint"> |
27 | | -bin/plugin -install Aconex/elasticsearch-head |
28 | | -bin/plugin -install lukas-vlcek/bigdesk |
29 | | -</pre> |
30 | | - |
31 | | -p. Will install both of those site plugins, with @elasticsearch-head@ available under @http://localhost:9200/_plugin/head/@ and @bigdesk@ available under @http://localhost:9200/_plugin/bigdesk/@. |
32 | | - |
33 | | -h2. Mandatory Plugins |
34 | | - |
35 | | -p. If you rely on some plugins, you can define mandatory plugins using the @plugin.mandatory@ attribute, for example, here is a sample config: |
36 | | - |
37 | | -<pre class="prettyprint"> |
38 | | -plugin.mandatory: mapper-attachments,lang-groovy |
39 | | -</pre> |
40 | | - |
41 | | -p. For safety reasons, if a mandatory plugin is not installed, the node will not start. |
42 | | - |
43 | | -h1. Known Plugins |
44 | | - |
45 | | -h2. Analysis Plugins |
46 | | - |
47 | | -* "Smart Chinese Analysis Plugin":https://github.com/elasticsearch/elasticsearch-analysis-smartcn (by elasticsearch team) |
48 | | -* "ICU Analysis plugin":https://github.com/elasticsearch/elasticsearch-analysis-icu (by elasticsearch team) |
49 | | -* "Stempel (Polish) Analysis plugin":https://github.com/elasticsearch/elasticsearch-analysis-stempel (by elasticsearch team) |
50 | | -* "IK Analysis Plugin":https://github.com/medcl/elasticsearch-analysis-ik (by Medcl) |
51 | | -* "Mmseg Analysis Plugin":https://github.com/medcl/elasticsearch-analysis-mmseg (by Medcl) |
52 | | -* "Hunspell Analysis Plugin":https://github.com/jprante/elasticsearch-analysis-hunspell (by Jörg Prante) |
53 | | -* "Japanese Analysis plugin":https://github.com/suguru/elasticsearch-analysis-japanese (by suguru). |
54 | | - |
55 | | -h2. River Plugins |
56 | | - |
57 | | -* "CouchDB River Plugin":https://github.com/elasticsearch/elasticsearch-river-couchdb (by elasticsearch team) |
58 | | -* "Wikipedia River Plugin":https://github.com/elasticsearch/elasticsearch-river-wikipedia (by elasticsearch team) |
59 | | -* "Twitter River Plugin":https://github.com/elasticsearch/elasticsearch-river-twitter (by elasticsearch team) |
60 | | -* "RabbitMQ River Plugin":https://github.com/elasticsearch/elasticsearch-river-rabbitmq (by elasticsearch team) |
61 | | -* "RSS River Plugin":http://dadoonet.github.com/rssriver/ (by David Pilato) |
62 | | -* "MongoDB River Plugin":https://github.com/richardwilly98/elasticsearch-river-mongodb/ (by Richard Louapre) |
63 | | - |
64 | | -h2. Transport Plugins |
65 | | - |
66 | | -* "Servlet transport":https://github.com/elasticsearch/elasticsearch-transport-wares (by elasticsearch team) |
67 | | -* "Memcached transport plugin":https://github.com/elasticsearch/elasticsearch-transport-memcached (by elasticsearch team) |
68 | | -* "Thrift Transport":https://github.com/elasticsearch/elasticsearch-transport-thrift (by elasticsearch team) |
69 | | -* "ZeroMQ transport layer plugin":https://github.com/tlrx/transport-zeromq (by Tanguy Leroux) |
70 | | - |
71 | | -h2. Scripting Plugins |
72 | | - |
73 | | -* "Python language Plugin":https://github.com/elasticsearch/elasticsearch-lang-python (by elasticsearch team) |
74 | | -* "JavaScript language Plugin":https://github.com/elasticsearch/elasticsearch-lang-javascript (by elasticsearch team) |
75 | | -* "Groovy lang Plugin":https://github.com/elasticsearch/elasticsearch-lang-groovy (by elasticsearch team) |
76 | | - |
77 | | -h2. Site Plugins |
78 | | - |
79 | | -* "BigDesk Plugin":https://github.com/lukas-vlcek/bigdesk (by Lukáš Vlček) |
80 | | -* "Elasticsearch Head Plugin":https://github.com/Aconex/elasticsearch-head (by Ben Birch) |
81 | | - |
82 | | -h2. Misc Plugins |
83 | | - |
84 | | -* "Mapper Attachments Type plugin":https://github.com/elasticsearch/elasticsearch-mapper-attachments (by elasticsearch team) |
85 | | -* "Hadoop Plugin":https://github.com/elasticsearch/elasticsearch-hadoop (by elasticsearch team) |
86 | | -* "AWS Cloud Plugin":https://github.com/elasticsearch/elasticsearch-cloud-aws (by elasticsearch team) |
87 | | -* "ElasticSearch Mock Solr Plugin":https://github.com/mattweber/elasticsearch-mocksolrplugin (by Matt Weber) |
88 | | -* "Suggester Plugin":https://github.com/spinscale/elasticsearch-suggest-plugin (by Alexander Reelsen) |
89 | | -* "ElasticSearch PartialUpdate Plugin":https://github.com/medcl/elasticsearch-partialupdate (by Medcl) |
90 | | - |
91 | | - |
| 1 | +--- |
| 2 | +layout: guide |
| 3 | +title: Plugins |
| 4 | +cat: guide |
| 5 | +sidebar: reference_modules |
| 6 | +--- |
| 7 | + |
| 8 | +h1. Plugins |
| 9 | + |
| 10 | +p. Plugins are a way to enhance the basic elasticsearch functionality in a custom manner. They range from adding custom mapping types, custom analyzers (in a more built in fashion), native scripts, custom discovery and more. |
| 11 | + |
| 12 | +h2. Installing plugins |
| 13 | + |
| 14 | +p. Installing plugins can either be done manually by placing them under the @plugins@ directory, or using the @plugin@ script. Several plugins can be found under the "elasticsearch":https://github.com/elasticsearch organization in GitHub, starting with @elasticsearch-@. |
| 15 | + |
| 16 | +p. Plugins can also be automatically downloaded and installed from gitub using: @user_name/repo_name@ structure, or, for explicit versions, using @user_name/repo_name/version_number@. When no version number is specified, first a version based on the elasticsearch version is tried, and if it does not work, then master is used. |
| 17 | + |
| 18 | +h2. Site Plugins |
| 19 | + |
| 20 | +p. Plugins can have "sites" in them, any plugin that exists under the @plugins@ directory with a @_site@ directory, its content will be statically served when hitting @/_plugin/[plugin_name]/@ url. Those can be added even after the process has started. |
| 21 | + |
| 22 | +p. Installed plugins that do not contain any java related content, will automatically be detected as site plugins, and their content will be moved under @_site@. |
| 23 | + |
| 24 | +p. The ability to install plugins from github allows to easily install site plugins hosted there, for example, running: |
| 25 | + |
| 26 | +<pre class="prettyprint"> |
| 27 | +bin/plugin -install Aconex/elasticsearch-head |
| 28 | +bin/plugin -install lukas-vlcek/bigdesk |
| 29 | +</pre> |
| 30 | + |
| 31 | +p. Will install both of those site plugins, with @elasticsearch-head@ available under @http://localhost:9200/_plugin/head/@ and @bigdesk@ available under @http://localhost:9200/_plugin/bigdesk/@. |
| 32 | + |
| 33 | +h2. Mandatory Plugins |
| 34 | + |
| 35 | +p. If you rely on some plugins, you can define mandatory plugins using the @plugin.mandatory@ attribute, for example, here is a sample config: |
| 36 | + |
| 37 | +<pre class="prettyprint"> |
| 38 | +plugin.mandatory: mapper-attachments,lang-groovy |
| 39 | +</pre> |
| 40 | + |
| 41 | +p. For safety reasons, if a mandatory plugin is not installed, the node will not start. |
| 42 | + |
| 43 | +h1. Known Plugins |
| 44 | + |
| 45 | +h2. Analysis Plugins |
| 46 | + |
| 47 | +* "Smart Chinese Analysis Plugin":https://github.com/elasticsearch/elasticsearch-analysis-smartcn (by elasticsearch team) |
| 48 | +* "ICU Analysis plugin":https://github.com/elasticsearch/elasticsearch-analysis-icu (by elasticsearch team) |
| 49 | +* "Stempel (Polish) Analysis plugin":https://github.com/elasticsearch/elasticsearch-analysis-stempel (by elasticsearch team) |
| 50 | +* "IK Analysis Plugin":https://github.com/medcl/elasticsearch-analysis-ik (by Medcl) |
| 51 | +* "Mmseg Analysis Plugin":https://github.com/medcl/elasticsearch-analysis-mmseg (by Medcl) |
| 52 | +* "Hunspell Analysis Plugin":https://github.com/jprante/elasticsearch-analysis-hunspell (by Jörg Prante) |
| 53 | +* "Japanese Analysis plugin":https://github.com/suguru/elasticsearch-analysis-japanese (by suguru). |
| 54 | + |
| 55 | +h2. River Plugins |
| 56 | + |
| 57 | +* "CouchDB River Plugin":https://github.com/elasticsearch/elasticsearch-river-couchdb (by elasticsearch team) |
| 58 | +* "Wikipedia River Plugin":https://github.com/elasticsearch/elasticsearch-river-wikipedia (by elasticsearch team) |
| 59 | +* "Twitter River Plugin":https://github.com/elasticsearch/elasticsearch-river-twitter (by elasticsearch team) |
| 60 | +* "RabbitMQ River Plugin":https://github.com/elasticsearch/elasticsearch-river-rabbitmq (by elasticsearch team) |
| 61 | +* "RSS River Plugin":http://dadoonet.github.com/rssriver/ (by David Pilato) |
| 62 | +* "MongoDB River Plugin":https://github.com/richardwilly98/elasticsearch-river-mongodb/ (by Richard Louapre) |
| 63 | + |
| 64 | +h2. Transport Plugins |
| 65 | + |
| 66 | +* "Servlet transport":https://github.com/elasticsearch/elasticsearch-transport-wares (by elasticsearch team) |
| 67 | +* "Memcached transport plugin":https://github.com/elasticsearch/elasticsearch-transport-memcached (by elasticsearch team) |
| 68 | +* "Thrift Transport":https://github.com/elasticsearch/elasticsearch-transport-thrift (by elasticsearch team) |
| 69 | +* "ZeroMQ transport layer plugin":https://github.com/tlrx/transport-zeromq (by Tanguy Leroux) |
| 70 | + |
| 71 | +h2. Scripting Plugins |
| 72 | + |
| 73 | +* "Python language Plugin":https://github.com/elasticsearch/elasticsearch-lang-python (by elasticsearch team) |
| 74 | +* "JavaScript language Plugin":https://github.com/elasticsearch/elasticsearch-lang-javascript (by elasticsearch team) |
| 75 | +* "Groovy lang Plugin":https://github.com/elasticsearch/elasticsearch-lang-groovy (by elasticsearch team) |
| 76 | + |
| 77 | +h2. Site Plugins |
| 78 | + |
| 79 | +* "BigDesk Plugin":https://github.com/lukas-vlcek/bigdesk (by Lukáš Vlček) |
| 80 | +* "Elasticsearch Head Plugin":https://github.com/Aconex/elasticsearch-head (by Ben Birch) |
| 81 | + |
| 82 | +h2. Misc Plugins |
| 83 | + |
| 84 | +* "Mapper Attachments Type plugin":https://github.com/elasticsearch/elasticsearch-mapper-attachments (by elasticsearch team) |
| 85 | +* "Hadoop Plugin":https://github.com/elasticsearch/elasticsearch-hadoop (by elasticsearch team) |
| 86 | +* "AWS Cloud Plugin":https://github.com/elasticsearch/elasticsearch-cloud-aws (by elasticsearch team) |
| 87 | +* "ElasticSearch Mock Solr Plugin":https://github.com/mattweber/elasticsearch-mocksolrplugin (by Matt Weber) |
| 88 | +* "Suggester Plugin":https://github.com/spinscale/elasticsearch-suggest-plugin (by Alexander Reelsen) |
| 89 | +* "ElasticSearch PartialUpdate Plugin":https://github.com/medcl/elasticsearch-partialupdate (by Medcl) |
| 90 | + |
0 commit comments