Skip to content

Update defaults in documentation for Windows MSI Installer #25483

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jun 30, 2017
Merged

Update defaults in documentation for Windows MSI Installer #25483

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 6 additions & 9 deletions docs/reference/setup/install/windows.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,6 @@ part of the installation:
[[msi-installer-selected-plugins]]
image::images/msi_installer/msi_installer_selected_plugins.png[]

By default, the {xpack-ref}/index.html[X-Pack] plugin will be selected to be installed, and if
installing with the <<ingest, ingest>> node role, the {plugins}/ingest-attachment.html[Ingest Attachment Processor] and {plugins}/ingest-geoip.html[Ingest GeoIP Processor] plugins will also be selected for installation.

NOTE: X-Pack includes a trial license for 30 days. After that, you can obtain one of the https://www.elastic.co/subscriptions[available subscriptions] or {ref}/security-settings.html[disable Security]. The Basic license is free and includes the https://www.elastic.co/products/x-pack/monitoring[Monitoring] extension.

After clicking the install button, Elasticsearch will be installed:
Expand Down Expand Up @@ -104,7 +101,7 @@ start /wait msiexec.exe /i elasticsearch-{version}.msi /qn

As with any MSI installation package, a log file for the installation process can be found
within the `%TEMP%` directory, with a randomly generated name adhering to the format
`MSI*.LOG`. The path to a log file can be supplied using the `/l` command line argument
`MSI<random>.LOG`. The path to a log file can be supplied using the `/l` command line argument

["source","sh",subs="attributes,callouts"]
--------------------------------------------
Expand All @@ -129,7 +126,7 @@ as _properties_ within Windows Installer documentation) that can be passed to ms
[horizontal]
`INSTALLDIR`::

The installation directory. Defaults to `%PROGRAMFILES%\Elastic\Elasticsearch`
The installation directory. Defaults to `%ProgramW6432%\Elastic\Elasticsearch`

`DATADIRECTORY`::

Expand Down Expand Up @@ -212,12 +209,13 @@ Defaults to `%ALLUSERSPROFILE%\Elastic\Elasticsearch\data`
`SELECTEDMEMORY`::

The amount of memory to allocate to the JVM heap for Elasticsearch.
Defaults to half of the available memory on the target machine, up to a maximum of 30.5GB
Defaults to `2048`. If the target machine has less than 4GB in total, defaults
to 50% of total memory.

`LOCKMEMORY`::

Whether `bootstrap.memory_lock` should be used to try to lock the process
address space into RAM. Defaults to `true`
address space into RAM. Defaults to `false`

`UNICASTNODES`::

Expand Down Expand Up @@ -245,8 +243,7 @@ Defaults to `%ALLUSERSPROFILE%\Elastic\Elasticsearch\data`

`PLUGINS`::

A comma separated list of the plugins to download and install as part of the installation. Defaults to
`x-pack, ingest-attachment, ingest-geoip`
A comma separated list of the plugins to download and install as part of the installation. Defaults `""`

To pass a value, simply append the property name and value using the format `<PROPERTYNAME>="<VALUE>"` to
the installation command. For example, to use a different installation directory to the default one:
Expand Down