Other command line parameters

The plugin scripts supports a number of other command line parameters:

Silent/Verbose mode

The --verbose parameter outputs more debug information, while the --silent parameter turns off all output. The script may return the following exit codes:

0

everything was OK

64

unknown command or incorrect option parameter

74

IO error

70

any other error

Custom config directory

If your elasticsearch.yml config file is in a custom location, you will need to specify the path to the config file when using the plugin script. You can do this as follows:

sudo bin/plugin -Des.path.conf=/path/to/custom/config/dir install <plugin name>

You can also set the CONF_DIR environment variable to the custom config directory path.

Timeout settings

By default, the plugin script will wait indefinitely when downloading before failing. The timeout parameter can be used to explicitly specify how long it waits. Here is some examples of setting it to different values:

# Wait for 30 seconds before failing
sudo bin/plugin install mobz/elasticsearch-head --timeout 30s

# Wait for 1 minute before failing
sudo bin/plugin install mobz/elasticsearch-head --timeout 1m

# Wait forever (default)
sudo bin/plugin install mobz/elasticsearch-head --timeout 0

Proxy settings

To install a plugin via a proxy, you can pass the proxy details in with the Java settings proxyHost and proxyPort. On Unix based systems, these options can be set on the command line:

sudo bin/plugin install mobz/elasticsearch-head -DproxyHost=host_name -DproxyPort=port_number

On Windows, they need to be added to the JAVA_OPTS environment variable:

set JAVA_OPTS="-DproxyHost=host_name -DproxyPort=port_number"
bin/plugin install mobz/elasticsearch-head