summaryrefslogtreecommitdiff
path: root/core/src/main/resources/org/elasticsearch/plugins/plugin-install.help
blob: 3cb31e22a9182b7fbfff8db43e84428c8111c43a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
NAME

    install - Install a plugin

SYNOPSIS

    plugin install <name or url>

DESCRIPTION

    This command installs an elasticsearch plugin. It can be used as follows:

    Officially supported or commercial plugins require just the plugin name:

        plugin install analysis-icu
        plugin install shield

    Plugins from GitHub require 'username/repository' or 'username/repository/version':

        plugin install lmenezes/elasticsearch-kopf
        plugin install lmenezes/elasticsearch-kopf/1.5.7

    Plugins from Maven Central or Sonatype require 'groupId/artifactId/version':

        plugin install org.elasticsearch/elasticsearch-mapper-attachments/2.6.0

    Plugins can be installed from a custom URL or file location as follows:

        plugin install http://some.domain.name//my-plugin-1.0.0.zip
        plugin install file:/path/to/my-plugin-1.0.0.zip

OFFICIAL PLUGINS

    The following plugins are officially supported and can be installed by just referring to their name

    - analysis-icu
    - analysis-kuromoji
    - analysis-phonetic
    - analysis-smartcn
    - analysis-stempel
    - delete-by-query
    - discovery-azure
    - discovery-ec2
    - discovery-gce
    - discovery-multicast
    - lang-javascript
    - lang-plan-a
    - lang-python
    - mapper-attachments
    - mapper-murmur3
    - mapper-size
    - reindex
    - repository-azure
    - repository-hdfs
    - repository-s3
    - store-smb


OPTIONS

    -t,--timeout                 Timeout until the plugin download is abort

    -v,--verbose                 Verbose output

    -h,--help                    Shows this message

    -b,--batch                   Enable batch mode explicitly, automatic confirmation of security permissions