Skip to content
This repository was archived by the owner on May 24, 2023. It is now read-only.

Commit a84c11c

Browse files
committed
Update README
1 parent 80729df commit a84c11c

File tree

1 file changed

+19
-13
lines changed

1 file changed

+19
-13
lines changed

README.md

Lines changed: 19 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,21 @@ This is the repository for the Elastic stack MSI-based Windows installers.
99
Simply clone the repository and run
1010

1111
```bat
12-
build
12+
build.bat
1313
```
1414

1515
This will download the latest version of the stack (currently only Elasticsearch) and create the MSIs.
1616

1717
You can also specify a specific version
1818

1919
```bat
20-
build 5.1.1
20+
build.bat 5.1.1
21+
```
22+
23+
There are many other configuration options available, run the following to see them all
24+
25+
```bat
26+
build.bat help
2127
```
2228

2329
**NOTE**: *Building from source should only be done for development purposes. Only the officially distributed and signed Elastic installer should be used in production. Using an unofficial Elastic installer is not supported.*
@@ -27,29 +33,29 @@ build 5.1.1
2733
Instead of installing through the UI, it is also possible to perform an installation in "quiet" mode via the command-line using [msiexec](https://technet.microsoft.com/en-us/library/bb490936.aspx?f=255&MSPPError=-2147217396) and passing the `/qn` flag, which will invoke the installer without the UI. This can be particularly useful for automating deployments.
2834

2935
```bat
30-
msiexec /i elasticsearch-5.1.1.msi /qn
36+
start /wait msiexec.exe /i elasticsearch-5.5.0.msi /qn
3137
```
3238

3339
You can also optionally specify a log file
3440

3541
```bat
36-
msiexec /i elasticsearch-5.1.1.msi /qn /l elastic-install.log
42+
start /wait msiexec.exe /i elasticsearch-5.5.0.msi /qn /l elastic-install.log
3743
```
3844

3945
All of the configurable options available in the UI are also exposed as command line arguments to `msiexec`:
4046

4147
```bat
42-
msiexec /i elasticsearch-5.1.1.msi /qn /l elastic-install.log NODENAME=my_node_name CLUSTERNAME=my_cluster_name
48+
start /wait msiexec.exe /i elasticsearch-5.5.0.msi /qn /l elastic-install.log NODENAME=my_node_name CLUSTERNAME=my_cluster_name
4349
```
4450

4551
### Command-line options
4652

4753
| Parameter name | Description | Default value |
4854
| -------------------------------- | -------------------------------- | -------------------------------- |
49-
| INSTALLDIR | Elasticsearch installation path | C:\Program Files\Elastic\Elasticsearch |
50-
| DATADIRECTORY | Data directory path | C:\ProgramData\Elastic\Elasticsearch\data |
51-
| CONFIGDIRECTORY | Config directory path | C:\ProgramData\Elastic\Elasticsearch\config |
52-
| LOGSDIRECTORY | Logs directory path | C:\ProgramData\Elastic\Elasticsearch\logs |
55+
| INSTALLDIR | Elasticsearch installation path | `%ProgramW6432%`\Elastic\Elasticsearch |
56+
| DATADIRECTORY | Data directory path | `%ALLUSERSPROFILE%`\Elastic\Elasticsearch\data |
57+
| CONFIGDIRECTORY | Config directory path | `%ALLUSERSPROFILE%`\Elastic\Elasticsearch\config |
58+
| LOGSDIRECTORY | Logs directory path | `%ALLUSERSPROFILE%`\Elastic\Elasticsearch\logs |
5359
| CLUSTERNAME | Cluster name | elasticsearch |
5460
| NODENAME | Node name | `%COMPUTERNAME%` |
5561
| UNICASTHOSTS | Comma-delimited list of unicast nodes ||
@@ -60,8 +66,8 @@ msiexec /i elasticsearch-5.1.1.msi /qn /l elastic-install.log NODENAME=my_node_n
6066
| DATANODE | Whether or not to make this a data node | `true` |
6167
| INGESTNODE | Whether or not to make this an ingest node| | `true` |
6268
| NETWORKHOST | Hostname to bind to and advertise to other nodes | `true` |
63-
| SELECTEDMEMORY | Amount of memory to allocate to the JVM | 50% of available RAM capped at 32GB |
64-
| LOCKMEMORY | Whether or not to lock JVM memory | `true` |
69+
| SELECTEDMEMORY | Amount of memory to allocate to the JVM | 2GB. If the target machine has less than 4GB RAM, then 50% RAM |
70+
| LOCKMEMORY | Whether or not to lock JVM memory | `false` |
6571
| INSTALLASSERVICE | Install as a Windows service | `true` |
6672
| STARTAFTERINSTALL | Start the service after install is completed | `true` |
6773
| STARTWHENWINDOWSSTARTS | Start the service when Windows starts (Automatic) | `true` |
@@ -70,7 +76,7 @@ msiexec /i elasticsearch-5.1.1.msi /qn /l elastic-install.log NODENAME=my_node_n
7076
| USEEXISTINGUSER | Run the service as the specified `USER` | `false` |
7177
| USER | Existing user to run the service as ||
7278
| PASSWORD | Password for the existing user ||
73-
| PLUGINS | Comma-delimited list of plugins to install | x-pack,ingest-attachment,ingest-geoip |
79+
| PLUGINS | Comma-delimited list of plugins to install | |
7480

7581
## Running as a service
7682

@@ -97,7 +103,7 @@ In addition to installing and running Elasticsearch as a service, it can also be
97103
It also accepts the same command-line arguments as the original bat file.
98104

99105
```bat
100-
./elasticsearch.exe -Ecluster.name=my_cluster_name -Enode.name=my_node_name
106+
./elasticsearch.exe -E cluster.name=my_cluster_name -E node.name=my_node_name
101107
```
102108

103109
## Reporting problems

0 commit comments

Comments
 (0)