From 42eda9f99e9eb0355c6a42d0e4728eab9eac77b8 Mon Sep 17 00:00:00 2001 From: Chris Earle Date: Fri, 18 Nov 2016 13:40:04 -0500 Subject: [PATCH 1/4] [DOCS] Plugin Installation for Windows This shows an example of how to install a plugin on Windows, which is not as obvious at I would have expected. --- docs/plugins/plugin-script.asciidoc | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/docs/plugins/plugin-script.asciidoc b/docs/plugins/plugin-script.asciidoc index e7f4d25802384..4c7d406dea303 100644 --- a/docs/plugins/plugin-script.asciidoc +++ b/docs/plugins/plugin-script.asciidoc @@ -64,13 +64,35 @@ sudo bin/elasticsearch-plugin install [url] <1> ----------------------------------- <1> must be a valid URL, the plugin name is determined from its descriptor. -For instance, to install a plugin from your local file system, you could run: +==== Unix File System + +To install a plugin from your local file system at `/path/to/plugin.zip`, you could run: [source,shell] ----------------------------------- sudo bin/elasticsearch-plugin install file:///path/to/plugin.zip ----------------------------------- +==== Windows File System + +On Windows, the `file` path is much easier to work with using absolute paths only. Absolute paths +that include a drive letter require three leading `/` before the drive letter. This uses Java's +built-in parsing behavior. + +[source,shell] +----------------------------------- +bin\elasticsearch-plugin install "file:///C:/Program Files/path/to/plugin.zip" +----------------------------------- + +NOTE: Any path that contains spaces must be contained in quotes! + +==== URL + +[source,shell] +----------------------------------- +sudo bin/elasticsearch-plugin install http://some.domain/path/to/plugin.zip +----------------------------------- + The plugin script will refuse to talk to an HTTPS URL with an untrusted certificate. To use a self-signed HTTPS cert, you will need to add the CA cert to a local Java truststore and pass the location to the script as follows: From f86811a8fe14d26de94991d365917ca621c0f9e1 Mon Sep 17 00:00:00 2001 From: Chris Earle Date: Mon, 21 Nov 2016 10:06:06 -0500 Subject: [PATCH 2/4] Change layout to remove extra titles and unnecessary detail --- docs/plugins/plugin-script.asciidoc | 30 ++++++++++++++--------------- 1 file changed, 14 insertions(+), 16 deletions(-) diff --git a/docs/plugins/plugin-script.asciidoc b/docs/plugins/plugin-script.asciidoc index 4c7d406dea303..2da45e7b7dc2c 100644 --- a/docs/plugins/plugin-script.asciidoc +++ b/docs/plugins/plugin-script.asciidoc @@ -64,39 +64,37 @@ sudo bin/elasticsearch-plugin install [url] <1> ----------------------------------- <1> must be a valid URL, the plugin name is determined from its descriptor. -==== Unix File System - +Unix:: ++ To install a plugin from your local file system at `/path/to/plugin.zip`, you could run: - ++ [source,shell] ----------------------------------- sudo bin/elasticsearch-plugin install file:///path/to/plugin.zip ----------------------------------- -==== Windows File System - -On Windows, the `file` path is much easier to work with using absolute paths only. Absolute paths -that include a drive letter require three leading `/` before the drive letter. This uses Java's -built-in parsing behavior. - +Windows:: ++ +To install a plugin from your local file system at `C:\path\to\plugin.zip`, you could run: ++ [source,shell] ----------------------------------- -bin\elasticsearch-plugin install "file:///C:/Program Files/path/to/plugin.zip" +bin\elasticsearch-plugin install file:///C:\path\to\plugin.zip ----------------------------------- ++ +NOTE: Any path that contains spaces must be wrapped in quotes! -NOTE: Any path that contains spaces must be contained in quotes! - -==== URL - +HTTP:: ++ [source,shell] ----------------------------------- sudo bin/elasticsearch-plugin install http://some.domain/path/to/plugin.zip ----------------------------------- - ++ The plugin script will refuse to talk to an HTTPS URL with an untrusted certificate. To use a self-signed HTTPS cert, you will need to add the CA cert to a local Java truststore and pass the location to the script as follows: - ++ [source,shell] ----------------------------------- sudo ES_JAVA_OPTS="-Djavax.net.ssl.trustStore=/path/to/trustStore.jks" bin/elasticsearch-plugin install https://.... From 21e0df33a04a91c90b32ec24b484fef85e2f655b Mon Sep 17 00:00:00 2001 From: Chris Earle Date: Mon, 21 Nov 2016 10:22:58 -0500 Subject: [PATCH 3/4] change '....' to 'host/plugin.zip' --- docs/plugins/plugin-script.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/plugins/plugin-script.asciidoc b/docs/plugins/plugin-script.asciidoc index 2da45e7b7dc2c..ec73d4a91bcf1 100644 --- a/docs/plugins/plugin-script.asciidoc +++ b/docs/plugins/plugin-script.asciidoc @@ -97,7 +97,7 @@ to a local Java truststore and pass the location to the script as follows: + [source,shell] ----------------------------------- -sudo ES_JAVA_OPTS="-Djavax.net.ssl.trustStore=/path/to/trustStore.jks" bin/elasticsearch-plugin install https://.... +sudo ES_JAVA_OPTS="-Djavax.net.ssl.trustStore=/path/to/trustStore.jks" bin/elasticsearch-plugin install https://host/plugin.zip ----------------------------------- [[listing-removing-updating]] From 3217f2219a0cd6055f2caaa33394868c5b44afa9 Mon Sep 17 00:00:00 2001 From: Chris Earle Date: Mon, 9 Oct 2017 19:17:12 -0400 Subject: [PATCH 4/4] flipping \ to / --- docs/plugins/plugin-script.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/plugins/plugin-script.asciidoc b/docs/plugins/plugin-script.asciidoc index ec73d4a91bcf1..6b17f1331f278 100644 --- a/docs/plugins/plugin-script.asciidoc +++ b/docs/plugins/plugin-script.asciidoc @@ -79,7 +79,7 @@ To install a plugin from your local file system at `C:\path\to\plugin.zip`, you + [source,shell] ----------------------------------- -bin\elasticsearch-plugin install file:///C:\path\to\plugin.zip +bin\elasticsearch-plugin install file:///C:/path/to/plugin.zip ----------------------------------- + NOTE: Any path that contains spaces must be wrapped in quotes!