-
Notifications
You must be signed in to change notification settings - Fork 25k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[DOCS] Plugin Installation for Windows #21671
Conversation
docs/plugins/plugin-script.asciidoc
Outdated
|
||
[source,shell] | ||
----------------------------------- | ||
sudo bin/elasticsearch-plugin install file:///path/to/plugin.zip | ||
----------------------------------- | ||
|
||
==== Windows File System |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure that the explanatory para is really necessary. Couldn't it just be replaced with:
Or on Windows:
...example...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm okay dropping it, but I regularly use relative paths with a Unix path. Whenever I go to Windows, I get stuck not being able to do it so that's why I mentioned it here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I wonder if I should switch it to break it down like
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::
+
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:\path\to\plugin.zip
-----------------------------------
+
NOTE: Any path that contains spaces must be wrapped in quotes!
http::
+
[source,shell]
-----------------------------------
sudo bin/elasticsearch-plugin install http://some.domain/path/to/plugin.zip
-----------------------------------
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yep, that works for me
docs/plugins/plugin-script.asciidoc
Outdated
@@ -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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think having a file that has three levels of titles in it upsets asciidoc. Check before merging please.
docs/plugins/plugin-script.asciidoc
Outdated
|
||
[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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks like we recommend using an absolute path for unix file systems as well. Maybe drop the mention of absolute paths entirely?
Updated @clintongormley. Let me know what you think. |
@clintongormley Are you ok with this to be merged? |
I don't think this is correct. According to https://blogs.msdn.microsoft.com/ie/2006/12/06/file-uris-in-windows/ the file URL should be |
@clintongormley Ping to review now that this has been updated. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
This shows an example of how to install a plugin on Windows, which is not as obvious at I would have expected.
This shows an example of how to install a plugin on Windows, which is not as obvious at I would have expected.
This shows an example of how to install a plugin on Windows, which is not as obvious at I would have expected.
This shows an example of how to install a plugin on Windows, which is not as obvious at I would have expected.
This shows an example of how to install a plugin on Windows, which is not as obvious at I would have expected.
This shows an example of how to install a plugin on Windows, which is not as obvious at I would have expected.
This shows an example of how to install a plugin on Windows, which is not as obvious at I would have expected.
This shows an example of how to install a plugin on Windows, which is not as obvious at I would have expected.
This shows an example of how to install a plugin on Windows, which is not as obvious at I would have expected.
* master: (35 commits) Create weights lazily in filter and filters aggregation (#26983) Use a dedicated ThreadGroup in rest sniffer (#26897) Fire global checkpoint sync under system context Update by Query is modified to accept short `script` parameter. (#26841) Cat shards bytes (#26952) Add support for parsing inline script (#23824) (#26846) Change default value to true for transpositions parameter of fuzzy query (#26901) Adding unreleased 5.6.4 version number to Version.java Rename TCPTransportTests to TcpTransportTests (#26954) Fix NPE for /_cat/indices when no primary shard (#26953) [DOCS] Fixed indentation of the definition list. Fix formatting in channel close test Check for closed connection while opening Clarify systemd overrides [DOCS] Plugin Installation for Windows (#21671) Painless: add tests for cached boxing (#24163) Don't detect source's XContentType in DocumentParser.parseDocument() (#26880) Fix handling of paths containing parentheses Allow only a fixed-size receive predictor (#26165) Add Homebrew instructions to getting started ...
* 6.x: (32 commits) Use a dedicated ThreadGroup in rest sniffer (#26897) Fire global checkpoint sync under system context Update by Query is modified to accept short `script` parameter. (#26841) Cat shards bytes (#26952) Adding unreleased 5.6.4 version number to Version.java Rename TCPTransportTests to TcpTransportTests (#26954) Fix NPE for /_cat/indices when no primary shard (#26953) [DOCS] Fixed indentation of the definition list. Check for closed connection while opening Clarify systemd overrides [DOCS] Plugin Installation for Windows (#21671) Painless: add tests for cached boxing (#24163) Don't detect source's XContentType in DocumentParser.parseDocument() (#26880) Return List instead of an array from settings (#26903) Emit deprecation warning for variable size predictor Fix handling of paths containing parentheses Deprecate variable-size receive predictor Add Homebrew instructions to getting started ingest: Fix bug that prevent date_index_name processor from accepting timestamps specified as a json number Scripting: Fix expressions to temporarily support filter scripts (#26824) ...
This shows an example of how to install a plugin on Windows, which is not as obvious at I would have expected.